jf-guillou / lcds

controllers/ScreenController.php

<?php

namespace app\controllers;

use Yii;
use app\models\Screen;
use app\models\ScreenTemplate;
use app\models\Flow;
use yii\helpers\ArrayHelper;
use yii\data\ActiveDataProvider;
use yii\filters\VerbFilter;
use yii\filters\AccessControl;
use yii\web\NotFoundHttpException;

/**
 * ScreenController implements the CRUD actions for Screen model.
 */
class ScreenController extends BaseController
{
    /**
     * {@inheritdoc}
     */
    public function behaviors()

This method seems to be duplicated in your project.

    {
        return [
            'verbs' => [
                'class' => VerbFilter::class,
                'actions' => [
                    'delete' => ['POST'],
                ],
            ],
            'access' => [
                'class' => AccessControl::class,
                'only' => ['index', 'view', 'create', 'update', 'delete', 'link', 'unlink'],
                'rules' => [
                    ['allow' => true, 'actions' => ['index', 'view', 'create', 'update', 'delete', 'link', 'unlink'], 'roles' => ['setScreens']],
                ],
            ],
        ];
    }

    /**
     * Lists all Screen models.
     *
     * @return string
     */
    public function actionIndex()
    {
        $dataProvider = new ActiveDataProvider([
            'query' => Screen::find()->joinWith('template'),
        ]);

        $dataProvider->sort->attributes['template'] = [
            'asc' => [ScreenTemplate::tableName() . '.name' => SORT_ASC],
            'desc' => [ScreenTemplate::tableName() . '.name' => SORT_DESC],
        ];

        return $this->render('index', [
            'dataProvider' => $dataProvider,
        ]);
    }

    /**
     * Displays a single Screen model.
     *
     * @param int $id
     *
     * @return string
     */
    public function actionView($id)
    {
        $model = Screen::find()->where([Screen::tableName() . '.id' => $id])->joinWith('template')->one();
        if ($model === null) {
            throw new NotFoundHttpException(Yii::t('app', 'The requested screen does not exist.'));
        }

        $dataProvider = new ActiveDataProvider([
            'query' => $model->getFlows(),
        ]);

        return $this->render('view', [
            'model' => $model,
            'dataProvider' => $dataProvider,
        ]);
    }

    /**
     * Creates a new Screen model.
     * If creation is successful, the browser will be redirected to the 'view' page.
     *
     * @return \yii\web\Response|string redirect or render
     */
    public function actionCreate($device_id = null)
    {
        $model = new Screen();
        $model->loadDefaultValues();

        if ($model->load(Yii::$app->request->post()) && $model->save()) {
            if ($device_id !== null) {
                return $this->redirect(['device/link', 'id' => $device_id]);
            }

            return $this->redirect(['view', 'id' => $model->id]);
        } else {

This code seems to be duplicated across your project.

            $templates = ScreenTemplate::find()->all();
            $templatesArray = array_reduce($templates, function ($a, $t) {
                $a[$t->id] = $t->name;

                return $a;
            }, []);

            return $this->render('create', [
                'model' => $model,
                'templates' => $templatesArray,
            ]);
        }
    }

    /**
     * Updates an existing Screen model.
     * If update is successful, the browser will be redirected to the 'view' page.
     *
     * @param int $id
     *
     * @return \yii\web\Response|string redirect or render
     */
    public function actionUpdate($id)
    {
        $model = $this->findModel($id);

        if ($model->load(Yii::$app->request->post()) && $model->save()) {
            return $this->redirect(['view', 'id' => $model->id]);
        } else {

This code seems to be duplicated across your project.

            $templates = ScreenTemplate::find()->all();
            $templatesArray = array_reduce($templates, function ($a, $t) {
                $a[$t->id] = $t->name;

                return $a;
            }, []);

            return $this->render('update', [
                'model' => $model,
                'templates' => $templatesArray,
            ]);
        }
    }

    /**
     * Deletes an existing Screen model.
     * If deletion is successful, the browser will be redirected to the 'index' page.
     *
     * @param int $id
     *
     * @return \yii\web\Response
     */
    public function actionDelete($id)
    {
        $this->findModel($id)->delete();

        return $this->redirect(['index']);
    }

    /**
     * Adds a flow to this screen or render link view.
     *
     * @param int $id
     * @param int $flowId
     *
     * @return \yii\web\Response|string redirect or render
     */
    public function actionLink($id, $flowId = null)
    {
        $model = $this->findModel($id);

        if ($flowId === null) {
            $dataProvider = new ActiveDataProvider([
                'query' => Flow::find()->where(['not', ['id' => ArrayHelper::getColumn($model->flows, 'id')]]),
            ]);

            return $this->render('link', [
                'model' => $model,
                'dataProvider' => $dataProvider,
            ]);
        } else {
            if (!$model->getFlows()->where(['id' => $flowId])->exists() && ($flow = Flow::findOne($flowId)) !== null) {
                $model->link('flows', $flow);

It seems like $flow defined by \app\models\Flow::findOne($flowId) on line 185 can also be of type array; however, yii\db\BaseActiveRecord::link() does only seem to accept object<yii\db\ActiveRecordInterface>, maybe add an additional type check?

            }

            return $this->redirect(['view', 'id' => $id]);
        }
    }

    /**
     * Remove a flow from a screen.
     *
     * @param int $id
     * @param int $flowId
     *
     * @return \yii\web\Response
     */
    public function actionUnlink($id, $flowId)

This method seems to be duplicated in your project.

    {
        $model = $this->findModel($id);

        if ($model->getFlows()->where(['id' => $flowId])->exists() && ($flow = Flow::findOne($flowId)) !== null) {
            $model->unlink('flows', $flow, true);

It seems like $flow defined by \app\models\Flow::findOne($flowId) on line 205 can also be of type array; however, yii\db\BaseActiveRecord::unlink() does only seem to accept object<yii\db\ActiveRecordInterface>, maybe add an additional type check?

        }

        return $this->redirect(['view', 'id' => $id]);
    }

    /**
     * Finds the Screen model based on its primary key value.
     * If the model is not found, a 404 HTTP exception will be thrown.
     *
     * @param int $id
     *
     * @return Screen the loaded model
     *
     * @throws NotFoundHttpException if the model cannot be found
     */
    protected function findModel($id)
    {
        if (($model = Screen::findOne($id)) !== null) {

The expression \app\models\Screen::findOne($id); of type yii\db\ActiveRecordInterface|array|null adds the type array to the return on line 225 which is incompatible with the return type documented by app\controllers\ScreenController::findModel of type app\models\Screen.

            return $model;
        } else {
            throw new NotFoundHttpException(Yii::t('app', 'The requested screen does not exist.'));
        }
    }
}