jf-guillou / lcds

controllers/ScreenTemplateController.php

<?php

namespace app\controllers;

use Yii;
use app\models\ContentType;
use app\models\ScreenTemplate;
use app\models\Field;
use app\models\TemplateBackground;
use yii\data\ActiveDataProvider;
use yii\helpers\Url;
use yii\web\NotFoundHttpException;
use yii\filters\VerbFilter;
use yii\filters\AccessControl;

/**
 * ScreentemplateController implements the CRUD actions for ScreenTemplate model.
 */
class ScreenTemplateController extends BaseController
{
    /**
     * {@inheritdoc}
     */
    public function behaviors()
    {
        return [
            'verbs' => [
                'class' => VerbFilter::class,
                'actions' => [
                    'delete' => ['POST'],
                ],
            ],
            'access' => [
                'class' => AccessControl::class,
                'only' => ['index', 'view', 'add-field', 'get-field', 'edit-field', 'set-field-pos', 'delete-field', 'create', 'update', 'delete'],
                'rules' => [
                    ['allow' => true, 'actions' => ['index', 'view', 'add-field', 'get-field', 'edit-field', 'set-field-pos', 'delete-field', 'create', 'update', 'delete'], 'roles' => ['setTemplates']],
                ],
            ],
        ];
    }

    /**
     * Lists all ScreenTemplate models.
     *
     * @return string
     */
    public function actionIndex()

This method seems to be duplicated in your project.

    {
        $dataProvider = new ActiveDataProvider([
            'query' => ScreenTemplate::find(),
        ]);

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

    /**
     * Displays a single ScreenTemplate model.
     *
     * @param int $id
     *
     * @return string
     */
    public function actionView($id)
    {
        $screenTemplate = $this->findModel($id);

        return $this->render('view', [
            'model' => $screenTemplate,
            'background' => $screenTemplate->background ? $screenTemplate->background->uri : null,
            'fields' => $screenTemplate->getFields()->with('contentTypes')->asArray()->all(),
            'contentTypes' => ContentType::getAllList(),
            'setFieldPosUrl' => Url::to([Yii::$app->controller->id . '/set-field-pos', 'id' => '']),
            'editFieldUrl' => Url::to([Yii::$app->controller->id . '/edit-field', 'id' => '']),
        ]);
    }

    /**
     * Creates a new ScreenTemplate 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()

This method seems to be duplicated in your project.

    {
        $model = new ScreenTemplate();

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

        return $this->render('create', [
            'model' => $model,
            'backgrounds' => self::backgroundsArray(),
        ]);
    }

    /**
     * Updates an existing ScreenTemplate 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)

This method seems to be duplicated in your project.

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

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

        return $this->render('update', [
            'model' => $model,
            'backgrounds' => self::backgroundsArray(),
        ]);
    }

    /**
     * Deletes an existing ScreenTemplate 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']);
    }

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

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

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

    /**
     * Create a field and save it.
     *
     * @api
     *
     * @param int $templateId
     *
     * @return string json status
     */
    public function actionAddField($templateId)
    {
        Yii::$app->response->format = \yii\web\Response::FORMAT_JSON;

        $field = new Field();
        $field->template_id = $templateId;
        $field->x1 = self::randf(0.1, 0.4);
        $field->y1 = self::randf(0.1, 0.4);
        $field->x2 = self::randf($field->x1, 0.8);
        $field->y2 = self::randf($field->y1, 0.8);

        if ($field->save()) {

This code seems to be duplicated across your project.

            return ['success' => true, 'field' => $field];
        } else {
            return ['success' => false, 'message' => Yii::t('app', 'Failed to insert new field')];
        }
    }

    /**
     * Retrieve a field spec.
     *
     * @api
     *
     * @param int $id field id
     *
     * @return string json field
     */
    public function actionGetField($id)
    {
        Yii::$app->response->format = \yii\web\Response::FORMAT_JSON;

        $field = Field::find()->where(['id' => $id])->with('contentTypes')->one();

        if ($field === null) {

This code seems to be duplicated across your project.

            return ['success' => false, 'message' => Yii::t('app', 'Field not found')];
        } else {
            return ['success' => true, 'field' => $field, 'contentTypes' => $field->contentTypes];
        }
    }

    /**
     * Read POST data and update field, or display AJAX popup form.
     *
     * @param int $id field id
     *
     * @return string
     */
    public function actionEditField($id)
    {
        $field = Field::find()->where(['id' => $id])->with('contentTypes')->one();
        if ($field === null) {
            return;
        }

        if ($field->load(Yii::$app->request->post())) {
            $newTypeIds = Yii::$app->request->post($field->formName())['contentTypes'];
            if (!is_array($newTypeIds)) {
                $newTypeIds = [];
            }
            $oldTypeIds = array_map(function ($c) {
                return $c->id;
            }, $field->contentTypes);

            $unlink = array_diff($oldTypeIds, $newTypeIds);
            $unlinkModels = ContentType::find()->where(['id' => $unlink])->all();
            foreach ($unlinkModels as $u) {
                $field->unlink('contentTypes', $u, true);
            }
            $link = array_diff($newTypeIds, $oldTypeIds);
            $linkModels = ContentType::find()->where(['id' => $link])->all();
            foreach ($linkModels as $l) {
                $field->link('contentTypes', $l);
            }

            if ($field->save()) {
                return '';
            }
        }

        return $this->renderAjax('editfield', [
            'field' => $field,
            'contentTypesArray' => ContentType::getAllList(),
            'selfContentIds' => ContentType::getAllList(true),
        ]);
    }

    /**
     * Update field position.
     *
     * @api
     *
     * @param int $id field id
     *
     * @return string json status
     */
    public function actionSetFieldPos($id = null)
    {
        Yii::$app->response->format = \yii\web\Response::FORMAT_JSON;

        if ($id !== null) {
            $field = Field::find()->where(['id' => $id])->one();
            if ($field === null) {

This code seems to be duplicated across your project.

                return ['success' => false, 'message' => Yii::t('app', 'No such field')];
            }
        } else {
            $field = new Field();
        }

        if ($field->load(Yii::$app->request->post())) {
            if ($field->save()) {
                return ['success' => true, 'id' => $field->id];
            }
        }

        return ['success' => false, 'message' => $field->errors];
    }

    /**
     * Delete a field.
     *
     * @api
     *
     * @param int $id field id
     *
     * @return string json status
     */
    public function actionDeleteField($id)
    {
        Yii::$app->response->format = \yii\web\Response::FORMAT_JSON;

        $field = Field::find()->where(['id' => $id])->with('contentTypes')->one();
        if ($field === null || $field->delete() === false) {

This code seems to be duplicated across your project.

            return ['success' => false, 'message' => Yii::t('app', 'Deletion failed')];
        }

        return ['success' => true];
    }

    /**
     * Builds an array of backgrounds usable in view.
     *
     * @return string[] backgrounds
     */
    public static function backgroundsArray()
    {
        $bgs = TemplateBackground::find()->all();

        $array = [];
        foreach ($bgs as $bg) {
            $array[$bg->id] = [
                'id' => $bg->id,
                'name' => $bg->name,
                'uri' => $bg->uri,
            ];
        }

        return $array;
    }

    /**
     * Custom min/max float rand.
     *
     * @param float $min
     * @param float $max
     *
     * @return float random float
     */
    public static function randf($min = 0.0, $max = 1.0)
    {
        return mt_rand($min * mt_getrandmax(), $max * mt_getrandmax()) / mt_getrandmax();
    }
}