Sirius\Input\Element

Complexity

Total Complexity

16

Size/Duplication

Total Lines	139
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	3

Test Coverage

Coverage

88.24%

Importance

Changes	3
Bugs	0	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	2
A	getDefaultSpecs()	0	4	1
A	getName()	0	4	1
A	setGroup()	0	6	1
A	getGroup()	0	4	2
A	setWidget()	0	6	1
A	getWidget()	0	4	2
A	setPosition()	0	6	1
A	getPosition()	0	4	2
A	prepareInputFilter()	0	9	3

<?php
namespace Sirius\Input;

use Sirius\Input\Traits\HasAttributesTrait;
use Sirius\Input\Traits\HasDataTrait;

/**
 *
 * @method Element getLabel() Get the label text
 * @method Element setLabel($label) Set label text
 * @method Element getLabelAttributes() Get the attributes for the label
 * @method Element setLabelAttributes(array $attributes) Set label attributes
 * @method Element setLabelAttribute($attr, $value = null) Set/Unset label attribute
 * @method Element addLabelClass($class) Add a CSS class to the label
 * @method Element removeLabelClass($class) Removes a CSS class from the label
 * @method Element toggleLabelClass($class) Toggles a class on the label
 * @method Element getHint() Get the hint text
 * @method Element setHint($label) Set hint text
 * @method Element getHintAttributes() Get the attributes for the hint
 * @method Element setHintAttributes(array $attributes) Set hint attributes
 * @method Element setHintAttribute($attr, $value = null) Set/Unset hint attribute
 * @method Element addHintClass($class) Add a CSS class to the hint
 * @method Element removeHintClass($class) Removes a CSS class from the hint
 * @method Element toggleHintClass($class) Toggles a class on the hint
 * @method Element getContainerAttributes() Get the attributes for the container
 * @method Element setContainerAttributes(array $attributes) Set container attributes
 * @method Element setContainerAttribute($attr, $value = null) Set/Unset container attribute
 * @method Element addContainerClass($class) Add a CSS class to the container
 * @method Element removeContainerClass($class) Removes a CSS class from the container
 * @method Element toggleContainerClass($class) Toggles a class on the container
 * @method Element getValidationRules() Get list of validation rules
 * @method Element setValidationRules(array $rules) Set list of validation rules
 * @method Element getFilters() Get list of data filters
 * @method Element setFilters(array $filters) Set list of filters
 * @method Element getUploadContainer() Get the upload container for the element
 * @method Element setUploadContainer($container) Set the upload container for the element
 * @method Element getUploadOptions() Get the upload options for the container
 * @method Element setUploadOptions(array $options) Set the upload options for the container
 * @method Element getUploadRules() Get the upload validation rules
 * @method Element setUploadRules(array $rules) Set the upload validation rules
 */
abstract class Element extends Specs
{
    use HasAttributesTrait;
    use HasDataTrait;

    /**
     * Name of the field (identifier of the element in the form's child list)
     *
     * @var string
     */
    protected $name;

    /**
     *
     * @param string $name
     *            Name of the form element that will make it identifiable
     * @param array $specs
     *            Specification for the element (attributes, parents, etc)
     */
    function __construct($name, $specs = array())

It is generally recommended to explicitly declare the visibility for methods.

    {
        $specs = array_merge($this->getDefaultSpecs(), $specs);
        foreach ($specs as $key => $value) {
            $this->set($key, $value);
        }
        $this->name = $name;
    }

    /**
     * Returns the default element specifications
     * To be used for easily extending objects
     *
     * @return array
     */
    protected function getDefaultSpecs()
    {
        return array();
    }

    /**
     * Retrieve the name of the form's element as registered within the form
     *
     * @return string
     */
    function getName()

It is generally recommended to explicitly declare the visibility for methods.

    {
        return $this->name;
    }

    /**
     * Sets the group this element belongs to
     *
     * @param null|string $group
     *
     * @return $this
     */
    function setGroup($group = null)

It is generally recommended to explicitly declare the visibility for methods.

    {
        $this[Element::GROUP] = (string) $group;

        return $this;
    }

    /**
     * Retrieve the group this element belongs to
     *
     * @return null|string
     */
    function getGroup()

It is generally recommended to explicitly declare the visibility for methods.

    {
        return isset($this[Element::GROUP]) ? $this[Element::GROUP] : null;
    }

    /**
     * Sets the widget for this element
     *
     * @param null|string $widget
     *
     * @return $this
     */
    function setWidget($widget = null)

It is generally recommended to explicitly declare the visibility for methods.

    {
        $this[Element::WIDGET] = (string) $widget;

        return $this;
    }

    /**
     * Retrieve the widget type for this element
     *
     * @return string
     */
    function getWidget()

It is generally recommended to explicitly declare the visibility for methods.

    {
        return isset($this[Element::WIDGET]) ? $this[Element::WIDGET] : null;
    }

    /**
     * Sets the display priority for this element
     *
     * @param integer $priority
     *
     * @return $this
     */
    function setPosition($priority = 0)

It is generally recommended to explicitly declare the visibility for methods.

    {
        $this[Element::POSITION] = (int) $priority;

        return $this;
    }

    /**
     * Retrieve display position for this element
     *
     * @return integer
     */
    function getPosition()

It is generally recommended to explicitly declare the visibility for methods.

    {
        return isset($this[Element::POSITION]) ? $this[Element::POSITION] : 0;
    }


    /**
     * Prepares the input filter to receive data and be rendered
     * It attaches the filters, validation rules, upload handler for the element
     *
     * @param InputFilter $inputFilter
     */
    function prepareInputFilter(InputFilter $inputFilter)

It is generally recommended to explicitly declare the visibility for methods.

    {
        $preparableMethods = array('prepareValidator', 'prepareFiltrator', 'prepareUploadHandlers');
        foreach ($preparableMethods as $method) {
            if (method_exists($this, $method)) {
                call_user_func(array( $this, $method), $inputFilter);
            }
        }
    }

}