angellco\spoon\services\BlockTypes

Complexity

Total Complexity

52

Size/Duplication

Total Lines	512
Duplicated Lines	0 %

Importance

Changes	30
Bugs	0	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	getById()	0	9	2
A	getBlockType()	0	18	4
A	deleteByContext()	0	13	3
B	save()	0	57	8
B	getByContext()	0	66	10
B	_populateBlockTypeFromRecord()	0	82	10
A	getFieldLayoutIds()	0	19	3
A	saveFieldLayout()	0	22	2
B	handleChangedBlockType()	0	63	6
A	handleDeletedBlockType()	0	21	3
A	_getBlockTypeRecord()	0	4	1

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

namespace angellco\spoon\services;

use angellco\spoon\models\BlockType;
use angellco\spoon\records\BlockType as BlockTypeRecord;
use angellco\spoon\errors\BlockTypeNotFoundException;

use Craft;
use craft\base\Component;
use craft\base\Field;
use craft\db\Table;
use craft\events\ConfigEvent;
use craft\helpers\Db;
use craft\helpers\ProjectConfig as ProjectConfigHelper;
use craft\helpers\StringHelper;
use craft\models\FieldLayout;

/**
 * BlockTypes Service
 *
 * @author    Angell & Co
 * @package   Spoon
 * @since     3.0.0
 */
class BlockTypes extends Component
{
    // Private Properties
    // =========================================================================

    private $_blockTypesByContext;

    private $_superTablePlugin;

    private $_superTableService;

    const CONFIG_BLOCKTYPE_KEY = 'spoonBlockTypes';

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

    /**
     * Returns a Spoon block type model by its ID
     *
     * @param $id
     *
     * @return BlockType|null
     * @throws BlockTypeNotFoundException
     */
    public function getById($id)
    {
        $blockTypeRecord = BlockTypeRecord::findOne($id);

        if (!$blockTypeRecord) {

$blockTypeRecord is of type yii\db\ActiveRecord, thus it always evaluated to true.

            throw new BlockTypeNotFoundException(Craft::t('spoon', 'No Spoon block type exists with the ID “{id}”', ['id' => $id]));
        }

        return $this->_populateBlockTypeFromRecord($blockTypeRecord);
    }

    /**
     * Returns a single BlockType Model by its context and blockTypeId
     *
     * @param bool $context
     * @param bool $matrixBlockTypeId
     *
     * @return BlockType|bool|null
     */
    public function getBlockType($context = false, $matrixBlockTypeId = false)
    {

        if (!$context || !$matrixBlockTypeId)
        {
            return false;
        }

        $blockTypeRecord = BlockTypeRecord::findOne([
            'context'           => $context,
            'matrixBlockTypeId' => $matrixBlockTypeId
        ]);

        if (!$blockTypeRecord) {

$blockTypeRecord is of type yii\db\ActiveRecord, thus it always evaluated to true.

            return null;
        }

        return $this->_populateBlockTypeFromRecord($blockTypeRecord);

    }

    /**
     * Returns a block type by its context.
     *
     * @param string       $context
     * @param null|string  $groupBy Group by an optional model attribute to group by
     * @param bool         $ignoreSubContext Optionally ignore the sub context (id)
     * @param null|integer $fieldId Optionally filter by fieldId
     *
     * @return array
     */
    public function getByContext($context, $groupBy = null, $ignoreSubContext = false, $fieldId = null): array
    {

        if ($ignoreSubContext) {

            if ($fieldId !== null) {
                if ($context === 'global') {
                    $condition = [
                        'fieldId' => $fieldId,
                        'context' => 'global'
                    ];
                } else {
                    $condition = [
                        'fieldId' => $fieldId,
                        ['like', 'context', $context.'%', false]
                    ];
                }
            } else {
                if ($context === 'global') {
                    $condition = [
                        'context' => 'global'
                    ];
                } else {
                    $condition = ['like', 'context', $context.'%', false];
                }
            }

        } else {
            $condition = [
                'context' => $context
            ];

            if ($fieldId !== null)
            {
                $condition['fieldId'] = $fieldId;
            }
        }

        $blockTypeRecords = BlockTypeRecord::find()
            ->where($condition)
            ->orderBy(['groupSortOrder' => SORT_ASC, 'sortOrder' => SORT_ASC])
            ->all();

        if ($blockTypeRecords) {

The expression $blockTypeRecords of type yii\db\ActiveRecordInterface[] is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

            foreach ($blockTypeRecords as $blockTypeRecord) {
                $blockType = $this->_populateBlockTypeFromRecord($blockTypeRecord);
                $this->_blockTypesByContext[$context][$blockType->id] = $blockType;
            }

        } else {
            return [];
        }

        if ($groupBy !== null) {
            $return = [];

            foreach ($this->_blockTypesByContext[$context] as $blockType)
            {
                $return[$blockType->$groupBy][] = $blockType;
            }

            return $return;
        }

        return $this->_blockTypesByContext[$context];

    }

    /**
     * Saves our version of a block type into the project config
     *
     * @param BlockType $blockType
     *
     * @return bool
     * @throws \Exception
     */
    public function save(BlockType $blockType): bool
    {
        $isNew = !$blockType->id;

        // Ensure the block type has a UID
        if ($isNew) {
            $blockType->uid = StringHelper::UUID();
        } else if (!$blockType->uid) {
            $existingBlockTypeRecord = BlockTypeRecord::findOne($blockType->id);

            if (!$existingBlockTypeRecord) {

$existingBlockTypeRecord is of type yii\db\ActiveRecord, thus it always evaluated to true.

                throw new BlockTypeNotFoundException("No Spoon Block Type exists with the ID “{$blockType->id}”");
            }

            $blockType->uid = $existingBlockTypeRecord->uid;
        }

        // Make sure it validates
        if (!$blockType->validate()) {
            return false;
        }

        // Save it to the project config
        $configData = [
            'groupName' => $blockType->groupName,
            'groupSortOrder' => $blockType->groupSortOrder,
            'sortOrder' => $blockType->sortOrder,
            'context' => $blockType->context,
            'field' => $blockType->getField()->uid,

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

            'matrixBlockType' => $blockType->getBlockType()->uid,
        ];

        // Handle any currently attached field layouts
        /** @var FieldLayout $fieldLayout */
        $fieldLayout = $blockType->getFieldLayout();

The method getFieldLayout() does not exist on angellco\spoon\models\BlockType. Since you implemented __call, consider adding a @method annotation.

        if ($fieldLayout && $fieldLayout->uid) {
            $fieldLayoutConfig = $fieldLayout->getConfig();

            $layoutUid = $fieldLayout->uid;

            $configData['fieldLayout'] = [
                $layoutUid => $fieldLayoutConfig
            ];
        } else {
            $configData['fieldLayout'] = null;
        }

        $configPath = self::CONFIG_BLOCKTYPE_KEY . '.' . $blockType->uid;

        Craft::$app->projectConfig->set($configPath, $configData);

        if ($isNew) {
            $blockType->id = Db::idByUid('{{%spoon_blocktypes}}', $blockType->uid);
        }

        return true;
    }

    /**
     * Deletes all the block types for a given context from the project config
     *
     * @param null $context

Are you sure the doc-type for parameter $context is correct as it would always require null to be passed?

     * @param null $fieldId

Are you sure the doc-type for parameter $fieldId is correct as it would always require null to be passed?

     *
     * @return bool|null
     * @throws \Exception
     */
    public function deleteByContext($context = null, $fieldId = null)
    {
        if (!$context) {

$context is of type null, thus it always evaluated to false.

            return false;
        }

        $blockTypes = $this->getByContext($context, null, false, $fieldId);

        foreach ($blockTypes as $blockType) {
            Craft::$app->getProjectConfig()->remove(self::CONFIG_BLOCKTYPE_KEY . '.' . $blockType->uid);
        }

        return true;
    }

    // Project config methods
    // =========================================================================

    /**
     * Handles a changed block type and saves it to the database
     *
     * @param ConfigEvent $event
     *
     * @throws \Throwable
     */
    public function handleChangedBlockType(ConfigEvent $event)
    {
        $fieldsService = Craft::$app->getFields();

        $uid = $event->tokenMatches[0];
        $data = $event->newValue;

        // Make sure the field has been synced
        $fieldId = Db::idByUid(Table::FIELDS, $data['field']);
        if ($fieldId === null) {
            Craft::$app->getProjectConfig()->defer($event, [$this, __FUNCTION__]);
            return;
        }

        // Make sure the matrix block type has been synced
        $matrixBlockTypeId = Db::idByUid(Table::MATRIXBLOCKTYPES, $data['matrixBlockType']);
        if ($matrixBlockTypeId === null) {
            Craft::$app->getProjectConfig()->defer($event, [$this, __FUNCTION__]);
            return;
        }

        // Make sure fields and sites are processed
        ProjectConfigHelper::ensureAllSitesProcessed();
        ProjectConfigHelper::ensureAllFieldsProcessed();

        $db = Craft::$app->getDb();
        $transaction = $db->beginTransaction();

        try {
            // Get the record
            $blockTypeRecord = $this->_getBlockTypeRecord($uid);

            // Prep the record with the new data
            $blockTypeRecord->fieldId = $fieldId;
            $blockTypeRecord->matrixBlockTypeId = $matrixBlockTypeId;
            $blockTypeRecord->groupName = $data['groupName'];
            $blockTypeRecord->context = $data['context'];
            $blockTypeRecord->groupSortOrder = $data['groupSortOrder'];
            $blockTypeRecord->sortOrder = $data['sortOrder'];
            $blockTypeRecord->uid = $uid;

            // Handle the field layout
            if (!empty($data['fieldLayout'])) {
                // Save the field layout
                $layout = FieldLayout::createFromConfig(reset($data['fieldLayout']));
                $layout->id = $blockTypeRecord->fieldLayoutId;
                $layout->type = BlockType::class;
                $layout->uid = key($data['fieldLayout']);
                $fieldsService->saveLayout($layout);
                $blockTypeRecord->fieldLayoutId = $layout->id;
            } else if ($blockTypeRecord->fieldLayoutId) {
                // Delete the field layout
                $fieldsService->deleteLayoutById($blockTypeRecord->fieldLayoutId);
                $blockTypeRecord->fieldLayoutId = null;
            }

            // Save the record
            $blockTypeRecord->save(false);

            $transaction->commit();
        } catch (\Throwable $e) {
            $transaction->rollBack();
            throw $e;
        }
    }

    /**
     * Handles a deleted block type and removes it from the database
     *
     * @param ConfigEvent $event
     *
     * @throws \Throwable
     */
    public function handleDeletedBlockType(ConfigEvent $event)
    {
        $uid = $event->tokenMatches[0];
        $blockTypeRecord = $this->_getBlockTypeRecord($uid);

        if (!$blockTypeRecord->id) {
            return;
        }

        $db = Craft::$app->getDb();
        $transaction = $db->beginTransaction();
        try {
            // Delete the block type record
            $db->createCommand()
                ->delete('{{%spoon_blocktypes}}', ['id' => $blockTypeRecord->id])
                ->execute();

            $transaction->commit();
        } catch (\Throwable $e) {
            $transaction->rollBack();
            throw $e;
        }
    }

    // Public Methods for FLDs on our Block Types
    // =========================================================================

    /**
     * Saves a field layout into the project config nested under the block type config
     *
     * @param BlockType $blockType
     *
     * @return bool
     * @throws \Exception
     */
    public function saveFieldLayout(BlockType $blockType): bool
    {
        /** @var FieldLayout $fieldLayout */
        $fieldLayout = $blockType->getFieldLayout();
//        $oldFieldLayoutId = $blockType->fieldLayoutId;

        if ($fieldLayout->uid) {
            $layoutUid = $fieldLayout->uid;
        } else {
            $layoutUid = StringHelper::UUID();
            $fieldLayout->uid = $layoutUid;
        }

        $fieldLayoutConfig = $fieldLayout->getConfig();

        $configPath = self::CONFIG_BLOCKTYPE_KEY . '.' . $blockType->uid . '.fieldLayout';

        Craft::$app->projectConfig->set($configPath, [
            $layoutUid => $fieldLayoutConfig
        ]);

        return true;
    }

    /**
     * Returns an array of fieldLayoutIds indexed by matrixBlockTypeIds
     * for the given context and fieldId combination
     *
     * @param  string       $context required
     * @param  bool|integer $fieldId required
     * @return false|array
     */
    public function getFieldLayoutIds($context, $fieldId = false)
    {

        if (!$fieldId)
        {
            return false;
        }

        $blockTypeRecords = BlockTypeRecord::findAll([
            'context' => $context,
            'fieldId' => $fieldId
        ]);

        $return = array();
        foreach ($blockTypeRecords as $blockTypeRecord)
        {
            $return[$blockTypeRecord->matrixBlockTypeId] = $blockTypeRecord->fieldLayoutId;
        }
        return $return;

    }


    // Private Methods
    // =========================================================================

    /**
     * Gets a block type's record by uid.
     *
     * @param string $uid
     *
     * @return BlockTypeRecord
     */
    private function _getBlockTypeRecord(string $uid): BlockTypeRecord
    {
        $record = BlockTypeRecord::findOne(['uid' => $uid]);
        return $record ?? new BlockTypeRecord();

The expression return $record ?? new angellco\spoon\records\BlockType() could return the type yii\db\ActiveRecord which includes types incompatible with the type-hinted return angellco\spoon\records\BlockType. Consider adding an additional type-check to rule them out.

    }

    /**
     * Populates a BlockTypeModel with attributes from a BlockTypeRecord.
     *
     * @param BlockTypeRecord $blockTypeRecord
     *
     * @return BlockType|null
     */
    private function _populateBlockTypeFromRecord(BlockTypeRecord $blockTypeRecord)
    {
        $blockType = new BlockType($blockTypeRecord->toArray([
            'id',
            'uid',
            'fieldId',
            'matrixBlockTypeId',
            'fieldLayoutId',
            'groupName',
            'context',
            'groupSortOrder',
            'sortOrder'
        ]));

        // Use the fieldId to get the field and save the handle on to the model
        /** @var Field $matrixField */
        $matrixField = Craft::$app->fields->getFieldById($blockType->fieldId);

It seems like $blockType->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?

        if (!$matrixField) {

$matrixField is of type craft\base\Field, thus it always evaluated to true.

            return null;
        }
        $blockType->fieldHandle = $matrixField->handle;


        // Super Table support
        if (!$this->_superTablePlugin) {
            $this->_superTablePlugin = \Craft::$app->plugins->getPluginByPackageName('verbb/super-table');
        }
        if ($this->_superTablePlugin) {

            if (!$this->_superTableService) {
                $this->_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?

            }

            // If the field is actually inside a SuperTable
            if (strpos($matrixField->context, 'superTableBlockType') === 0) {
                $parts = explode(':', $matrixField->context);
                if (isset($parts[1])) {

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

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

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

                    $blockType->fieldHandle = $superTableField->handle."-".$matrixField->handle;

                    // 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);

                            $blockType->fieldHandle = $globalField->handle."-".$superTableField->handle."-".$matrixField->handle;
                        }
                    }
                }
            }
        }


        // Save the MatrixBlockTypeModel on to our model
        $blockType->matrixBlockType = $blockType->getBlockType();

        // Save the field layout content on to our model
        if ($blockType->fieldLayoutId) {

The expression $blockType->fieldLayoutId of type integer|null is loosely compared to true; this is ambiguous if the integer can be 0. You might want to explicitly use !== null instead.

            $layout = $blockType->getFieldLayout();
            $blockType->fieldLayoutModel = [
                'tabs' => $layout->getTabs(),
                'fields' => $layout->getFields()
            ];
        }

        return $blockType;
    }

}