yii2-giiant
Extended models and CRUDs for Gii, the code generator of Yii2 Framework, (*1)
PROJECT IS IN BETA STAGE!, (*2)
What is it?
Giiant provides templates for model and CRUD generation with relation support and a sophisticated UI.
A main project goal is porting many features and learnings from gtc, giix, awecrud and others into one solution., (*3)
Installation
The preferred way to install this extension is through composer., (*4)
composer.phar require schmunk42/yii2-giiant:"*"
The generators are registered automatically in the application bootstrap process, if the Gii module is enabled, (*5)
Usage
Visit your application's Gii (eg. index.php?r=gii and choose one of the generators from the main menu screen., (*6)
For basic usage instructions see the Yii2 Guide section for Gii., (*7)
Command Line Batches
You can run batches of base-model and CRUD generation with the build in batch command:, (*8)
./yii giiant-batch --tables=profile,social_account,user,token
It will process the given tables, for more details see ./yii help giiant-batch. See the Sakila example for a detailed example., (*9)
Features
Model generator
- generates separate model classes to customize and base models classes to regenerate
- table prefixes can be stipped off model class names (not bound to db connection setting)
CRUD generator
- model, view and controller locations can be customized to use subfolders
- horizontal and vertical form layout
- action button class customization (Select "App Class" option on the Action Button Class option on CRUD generator to customize)
- input, attribute, column and relation customization with provider queue
- callback provider to inject any kind of code for inputs, attributes and columns via dependency injection
Providers
-
CallbackProvider universal provider to modify any input, attribute or column with highly flexible callback functions
-
RelationProvider renders code for relations (eg. links, dropdowns)
-
EditorProvider renders RTE, like
Ckeditor as input widget
-
DateTimeProvider renders date inputs
-
OptsProvider render a populated dropdown, if the model contains and
optsColumnName() method.
Customization with providers
In many cases you want to exchange i.e. some inputs with a customized version for your project.
Examples for this use-case are editors, file-uploads or choosers, complex input widget with a modal screen, getting
data via AJAX and so on., (*10)
With Giiant Providers you can create a queue of instances which may provide custom code depending on more complex
rules. Take a look at some existing giiant providers., (*11)
Configure providers, add this to your provider list in the form:, (*12)
\schmunk42\giiant\crud\providers\EditorProvider,
\schmunk42\giiant\crud\providers\SelectProvider,
\schmunk42\giiant\crud\providers\OptsProvider,
And configure the settings of the provider, add setting via dependecy injection this to your application config, eg. in console/config/bootstrap.php:, (*13)
\Yii::$container->set(
'schmunk42\giiant\crud\providers\EditorProvider',
[
'columnNames' => ['description']
]
);
This will render a Ckeditor widget for every column named description., (*14)
<?= $form->field($model, 'description')->widget(
\dosamigos\ckeditor\CKEditor::className(),
[
'options' => ['rows' => 6],
'preset' => 'basic'
]) ?>
NOTE The OptsProvider matches every model with opts methods for a field, i.e. method optsMembers matches for model attribute members., (*15)
Using "prompt" in dropdown lists
Set the first entry in your getColumnName() method to value null., (*16)
null => \Yii::t('app', 'Select'),
To ensure that the correct value is written to the database you should add a validation rule in the model., (*17)
public function rules()
{
return ArrayHelper::merge(
parent::rules(),
[
[
['field_name'],
'default',
'value' => null
]
]
);
}
Universal CallbackProvider
This provider has three properties activeFields (form), columnFormats (index) and attributeFormats (view) which all take an array of callback as input. The keys are evaluated as a regular expression the match the class and attribute name.
While the callback function takes the current attribute and generator as input parameters., (*18)
The configuration can be done via the dependency injection container of Yii2., (*19)
Define callbacks for input fields in _form view, (*20)
$activeFields = [
/**
* Generate a checkbox for specific column (model attribute)
*/
'models\\\\Foo.isAvailable' => function ($attribute, $generator) {
$data = \yii\helpers\VarDumper::export([0 => 'Nein', 1 => 'Ja']);
return <<<INPUT
\$form->field(\$model, '{$attribute->name}')->checkbox({$data});
INPUT;
},
];
Define callbacks for grid columns in index view, (*21)
columnFormats = [
// generate custom HTML in column
'common\models\Foo.html' => function ($attribute, $generator) {
return <<<FORMAT
[
'format' => 'html',
'label'=>'FOOFOO',
'attribute' => 'item_id',
'value'=> function(\$model){
return \yii\helpers\Html::a(\$model->bar,['/crud/item/view', 'id' => \$model->link_id]);
}
]
FORMAT;
},
// hide all text fields in grid
'.+' => function ($column, $model) {
if ($column->dbType == 'text') {
return false;
}
},
// hide system fields in grid
'created_at$|updated_at$' => function () {
return false;
},
];
Detail view attributes, (*22)
$attributeFormats = [
// usa a static helper function for all columns ending with `_json`
'_json$' => function ($attribute, $generator) {
$formattter = StringFormatter::className();
return <<<FORMAT
[
'format' => 'html',
#'label'=>'FOOFOO',
'attribute' => '{$attribute->name}',
'value'=> {$formattter}::contentJsonToHtml(\$model->{$attribute->name})
]
FORMAT;
},
];
Finally add the configuration via DI container, (*23)
\Yii::$container->set(
'schmunk42\giiant\crud\providers\CallbackProvider',
[
'activeFields' => $activeFields,
'columnFormats' => $columnFormats,
'attributeFormats' => $attributeFormats,
]
);
More providers..., (*24)
Use custom generators, model and crud templates
$config['modules']['gii'] = [
'class' => 'yii\gii\Module',
'allowedIPs' => ['127.0.0.1'],
'generators' => [
// generator name
'giiant-model' => [
//generator class
'class' => 'schmunk42\giiant\model\Generator',
//setting for out templates
'templates' => [
// template name => path to template
'mymodel' =>
'@app/giiTemplates/model/default',
]
]
],
];
A detailed description how to use MySQL workbench for model updates and migration see here., (*25)
Special thanks to motin, thyseus, uldisn and rcoelho for their work, inspirations and feedback., (*26)
Troubleshooting
You can also add, (*27)
"repositories": [
{
"type": "vcs",
"url": "https://github.com/schmunk42/yii2-giiant.git"
}
],
"require": {
.....(your required modules)....
"schmunk42/yii2-giiant":"dev-master"
},
to your *** composer.json *** file and run, (*28)
composer update
if you are having trouble with "Not found" errors using the preferred method., (*29)
Screenshots
, (*30)
Links
Wallogit.com
