laravel-orm/laravel-orm

Describe your table fields in the model and let Laravel manage your migration for you

v0.2.0 2018-11-14 20:37 UTC

Requires

• php: >=7.1.3
• illuminate/database: >=5.0
• mustache/mustache: ^2.12
• nesbot/carbon: >=1.0.0
• symfony/http-kernel: >=4.0.0

Requires (Dev)

• phpmd/phpmd: ^2.6
• squizlabs/php_codesniffer: ^3.3

GPL-3.0+

• Nastuzzi Samy

• database
• orm
• migration
• model
• uuid
• laravel
• automatic
• table
• meta
• field
• auto
• fields
• validations

README

Describe your table fields in the model and let Laravel manage your migration for you.

Installation

Simple installation

composer require laravel-orm/laravel-orm

Usage

Laravel ORM allows you to automate multiple Laravel features as: - Describe perfectly all fields and relations for your model - Manage with the right type all your model attributes - Create easely your relations - Generate for you all your migrations (depending on your model description) - Create all scopes and helpers for building queries - Smartly add validations to your controller

Model description

In a regular User model, it is hard to detect all the fields, the relations, without reading deeply the code or the migration file(s).

Before

use Illuminate\Database\Eloquent\Model;

class User extends Model {
    protected $fillable = ['firstname', 'lastname', 'email', 'admin', 'group_id'];

    protected $casts = [
        'admin' => 'boolean',
    ];

    // By default, we want all except the admin boolean
    protected $hidden = ['admin'];

    public function group() {
        $this->belongsTo(Group::class);
    }
}

After

use LaravelORM\Fields\{
    IncrementField, StringField, EmailField, BooleanField
};
use LaravelORM\CompositeFields\BelongsField;
use LaravelORM\Model;

class User extends Model {
    protected function __schema($schema, $fields) {
        $fields->id = IncrementField::class; // an increment field is by default unfillable
        $fields->firstname = StringField::class;
        $fields->lastname = StringField::class;
        $fields->email = EmailField::new()->unique();
        $fields->admin = BooleanField::new()->default(false)->hidden(); // Auto cast and hidden by default
        $fields->group = BelongsField::new()->to(Group::class);

        $schema->timestamps();

        $schema->unique([$fields->firstname, $fields->lastname]);
    }
}

Here we can now know all defined fields. The group relation is automatically defined.

Migrations

Before

Part of the migration file:

Schema::create('users', function (Blueprint $table) {
    $table->increments('id');
    $table->string('firstname');
    $table->string('lastname');
    $table->string('email')->unique();
    $table->integer('group_id')->unsigned(true);
    $table->timestamp('created_at')->nullable(true);
    $table->timestamp('updated_at')->nullable(true);

    $table->foreign('group_id')->references('id')->on('users');

    $table->unique('firstname', 'lastname');
});

After

The previous file is generated via your model description.

Model interaction

Before

	// Get the first user
	$user = User::first();
	// Get with id 2
	User::where('id', 2)->first();
	// Get the email adress
	$user->email;
	// Set a bad format email adress
	$user->email = 'bad-email';
	// Set a good format email adress
	$user->email = '[e-mail]';
	// Get user group relation
	$user->group();
	// Get user group
	$group = $user->group;
	// Search one user by group
	$user = $user->where('group_id', $group->id)->first();
	// Search all users by group
	$user = $user->where('group_id', $group->id)->get();
	// Search all users with a group id greater than specific one
	$user = $user->where('group_id', '>', $group->id)->get();
	// Get admin boolean (with casting)
	$user->admin; // true
	// Get admin boolean (without casting)
	$user->admin; // 1

After

	// Get the first user
	$user = User::first();
	// Get with id 2
	$user2 = User::id(2);
	// Get the email adress
	$user->email;
	/* Set a bad format email adress
	 * In function of setttings:
	 * - Add automatically the domain (ex: '@email.orm')
	 * - Write the wrong email
	 * - Throw an exception telling the email adress is wrong
	 */
	$user->email = 'bad-email'; // => [e-mail] or Exception
	// Set a good format email adress
	$user->email = '[e-mail]';
	// Get user group relation
	$user->group();
	// Get user group
	$group = $user->group;
	// Search user by group
	$user = $user->group($group);
	// Search user by group
	$user = $user->whereGroup($group)->get();
	// Search all users with a group id greater than specific one
	$user = $user->whereGroup('>', $group)->get();
	// Get admin boolean (auto casting)
	$user->admin; // true

Validations

Not yet done