angellco\spoon\controllers\BlockTypesController

Complexity

Total Complexity

21

Size/Duplication

Total Lines	219
Duplicated Lines	0 %

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
B	actionIndex()	0	63	8
A	actionDelete()	0	17	2
B	actionSave()	0	54	7
A	actionSaveFieldLayout()	0	33	4

<?php
/**
 * Spoon plugin for Craft CMS 3.x
 *
 * Enhance Matrix
 *
 * @link      https://angell.io
 * @copyright Copyright (c) 2018 Angell & Co
 */

namespace angellco\spoon\controllers;

use angellco\spoon\models\BlockType;
use angellco\spoon\Spoon;

use Craft;
use craft\helpers\Db;
use craft\web\Controller;

/**
 * BlockTypes Controller
 *
 * @author    Angell & Co
 * @package   Spoon
 * @since     3.0.0
 */
class BlockTypesController extends Controller
{

    // Protected Properties
    // =========================================================================

    /**
     * @var    bool|array Allows anonymous access to this controller's actions.
     *         The actions must be in 'kebab-case'
     * @access protected
     */
    protected $allowAnonymous = false;

    // Public Methods
    // =========================================================================

    /**
     * Loads the edit page for the global context.
     *
     * @param array $variables
     *
     * @return \yii\web\Response
     */
    public function actionIndex($variables = [])
    {
        $variables['matrixFields'] = Spoon::$plugin->fields->getMatrixFields();

        $variables['globalSpoonedBlockTypes'] = Spoon::$plugin->blockTypes->getByContext('global', 'fieldId', true);

        // If Super Table is installed get all of the ST fields and store by child field context
        $superTablePlugin = \Craft::$app->plugins->getPlugin('super-table');
        if ($superTablePlugin && $variables['matrixFields']) {
            $superTableService = new \verbb\supertable\services\SuperTableService();

The type verbb\supertable\services\SuperTableService was not found. Maybe you did not declare it correctly or list all dependencies?

            foreach ($variables['matrixFields'] as $matrixField) {
                if (strpos($matrixField->context, 'superTableBlockType') === 0) {

Accessing context on the interface craft\base\FieldInterface suggest that you code against a concrete implementation. How about adding an instanceof check?

                    $parts = explode(':', $matrixField->context);
                    if (isset($parts[1])) {

                        $superTableBlockTypeId = Db::idByUid('{{%supertableblocktypes}}', $parts[1]);

                        /** @var \verbb\supertable\models\SuperTableBlockTypeModel $superTableBlockType */
                        $superTableBlockType = $superTableService->getBlockTypeById($superTableBlockTypeId);

                        /** @var \verbb\supertable\fields\SuperTableField $superTableField */
                        $superTableField = \Craft::$app->fields->getFieldById($superTableBlockType->fieldId);

                        $variables['superTableFields'][$matrixField->context] = [
                            'kind' => 'Super Table',
                            'field' => $superTableField,
                            'child' => false
                        ];

                        // If the context of _this_ field is inside a Matrix block ... then we need to do more inception
                        if (strpos($superTableField->context, 'matrixBlockType') === 0) {
                            $nestedParts = explode(':', $superTableField->context);
                            if (isset($nestedParts[1])) {

                                $matrixBlockTypeId = Db::idByUid('{{%matrixblocktypes}}', $nestedParts[1]);

                                /** @var craft\models\MatrixBlockType $matrixBlockType */
                                $matrixBlockType = \Craft::$app->matrix->getBlockTypeById($matrixBlockTypeId);

                                /** @var craft\fields\Matrix $globalField */
                                $globalField = \Craft::$app->fields->getFieldById($matrixBlockType->fieldId);

It seems like $matrixBlockType->fieldId can also be of type null; however, parameter $fieldId of craft\services\Fields::getFieldById() does only seem to accept integer, maybe add an additional type check?

                                $variables['superTableFields'][$matrixField->context] = [
                                    'kind' => 'Matrix',
                                    'field' => $globalField,
                                    'child' => [
                                        'kind' => 'Super Table',
                                        'field' => $superTableField
                                    ]
                                ];

                            }
                        }

                    }
                }
            }
        }

        Spoon::$plugin->loader->configurator('#spoon-global-context-table', 'global');

        return $this->renderTemplate('spoon/edit-global-context', $variables);
    }

    /**
     * Saves a Spoon block type
     *
     * @return \yii\web\Response
     * @throws \yii\db\Exception
     * @throws \yii\web\BadRequestHttpException
     */
    public function actionSave()
    {
        $this->requirePostRequest();
        $this->requireAcceptsJson();

        // This will be an array of Tab Names with Block Type IDs.
        // The order in which they appear is the order in which they should also
        // be returned in eventually, so we will just rely on the id to describe this
        // and make sure each time we are referencing a context that already exists to
        // delete the rows matching that context before proceeding with the save.
        $blockTypesPostData = Craft::$app->getRequest()->getParam('spoonedBlockTypes');

        $context = (string)Craft::$app->getRequest()->getParam('context');
        $fieldId = (integer)Craft::$app->getRequest()->getParam('fieldId');

        // Get any existing field layouts so we don’t lose them
        $fieldLayoutIds = Spoon::$plugin->blockTypes->getFieldLayoutIds($context, $fieldId);


        // Remove all current block types by context
        Spoon::$plugin->blockTypes->deleteByContext($context, $fieldId);

        // Loop over the data and save new rows for each block type / group combo
        $errors = 0;
        if (is_array($blockTypesPostData))
        {
            foreach ($blockTypesPostData as $groupName => $blockTypeIds)
            {
                foreach ($blockTypeIds as $blockTypeId)
                {
                    $spoonedBlockType = new BlockType();
                    $spoonedBlockType->fieldId           = $fieldId;
                    $spoonedBlockType->matrixBlockTypeId = $blockTypeId;
                    $spoonedBlockType->fieldLayoutId     = isset($fieldLayoutIds[$blockTypeId]) ? $fieldLayoutIds[$blockTypeId] : null;
                    $spoonedBlockType->groupName         = urldecode($groupName);
                    $spoonedBlockType->context           = $context;

                    if (!Spoon::$plugin->blockTypes->save($spoonedBlockType))
                    {
                        $errors++;
                    }
                }
            }
        }

        if ($errors > 0)
        {
            return $this->asJson([
                'success' => false
            ]);
        }

        return $this->asJson([
            'success' => true
        ]);
    }

    /**
     * Delete a set of Spoon block types for a given field and context
     *
     * @return \yii\web\Response
     * @throws \yii\db\Exception
     * @throws \yii\web\BadRequestHttpException
     */
    public function actionDelete()
    {
        $this->requirePostRequest();
        $this->requireAcceptsJson();

        $context = (string)Craft::$app->getRequest()->getParam('context');
        $fieldId = (integer)Craft::$app->getRequest()->getParam('fieldId');

        if (!Spoon::$plugin->blockTypes->deleteByContext($context, $fieldId))
        {
            $this->asJson([
                'success' => false
            ]);
        }

        return $this->asJson([
            'success' => true
        ]);
    }

    /**
     * Saves a field layout for a given Spoon block type
     *
     * @return bool|\yii\web\Response
     * @throws \angellco\spoon\errors\BlockTypeNotFoundException
     * @throws \yii\web\BadRequestHttpException
     */
    public function actionSaveFieldLayout()
    {
        $this->requirePostRequest();
        $this->requireAcceptsJson();

        $spoonedBlockTypeId = Craft::$app->getRequest()->getParam('spoonedBlockTypeId');
        $blockTypeFieldLayouts = Craft::$app->getRequest()->getParam('blockTypeFieldLayouts');

The assignment to $blockTypeFieldLayouts is dead and can be removed.

        if ($spoonedBlockTypeId)
        {
            if (!$spoonedBlockType = Spoon::$plugin->blockTypes->getById($spoonedBlockTypeId)) {

Are you sure the assignment to $spoonedBlockType is correct as angellco\spoon\Spoon::plugin->blockTypes->getById($spoonedBlockTypeId) targeting angellco\spoon\services\BlockTypes::getById() seems to always return null.

                return false;
            }
        } else
        {
            return false;
        }

        // Set the field layout on the model
        $postedFieldLayout = Craft::$app->getRequest()->getParam('blockTypeFieldLayouts');
        $assembledLayout = Craft::$app->fields->assembleLayout($postedFieldLayout);

It seems like $postedFieldLayout can also be of type null and string; however, parameter $postedFieldLayout of craft\services\Fields::assembleLayout() does only seem to accept array, maybe add an additional type check?

        $spoonedBlockType->setFieldLayout($assembledLayout);

        // Save it
        if (!Spoon::$plugin->blockTypes->saveFieldLayout($spoonedBlockType))

$spoonedBlockType of type void is incompatible with the type angellco\spoon\models\BlockType expected by parameter $spoonedBlockType of angellco\spoon\services\BlockTypes::saveFieldLayout().

        {
            return $this->asJson([
                'success' => false
            ]);
        }

        return $this->asJson([
            'success' => true
        ]);
    }

}