CategoryLayoutPlugin::getLayoutProcessor() - Code Metrics - Inspection of "Merge pull request #5 from integer-net/tests" - integer-net/magento2-global-custom-layout - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d80aef...0536a3 )

by Willem

created 2020-04-30 15:39 UTC

CategoryLayoutPlugin::getLayoutProcessor() A

↳ Parent: CategoryLayoutPlugin

Complexity

Conditions	2
Paths	2

Size

Total Lines	15
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	2.3149

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	7
c	1
b	0
f	0
dl	0
loc	15
ccs	8
cts	14
cp	0.5714
rs	10
cc	2
nc	2
nop	0
crap	2.3149

<?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;
filter:
    dependency_paths: ["lib/*"]

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
    )
    {
        $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,
        /** @scrutinizer ignore-unused */ LayoutUpdateManager $subject,
        array $result,
        CategoryInterface $category
    ): array
    {
        if (!$category->getId()) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            return $result;
        }

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

        return array_merge($result, array_filter(
            array_map(
                function(string $handle) use ($category) : ?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,
        /** @scrutinizer ignore-unused */ LayoutUpdateManager $subject,
        $result,
        /** @scrutinizer ignore-unused */ $result,
        CategoryInterface $category,
        DataObject $intoSettings
    ): void
    {
        if ($category->getId() && $value = $this->extractAttributeValue($category)) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            $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;
    }
}


integer-net / magento2-global-custom-layout

Push — master ( d80aef...0536a3 )

CategoryLayoutPlugin::getLayoutProcessor() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like