Khusseini\PimcoreRadBrickBundle\Areabricks\AbstractAreabrick

Complexity

Total Complexity

14

Size/Duplication

Total Lines	145
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	getTemplateSuffix()	0	3	1
A	doAction()	0	3	1
A	__construct()	0	12	1
A	hasEditTemplate()	0	3	1
A	getTemplateLocation()	0	3	1
A	getIcon()	0	3	2
A	getName()	0	3	2
A	action()	0	5	1
A	postRenderAction()	0	3	1
A	getHtmlTagClose()	0	3	1
A	getHtmlTagOpen()	0	3	1
A	configure()	0	2	1

<?php

namespace Khusseini\PimcoreRadBrickBundle\Areabricks;

use Khusseini\PimcoreRadBrickBundle\AreabrickRenderer;
use Pimcore\Extension\Document\Areabrick\AbstractTemplateAreabrick;
use Pimcore\Model\Document\Tag\Area\Info;
use Symfony\Component\HttpFoundation\Response;

abstract class AbstractAreabrick extends AbstractTemplateAreabrick
{
    /**
     * @var string
     */
    private $name;
    /**
     * @var string
     */
    private $icon;
    /**
     * @var string
     */
    private $label;
    /**
     * @var string
     */
    private $openTag = '';
    /**
     * @var string
     */
    private $closeTag = '';
    /**
     * @var bool
     */
    private $useEdit = false;

    /**
     * @var AreabrickRenderer
     */
    private $areabrickRenderer;

    public function __construct(
        string $name,
        AreabrickRenderer $areabrickRenderer
    ) {
        $this->name = $name;
        $this->areabrickRenderer = $areabrickRenderer;
        $options = $areabrickRenderer->getAreabrickConfig($name);
        $this->icon = $options['icon'];
        $this->label = $options['label'];
        $this->openTag = $options['open'];
        $this->closeTag = $options['close'];
        $this->useEdit = $options['use_edit'];
    }

    /**
     * @return string
     * @codeCoverageIgnore
     */
    public function getIcon()
    {
        return $this->icon ?: parent::getIcon();

Are you sure the usage of parent::getIcon() targeting Pimcore\Extension\Document\Areabrick\AbstractAreabrick::getIcon() seems to always return null.

    }

    /**
     * @return string
     * @codeCoverageIgnore
     */
    public function getName()
    {
        return $this->label ?: parent::getName();
    }

    /**
     * @return bool
     * @codeCoverageIgnore
     */
    public function hasEditTemplate()
    {
        return $this->useEdit;
    }

    /**
     * {@inheritdoc}
     *
     * @codeCoverageIgnore
     */
    public function getTemplateLocation()
    {
        return static::TEMPLATE_LOCATION_GLOBAL;
    }

    /**
     * {@inheritdoc}
     *
     * @codeCoverageIgnore
     */
    public function getTemplateSuffix()
    {
        return static::TEMPLATE_SUFFIX_TWIG;
    }

    /**
     * @return Response|null
     */
    public function action(Info $info)
    {
        $this->areabrickRenderer->render($this->name, $info);

        return $this->doAction($info);

Are you sure the usage of $this->doAction($info) targeting Khusseini\PimcoreRadBrickBundle\Areabricks\AbstractAreabrick::doAction() seems to always return null.

    }

    public function doAction(Info $info): ?Response

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

    {
        return null;
    }

    /**
     * @codeCoverageIgnore
     *
     * @param array<string, mixed> $options
     */
    public function configure(array $options): void

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

    {
    }

    /**
     * {@inheritdoc}
     *
     * @codeCoverageIgnore
     */
    public function postRenderAction(Info $info)
    {
        return null;
    }

    /**
     * {@inheritdoc}
     *
     * @codeCoverageIgnore
     */
    public function getHtmlTagOpen(Info $info)
    {
        return $this->openTag;
    }

    /**
     * {@inheritdoc}
     *
     * @codeCoverageIgnore
     */
    public function getHtmlTagClose(Info $info)
    {
        return $this->closeTag;
    }
}