Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ajcastro/fk-adder

Lets you add foreign keys smart and easy!
https://github.com/ajcastro/fk-adder

foreign-keys laravel laravel-migration

Last synced: 2 months ago
JSON representation

Lets you add foreign keys smart and easy!

Awesome Lists containing this project

README 

        
## FkAdder for Laravel Migration



Lets you add foreign keys smart and easy! Foreign key adder for laravel migration.

For Laravel `4.2` and `5.*`.



The purpose of `FkAdder` is to simplify declaration of foreign key columns in migration.



##### Things that `FkAdder` do for you:

  * __Remembers the data type of a foreign key__, and it will provide the correct data type for you, so that you don't have to recall the data type of foreign key column

      whenever you need that particular foreign key.

  * __Lets you create migration tables in any order__. This solves the problem when your table is created prior than the reference table. Usually this may cause error like `Reference table some_table does not exist`, this happens when referencing the table which are to be migrated on last part of migrations.

  * __Speeds up laravel migration development.__



### Installation



`composer require ajcastro/fk-adder`



### Alias



Add alias into `config/app.php` file. You can skip this because of laravel's auto-discovery.



```php

 'Fk' => FkAdder\Fk::class

```



### Configuration



Create a config file named `config/fk_adder.php`



```php

 base_path('database/foreign_keys/fk_datatypes.php')

    // For class-based declaration, used for special cases and more control. You don't need this for simple cases .

    'fk_namespace' => 'Your\Fk\Namespace',

];

```



### Setup



There are two ways to setup your foreign keys: __string-based declaration__ and __class-based declaration__.

String-based is preferred for simpler datatype declaration.



##### String-based declaration



Open your `fk_datatypes_path` file and add the foreign key declaration in the array.

The array keys are the foreign key columns and its values are the datatypes.

The reference tables are smartly guessed already by remove the `_id` and pluralizing the foreign key names e.g. `user_id` -> `users`.



```php

 'unsignedInteger',

    'group_id'      => 'unsignedInteger',

    'preference_id' => 'unsignedBigInteger',

];

```



Since version 1.2, you can now also define the reference table. This is helpful for foreign keys which has custom table names.



```php

 'unsignedInteger, custom_users',

    'group_id'      => 'unsignedInteger, custom_groups',

];

```



##### Class-based declaration



Create classes of foreign keys declaration inside your `fk_namespace` directory path.



__Naming Convention__



If the foreign key is e.g. `user_id`, then the class name should be `UserId`.



Example:



```php

table->unsignedInteger($column);

    }

}



```



### Sample Usage, Before vs After



__Before__



```php

increments('id');

            $table->unsignedInteger('group_id')->nullable()->comment('Group of the user');

            $table->unsignedBigInteger('preference_id')->nullable()->comment('Preference of the user');



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

            $table->foreign('preference_id')->references('id')->on('preferences')

                ->onDelete('cascade')>onUpdate('cascade');

        });

    }

}



```



__After__



```php

increments('id');



            Fk::make($table)->add('group_id')->nullable()->comment('Group of the user');



            Fk::make($table)

                ->onDelete('cascade')

                ->onUpdate('cascade')

                ->add('preference_id')

                ->nullable()

                ->comment('Preference of the user');

        });



        Fk::migrate();

    }

}



```



__More Features, Benefits and Explanations__



```php

increments('id');



            // Foreign key declaration is one-liner, simpler and more compact.

            // You dont have to type what datatype it is. You will just declare it once.

            Fk::make($table)->add('group_id')->nullable()->comment('Group of the user');

            Fk::make($table)->onDelete('cascade')->add('preference_id')

                ->nullable()->comment('Preference of the user');



            // After you call the method `add()`, it will return an instance of the usual \Illuminate\Support\Fluent,

            // so that you can chain more column declaration like `nullable()` and `comment()`



            // If ever you need a different column name from the foreign key, just pass a second parameter

            // to `add()` method e.g.

            Fk::make($table)->add('group_id', 'new_group_id')->nullable()->comment('New group of the user');



            // The default `onDelete` settings is `restrict` and `onUpdate` is `cascade`.

            Fk::make($table)->onDelete('restrict')->onUpdate('cascade')->add('group_id', 'new_group_id');



            // You can also pass the key name for the foreign key.

            Fk::make($table)->keyName('users_new_group_id_foreign_key')->add('group_id', 'new_group_id');



            // Take note that those foreign key modifiers should be called prior or before the `add()` method.

        });



        // Finally, you may now migrate and persist foreign keys in mysql database.

        // You can call this once at the very end of migration,

        // so all your foreign key declarations accross different migration files will be persisted.

        Fk::migrate();

    }



    /**

     * Reverse the migrations.

     *

     * @return void

     */

    public function down()

    {

        Fk::rollback(); // delete foreign keys persisted by Fk::migrate(), (coming soon...)

        Schema::dropIfExists('users');

    }

}



```



#### License



Released under MIT License.