shiftonelabs/laravel-nomad

Add extra functionality to Laravel migrations.

2.0.0 2020-01-15 18:51 UTC

This package is auto-updated.

Last update: 2020-10-15 21:08:48 UTC


README

Latest Version on Packagist Software License Build Status Coverage Status Quality Score Total Downloads

This Laravel/Lumen package provides additional functionality for the Illuminate Database migrations. Currently the only additional functionality is the ability to specify custom database field types, but new functionality can be added as requested/submitted.

Supported Versions

4.1, 4.2, 5.0, 5.1, 5.2, 5.3, 5.4, 5.5, 5.6, 5.7, 5.8, 6.x

This package has been tested on Laravel 4.1 through Laravel 6.x, though it may continue to work on later versions as they are released. This section will be updated to reflect the versions on which the package has actually been tested.

Install

Via Composer

$ composer require shiftonelabs/laravel-nomad

Once composer has been updated and the package has been installed, the service provider will need to be loaded.

Laravel 5.5+, 6.x (5.5, 5.6, 5.7, 5.8, 6.x)

This package uses auto package discovery. The service provider will automatically be registered.

Laravel 5.0 - 5.4 (5.0, 5.1, 5.2, 5.3, 5.4)

For Laravel 5.0 - 5.4, open config/app.php and add the following line to the providers array:

ShiftOneLabs\LaravelNomad\LaravelNomadServiceProvider::class,

Laravel 4 (4.1, 4.2)

For Laravel 4, open app/config/app.php and add the following line to the providers array:

'ShiftOneLabs\LaravelNomad\LaravelNomadServiceProvider',

Lumen 5.0+, 6.x (5.0, 5.1, 5.2, 5.3, 5.4, 5.5, 5.6, 5.7, 5.8, 6.x)

For Lumen 5.0+, 6.x, open bootstrap/app.php and add the following line under the "Register Service Providers" section:

$app->register(ShiftOneLabs\LaravelNomad\LaravelNomadServiceProvider::class);

Usage

Custom Field Types

Laravel's migrations provide methods for a wide base of the standard field types used in the supported databases, however it is not an exhaustive list. Additionally, some databases have extensions that can be enabled that add new field types. Unfortunately, one cannot create fields with these new data types using built-in migration methods.

As an example, PostgreSQL has a "citext" module to allow easy case-insensitive matching. This module adds a new "citext" field data type for storing case-insensitive string data. The built-in migration methods do not have a way to create a "citext" field, so one would have to add a direct "ALTER" statement to run after the table is created.

This package adds a new passthru method to allow defining custom data types in the migration. The passthru method can be used to add a field with any data type, as the specified type is merely passed through to the schema grammar.

The passthru method requires two parameters: the data type and the field name. An optional third parameter can be used to specify the actual data type definition, if needed. The definition method can also be chained on to specify the actual data type definition. A usage example is shown below:

class CreateUsersTable extends Migration {
    public function up()
    {
        Schema::create('users', function(Blueprint $table)
        {
            $table->increments('id');
            $table->passthru('citext', 'name');
            $table->passthru('citext', 'title')->nullable();
            $table->passthru('string', 'email', 'varchar(255)')->unique();
            $table->passthru('string', 'password')->definition('varchar(60)');
            $table->rememberToken();
            $table->timestamps();
        });
    }

    public function down()
    {
        Schema::drop('users');
    }
}

Changelog

This package maintains a changelog. Please see CHANGELOG for details.

Contributing

Contributions are very welcome. Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email patrick@shiftonelabs.com instead of using the issue tracker.

Credits

License

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