Charcoal\Admin\Widget\FormWidget

Complexity

Total Complexity

20

Size/Duplication

Total Lines	147
Duplicated Lines	36.05 %

Coupling/Cohesion

Components	2
Dependencies	7

Importance

Changes	8
Bugs	1	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	setDependencies()	0	5	1
A	createGroup()	0	13	3
A	createFormProperty()	0	10	2
A	setSidebars()	0	8	2
B	addSidebar()	23	23	4
A	sidebars()	18	18	3
A	sortSidebarsByPriority()	12	12	3
A	widgetFactory()	0	7	2

<?php

namespace Charcoal\Admin\Widget;

use InvalidArgumentException;

use \Pimple\Container;

// From `charcoal-app`
use \Charcoal\App\Template\WidgetFactory;

/// 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\Admin\AdminWidget;
//use \Charcoal\Admin\Ui\FormInterface;
use \Charcoal\Admin\Ui\FormTrait;
use \Charcoal\Admin\Ui\FormGroupInterface;
use \Charcoal\Admin\Widget\LayoutWidget;

// Local namespace dependencies
use \Charcoal\Admin\Widget\FormGroupWidget;

/**
 *
 */
class FormWidget extends AdminWidget implements
    FormInterface,
    LayoutAwareInterface
{
    use FormTrait;
    use LayoutAwareTrait;

    protected $sidebars = [];

    /**
    * @var WidgetFactory $widgetFactory
    */
    private $widgetFactory;

    public function setDependencies(Container $container)
    {
        //$this->setFormGroupBuilder($container['form/group/builder']);

90% of this comment could be valid code. Did you maybe forget this after debugging?

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

    /**
     * @param array|null $data
     * @return FormGroupInterface
     */
    public function createGroup(array $data = null)
    {
        $widget_type = (isset($data['widget_type']) ? $data['widget_type'] : 'charcoal/admin/widget/formGroup');
        $group = $this->widgetFactory()->create($widget_type, [
            'logger' => $this->logger
        ]);
        $group->setForm($this);
        if ($data) {

The expression $data 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.

            $group->setData($data);
        }
        return $group;

    }

    /**
     * @param array $data
     * @return FormPropertyInterface
     */
    public function createFormProperty(array $data = null)
    {
        $p = new FormPropertyWidget([
            'logger'=>$this->logger
        ]);
        if ($data !== null) {
            $p->setData($data);
        }
        return $p;
    }

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

    /**
     * @param array|FormSidebarWidget $sidebar
     * @throws InvalidArgumentException
     * @return FormWidget Chainable
     */
    public function addSidebar($sidebarIdent, $sidebar)

This method seems to be duplicated in your project.

    {
        if (!is_string($sidebarIdent)) {
            throw new InvalidArgumentException(
                'Sidebar ident must be a string'
            );
        }
        if (($sidebar instanceof FormSidebarWidget)) {
            $this->sidebars[$sidebarIdent] = $sidebar;
        } else if (is_array($sidebar)) {
            $s = new FormSidebarWidget([
                'logger'=>$this->logger
            ]);
            $s->setForm($this);
            $s->setData($sidebar);
            $this->sidebars[$sidebarIdent] = $s;
        } else {
            throw new InvalidArgumentException(
                'Sidebar must be a FormSidebarWidget object or an array'
            );
        }
        return $this;
    }

    /**
     * @return FormSidebarWidget
     */
    public function sidebars()

This method seems to be duplicated in your project.

sidebars uses the super-global variable $GLOBALS which is generally not recommended.

    {
        $sidebars = $this->sidebars;
        if (!is_array($this->sidebars)) {
            yield null;
        } else {
            uasort($sidebars, ['self', 'sortSidebarsByPriority']);
            foreach ($sidebars as $sidebar) {
                /*if ($sidebar->widget_type() != '') {

61% of this comment could be valid code. Did you maybe forget this after debugging?

                    $GLOBALS['widget_template'] = $sidebar->widget_type();
                } else {
                    $GLOBALS['widget_template'] = 'charcoal/admin/widget/form.sidebar';
                }*/
                $GLOBALS['widget_template'] = 'charcoal/admin/widget/form.sidebar';
                yield $sidebar->ident() => $sidebar;
            }
        }
    }

    /**
     * To be called with uasort().
     *
     * @param FormGroupInterface $a Item "a" to compare, for sorting.
     * @param FormGroupInterface $b Item "b" to compaer, for sorting.
     * @return integer Sorting value: -1, 0, or 1
     */
    protected static function sortSidebarsByPriority(FormGroupInterface $a, FormGroupInterface $b)

This method seems to be duplicated in your project.

    {
        $a = $a->priority();
        $b = $b->priority();

        if ($a == $b) {
            return 1;
// Should be 0?
        }

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

    /**
     * @return WidgetFactory
     */
    private function widgetFactory()
    {
        if ($this->widgetFactory === null) {
            $this->widgetFactory = new WidgetFactory();
        }
        return $this->widgetFactory;
    }
}