README

Wrapper package for laravel model generation from database using krlove/eloquent-model-generator

Installation

Get package

composer require eab-dsvenss/php-laravel-model-generator --dev

'providers' => [
    // ...
    se\eab\php\laravel\modelgenerator\provider\ModelGeneratorServiceProvider::class
];

php artisan eab-modelgenerator:install

Usage

Specify models to generate in app/config/eab-modelgeneratorconfig.php

Specify the details for each model in app/config/eab-modelgenerator/<modelname>.php

Call php artisan eab-modelgenerator:generate to generate the models specified in the config file

Configuration

eab-modelgeneratorconfig.php

return [
    "outputpath" => "model",
    "namespace" => "custom\\namespace"
    "library" => "krlove/reliese/pepij",
    "models" => [
        ["name" => "Dummy", <"table" => "DummyTable">, <"extras" => ["crud", "translatable"]>]
    ]
];

Each model can be decorated with extras. They are specified in the extras-array and point to files in app/config/eab-modelgenerator/extras/<extrasname>.php

The extras-file is formatted in the same way as any other modelconfig-file.

Library

By specifying one or the other of krlove or reliese for the lib it is possible to choose which library should be used to generate the models.

If choosing krlove further config need to be set in the corresponding config-file for that dependency. The options and details are specified here, https://github.com/krlove/eloquent-model-generator

If instead choosing reliese, the config that should be set is instead specified here, https://github.com/reliese/laravel

Relise

This automatically updates models with the date that the model was generated. If that is not desirable it is required to modify the following file vendor/reliese/laravel/src/Coders/Model/Templates/model by removing the dynamic date-line in the header of the file.

Model config

return [

    "dependencies" => ["dep1","dep2"],
    "replaceables" => [
        ["pattern" => "regex", "replacement" => "replacement"]
    ],
    "removablefns" => [
        ["access" => "public", "name" => "dummyname", "content" => "dummycontent"]
    ],
    "functions" => [
<<<EOT
public function test() {
    \$test;
}
EOT
    ],
    "variables" => [
        ["access" => "public", "name" => "varname", <"value" => "some value">]
    ],
    "traits" => [
        ["name" => "traitname", "dependency" => "traitname"
    ]
];

The replacements that occur use preg_replace which means that regex and replacement should be formatted according to that method's requirements.

Common Class Attributes

If there are attributes that should be present in all classes, specify that in app/config/eab-modelgenerator/EABCommon.php

eab-dsvenss / php-laravel-model-generator

Maintainers

Details