yii2 panel controller ¶

1. Realisation
2. Sequence
3. Installation by composer

Yii2Panel was designed to make boards that display different panels from different modules/extensions with access rights control.

Meeting better as expected, as the Yii2Panel can be used for displaying panel from any other module/extension with access control.

Another benefit is that the panels to be displayed are assigned to a module configuration that allows different panels to be used in the module for different projects.

For procesing submited data from PanelWidgwet van use PanleLogic

Realisation ¶

Simply dashboard solution. Each dashboard panel define as panel controller action identically as Yii page:

• panel controller in behaviors can control access - panel display only for users, who has access;
• panel controller controller action for creating HTML or response;
• create view folder in same folder, where all module controller views;
• for displaying add PanelWidget like anchor in view file;
• in module config for PanelWidget set one or more panels as Yii routes with parameters to panel controller;

Sequence ¶

• PanelWidget get panel list from module configuration
• PanelWidget call panel controller action with parameters
• Panel controller validate access. If no access, return empty string
• panel controller action create response HTML
• PanelWidget output response HTML

Installation by composer ¶

{
    "require": {
       "unyii2/yii2-panel": "dev-master"
    }
}

Or

$ composer require unyii2/yii2-panel "dev-master"

Widget ¶

echo \unyii2\yii2panel\PanelWidget::widget([
    'name' => 'exportSettings',
    'params' => [
        'docId' => 777
    ]
]);

Controller action ¶

For processing submited data form panel widget can use PanelLogic `php

public function actionCreate()
{

    $model = new RkInvoiceForm();
    if($model->load($request->post()) && $model->save()) {
        $panelLogic = Yii::createObject([
            'class' => PanelLogic::class,
            'name' => 'LietvedibaRkInvoiceSave',
            'params' => [
                'modelRecordId' => $model->id
            ]
        ]);
        $panelLogic->run();
        return $this->redirect(['view', 'id' => $model->id]);
    }
    return $this->render('create', [
        'model' => $model,
    ]);
   
}

# Module config

To module add parameter 'panels' and in configuration for module add panels routes
```php
        'invoices' => [
            'class' => 'd3modules\d3invoices\Module',
            'panels' => [
                /** for widget */
                'exportSettings' => [
                    [
                        'route' => 'd3accexport/invoice-panel/document-settings',
                        'params' => [
                            'docId' => 13 // action parameter value
                         ]
                        'tag' => 'div', // optinal. Add enclosing tag to panel  
                        'options' => ['class' => 'col-sm-8 col-md-6 col-lg-4'] //enclosing tag options
                     ]
                 ],
                 /** for panel logic */
                 'LietvedibaRkInvoiceSave' => [
                    [
                        'route' => 'deal/panel/save'
                    ]
                ],
            ],
        ],

To controller add parameter 'panels' and in configuration for module add panels routes `php

    'invoices' => [
        'class' => 'd3modules\d3invoices\Module',
        'controllerMap' => [
            'settings' => [
                'class' => 'yii3\persons\controllers\SettingsController',
                'panels' => [
                    'UserSettingsProvileLeft' =>
                        [
                            [
                                'route' => 'myauth/panel/show-qrc'
                             ]
                        ]
                ]
            ],
        ],

Optionally, if no possible add to module parameter 'panels', panel routes can define in parameters

```php
'params' => [
    'panelWidget' => [
        'dashboard' => [
            'last' =>  [
                [
                    'route' => 'delivery/panel/transit-declarations',
                    /**  
                     * parameters for action method:
                     * public function actionMyTransitDeclarations(array $statusIdList): string 
                     */
                    'params' => [
                        'statusIdList' => [5, 20]
                    ]                    
                ]
            ],
        ]
    ],
]

Panel controller with access control and view rendering ¶

Standard view path: d3modules/d3accexport/views/invoice-panel/setting_grid.php

<?php

namespace d3modules\d3accexport\controllers;

use unyii2\yii2panel\Controller;
use yii\filters\AccessControl;

class InvoicePanelController extends Controller
{

    /**
     * @inheritdoc
     */
    public function behaviors()
    {
        return [
            'access' => [
                'class' => AccessControl::class,
                'rules' => [
                    /**
                    * standard definition
                    */
                    [
                        'allow' => true,
                        'actions' => [
                            'document-settings',
                        ],
                        'roles' => [
                            'DocSetting',
                        ],
                    ],
                    
                    /**
                    * roles define in panel module config. 
                    *   Example of edi module config:
                    *        'edi' => [
                    *            'class' => 'd3yii2\d3edi\Module',
                    *            'accessRulesMessageRoles' => ['Depo3EdiFull']
                    *        ],
                    *   In Module add property:
                    *        class Module extends D3Module
                    *           public $accessRulesMessageRoles;
                    *           ....
                    */
                    [
                        'allow' => true,
                        'actions' => [
                            'message',
                        ],
                        'roles' => $this->module->rulesMessageRoles??['@'],
                    ],                    
                ],
            ],
        ];
    }

    /** for widget */
    public function actionDocumentSettings()
    {
        return $this->render('setting_grid',[]);

    }

    /** for widget */
    public function actionMessage()
    {
        return $this->render('message',[]);

    }

    /** for controller logic */
    public function actionSave(int $modelRecordId): bool
    {
        if (!$model = DealInvoice::findOne(['invoice_id' => $modelRecordId])) {
            $model = new DealInvoice();
            $model->invoice_id = $modelRecordId;
        }

        $request = Yii::$app->request;
        if ($model->load($request->post())
            && $model->deal_id
            && $model->save()
        ) {
            return true;
        }

        if ($model->hasErrors()) {
            throw new \Exception(json_encode($model->getErrors()));
        }
        return true;
    }

}