AbterPhp\Website\Form\Factory\ContentList

Complexity

Total Complexity

50

Size/Duplication

Total Lines	502
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

18 Methods

Rating	Name	Duplication	Size	Complexity
A	addClasses()	0	13	2
A	addWithLinks()	0	23	3
A	addName()	0	13	3
A	isUserAdvanced()	0	14	2
A	addProtected()	0	23	3
A	addWithImages()	0	23	3
A	showAdvancedFields()	0	7	4
A	addNewButtons()	0	13	1
A	addIdentifier()	0	20	3
A	addWithClasses()	0	23	3
A	addButtons()	0	7	2
A	__construct()	0	12	1
A	addNewItems()	0	34	5
A	addWithLabelLinks()	0	23	3
A	addWithHtml()	0	23	3
A	addExistingItems()	0	32	4
A	addAddBtn()	0	17	4
A	create()	0	27	1

<?php

declare(strict_types=1);

namespace AbterPhp\Website\Form\Factory;

use AbterPhp\Admin\Form\Factory\Base;
use AbterPhp\Framework\Constant\Html5;
use AbterPhp\Framework\Constant\Session;
use AbterPhp\Framework\Form\Container\CheckboxGroup;
use AbterPhp\Framework\Form\Container\FormGroup;
use AbterPhp\Framework\Form\Element\Input;
use AbterPhp\Framework\Form\Extra\DefaultButtons;
use AbterPhp\Framework\Form\Extra\Help;
use AbterPhp\Framework\Form\IForm;
use AbterPhp\Framework\Form\Label\Label;
use AbterPhp\Framework\Html\Component;
use AbterPhp\Framework\Html\Component\Button;
use AbterPhp\Framework\Html\Tag;
use AbterPhp\Framework\I18n\ITranslator;
use AbterPhp\Website\Constant\Authorization;
use AbterPhp\Website\Domain\Entities\ContentList as Entity;
use AbterPhp\Website\Domain\Entities\ContentListItem;
use AbterPhp\Website\Form\Factory\ContentList\Item as ItemFactory;
use AbterPhp\Website\Orm\ContentListItemRepo as ItemRepo;
use Casbin\Enforcer;
use Opulence\Orm\IEntity;
use Opulence\Sessions\ISession;

/**
 * @SuppressWarnings(PHPMD.ExcessiveClassComplexity)
 */
class ContentList extends Base
{
    private const NEW_ITEM_NAME = 'website:contentListItemNew';

    private const ITEM_TEMPLATE_CLASS         = 'item-template';
    private const NEW_ITEMS_CONTAINER_ID      = 'new-items';
    private const EXISTING_ITEMS_CONTAINER_ID = 'existing-items';

    /** @var ItemRepo */
    protected $itemRepo;

    /** @var ItemFactory */
    protected $itemFactory;

    /** @var Enforcer */
    protected $enforcer;

    /** @var bool */
    private $isNew = false;

    /** @var bool|null */
    protected $advancedAllowed;

    /**
     * ContentList constructor.
     *
     * @param ISession    $session
     * @param ITranslator $translator
     * @param ItemRepo    $itemRepo
     * @param ItemFactory $itemFactory
     * @param Enforcer    $enforcer
     */
    public function __construct(
        ISession $session,
        ITranslator $translator,
        ItemRepo $itemRepo,
        ItemFactory $itemFactory,
        Enforcer $enforcer
    ) {
        parent::__construct($session, $translator);

        $this->itemRepo    = $itemRepo;
        $this->itemFactory = $itemFactory;
        $this->enforcer    = $enforcer;
    }

    /**
     * @return bool
     * @throws \Casbin\Exceptions\CasbinException
     */
    protected function isUserAdvanced(): bool
    {
        if ($this->advancedAllowed !== null) {
            return $this->advancedAllowed;
        }

        $username              = $this->session->get(Session::USERNAME);
        $this->advancedAllowed = $this->enforcer->enforce(
            $username,
            Authorization::RESOURCE_LISTS,
            Authorization::ROLE_ADVANCED_WRITE
        );

        return $this->advancedAllowed;
    }

    /**
     * @param IEntity|null $entity
     *
     * @return bool
     * @throws \Casbin\Exceptions\CasbinException
     */
    protected function showAdvancedFields(?IEntity $entity): bool
    {
        if (null === $entity || !$entity->getId()) {
            return true;
        }

        return !$entity->isProtected() || $this->isUserAdvanced();

The method isProtected() does not exist on Opulence\Orm\IEntity. It seems like you code against a sub-type of Opulence\Orm\IEntity such as AbterPhp\Website\Domain\Entities\ContentList.

    }

    /**
     * @param string       $action
     * @param string       $method
     * @param string       $showUrl
     * @param IEntity|null $entity
     *
     * @return IForm
     * @throws \Casbin\Exceptions\CasbinException
     */
    public function create(string $action, string $method, string $showUrl, ?IEntity $entity = null): IForm
    {
        assert($entity instanceof Entity, new \InvalidArgumentException());

        $this->isNew = ($entity->getName() == '');

        $this->createForm($action, $method)
            ->addDefaultElements()
            ->addName($entity)
            ->addIdentifier($entity)
            ->addClasses($entity)
            ->addProtected($entity)
            ->addWithLinks($entity)
            ->addWithLabelLinks($entity)
            ->addWithHtml($entity)
            ->addWithImages($entity)
            ->addWithClasses($entity)
            ->addExistingItems($entity)
            ->addNewItems($entity)
            ->addAddBtn($entity)
            ->addButtons($entity, $showUrl);

        $form = $this->form;

        $this->form = null;

        return $form;
    }

    /**
     * @param Entity $entity
     *
     * @return $this
     */
    protected function addName(Entity $entity): self
    {
        // Identifier of protected lists can only be set by advanced users
        if ($entity->isProtected() && !$this->isUserAdvanced()) {
            return $this;
        }

        $input = new Input('name', 'name', $entity->getName());
        $label = new Label('name', 'website:contentListName');

        $this->form[] = new FormGroup($input, $label, null, [], [Html5::ATTR_CLASS => FormGroup::CLASS_REQUIRED]);

        return $this;
    }

    /**
     * @param Entity $entity
     *
     * @return $this
     */
    protected function addIdentifier(Entity $entity): self
    {
        // Identifier of protected lists can only be set by advanced users
        if ($entity->isProtected() && !$this->isUserAdvanced()) {
            return $this;
        }

        $input = new Input(
            'identifier',
            'identifier',
            $entity->getIdentifier(),
            [],
            [Html5::ATTR_CLASS => 'semi-auto']
        );
        $label = new Label('identifier', 'website:contentListIdentifier');
        $help  = new Help('website:contentListIdentifierHelp');

        $this->form[] = new FormGroup($input, $label, $help);

        return $this;
    }

    /**
     * @param Entity $entity
     *
     * @return $this
     */
    protected function addClasses(Entity $entity): self
    {
        if (!$this->showAdvancedFields($entity)) {
            return $this;
        }

        $input = new Input('classes', 'classes', $entity->getClasses());
        $label = new Label('classes', 'website:contentListClasses');
        $help  = new Help('website:contentListClassesHelp');

        $this->form[] = new FormGroup($input, $label, $help);

        return $this;
    }

    /**
     * @param Entity $entity
     *
     * @return $this
     */
    protected function addProtected(Entity $entity): self
    {
        if (!$this->showAdvancedFields($entity)) {
            return $this;
        }

        $attributes = [Html5::ATTR_TYPE => Input::TYPE_CHECKBOX];
        if ($entity->isProtected()) {
            $attributes[Html5::ATTR_CHECKED] = null;
        }
        $input = new Input(
            'protected',
            'protected',
            '1',
            [],
            $attributes
        );
        $label = new Label('protected', 'website:contentListProtected');
        $help  = new Help('website:contentListProtectedHelp');

        $this->form[] = new CheckboxGroup($input, $label, $help, [], [Html5::ATTR_ID => 'protected-container']);

        return $this;
    }

    /**
     * @param Entity $entity
     *
     * @return INode

The type AbterPhp\Website\Form\Factory\INode was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    protected function addWithLinks(Entity $entity): self
    {
        if (!$this->showAdvancedFields($entity)) {
            return $this;

The expression return $this returns the type AbterPhp\Website\Form\Factory\ContentList which is incompatible with the documented return type AbterPhp\Website\Form\Factory\INode.

        }

        $attributes = [Html5::ATTR_TYPE => Input::TYPE_CHECKBOX];
        if ($entity->isWithLinks()) {
            $attributes[Html5::ATTR_CHECKED] = null;
        }
        $input = new Input(
            'with_links',
            'with_links',
            '1',
            [],
            $attributes
        );
        $label = new Label('with_links', 'website:contentListWithLinks');
        $help  = new Help('website:contentListWithLinksHelp');

        $this->form[] = new CheckboxGroup($input, $label, $help, [], [Html5::ATTR_ID => 'withLinks-container']);

        return $this;

The expression return $this returns the type AbterPhp\Website\Form\Factory\ContentList which is incompatible with the documented return type AbterPhp\Website\Form\Factory\INode.

    }

    /**
     * @param Entity $entity
     *
     * @return INode
     */
    protected function addWithLabelLinks(Entity $entity): self
    {
        if (!$this->showAdvancedFields($entity)) {
            return $this;

The expression return $this returns the type AbterPhp\Website\Form\Factory\ContentList which is incompatible with the documented return type AbterPhp\Website\Form\Factory\INode.

        }

        $attributes = [Html5::ATTR_TYPE => Input::TYPE_CHECKBOX];
        if ($entity->isWithLabelLinks()) {
            $attributes[Html5::ATTR_CHECKED] = null;
        }
        $input = new Input(
            'with_label_links',
            'with_label_links',
            '1',
            [],
            $attributes
        );
        $label = new Label('with_label_links', 'website:contentListWithLabelLinks');
        $help  = new Help('website:contentListWithLabelLinksHelp');

        $this->form[] = new CheckboxGroup($input, $label, $help, [], [Html5::ATTR_ID => 'withLabelLinks-container']);

        return $this;

The expression return $this returns the type AbterPhp\Website\Form\Factory\ContentList which is incompatible with the documented return type AbterPhp\Website\Form\Factory\INode.

    }

    /**
     * @param Entity $entity
     *
     * @return INode
     */
    protected function addWithHtml(Entity $entity): self
    {
        if (!$this->showAdvancedFields($entity)) {
            return $this;

The expression return $this returns the type AbterPhp\Website\Form\Factory\ContentList which is incompatible with the documented return type AbterPhp\Website\Form\Factory\INode.

        }

        $attributes = [Html5::ATTR_TYPE => Input::TYPE_CHECKBOX];
        if ($entity->isWithHtml()) {
            $attributes[Html5::ATTR_CHECKED] = null;
        }
        $input = new Input(
            'with_html',
            'with_html',
            '1',
            [],
            $attributes
        );
        $label = new Label('with_html', 'website:contentListWithHtml');
        $help  = new Help('website:contentListWithHtmlHelp');

        $this->form[] = new CheckboxGroup($input, $label, $help, [], [Html5::ATTR_ID => 'withHtml-container']);

        return $this;

The expression return $this returns the type AbterPhp\Website\Form\Factory\ContentList which is incompatible with the documented return type AbterPhp\Website\Form\Factory\INode.

    }

    /**
     * @param Entity $entity
     *
     * @return $this
     */
    protected function addWithImages(Entity $entity): self
    {
        if (!$this->showAdvancedFields($entity)) {
            return $this;
        }

        $attributes = [Html5::ATTR_TYPE => Input::TYPE_CHECKBOX];
        if ($entity->isWithImages()) {
            $attributes[Html5::ATTR_CHECKED] = null;
        }
        $input = new Input(
            'with_images',
            'with_images',
            '1',
            [],
            $attributes
        );
        $label = new Label('with_images', 'website:contentListWithImages');
        $help  = new Help('website:contentListWithImagesHelp');

        $this->form[] = new CheckboxGroup($input, $label, $help, [], [Html5::ATTR_ID => 'withImages-container']);

        return $this;
    }

    /**
     * @param Entity $entity
     *
     * @return $this
     */
    protected function addWithClasses(Entity $entity): self
    {
        if (!$this->showAdvancedFields($entity)) {
            return $this;
        }

        $attributes = [Html5::ATTR_TYPE => Input::TYPE_CHECKBOX];
        if ($entity->isWithClasses()) {
            $attributes[Html5::ATTR_CHECKED] = null;
        }
        $input = new Input(
            'with_classes',
            'with_classes',
            '1',
            [],
            $attributes
        );
        $label = new Label('with_classes', 'website:contentListWithClasses');
        $help  = new Help('website:contentListWithClassesHelp');

        $this->form[] = new CheckboxGroup($input, $label, $help, [], [Html5::ATTR_ID => 'withClasses-container']);

        return $this;
    }

    /**
     * @param Entity $entity
     *
     * @return $this
     */
    protected function addExistingItems(Entity $entity): self
    {
        // There's no reason to check existing items during creation
        if (!$entity->getId()) {
            return $this;
        }

        $links      = $entity->isWithLinks();
        $labelLinks = $entity->isWithLabelLinks();
        $html       = $entity->isWithHtml();
        $images     = $entity->isWithImages();
        $classes    = $entity->isWithClasses();

        $containerAttribs = [Html5::ATTR_ID => static::EXISTING_ITEMS_CONTAINER_ID];
        $container        = new Component(null, [], $containerAttribs, Html5::TAG_SECTION);

        /** @var ContentListItem[] $items */
        $items = $this->itemRepo->getByListId($entity->getId());
        foreach ($items as $item) {
            $fieldset   = new Component(null, [], [], Html5::TAG_FIELDSET);
            $fieldset[] = new Tag($item->getLabel(), [], [], Html5::TAG_LEGEND);

            $components = $this->itemFactory->create($item, $links, $labelLinks, $html, $images, $classes);
            foreach ($components as $component) {
                $fieldset[] = $component;
            }
            $container[] = $fieldset;
        }

        $this->form[] = $container;

        return $this;
    }

    /**
     * @param Entity $entity
     *
     * @return $this
     */
    protected function addNewItems(Entity $entity): self
    {
        // New items can not be added during creation
        if (!$entity->getId()) {
            return $this;
        }
        // New items can only be added to protected lists by advanced users
        if ($entity->isProtected() && !$this->isUserAdvanced()) {
            return $this;
        }

        $links      = $entity->isWithLinks();
        $labelLinks = $entity->isWithLabelLinks();
        $html       = $entity->isWithHtml();
        $images     = $entity->isWithImages();
        $classes    = $entity->isWithClasses();

        $containerAttribs = [Html5::ATTR_ID => static::NEW_ITEMS_CONTAINER_ID];
        $container        = new Component(null, [], $containerAttribs, Html5::TAG_SECTION);

        $itemAttribs = [Html5::ATTR_CLASS => static::ITEM_TEMPLATE_CLASS];
        $item        = new Component(null, [], $itemAttribs, Html5::TAG_FIELDSET);
        $item[]      = new Tag(static::NEW_ITEM_NAME, [], [], Html5::TAG_LEGEND);

        $components = $this->itemFactory->create(null, $links, $labelLinks, $html, $images, $classes);
        foreach ($components as $component) {
            $item[] = $component;
        }

        $container[] = $item;

        $this->form[] = $container;

        return $this;
    }

    /**
     * @param Entity $entity
     *
     * @return $this
     */
    protected function addAddBtn(Entity $entity): ContentList
    {
        // New items can not be added during creation
        if (!$entity->getId()) {
            return $this;
        }
        // New items can only be added to protected lists by advanced users
        if ($entity->isProtected() && !$this->isUserAdvanced()) {
            return $this;
        }

        $i   = new Component('add', [Component::INTENT_SMALL, Component::INTENT_ICON], [], Html5::TAG_I);
        $btn = new Button($i, [Button::INTENT_FAB, Button::INTENT_PRIMARY], [Html5::ATTR_TYPE => Button::TYPE_BUTTON]);

        $this->form[] = new Component($btn, [], [Html5::ATTR_ID => 'add-item-container'], Html5::TAG_DIV);

        return $this;
    }

    /**
     * @param string $showUrl
     *
     * @return Base
     */
    protected function addButtons(Entity $entity, string $showUrl): Base
    {
        if ($entity->getName()) {
            return parent::addDefaultButtons($showUrl);
        }

        return $this->addNewButtons($showUrl);
    }

    /**
     * @param string $showUrl
     *
     * @return Base
     */
    protected function addNewButtons(string $showUrl): Base
    {
        $buttons = new DefaultButtons();

        $buttons
            ->addSaveAndEdit(Button::INTENT_PRIMARY, Button::INTENT_FORM)
            ->addBackToGrid($showUrl)
            ->addSaveAndBack(Button::INTENT_WARNING, Button::INTENT_FORM)
            ->addSaveAndCreate();

        $this->form[] = $buttons;

        return $this;
    }
}