tusimo/eloquent-default

set default value for eloquent

v0.1 2018-02-12 08:57 UTC

Requires

• illuminate/container: ^5.1
• illuminate/database: ^5.1
• illuminate/events: ^5.1
• illuminate/support: ^5.1

MIT

• tusimo

• database
• model
• laravel
• eloquent
• default

README

set the default value for Laravel's ORM. And define the column can save to database.

Installation

Either PHP 5.6+ is required.

To get the latest version of EloquentDefault, simply require the project using Composer:

$ composer require tusimo/eloquent-default

Instead, you may of course manually update your require block and run composer update if you so choose:

{
    "require": {
        "tusimo/eloquent-default": "^0.1"
    }
}

Usage

Within your eloquent model class add following line

use Tusimo\EloquentDefault\DefaultTrait;

class User extends Model {
    use DefaultTrait;
    
    /**
     * define the columns the table has 
     * and define the default value saving to the database when attributes not set the column
     */
    protected $defaults = [
        '_id',
        'gender' => 1,
        'status' => 0,
        'deleted_at' => null,
    ];
    /**
     * when save attributes to database ,columns only defined in the defaults will save to database
     * default is false and we do nothing when the column is not in the database and this will throw 
     * a exception when you using mysql or the data will saving to the database when you using mongo
     */
    protected $columnStrict = true;
    
    /**
     *Also you can define a method as `get*Default` to set a default value
     */
    preotected function getCustomDefault($custom)
    {
        return \Auth::isAdmin ? 'admin' : 'user';
    }
}

License

The MIT License (MIT). Please see License File for more information.