README

This is where your description should go. Take a look at contributing.md to see a to do list.

Installation

Via Composer

$ composer require haakco/laravel-enum-generator --dev

Configuration for local environment only

If you wish to enable generators only for your local environment, you should install it via composer using the --dev option like this:

composer require haakco/laravel-enum-generator --dev

Then you'll need to register the provider in app/Providers/AppServiceProvider.php file.

public function register()
{
    if ($this->app->environment() == 'local') {
        $this->app->register(\HaakCo\LaravelEnumGenerator\LaravelEnumGeneratorServiceProvider::class);
    }
}

Usage

Copy the config over

php artisan vendor:publish --provider="HaakCo\LaravelEnumGenerator\LaravelEnumGeneratorServiceProvider"

Edit the config file enum-generator.php to specify which tables to use to generate the files.

Now run the following to re-create your models.

php artisan modelEnum:create

Configuration

The config/enum-generator.php file supports the following options:

Global Options

Per-Table Options

Each table in the tables array can have these options:

'tables' => [
    'public.statuses' => [
        'uuid' => false,
        'leave-schema' => true,
        'prepend-class' => 'App',
        'prepend-name' => 'Status',
        'id-field' => 'id',
        'name-field' => 'name',
        'order-by' => ['name' => 'asc'],
        'where' => [
            'is_active' => true,
            'type' => 'public',
        ],
    ],
],

Filtering Rows with where

Use the where option to filter which database rows become enum cases. This is useful when:

• You have duplicate values and need to filter by another column
• You only want active/enabled records
• You need to limit enums to a specific type or category

'tables' => [
    // Only generate enums for active permissions
    'permissions' => [
        'where' => [
            'is_active' => true,
        ],
    ],

    // Only generate enums where type equals 'system'
    'categories' => [
        'where' => [
            'type' => 'system',
            'deleted_at' => null,
        ],
    ],
],

The where option accepts an associative array where keys are column names and values are matched with equality (=). Multiple conditions are combined with AND.

Change log

Please see the changelog for more information on what has changed recently.

Testing

$ composer test

Contributing

Please see contributing.md for details and a todolist.

Security

If you discover any security related issues, please email tim@haak.co instead of using the issue tracker.

Credits

• Tim Haak
• All Contributors

License

mit. Please see the license file for more information.