Framework: use macroable functionality on schema builder

Created on 29 Feb 2016 · 4Comments · Source: laravel/framework

i think its a little more involved than just adding the macroable trait, but it would be great if we could create macros for migration schemas.

say for example your working on a schema that has a "tenant_id" column (im not going to get into the multi tenant debate here, im aware thats a complicated issue).

it would be great if we could do this:

Blueprint::macro('tenantable', function(Blueprint $table){
    $table->integer('tenant_id')->unsigned();
    $table->foreign('tenant_id')
                  ->references('id')
                  ->on('tenants')
                  ->onDelete('cascade');
});

and then in your migrations use:

Schema::create('users', function (Blueprint $table) {
    //..normal schema functions
    $table->tenantable();
});

having looked at the schema and builder classes i know this wouldnt work for interacting with the db nativley as the grammer used is seperated out into its own class, but we could still use blueprint base functions without issue and creating a macro would just be like grouping a few definitions together but gives a more descriptive definition "in code"

this could be especially useful for foreign key columns and indexes like above, but also for apps where 1 model has multiple relationships. here comes the expected blog example ;-)

Blueprint::macro('hasPost', function(Blueprint $table){
    $table->integer('post_id')->unsigned();
    $table->foreign('post_id')
                  ->references('id')
                  ->on(posts')
                  ->onDelete('cascade');
});

// then
Schema::create('comments', function (Blueprint $table) {
    //..normal schema functions
    $table->hasPost();
});
Schema::create('likes', function (Blueprint $table) {
    //..normal schema functions
    $table->hasPost();
});
Schema::create('images', function (Blueprint $table) {
    //..normal schema functions
    $table->hasPost();
});

as far as im aware adding something like this would be relativly simple and shouldnt cause any breaking changes. if generally accepted id be happy to get something ready for a pull request.

Source

leemason

👍1

All 4 comments

Currently to extend the Blueprint class you would have to do first:

class ExtendedBlueprint extends Illuminate\Database\Schema\Blueprint
{
    ...
}

... then:

$newInstance = Schema::getFacadeRoot();

$newInstance->blueprintResolver(function ($table, $callback = null) {
    return new ExtendedBlueprint($table, $callback);
});

$newInstance->create('foobar', function ($table) {
    ...
});

Indeed, maybe this should be streamlined.