Download the PHP package rayvenues/eloquent-model-generator without Composer
On this page you can find all versions of the php package rayvenues/eloquent-model-generator. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package eloquent-model-generator
Eloquent Model Generator
Eloquent Model Generator generates Eloquent models using database schema as a source.
Version 1.0.0
Version 1.0.0 has been released.
Installation
Step 1. Configure your database connection. Run your migrations.
Step 2. Add Eloquent Model Generator to your project:
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 pathCustom/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:
no-timestamps
If you want to disable timestamps for the model, specify --no-timestamps
option:
date-format
If you want to specify date format for the model, specify --date-format
option:
connection
If you want to specify connection name for the model, specify --connection
option:
Overriding default options
Instead of specifying options each time when executing the command you can publish the config file by executing the following command:
This will create a file named eloquent_model_generator.php
at project's config
directory. You can
modify the file 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 <TYPE>
at your config/eloquent_model_generator.php
:
Usage example
Table user
:
Command:
Result:
App\Models\User.php
Generating models for all tables
Command ray:generate:models
will generate models for all tables in the database. It accepts all options available
for ray:generate:model
along with the skip-table
option.
skip-table
Specify one or multiple table names to skip:
OR specify a string of tables separated by a comma:
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 Ray\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:
Notes:
Processor priority is important. Priority 0 is the highest priority. The higher the priority, the later the processor is called.
Default processor priority:
TableNameProcessor
- 0ClassDefinitionProcessor
- 18NamespaceProcessor
- 1BaseClassProcessor
- 2CustomPrimaryKeyProcessor
- 3SoftDeleteTraitProcessor
- 4DateFormatProcessor
- 5ConnectionProcessor
- 6NoBackupProcessor
- 7PropertyProcessor
- 8RelationProcessor
- 9DocBlockProcessor
- 10FillableProcessor
- 11PrimaryKeyProcessor
- 12TimestampsProcessor
- 13TableNameProcessor
- 14BackupProcessor
- 15ModelProcessor
- 16UseStatementProcessor
- 17NamespaceDirectoryProcessor
- 19
All versions of eloquent-model-generator with dependencies
illuminate/database Version ^10.0
illuminate/support Version ^10.0
illuminate/config Version ^10.0
illuminate/console Version ^10.0
doctrine/dbal Version ^3.3