Charcoal\Admin\Widget\FormWidget

Complexity

Total Complexity

65

Size/Duplication

Total Lines	509
Duplicated Lines	0 %

Importance

Changes

0

23 Methods

Rating	Name	Duplication	Size	Complexity
A	defaultGroupType()	0	3	1
A	acceptedRequestData()	0	9	1
A	setDependencies()	0	14	1
A	dataFromRequest()	0	3	1
A	addHiddenProperties()	0	7	2
A	sortSidebarsByPriority()	0	12	3
A	sidebars()	0	18	4
A	createFormProperty()	0	8	2
A	formProperties()	0	16	4
A	defaultSubmitLabel()	0	3	1
B	addSidebar()	0	39	8
A	addHiddenProperty()	0	18	5
A	sortItemsByPriority()	0	12	3
A	setSidebars()	0	8	2
A	widgetFactory()	0	10	2
A	addFormProperties()	0	7	2
A	addFormProperty()	0	18	5
A	hiddenProperties()	0	8	3
A	setWidgetFactory()	0	3	1
A	submitLabel()	0	7	2
B	getOrCreateFormProperty()	0	50	10
A	setHiddenProperties()	0	7	1
A	setFormProperties()	0	7	1

<?php

namespace Charcoal\Admin\Widget;

use Charcoal\Admin\Property\HierarchicalObjectProperty;
use Exception;
use InvalidArgumentException;
use RuntimeException;

// From Pimple
use Pimple\Container;

// From PSR-7
use Psr\Http\Message\RequestInterface;

// From 'charcoal-factory'
use Charcoal\Factory\FactoryInterface;

/// From 'charcoal-ui'
use Charcoal\Ui\Form\FormInterface;
use Charcoal\Ui\Form\FormTrait;
use Charcoal\Ui\Layout\LayoutAwareInterface;
use Charcoal\Ui\Layout\LayoutAwareTrait;
use Charcoal\Ui\PrioritizableInterface;

// From 'charcoal-admin'
use Charcoal\Admin\AdminWidget;
use Charcoal\Admin\Ui\FormSidebarInterface;
use Charcoal\Admin\Ui\ObjectContainerInterface;
use Charcoal\Admin\Support\HttpAwareTrait;
use Charcoal\Admin\Widget\FormPropertyWidget;

/**
 * A Basic Admin Form
 *
 * For submitting information to a web server.
 *
 * The widget is a variant of {@see \Charcoal\Ui\Form\AbstractForm}.
 */
class FormWidget extends AdminWidget implements
    FormInterface,
    LayoutAwareInterface
{
    use FormTrait;
    use HttpAwareTrait;
    use LayoutAwareTrait;

    /**
     * The form's sidebars.
     *
     * @var array
     */
    protected $sidebars = [];

    /**
     * The form's controls.
     *
     * @var array
     */
    protected $formProperties = [];

    /**
     * The form's hidden controls.
     *
     * @var array
     */
    protected $hiddenProperties = [];

    /**
     * Label for the form submission button.
     *
     * @var \Charcoal\Translator\Translation|string
     */
    protected $submitLabel;

    /**
     * Store the factory instance for the current class.
     *
     * @var FactoryInterface
     */
    private $widgetFactory;

    /**
     * @param array $data Optional. The form property data to set.
     * @return FormPropertyWidget
     */
    public function createFormProperty(array $data = null)
    {
        $p = $this->widgetFactory()->create(FormPropertyWidget::class);
        if ($data !== null) {
            $p->setData($data);
        }

        return $p;
    }

    /**
     * @param string $ident Property ident.
     * @param array  $data  Property metadata.
     * @return \Charcoal\Admin\Widget\FormPropertyWidget|mixed
     */
    public function getOrCreateFormProperty($ident, array $data = null)
    {
        if ($ident && isset($this->formProperties[$ident])) {
            $p = $this->formProperties[$ident];

            if ($data !== null) {
                $p->setData($data);
            }

            $this->formProperties[$ident] = $p;

            return $this->formProperties[$ident];
        }

        if ($ident && isset($this->hiddenProperties[$ident])) {
            $p = $this->hiddenProperties[$ident];

            if ($data !== null) {
                $p->setData($data);
            }

            $this->hiddenProperties[$ident] = $p;

            return $this->hiddenProperties[$ident];
        }

        $prop = $this->createFormProperty($data);
        $prop->setPropertyIdent($ident);

        if ($this instanceof ObjectContainerInterface) {
            $prop->setPropertyVal($this->obj()[$ident]);

            if ($prop->propertyType() === HierarchicalObjectProperty::class) {
                $prop->merge(['obj_id' => $this->obj()->id()]);
            }
        }

        $prop->setViewController($this->viewController());

        if ($prop->hidden()) {
            $prop->setInputType(FormPropertyWidget::HIDDEN_FORM_CONTROL);

            $this->hiddenProperties[$ident] = $prop;

            return $this->hiddenProperties[$ident];
        }

        $this->formProperties[$ident] = $prop;

        return $this->formProperties[$ident];
    }

    /**
     * @param array $sidebars The form sidebars.
     * @return self
     */
    public function setSidebars(array $sidebars)
    {
        $this->sidebars = [];
        foreach ($sidebars as $sidebarIdent => $sidebar) {
            $this->addSidebar($sidebarIdent, $sidebar);
        }

        return $this;
    }

    /**
     * @param string                     $sidebarIdent The sidebar identifier.
     * @param array|FormSidebarInterface $sidebar      The sidebar data or object.
     * @throws InvalidArgumentException If the ident is not a string or the sidebar is not valid.
     * @return self
     */
    public function addSidebar($sidebarIdent, $sidebar)
    {
        if (!is_string($sidebarIdent)) {

The condition is_string($sidebarIdent) is always true.

            throw new InvalidArgumentException(
                'Sidebar ident must be a string'
            );
        }
        if (($sidebar instanceof FormSidebarInterface)) {
            $this->sidebars[$sidebarIdent] = $sidebar;
        } elseif (is_array($sidebar)) {

The condition is_array($sidebar) is always true.

            if (isset($sidebar['widget_type'])) {
                $s = $this->widgetFactory()->create($sidebar['widget_type']);
                $s->setTemplate($sidebar['widget_type']);
            }

            if (!isset($s) || !($s instanceof FormSidebarInterface)) {
                $s = $this->widgetFactory()->create('charcoal/admin/widget/form-sidebar');
            }

            $s->setForm($this->formWidget());
            $s->setData($sidebar);

The method setData() does not exist on Charcoal\Admin\Ui\FormSidebarInterface. Since it exists in all sub-types, consider adding an abstract or default implementation to Charcoal\Admin\Ui\FormSidebarInterface.

            // Test sidebar vs. ACL roles
            $authUser = $this->authenticator()->authenticate();
            if (!$this->authorizer()->userAllowed($authUser, $s->requiredGlobalAclPermissions())) {

It seems like $authUser can also be of type null; however, parameter $user of Charcoal\User\Authorizer::userAllowed() does only seem to accept Charcoal\User\UserInterface, maybe add an additional type check?

The method requiredGlobalAclPermissions() does not exist on Charcoal\Admin\Ui\FormSidebarInterface. Since it exists in all sub-types, consider adding an abstract or default implementation to Charcoal\Admin\Ui\FormSidebarInterface.

                header('HTTP/1.0 403 Forbidden');
                header('Location: '.$this->adminUrl().'login');

                return $this;
            }

            $this->sidebars[$sidebarIdent] = $s;
        } else {
            throw new InvalidArgumentException(
                'Sidebar must be a FormSidebarWidget object or an array'
            );
        }

        return $this;
    }

    /**
     * Yield the form sidebar(s).
     *
     * @return \Generator
     */
    public function sidebars()
    {
        $sidebars = $this->sidebars;
        uasort($sidebars, [$this, 'sortSidebarsByPriority']);
        foreach ($sidebars as $sidebarIdent => $sidebar) {
            if (!$sidebar->active()) {
                continue;
            }

            if ($sidebar->template()) {
                $template = $sidebar->template();
            } else {
                $template = 'charcoal/admin/widget/form.sidebar';
            }

            $GLOBALS['widget_template'] = $template;
            yield $sidebarIdent => $sidebar;
            $GLOBALS['widget_template'] = '';
        }
    }

    /**
     * Replace property controls to the form.
     *
     * @param  array $properties The form properties.
     * @return self
     */
    public function setFormProperties(array $properties)
    {
        $this->formProperties = [];

        $this->addFormProperties($properties);

        return $this;
    }

    /**
     * Add property controls to the form.
     *
     * @param  array $properties The form properties.
     * @return self
     */
    public function addFormProperties(array $properties)
    {
        foreach ($properties as $propertyIdent => $property) {
            $this->addFormProperty($propertyIdent, $property);
        }

        return $this;
    }

    /**
     * Add a property control to the form.
     *
     * If a given property uses a hidden form control, the form property will be
     * added to {@see FormWidget::$hiddenProperties}.
     *
     * @param  string                   $propertyIdent The property identifier.
     * @param  array|FormPropertyWidget $formProperty  The property object or structure.
     * @throws InvalidArgumentException If the identifier or the property is invalid.
     * @return FormInterface Chainable
     */
    public function addFormProperty($propertyIdent, $formProperty)
    {
        if (!is_string($propertyIdent)) {

The condition is_string($propertyIdent) is always true.

            throw new InvalidArgumentException(
                'Property ident must be a string'
            );
        }

        if (is_array($formProperty)) {
            $this->getOrCreateFormProperty($propertyIdent, $formProperty);
        } elseif (!$formProperty instanceof FormPropertyWidget) {

$formProperty is always a sub-type of Charcoal\Admin\Widget\FormPropertyWidget.

            throw new InvalidArgumentException(sprintf(
                'Property must be an array or an instance of FormPropertyWidget, received %s',
                is_object($formProperty) ? get_class($formProperty) : gettype($formProperty)
            ));
        }

        return $this;
    }

    /**
     * Yield the form's property controls.
     *
     * @return \Generator
     */
    public function formProperties()
    {
        $sidebars = $this->sidebars;
        if (!is_array($sidebars)) {

The condition is_array($sidebars) is always true.

            yield null;
        } else {
            foreach ($this->formProperties as $formProperty) {
                if ($formProperty->active() === false) {
                    continue;
                }

                $GLOBALS['widget_template'] = $formProperty->inputType();

                yield $formProperty->propertyIdent() => $formProperty;

                $GLOBALS['widget_template'] = '';
            }
        }
    }

    /**
     * Replace hidden property controls to the form.
     *
     * @param  array $properties The hidden form properties.
     * @return FormInterface Chainable
     */
    public function setHiddenProperties(array $properties)
    {
        $this->hiddenProperties = [];

        $this->addHiddenProperties($properties);

        return $this;
    }

    /**
     * Add hidden property controls to the form.
     *
     * @param  array $properties The hidden form properties.
     * @return FormInterface Chainable
     */
    public function addHiddenProperties(array $properties)
    {
        foreach ($properties as $propertyIdent => $property) {
            $this->addHiddenProperty($propertyIdent, $property);
        }

        return $this;
    }

    /**
     * Add a hidden property control to the form.
     *
     * @param  string                      $propertyIdent The property identifier.
     * @param  array|FormPropertyInterface $formProperty  The property object or structure.

The type Charcoal\Admin\Widget\FormPropertyInterface was not found. Maybe you did not declare it correctly or list all dependencies?

     * @throws InvalidArgumentException If the identifier or the property is invalid.
     * @return FormInterface Chainable
     */
    public function addHiddenProperty($propertyIdent, $formProperty)
    {
        if (!is_string($propertyIdent)) {

The condition is_string($propertyIdent) is always true.

            throw new InvalidArgumentException(
                'Property ident must be a string'
            );
        }

        if (is_array($formProperty)) {
            $this->getOrCreateFormProperty($propertyIdent, $formProperty);
        } elseif (!$formProperty instanceof FormPropertyWidget) {
            throw new InvalidArgumentException(sprintf(
                'Property must be an array or an instance of FormPropertyWidget, received %s',
                is_object($formProperty) ? get_class($formProperty) : gettype($formProperty)
            ));
        }

        return $this;
    }

    /**
     * Yield the form's hidden property controls.
     *
     * @return \Generator
     */
    public function hiddenProperties()
    {
        foreach ($this->hiddenProperties as $formProperty) {
            if ($formProperty->active() === false) {
                continue;
            }

            yield $formProperty->propertyIdent() => $formProperty;
        }
    }

    /**
     * Retrieve the label for the form submission button.
     *
     * @return \Charcoal\Translator\Translation|string|null
     */
    public function submitLabel()
    {
        if ($this->submitLabel === null) {
            $this->submitLabel = $this->defaultSubmitLabel();
        }

        return $this->submitLabel;
    }

    /**
     * Retrieve the default label for the form submission button.
     *
     * @return \Charcoal\Translator\Translation|null
     */
    public function defaultSubmitLabel()
    {
        return $this->translator()->translation('Save');
    }

    /**
     * @return string
     */
    public function defaultGroupType()
    {
        return 'charcoal/admin/widget/form-group/generic';
    }

    /**
     * @param  Container $container The DI container.
     * @return void
     */
    protected function setDependencies(Container $container)
    {
        parent::setDependencies($container);

        // Satisfies HttpAwareTrait dependencies
        $this->setHttpRequest($container['request']);

        $this->setWidgetFactory($container['widget/factory']);

        // Satisfies FormInterface
        $this->setFormGroupFactory($container['form/group/factory']);

        // Satisfies LayoutAwareInterface
        $this->setLayoutBuilder($container['layout/builder']);
    }

    /**
     * Retrieve the widget factory.
     *
     * @throws RuntimeException If the widget factory was not previously set.
     * @return FactoryInterface
     */
    protected function widgetFactory()
    {
        if ($this->widgetFactory === null) {
            throw new RuntimeException(sprintf(
                'Widget Factory is not defined for "%s"',
                get_class($this)
            ));
        }

        return $this->widgetFactory;
    }

    /**
     * Fetch metadata from the current request.
     *
     * @return array
     */
    protected function dataFromRequest()
    {
        return $this->httpRequest()->getParams($this->acceptedRequestData());

The method getParams() does not exist on Psr\Http\Message\RequestInterface. It seems like you code against a sub-type of Psr\Http\Message\RequestInterface such as Slim\Http\Request.

    }

    /**
     * Retrieve the accepted metadata from the current request.
     *
     * @return array
     */
    protected function acceptedRequestData()
    {
        return [
            'form_ident',
            'form_data',
            'l10n_mode',
            'group_display_mode',
            'next_url',
            'tab_ident',
        ];
    }

    /**
     * Comparison function used by {@see uasort()}.
     *
     * @param  PrioritizableInterface $a Sortable entity A.
     * @param  PrioritizableInterface $b Sortable entity B.
     * @return integer Sorting value: -1 or 1.
     */
    protected function sortItemsByPriority(
        PrioritizableInterface $a,
        PrioritizableInterface $b
    ) {
        $priorityA = $a->priority();
        $priorityB = $b->priority();

        if ($priorityA === $priorityB) {
            return 0;
        }

        return ($priorityA < $priorityB) ? (-1) : 1;
    }

    /**
     * To be called with {@see uasort()}.
     *
     * @param  FormSidebarInterface $a Sortable entity A.
     * @param  FormSidebarInterface $b Sortable entity B.
     * @return integer Sorting value: -1, 0, or 1
     */
    protected function sortSidebarsByPriority(
        FormSidebarInterface $a,
        FormSidebarInterface $b
    ) {
        $a = $a->priority();
        $b = $b->priority();

        if ($a === $b) {
            return 0;
        }

        return ($a < $b) ? (-1) : 1;
    }

    /**
     * Set an widget factory.
     *
     * @param FactoryInterface $factory The factory to create widgets.
     * @return void
     */
    private function setWidgetFactory(FactoryInterface $factory)
    {
        $this->widgetFactory = $factory;
    }
}