matthew-p/yii2-di-magic

Improvement for Yii2 that add dependency injection in action methods and provide model binding.

2.0.1 2018-03-29 09:59 UTC

Requires

• php: >=7.0
• yiisoft/yii2: *

BSD-3-Clause

• Matthew Patell

• dependency
• di
• controller
• extension
• injection
• model
• action
• yii2
• bind

README

Improvement for Yii2 that add dependency injection in action methods and provide model binding.

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist matthew-p/yii2-di-magic "*"

or add

"matthew-p/yii2-di-magic": "*"

to the require section of your composer.json file.

Usage

Once the extension is installed, simply use it in your code by:

In main.php config add:

return [
    ...
        'container'  => [
            'definitions' => [
                ARModel::class  =>  DIClassBuilder::bind([
                    'className'     => ARModel::class,     // optional
                    'requestFields' => ['id', 'model_id'], // array request fields (find by primaryKey)
                    'errorMessage'  => Yii::t('app', 'Model not found'),
                ]);
                
                ARModel2::class  => DIClassBuilder::bind([
                    'requestFields' => ['requestField' => 'modelColumn', 'requestField2' => 'modelColumn', 'requestFiled'], // find by primary key or modelColumn
                    'errorMessage'  => Yii::t('app', 'Model not found'),
                ]);
                
                ARModel3::class  => DIClassBuilder::bind(); // find by id default
            ],
        ],
    ...
];

And use:

class ModelController extends Controller
{
    use ActionDITrait;

    /**
     * View model.
     *
     * @param  ARModel $model
     *
     * @return string
     * @throws NotFoundHttpException
     */
    public function actionView(ARModel $model): string
    {
        // A search was made in the database. var_dump($model);
        ...
              
        // Get empty model
        $duplicateModel = Yii::$container->get(ARModel::class);
    }
    
    /**
     * Sample action.
     *
     * @param  ARModel|NULL $model not required
     *
     * @return void
     */
    public function actionSample(ARModel $model = NULL): void
    {        
        if (is_null($model)) {
            // 
        }
    }
}

Run: /model/view?id=1 or /model/view?model_id=1 or /model/sample?id=99999

That's all. Check it.