Download the PHP package haakco/laravel-enum-generator without Composer
On this page you can find all versions of the php package haakco/laravel-enum-generator. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download haakco/laravel-enum-generator
More information about haakco/laravel-enum-generator
Files in haakco/laravel-enum-generator
Package laravel-enum-generator
Short Description Generates simple class to act as an enum from a table specified in its con
License mit
Homepage https://github.com/haakco/laravel-enum-generator
Informations about the package laravel-enum-generator
LaravelEnumGenerator
This is where your description should go. Take a look at contributing.md to see a to do list.
Installation
Via Composer
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:
Then you'll need to register the provider in app/Providers/AppServiceProvider.php file.
Usage
Copy the config over
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.
Configuration
The config/enum-generator.php file supports the following options:
Global Options
| Option | Default | Description |
|---|---|---|
use-enum-format |
true |
Use PHP 8.1+ enum format (vs legacy class constants) |
default-leave-schema |
false |
Include schema name in generated class name |
default-uuid |
false |
Include UUID field in generated enums |
id-field |
'id' |
Default column name for enum values |
name-field |
'name' |
Default column name for enum case names |
default-prepend_class |
'' |
Prefix for generated class names |
default-prepend_name |
'' |
Prefix for generated enum case names |
enumPath |
app_path() . '/Models/Enums' |
Output directory for generated files |
default-order-by |
['name', 'id'] |
Default ordering for enum cases |
Per-Table Options
Each table in the tables array can have these options:
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
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
Contributing
Please see contributing.md for details and a todolist.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
- Tim Haak
- All Contributors
License
mit. Please see the license file for more information.
All versions of laravel-enum-generator with dependencies
illuminate/support Version ^12.0
illuminate/console Version ^12.0
illuminate/database Version ^12.0
archtechx/enums Version >=1.1.2