Charcoal\Ui\FormGroup\FormGroupTrait

Complexity

Total Complexity

35

Size/Duplication

Total Lines	365
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	1

Importance

Changes

0

23 Methods

Rating	Name	Duplication	Size	Complexity
	sortItemsByPriority()	0	4	?
A	setFormInputBuilder()	0	6	1
A	setInputCallback()	0	6	1
A	setForm()	0	6	1
A	form()	0	4	1
A	setL10nMode()	0	6	1
A	l10nMode()	0	4	1
A	setInputs()	0	9	2
A	addInput()	0	23	4
A	inputs()	0	18	5
A	hasInputs()	0	4	1
A	numInputs()	0	4	1
A	setIdent()	0	6	1
A	ident()	0	4	1
A	setTabCssClasses()	0	12	3
A	tabCssClasses()	0	4	1
A	isHidden()	0	4	1
A	setIsHidden()	0	6	1
A	conditionalLogic()	0	4	1
A	rawConditionalLogic()	0	4	1
A	setConditionalLogic()	0	17	4
A	conditionalLogicUnmet()	0	4	1
A	setConditionalLogicUnmet()	0	6	1

<?php

namespace Charcoal\Ui\FormGroup;

use InvalidArgumentException;

// From 'charcoal-ui'
use Charcoal\Ui\Form\FormInterface;
use Charcoal\Ui\FormInput\FormInputBuilder;
use Charcoal\Ui\FormInput\FormInputInterface;
use Charcoal\Ui\PrioritizableInterface;

/**
 * Provides an implementation of {@see \Charcoal\Ui\FormGroup\FormGroupInterface}.
 */
trait FormGroupTrait
{
    /**
     * Store a reference to the parent form widget.
     *
     * @var FormInterface
     */
    protected $form;

    /**
     * The group's collection of fields.
     *
     * @var FormInputInterface[]
     */
    private $inputs = [];

    /**
     * The input callback; called on every input.
     *
     * Callable signature: `function(FormInputInterface $input)`
     *
     * @var callable
     */
    private $inputCallback;

    /**
     * Store the builder instance for the current class.
     *
     * @var FormInputBuilder
     */
    protected $formInputBuilder;

    /**
     * The L10N display mode.
     *
     * @var string
     */
    private $l10nMode;

    /**
     * The group's identifier.
     *
     * @var string
     */
    private $ident;

    /**
     * The required Acl permissions fetch from form group.
     *
     * @var string[] $requiredAclPermissions
     */
    private $requiredAclPermissions = [];

    /**
     * One or many CSS classes for tab form group.
     *
     * @var string
     */
    private $tabCssClasses;

    /**
     * @var boolean
     */
    private $isHidden;

    /**
     * @var array|null
     */
    private $conditionalLogic;

    /**
     * @var array|null
     */
    private $rawConditionalLogic;

    /**
     * @var boolean
     */
    private $conditionalLogicUnmet;

    /**
     * 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.
     */
    abstract protected function sortItemsByPriority(
        PrioritizableInterface $a,
        PrioritizableInterface $b
    );

    /**
     * @param FormInputBuilder $builder The builder, to create customized form input objects.
     * @return FormGroupInterface Chainable
     */
    protected function setFormInputBuilder(FormInputBuilder $builder)
    {
        $this->formInputBuilder = $builder;

        return $this;
    }

    /**
     * @param callable $cb The input callback.
     * @return FormGroupInterface Chainable
     */
    public function setInputCallback(callable $cb)
    {
        $this->inputCallback = $cb;

        return $this;
    }

    /**
     * @param FormInterface $form The parent form object.
     * @return FormGroupInterface Chainable
     */
    public function setForm(FormInterface $form)
    {
        $this->form = $form;

        return $this;
    }

    /**
     * @return FormInterface
     */
    public function form()
    {
        return $this->form;
    }

    /**
     * @param string $mode The l10n mode.
     * @return FormGroupInterface Chainable
     */
    public function setL10nMode($mode)
    {
        $this->l10nMode = $mode;

        return $this;
    }

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

    /**
     * @param array $inputs The group inputs.
     * @return FormGroupInterface Chainable
     */
    public function setInputs(array $inputs)
    {
        $this->inputs = [];
        foreach ($inputs as $inputIdent => $input) {
            $this->addInput($inputIdent, $input);
        }

        return $this;
    }

    /**
     * @param string                   $inputIdent The input identifier.
     * @param array|FormInputInterface $input      The input object or structure.
     * @throws InvalidArgumentException If the ident argument is not a string or if the input is not valid.
     * @return FormGroupInterface Chainable
     */
    public function addInput($inputIdent, $input)
    {
        if (!is_string($inputIdent)) {
            throw new InvalidArgumentException(
                'Group ident must be a string'
            );
        }

        if (($input instanceof FormInputInterface)) {
            $input->setForm($this->form);

The method setForm() does not exist on Charcoal\Ui\FormInput\FormInputInterface. Did you maybe mean setFormGroup()?

            $input->setFormGroup($this);
            $this->inputs[$inputIdent] = $input;
        } elseif (is_array($input)) {
            $g                         = $this->formInputBuilder->build($input);
            $this->inputs[$inputIdent] = $g;
        } else {
            throw new InvalidArgumentException(
                'Group must be a Form Group object or an array of form group options'
            );
        }

        return $this;
    }

    /**
     * Form Input generator.
     *
     * @param callable $inputCallback Optional. Input callback.
     * @return FormGroupInterface[]|Generator
     */
    public function inputs(callable $inputCallback = null)
    {
        $groups = $this->groups;

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

        uasort($groups, [ $this, 'sortItemsByPriority' ]);

        $inputCallback = isset($inputCallback) ? $inputCallback : $this->inputCallback;
        foreach ($inputs as $input) {

The variable $inputs does not exist. Did you forget to declare it?

            if (!$input->l10nMode()) {
                $input->setL10nMode($this->l10nMode());
            }
            if ($inputCallback) {
                $inputCallback($input);
            }
            $GLOBALS['widget_template'] = $input->template();
            yield $input->ident() => $input;
            $GLOBALS['widget_template'] = '';
        }
    }

    /**
     * Wether this group contains any inputs.
     *
     * @return boolean
     */
    public function hasInputs()
    {
        return (count($this->inputs) > 0);
    }

    /**
     * Get the number of inputs in this group.
     *
     * @return integer
     */
    public function numInputs()
    {
        return count($this->inputs);
    }

    /**
     * Set the identifier of the group.
     *
     * @param string $ident The group identifier.
     * @return self
     */
    public function setIdent($ident)
    {
        $this->ident = $ident;

        return $this;
    }

    /**
     * Retrieve the idenfitier of the group.
     *
     * @return string
     */
    public function ident()
    {
        return $this->ident;
    }

    /**
     * @param string|\string[] $classes Class or Classes for tab form group.
     * @return self
     */
    public function setTabCssClasses($classes)
    {
        if (is_string($classes)) {
            $this->tabCssClasses = $classes;
        }

        if (is_array($classes)) {
            $this->tabCssClasses = implode(' ', $classes);
        }

        return $this;
    }

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

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

    /**
     * @param  boolean $isHidden Hidden (TRUE) or shown (FALSE).
     * @return self
     */
    public function setIsHidden($isHidden)
    {
        $this->isHidden = $isHidden;

        return $this;
    }

    /**
     * @return array|null
     */
    public function conditionalLogic()
    {
        return $this->conditionalLogic;
    }

    /**
     * @return array|null
     */
    public function rawConditionalLogic()
    {
        return $this->rawConditionalLogic;
    }

    /**
     * @param array|null $conditionalLogic ConditionalLogic for FormGroupWidget.
     * @return self
     */
    public function setConditionalLogic($conditionalLogic)
    {
        $this->rawConditionalLogic = $conditionalLogic;

        if ($conditionalLogic && is_array($conditionalLogic)) {
            foreach ($conditionalLogic as &$condition) {
                $prop = $this->form()->formProperty($condition['property']);

The method formProperty() does not seem to exist on object<Charcoal\Ui\Form\FormInterface>.

                $condition['input_id'] = $prop->input()->inputId();
            }
        }

        $this->conditionalLogic = [
            $this->widgetId() => $conditionalLogic

It seems like widgetId() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        ];

        return $this;
    }

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

    /**
     * @param boolean $conditionalLogicUnmet ConditionalLogicUnmet for FormGroupTrait.
     * @return self
     */
    public function setConditionalLogicUnmet($conditionalLogicUnmet)
    {
        $this->conditionalLogicUnmet = $conditionalLogicUnmet;

        return $this;
    }
}