Download the PHP package max26292/eloquent-model-generator without Composer

Eloquent Model Generator

Eloquent Model Generator generates Eloquent models using database schema as a source. ## Version 2.0.0 Version 2.0.0 has been released. Checkout [this discussion](https://github.com/krlove/eloquent-model-generator/discussions/89) for more details and upgrade instructions. ## Installation Step 1. Add Eloquent Model Generator to your project: Step 2. Register `GeneratorServiceProvider`: Step 3. Configure your database connection. ## Usage Use to generate a model class. Generator will look for table named `users` and generate a model for it. ### table-name Use `table-name` option to specify another table name: In this case generated model will contain `protected $table = 'user'` property. ### output-path Generated file will be saved into `app/Models` directory of your application and have `App\Models` namespace by default. If you want to change the destination and namespace, supply the `output-path` and `namespace` options respectively: `output-path` can be absolute path or relative to project's `app` directory. Absolute path must start with `/`: - `/var/www/html/app/Models` - absolute path - `Custom/Models` - relative path, will be transformed to `/var/www/html/app/Custom/Models` (assuming your project app directory is `/var/www/html/app`) ### base-class-name By default, generated class will be extended from `Illuminate\Database\Eloquent\Model`. To change the base class specify `base-class-name` option: ### no-backup If `User.php` file already exist, it will be renamed into `User.php~` first and saved at the same directory. Unless `no-backup` option is specified: ### Other options There are several useful options for defining several model's properties: - `no-timestamps` - adds `public $timestamps = false;` property to the model - `date-format` - specifies `dateFormat` property of the model - `connection` - specifies connection name property of the model ### Overriding default options Instead of specifying options each time when executing the command you can create a config file named `eloquent_model_generator.php` at project's `config` directory with your own default values: ### Registering custom database types If running a command leads to an error it means that you must register your type `` at your `config/eloquent_model_generator.php`: ### Usage example Table `user`: Command: Result: ## Generating models for all tables Command `krlove:generate:models` will generate models for all tables in the database. It accepts all options available for `krlove:generate:model` along with `skip-table` option. ### skip-table Specify one or multiple table names to skip: Note that table names must be specified without prefix if you have one configured. ## Customization You can hook into the process of model generation by adding your own instances of `Krlove\EloquentModelGenerator\Processor\ProcessorInterface` and tagging it with `GeneratorServiceProvider::PROCESSOR_TAG`. Imagine you want to override Eloquent's `perPage` property value. `getPriority` determines the order of when the processor is called relative to other processors. In your service provider: After that, generated models will contain the following code: