README

A set of tools and helpers to help the Laravel 4 development.

Instalation

Install via Composer.

{
    "require": {
        "escapework/laravelhelpers": "0.7.*"
    }
}

Models

To make use of the best things in LaravelHelpers, please make sure all your models extends the BaseModel class.

use EscapeWork\LaravelHelpers\BaseModel;

class Product extends BaseModel
{

    // ...
}

Slugs

If you need to make an slug for your model, just use the SluggableTrait;

use EscapeWork\LaravelHelpers\BaseModel;
use EscapeWork\LaravelHelpers\SluggableTrait;

class Product extends BaseModel
{

    use SluggableTrait;
}

When executing the save and update method, the slug is going to be automatically generated by the helper.

The default slug is made by the attribute title. But if you have a diferent attribute, just declare the $sluggableAttr with the field name.

protected $sluggableAttr = 'name';

If you don't want the slug to change when updating your model, set the $makeSlugOnUpdate attribute on your model.

    protected $makeSlugOnUpdate = false;

And the, just use in the regular way your model:

    public function store()
    {
        $this->product->title = 'Hello World';
        $this->product->save();

        echo $this->product->slug; // prints hello-world
    }
}

Search

For search for multiple terms, you can use the scopeSearch method.

$products = $product->search('title', 'this title')->get();

This will convert the SQL too:

select * from products where title regexp 'this.+title'

Setters

LaravelHelpers BaseModel have two setters method to help you:

_setDateAttribute

// model
...
    public function setDateAttribute($date)
    {
        $this->_setDateAttribute('date', $date, $format = 'd/m/Y');
    }
...

// whaterer place you need
$model->date = '10/03/1991'; // this format should be the same as the above

If everything goes fine, $model->date will be an instance of Carbon. Otherwise, $model->date will be null.

_setCurrencyAttribute

// model
...
    public function setPriceBRLAttribute($price)
    {
        $this->_setCurrencyAttribute('priceBRL', $price);
    }

    public function setPriceAttribute($price)
    {
        $this->_setCurrencyAttribute('price', $price, 'USD');
    }
...

// whaterer place you need
$model->priceBRL = '10,90';
$model->price    = '10.90';

var_dump($model->priceBRL); // (float) 10.90';
var_dump($model->price);    // (float) 10.90';

If everything goes fine, a float value will be setted. Otherwise, the value will be null.

Combobox

LaravelHelpers have a method for make combobox easier when using with the Form class.

Form::select('product_id', Product::all()->combobox());

The default attribute for the option text is the title attribute. In case you need other field, just use like this:

Form::select('client_id', Client::all()->combobox(['field' => 'name']); // for using the 'name' field

If you want to create an 'empty' option, you can use like this:

Form::select('client_id', Client::all()->combobox(['field' => 'name', 'empty_option' => true, 'empty_option_label' => 'Select a client']));

The documentation below this line is for the version 0.6, so not everything is the same for now.

Find or Fail By

$product = App::make('ProductRepository'); // just a sample, you probably will use dependency injection
$product->findOrFailBy('slug', 'office-chair');

dd($product->title);

If the product was not found, then a Illuminate\Database\Eloquent\ModelNotFoundException will be thrown, like the Eloquent function findOrFail.

License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

escapework / laravelhelpers

Maintainers

Details