IntegerNet\GlobalCustomLayout\Plugin\CategoryLayoutPlugin

Complexity

Total Complexity

12

Size/Duplication

Total Lines	146
Duplicated Lines	0 %

Test Coverage

Coverage

89.74%

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	1
A	getLayoutProcessor()	0	15	2
A	afterExtractCustomSettings()	0	13	3
A	extractAttributeValue()	0	10	4
A	afterFetchAvailableFiles()	0	24	2

<?php
declare(strict_types=1);

namespace IntegerNet\GlobalCustomLayout\Plugin;

use Magento\Catalog\Api\Data\CategoryInterface;
use Magento\Catalog\Model\Category;
use Magento\Catalog\Model\Category\Attribute\LayoutUpdateManager;
use Magento\Framework\App\Area;
use Magento\Framework\DataObject;
use Magento\Framework\View\Design\Theme\FlyweightFactory;
use Magento\Framework\View\DesignInterface;
use Magento\Framework\View\Model\Layout\Merge as LayoutProcessor;
use Magento\Framework\View\Model\Layout\MergeFactory as LayoutProcessorFactory;

The type Magento\Framework\View\Model\Layout\MergeFactory was not found. Maybe you did not declare it correctly or list all dependencies?

class CategoryLayoutPlugin
{

    /**
     * @var FlyweightFactory
     */
    private $themeFactory;

    /**
     * @var DesignInterface
     */
    private $design;

    /**
     * @var LayoutProcessorFactory
     */
    private $layoutProcessorFactory;

    /**
     * @var LayoutProcessor|null
     */
    private $layoutProcessor;

    /**
     * @param FlyweightFactory $themeFactory
     * @param DesignInterface $design
     * @param LayoutProcessorFactory $layoutProcessorFactory
     */
    public function __construct(
        FlyweightFactory $themeFactory,
        DesignInterface $design,
        LayoutProcessorFactory $layoutProcessorFactory)

The closing parenthesis of a multi-line function declaration must be on a new line

    {

The closing parenthesis and the opening brace of a multi-line function declaration must be on the same line

        $this->themeFactory = $themeFactory;
        $this->design = $design;
        $this->layoutProcessorFactory = $layoutProcessorFactory;
    }

    /**
     * Get the processor instance.
     *
     * @return LayoutProcessor
     *
     * Unchanged private method copied over from @var LayoutUpdateManager
     */
    private function getLayoutProcessor(): LayoutProcessor
    {
        if (!$this->layoutProcessor) {
            $this->layoutProcessor = $this->layoutProcessorFactory->create(
                [
                    'theme' => $this->themeFactory->create(
                        $this->design->getConfigurationDesignTheme(Area::AREA_FRONTEND)
                    ),
                ]
            );
            $this->themeFactory = null;
            $this->design = null;
        }

        return $this->layoutProcessor;
    }

    /**
     * Fetch list of available global files/handles for the category.
     *
     * @param LayoutUpdateManager $subject
     * @param array $result
     * @param CategoryInterface $category
     * @return array
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     */
    public function afterFetchAvailableFiles(
        LayoutUpdateManager $subject,

The parameter $subject is not used and could be removed.

        array $result,
        CategoryInterface $category): array

The parameter $category is not used and could be removed.

The closing parenthesis of a multi-line function declaration must be on a new line

    {

The closing parenthesis and the opening brace of a multi-line function declaration must be on the same line

        $handles = $this->getLayoutProcessor()->getAvailableHandles();

        return array_merge(
            $result,
            array_filter(
                array_map(
                    function (string $handle): ?string {
                        preg_match(
                            '/^catalog\_category\_view\_selectable\_0\_([a-z0-9]+)/i',
                            $handle,
                            $selectable
                        );
                        if (!empty($selectable[1])) {
                            return $selectable[1];
                        }

                        return null;
                    },
                    $handles
                )
            )
        );
    }

    /**
     * Extract selected global custom layout settings.
     *
     * If no update is selected none will apply.
     *
     * @param LayoutUpdateManager $subject
     * @param $result
     * @param CategoryInterface $category
     * @param DataObject $intoSettings
     * @return void
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     */
    public function afterExtractCustomSettings(
        LayoutUpdateManager $subject,

The parameter $subject is not used and could be removed.

        $result,

The parameter $result is not used and could be removed.

        CategoryInterface $category,
        DataObject $intoSettings): void

The closing parenthesis of a multi-line function declaration must be on a new line

    {

The closing parenthesis and the opening brace of a multi-line function declaration must be on the same line

        if ($category->getId() && $value = $this->extractAttributeValue($category)) {

The expression $category->getId() 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.

            $handles = $intoSettings->getPageLayoutHandles() ?? [];
            $handles = array_merge_recursive(
                $handles,
                ['selectable_0' => $value]
            );
            $intoSettings->setPageLayoutHandles($handles);
        }
    }

    /**
     * Extract custom layout attribute value.
     *
     * @param CategoryInterface $category
     * @return mixed
     *
     * Unchanged private method copied over from @var LayoutUpdateManager
     */
    private function extractAttributeValue(CategoryInterface $category)
    {
        if ($category instanceof Category && !$category->hasData(CategoryInterface::CUSTOM_ATTRIBUTES)) {
            return $category->getData('custom_layout_update_file');
        }
        if ($attr = $category->getCustomAttribute('custom_layout_update_file')) {
            return $attr->getValue();
        }

        return null;
    }
}