Charcoal\Admin\Widget\DocWidget

Complexity

Total Complexity

83

Size/Duplication

Total Lines	669
Duplicated Lines	0 %

Importance

Changes

0

32 Methods

Rating	Name	Duplication	Size	Complexity
A	formIdent()	0	3	1
A	showHeader()	0	3	1
A	widgetType()	0	3	1
A	objData()	0	3	1
A	defaultDataSources()	0	3	1
A	showTitle()	0	3	1
A	isTabbable()	0	3	1
A	defaultGroupType()	0	3	1
A	sidebars()	0	42	4
A	setDependencies()	0	6	1
A	displayOptions()	0	7	2
A	setShowTitle()	0	5	1
A	formProperty()	0	24	4
A	setFormData()	0	18	2
A	setNextUrl()	0	20	4
A	setShowHeader()	0	5	1
A	setDisplayOptions()	0	9	2
C	dataFromObject()	0	48	12
A	setData()	0	7	1
A	setFormIdent()	0	11	2
A	formData()	0	7	2
A	acceptedRequestData()	0	5	1
B	formProperties()	0	35	7
A	createFormProperty()	0	8	2
A	defaultBackToObjectLabel()	0	7	2
A	defaultDataSourceFilters()	0	5	1
A	formIdentFallback()	0	9	2
A	resolveDataSourceFilter()	0	22	4
A	defaultDisplayOptions()	0	6	1
A	action()	0	14	3
B	updateFormGroup()	0	26	7
B	createFormGroup()	0	29	7

<?php

namespace Charcoal\Admin\Widget;

use InvalidArgumentException;
use phpDocumentor\Reflection\DocBlock\Tags\Var_;
use UnexpectedValueException;

// From Pimple
use Pimple\Container;

// From 'charcoal-ui'
use Charcoal\Ui\FormGroup\FormGroupInterface;

// From 'charcoal-admin'
use Charcoal\Admin\Docs\Widget\DocFormPropertyWidget;
use Charcoal\Admin\Ui\FormSidebarInterface;
use Charcoal\Admin\Ui\ObjectContainerInterface;
use Charcoal\Admin\Ui\ObjectContainerTrait;
use Charcoal\Admin\Widget\FormWidget;

/**
 * Object Admin Form
 */
class DocWidget extends FormWidget implements
    ObjectContainerInterface
{
    use ObjectContainerTrait;

    /**
     * @var string
     */
    protected $formIdent;

    /**
     * @var array
     */
    protected $formData;

    /**
     * @var boolean
     */
    protected $showHeader;

    /**
     * @var boolean
     */
    protected $showTitle;

    /**
     * Display options.
     *
     * @var array
     */
    private $displayOptions;

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

        // Fill ObjectContainerInterface dependencies
        $this->setModelFactory($container['model/factory']);
    }

    /**
     * For doc, disable tab view
     *
     * @return boolean
     */
    public function isTabbable()
    {
        return false;
    }

    /**
     * @return string
     */
    public function widgetType()
    {
        return 'charcoal/admin/widget/doc';
    }

    /**
     * Retrieve the default label for the form submission button.
     *
     * @return Translation|string|null

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

     */
    public function defaultBackToObjectLabel()
    {
        if ($this->objId()) {
            return $this->translator()->translation('Update');
        }

        return parent::defaultSubmitLabel();
    }

    /**
     * @param array $data The widget data.
     * @return ObjectForm Chainable
     */
    public function setData(array $data)
    {
        parent::setData($data);

        $this->mergeDataSources($data);

        return $this;

The expression return $this returns the type Charcoal\Admin\Widget\DocWidget which is incompatible with the documented return type Charcoal\Admin\Widget\ObjectForm.

    }

    /**
     * @return FormSidebarInterface[]|\Generator
     */
    public function sidebars()
    {
        $objId = $this->obj()->id();

        if ($objId) {
            $translator = $this->translator();

            $template = 'charcoal/admin/widget/form.sidebar';
            $GLOBALS['widget_template'] = $template;

            $metadata = $this->obj()->metadata();
            $objType  = (isset($metadata['labels']['singular_name'])
                        ? $translator->translate($metadata['labels']['singular_name'])
                        : null);

            $label = $translator->translate('Back to {{name}} id: {{id}}');
            $label = strtr($label, [
                '{{name}}' => $objType ?: $this->obj()['obj_type'],
                '{{id}}'   => $this->obj()->id()
            ]);

            $url = 'object/edit?main_menu='.$this->obj()['main_menu'].'&obj_type={{obj_type}}&obj_id={{id}}';

            $out = [
                'title'       => $translator->translate('Actions'),
                'show_footer' => false,
                'actions'     => [
                    [
                        'label' => $label,
                        'url'   => $url
                    ]
                ]
            ];

            /** @var FormSidebarWidget $sidebar */
            $sidebar = $this->widgetFactory()->create(FormSidebarWidget::class);
            $sidebar->setViewController($this->viewController());
            $sidebar->setData($out);

            yield $sidebar;

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

    /**
     * Set the key for the form structure to use.
     *
     * @param  string $formIdent The form identifier.
     * @throws InvalidArgumentException If the identifier is not a string.
     * @return self
     */
    public function setFormIdent($formIdent)
    {
        if (!is_string($formIdent)) {

The condition is_string($formIdent) is always true.

            throw new InvalidArgumentException(
                'Form identifier must be a string'
            );
        }

        $this->formIdent = $formIdent;

        return $this;
    }

    /**
     * Retrieve a key for the form structure to use.
     *
     * If the form key is undefined, resolve a fallback.
     *
     * @return string
     */
    public function formIdentFallback()
    {
        $metadata = $this->obj()->metadata();

        if (isset($metadata['admin']['default_form'])) {
            return $metadata['admin']['default_form'];
        }

        return '';
    }

    /**
     * Retrieve the display options for the widget.
     *
     * @return array
     */
    public function displayOptions()
    {
        if (!$this->displayOptions) {

The expression $this->displayOptions of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

            $this->setDisplayOptions([]);
        }

        return $this->displayOptions;
    }

    /**
     * Set the display options for the widget.
     *
     * @param  array $options Display configuration.
     * @throws \RuntimeException If the display options are not an associative array.
     * @return self
     */
    public function setDisplayOptions(array $options)
    {
        if (!is_array($options)) {

The condition is_array($options) is always true.

            throw new \RuntimeException('The display options must be an associative array.');
        }

        $this->displayOptions = array_merge($this->defaultDisplayOptions(), $options);

        return $this;
    }

    /**
     * Retrieve the default display options for the widget.
     *
     * @return array
     */
    public function defaultDisplayOptions()
    {
        return [
            'parented'    => false,
            'collapsible' => false,
            'collapsed'   => false
        ];
    }

    /**
     * Retrieve the key for the form structure to use.
     *
     * @return string
     */
    public function formIdent()
    {
        return $this->formIdent;
    }

    /**
     * @param string $url The next URL.
     * @throws InvalidArgumentException If argument is not a string.
     * @return ActionInterface Chainable

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

     */
    public function setNextUrl($url)
    {
        if (!is_string($url)) {

The condition is_string($url) is always true.

            throw new InvalidArgumentException(
                'URL needs to be a string'
            );
        }

        if (!$this->obj()) {
            $this->nextUrl = $url;

The property nextUrl does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

            return $this;

The expression return $this returns the type Charcoal\Admin\Widget\DocWidget which is incompatible with the documented return type Charcoal\Admin\Widget\ActionInterface.

        }

        $obj = $this->obj();
        if ($obj->view()) {

The method view() does not exist on Charcoal\Model\ModelInterface. It seems like you code against a sub-type of said class. However, the method does not exist in Charcoal\Queue\QueueItemInterface or Charcoal\Object\ContentInterface or Charcoal\Object\UserDataInterface or Charcoal\User\UserInterface. Are you sure you never get one of those?

            $this->nextUrl = $obj->render($url);

The method render() does not exist on Charcoal\Model\ModelInterface. It seems like you code against a sub-type of said class. However, the method does not exist in Charcoal\Queue\QueueItemInterface or Charcoal\Object\ContentInterface or Charcoal\Object\UserDataInterface or Charcoal\User\UserInterface. Are you sure you never get one of those?

        }

        return $this;

The expression return $this returns the type Charcoal\Admin\Widget\DocWidget which is incompatible with the documented return type Charcoal\Admin\Widget\ActionInterface.

    }

    /**
     * Form action (target URL)
     *
     * @return string Relative URL
     */
    public function action()
    {
        $action = parent::action();

        if (!$action) {
            $obj = $this->obj();
            $objId = $obj->id();
            if ($objId) {
                return 'object/edit';
            } else {
                return 'object/collection';
            }
        } else {
            return $action;
        }
    }

    /**
     * Retrieve the object's properties as form controls.
     *
     * @param  array $group An optional group to use.
     * @throws UnexpectedValueException If a property data is invalid.
     * @return DocFormPropertyWidget[]|Generator
     */
    public function formProperties(array $group = null)
    {
        $obj = $this->obj();
        $props = $obj->metadata()->properties();

        // We need to sort form properties by form group property order if a group exists
        if (!empty($group)) {
            $props = array_merge(array_flip($group), $props);
        }

        foreach ($props as $propertyIdent => $propertyMetadata) {
            if (method_exists($obj, 'filterPropertyMetadata')) {
                $propertyMetadata = $obj->filterPropertyMetadata($propertyMetadata, $propertyIdent);
            }

            if (!is_array($propertyMetadata)) {
                throw new UnexpectedValueException(sprintf(
                    'Invalid property data for "%1$s", received %2$s',
                    $propertyIdent,
                    (is_object($propertyMetadata) ? get_class($propertyMetadata) : gettype($propertyMetadata))
                ));
            }

            $propertyMetadata['display_options'] = $this->displayOptions();

            $formProperty = $this->createFormProperty();
            $formProperty->setViewController($this->viewController());
            $formProperty->setPropertyIdent($propertyIdent);
            $formProperty->setData($propertyMetadata);
            $formProperty->setPropertyVal($obj[$propertyIdent]);

            if ($formProperty->hidden()) {
                $this->hiddenProperties[$propertyIdent] = $formProperty;
            } else {
                yield $propertyIdent => $formProperty;

The expression yield $propertyIdent => $formProperty returns the type Generator which is incompatible with the documented return type Charcoal\Admin\Docs\Widget\DocFormPropertyWidget[]&Charcoal\Admin\Widget\Generator.

            }
        }
    }

    /**
     * Retrieve an object property as a form control.
     *
     * @param  string $propertyIdent An optional group to use.
     * @throws InvalidArgumentException If the property identifier is not a string.
     * @throws UnexpectedValueException If a property data is invalid.
     * @return DocFormPropertyWidget
     */
    public function formProperty($propertyIdent)
    {
        if (!is_string($propertyIdent)) {

The condition is_string($propertyIdent) is always true.

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

        $propertyMetadata = $this->obj()->metadata()->property($propertyIdent);

        if (!is_array($propertyMetadata)) {
            throw new UnexpectedValueException(sprintf(
                'Invalid property data for "%1$s", received %2$s',
                $propertyIdent,
                (is_object($propertyMetadata) ? get_class($propertyMetadata) : gettype($propertyMetadata))
            ));
        }

        $p = $this->createFormProperty();
        $p->setViewController($this->viewController());
        $p->setPropertyIdent($propertyIdent);
        $p->setData($propertyMetadata);

        return $p;
    }

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

        return $p;
    }

    /**
     * Set the form's auxiliary data.
     *
     * This method is called via {@see self::setData()} if a "form_data" parameter
     * is present on the HTTP request.
     *
     * @param array $data Data.
     * @return ObjectFormWidget Chainable.
     */
    public function setFormData(array $data)
    {
        $objData = $this->objData();
        $merged = array_replace_recursive($objData, $data);

        // Remove null values
        $merged = array_filter($merged, function ($val) {
            if ($val === null) {
                return false;
            }

            return true;
        });

        $this->formData = $merged;
        $this->obj()->setData($merged);

        return $this;

The expression return $this returns the type Charcoal\Admin\Widget\DocWidget which is incompatible with the documented return type Charcoal\Admin\Widget\ObjectFormWidget.

    }

    /**
     * Retrieve the form's auxiliary  data.
     *
     * @return array
     */
    public function formData()
    {
        if (!$this->formData) {

The expression $this->formData of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

            $this->formData = $this->objData();
        }

        return $this->formData;
    }

    /**
     * Object data.
     * @return array Object data.
     */
    public function objData()
    {
        return $this->obj()->data();
    }

    /**
     * @return boolean
     */
    public function showHeader()
    {
        return $this->showHeader;
    }

    /**
     * @param boolean $showHeader Is the Header to be shown.
     * @return self
     */
    public function setShowHeader($showHeader)
    {
        $this->showHeader = $showHeader;

        return $this;
    }

    /**
     * @return boolean
     */
    public function showTitle()
    {
        return $this->showTitle;
    }

    /**
     * @param boolean $showTitle Is the title to be shown.
     * @return self
     */
    public function setShowTitle($showTitle)
    {
        $this->showTitle = $showTitle;

        return $this;
    }

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

    /**
     * Retrieve the default data sources (when setting data on an entity).
     *
     * @return string[]
     */
    protected function defaultDataSources()
    {
        return [ static::DATA_SOURCE_REQUEST, static::DATA_SOURCE_OBJECT ];
    }

    /**
     * Retrieve the default data source filters (when setting data on an entity).
     *
     * @return array
     */
    protected function defaultDataSourceFilters()
    {
        return [
            'request' => null,
            'object'  => 'array_replace_recursive'
        ];
    }

    /**
     * Retrieve the default data source filters (when setting data on an entity).
     *
     * Note: Adapted from {@see \Slim\CallableResolver}.
     *
     * @link   https://github.com/slimphp/Slim/blob/3.x/Slim/CallableResolver.php
     * @param  mixed $toResolve A callable used when merging data.
     * @return callable|null
     */
    protected function resolveDataSourceFilter($toResolve)
    {
        if (is_string($toResolve)) {
            $obj = $this->obj();

            $resolved = [ $obj, $toResolve ];

            // Check for Slim callable
            $callablePattern = '!^([^\:]+)\:([a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*)$!';
            if (preg_match($callablePattern, $toResolve, $matches)) {
                $class = $matches[1];
                $method = $matches[2];

                if ($class === 'parent') {
                    $resolved = [ $obj, $class.'::'.$method ];
                }
            }

            $toResolve = $resolved;
        }

        return parent::resolveDataSourceFilter($toResolve);
    }

    /**
     * Retrieve the accepted metadata from the current request.
     *
     * @return array
     */
    protected function acceptedRequestData()
    {
        return array_merge(
            [ 'obj_type', 'obj_id', 'template' ],
            parent::acceptedRequestData()
        );
    }

    /**
     * Fetch metadata from the current object type.
     *
     * @return array
     */
    protected function dataFromObject()
    {
        $obj = $this->obj();
        $objMetadata = $obj->metadata();
        $adminMetadata = (isset($objMetadata['admin']) ? $objMetadata['admin'] : null);

        $formIdent = $this->formIdent();
        if (!$formIdent) {
            $formIdent = $this->formIdentFallback();
        }

        if ($formIdent && $obj->view()) {
            $formIdent = $obj->render($formIdent);
        }

        if (isset($adminMetadata['forms'][$formIdent])) {
            $objFormData = $adminMetadata['forms'][$formIdent];
        } else {
            $objFormData = [];
        }

        if (isset($objFormData['groups']) && isset($adminMetadata['form_groups'])) {
            $extraFormGroups = array_intersect(
                array_keys($adminMetadata['form_groups']),
                array_keys($objFormData['groups'])
            );
            foreach ($extraFormGroups as $groupIdent) {
                $objFormData['groups'][$groupIdent] = array_replace_recursive(
                    $adminMetadata['form_groups'][$groupIdent],
                    $objFormData['groups'][$groupIdent]
                );
            }
        }

        if (isset($objFormData['sidebars']) && isset($adminMetadata['form_sidebars'])) {
            $extraFormSidebars = array_intersect(
                array_keys($adminMetadata['form_sidebars']),
                array_keys($objFormData['sidebars'])
            );
            foreach ($extraFormSidebars as $sidebarIdent) {
                $objFormData['sidebars'][$sidebarIdent] = array_replace_recursive(
                    $adminMetadata['form_sidebars'][$sidebarIdent],
                    $objFormData['sidebars'][$sidebarIdent]
                );
            }
        }

        return $objFormData;
    }

    /**
     * Create a new form group widget.
     *
     * @see    \Charcoal\Ui\Form\FormTrait::createFormGroup()
     * @param  array|null $data Optional. The form group data to set.
     * @return FormGroupInterface
     */
    protected function createFormGroup(array $data = null)
    {
        $type = $this->defaultGroupType();

        if (isset($data['template'])) {
            unset($data['template']);
        }

        $group = $this->formGroupFactory()->create($type);

The method create() does not exist on Charcoal\Ui\Form\FormInterface.

        $group->setForm($this);

        if ($group instanceof ObjectContainerInterface) {
            if (empty($group->objType())) {
                $group->setObjType($this->objType());
            }

            if (empty($group->objId()) && !empty($this->objId())) {
                $group->setObjId($this->objId());
            }
        }

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

        $group['show_header'] = $this->showHeader();
        $group['show_title'] = $this->showTitle();

        return $group;
    }

    /**
     * Update the given form group widget.
     *
     * @see    \Charcoal\Ui\Form\FormTrait::updateFormGroup()
     * @param  FormGroupInterface $group      The form group to update.
     * @param  array|null         $groupData  Optional. The new group data to apply.
     * @param  string|null        $groupIdent Optional. The new group identifier.
     * @return FormGroupInterface
     */
    protected function updateFormGroup(
        FormGroupInterface $group,
        array $groupData = null,
        $groupIdent = null
    ) {
        $group->setForm($this);

        if ($groupIdent !== null) {
            $group->setIdent($groupIdent);
        }

        if ($group instanceof ObjectContainerInterface) {
            if (empty($group->objType())) {
                $group->setObjType($this->objType());
            }

            if (empty($group->objId()) && !empty($this->objId())) {
                $group->setObjId($this->objId());
            }
        }

        if ($groupData !== null) {
            $group->setData($groupData);
        }

        return $group;
    }
}