Charcoal\Admin\Widget\ObjectFormWidget

Complexity

Total Complexity

23

Size/Duplication

Total Lines	181
Duplicated Lines	12.15 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	9
Bugs	3	Features	2

10 Methods

Rating	Name	Duplication	Size	Complexity
A	setDependencies()	0	7	1
A	widgetType()	0	4	1
A	setData()	0	15	1
A	setNextUrl()	0	16	3
A	action()	0	15	3
A	setFormIdent()	0	10	2
A	formIdent()	0	4	1
B	dataFromObject()	13	13	5
B	formProperties()	9	28	5
A	formData()	0	6	1

<?php

namespace Charcoal\Admin\Widget;

use \InvalidArgumentException;
use \Exception;

use \Pimple\Container;

use \Charcoal\Admin\Widget\FormWidget;
use \Charcoal\Admin\Widget\FormPropertyWidget;

use \Charcoal\Admin\Ui\ObjectContainerInterface;
use \Charcoal\Admin\Ui\ObjectContainerTrait;

/**
 *
 */
class ObjectFormWidget extends FormWidget implements ObjectContainerInterface
{
    use ObjectContainerTrait;

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

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

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

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

    /**
     * @param array|ArrayInterface $data The widget data.
     * @return ObjectForm Chainable
     */
    public function setData($data)

setData uses the super-global variable $_GET which is generally not recommended.

    {
        // @TODO Remove once RequirementContainer is implemented
        // Needed this to be able to output {{objId}}
        $data = array_merge($_GET, $data);

        parent::setData($data);

        $objData = $this->dataFromObject();
        $data = array_merge_recursive($objData, $data);

        parent::setData($data);

        return $this;
    }

     /**
      * @param string $url The next URL.
      * @throws InvalidArgumentException If argument is not a string.
      * @return ActionInterface Chainable
      */
    public function setNextUrl($url)
    {
        if (!is_string($url)) {
            throw new InvalidArgumentException(
                'URL needs to be a string'
            );
        }

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

The property nextUrl does not exist. Did you maybe forget to declare it?

            return $this;
        }

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

    /**
     * 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 'action/object/update';
            } else {
                return 'action/object/save';
            }
        } else {
            return $action;
        }
    }

    /**
     * @param string $formIdent The form ident.
     * @throws InvalidArgumentException If the argument is not a string.
     * @return ObjectForm Chainable
     */
    public function setFormIdent($formIdent)
    {
        if (!is_string($formIdent)) {
            throw new InvalidArgumentException(
                'Form ident must be a string'
            );
        }
        $this->formIdent = $formIdent;
        return $this;
    }

    /**
     * @return string
     */
    public function formIdent()
    {
        return $this->formIdent;
    }

    /**
     * Set the data from an object.
     *
     * @return array
     */
    public function dataFromObject()

This method seems to be duplicated in your project.

    {
        $obj = $this->obj();
        $metadata = $obj->metadata();
        $admin_metadata = isset($metadata['admin']) ? $metadata['admin'] : null;
        $formIdent = $this->formIdent();
        if (!$formIdent) {
            $formIdent = isset($admin_metadata['default_form']) ? $admin_metadata['default_form'] : '';
        }

        $objFormData = isset($admin_metadata['forms'][$formIdent]) ? $admin_metadata['forms'][$formIdent] : [];
        return $objFormData;
    }

    /**
     * FormProperty Generator
     *
     * @param array $group An optional group to use.
     * @throws Exception If a property data is invalid.
     * @return void This is a 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 => $property) {
            if (!is_array($property)) {

This code seems to be duplicated across your project.

                throw new Exception(
                    sprintf(
                        'Invalid property data for "%1$s", received %2$s',
                        $propertyIdent,
                        (is_object($property) ? get_class($property) : gettype($property))
                    )
                );
            }
            $p = new FormPropertyWidget([
                'logger' => $this->logger
            ]);
            $p->setPropertyIdent($propertyIdent);
            $p->setData($property);
            yield $propertyIdent => $p;
        }
    }

    /**
     * @return array
     */
    public function formData()
    {
        $obj = $this->obj();
        $formData = $obj->data();
        return $formData;
    }
}