Element::set() - Code Metrics - Inspection of "Refactoring: keep all constants only in the `Specs..." - siriusphp/input - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 25a367...4e273e )

by Adrian

created 2016-05-16 06:54 UTC

Element::set() A

↳ Parent: Element

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	10
ccs	6
cts	6
cp	1
rs	9.4285
cc	2
eloc	6
nc	2
nop	2
crap	2

<?php
namespace Sirius\Input;

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

/**
 *
 * @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 \ArrayObject
{
    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)
     */
    public function __construct($name, $specs = array())
    {
        $specs = array_merge($this->getDefaultSpecs(), $specs);
        foreach ($specs as $key => $value) {
            $this->set($key, $value);
        }
        $this->name = $name;
    }

    protected function inflectUnderscoreToClass($var)
    {
        $var = str_replace('_', ' ', $var);
        $var = ucwords($var);

        return str_replace(' ', '', $var);
    }

    public function get($key)
    {
        $method = 'get' . $this->inflectUnderscoreToClass($key);
        if (method_exists($this, $method)) {
            return $this->{$method}();
        }

        return isset($this[$key]) ? $this[$key] : null;
    }

    public function set($key, $value)
    {
        $method = 'set' . $this->inflectUnderscoreToClass($key);
        if (method_exists($this, $method)) {
            return $this->{$method}($value);
        }
        $this[$key] = $value;

        return $this;
    }


    /**
     * Returns the default element specifications
     * The default specs are merged with the constructor specs
     *
     * @return array
     */
    protected function getDefaultSpecs()
    {
        return array();
    }

    /**
     * Retrieve the name of the form's element as registered within the form
     *
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Sets the group this element belongs to
     *
     * @param null|string $group
     *
     * @return $this
     */
    public function setGroup($group = null)
    {
        $this[Specs::GROUP] = (string) $group;

        return $this;
    }

    /**
     * Retrieve the group this element belongs to
     *
     * @return null|string
     */
    public function getGroup()
    {
        return isset($this[Specs::GROUP]) ? $this[Specs::GROUP] : null;
    }

    /**
     * Sets the widget for this element
     *
     * @param null|string $widget
     *
     * @return $this
     */
    public function setWidget($widget = null)
    {
        $this[Specs::WIDGET] = (string) $widget;

        return $this;
    }

    /**
     * Retrieve the widget type for this element
     *
     * @return string
     */
    public function getWidget()
    {
        return isset($this[Specs::WIDGET]) ? $this[Specs::WIDGET] : null;
    }

    /**
     * Sets the display priority for this element
     *
     * @param integer $priority
     *
     * @return $this
     */
    public function setPosition($priority = 0)
    {
        $this[Specs::POSITION] = (int) $priority;

        return $this;
    }

    /**
     * Retrieve display position for this element
     *
     * @return integer
     */
    public function getPosition()
    {
        return isset($this[Specs::POSITION]) ? $this[Specs::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
     */
    public function prepareInputFilter(InputFilter $inputFilter)
    {
        $preparableMethods = array('prepareValidator', 'prepareFiltrator', 'prepareUploadHandlers');
        foreach ($preparableMethods as $method) {
            if (method_exists($this, $method)) {
                call_user_func(array($this, $method), $inputFilter);
            }
        }
    }

}


1		<?php
2		namespace Sirius\Input;
3
4		use Sirius\Input\Traits\HasAttributesTrait;
5		use Sirius\Input\Traits\HasDataTrait;
6		use Sirius\Input\Specs;
7
8		/**
9		*
10		* @method Element getLabel() Get the label text
11		* @method Element setLabel($label) Set label text
12		* @method Element getLabelAttributes() Get the attributes for the label
13		* @method Element setLabelAttributes(array $attributes) Set label attributes
14		* @method Element setLabelAttribute($attr, $value = null) Set/Unset label attribute
15		* @method Element addLabelClass($class) Add a CSS class to the label
16		* @method Element removeLabelClass($class) Removes a CSS class from the label
17		* @method Element toggleLabelClass($class) Toggles a class on the label
18		* @method Element getHint() Get the hint text
19		* @method Element setHint($label) Set hint text
20		* @method Element getHintAttributes() Get the attributes for the hint
21		* @method Element setHintAttributes(array $attributes) Set hint attributes
22		* @method Element setHintAttribute($attr, $value = null) Set/Unset hint attribute
23		* @method Element addHintClass($class) Add a CSS class to the hint
24		* @method Element removeHintClass($class) Removes a CSS class from the hint
25		* @method Element toggleHintClass($class) Toggles a class on the hint
26		* @method Element getContainerAttributes() Get the attributes for the container
27		* @method Element setContainerAttributes(array $attributes) Set container attributes
28		* @method Element setContainerAttribute($attr, $value = null) Set/Unset container attribute
29		* @method Element addContainerClass($class) Add a CSS class to the container
30		* @method Element removeContainerClass($class) Removes a CSS class from the container
31		* @method Element toggleContainerClass($class) Toggles a class on the container
32		* @method Element getValidationRules() Get list of validation rules
33		* @method Element setValidationRules(array $rules) Set list of validation rules
34		* @method Element getFilters() Get list of data filters
35		* @method Element setFilters(array $filters) Set list of filters
36		* @method Element getUploadContainer() Get the upload container for the element
37		* @method Element setUploadContainer($container) Set the upload container for the element
38		* @method Element getUploadOptions() Get the upload options for the container
39		* @method Element setUploadOptions(array $options) Set the upload options for the container
40		* @method Element getUploadRules() Get the upload validation rules
41		* @method Element setUploadRules(array $rules) Set the upload validation rules
42		*/
43		abstract class Element extends \ArrayObject
44		{
45		use HasAttributesTrait;
46		use HasDataTrait;
47
48		/**
49		* Name of the field (identifier of the element in the form's child list)
50		*
51		* @var string
52		*/
53		protected $name;
54
55		/**
56		*
57		* @param string $name
58		* Name of the form element that will make it identifiable
59		* @param array $specs
60		* Specification for the element (attributes, parents, etc)
61		*/
62	50	public function __construct($name, $specs = array())
63		{
64	50	$specs = array_merge($this->getDefaultSpecs(), $specs);
65	50	foreach ($specs as $key => $value) {
66	42	$this->set($key, $value);
67		}
68	50	$this->name = $name;
69	50	}
70
71	44	protected function inflectUnderscoreToClass($var)
72		{
73	44	$var = str_replace('_', ' ', $var);
74	44	$var = ucwords($var);
75
76	44	return str_replace(' ', '', $var);
77		}
78
79	2	public function get($key)
80		{
81	2	$method = 'get' . $this->inflectUnderscoreToClass($key);
82	2	if (method_exists($this, $method)) {
83	1	return $this->{$method}();
84		}
85
86	1	return isset($this[$key]) ? $this[$key] : null;
87		}
88
89	44	public function set($key, $value)
90		{
91	44	$method = 'set' . $this->inflectUnderscoreToClass($key);
92	44	if (method_exists($this, $method)) {
93	43	return $this->{$method}($value);
94		}
95	2	$this[$key] = $value;
96
97	2	return $this;
98		}
99
100
101		/**
102		* Returns the default element specifications
103		* The default specs are merged with the constructor specs
104		*
105		* @return array
106		*/
107	8	protected function getDefaultSpecs()
108		{
109	8	return array();
110		}
111
112		/**
113		* Retrieve the name of the form's element as registered within the form
114		*
115		* @return string
116		*/
117	14	public function getName()
118		{
119	14	return $this->name;
120		}
121
122		/**
123		* Sets the group this element belongs to
124		*
125		* @param null\|string $group
126		*
127		* @return $this
128		*/
129	1	public function setGroup($group = null)
130		{
131	1	$this[Specs::GROUP] = (string) $group;
132
133	1	return $this;
134		}
135
136		/**
137		* Retrieve the group this element belongs to
138		*
139		* @return null\|string
140		*/
141	9	public function getGroup()
142		{
143	9	return isset($this[Specs::GROUP]) ? $this[Specs::GROUP] : null;
144		}
145
146		/**
147		* Sets the widget for this element
148		*
149		* @param null\|string $widget
150		*
151		* @return $this
152		*/
153	42	public function setWidget($widget = null)
154		{
155	42	$this[Specs::WIDGET] = (string) $widget;
156
157	42	return $this;
158		}
159
160		/**
161		* Retrieve the widget type for this element
162		*
163		* @return string
164		*/
165		public function getWidget()
166		{
167		return isset($this[Specs::WIDGET]) ? $this[Specs::WIDGET] : null;
168		}
169
170		/**
171		* Sets the display priority for this element
172		*
173		* @param integer $priority
174		*
175		* @return $this
176		*/
177	7	public function setPosition($priority = 0)
178		{
179	7	$this[Specs::POSITION] = (int) $priority;
180
181	7	return $this;
182		}
183
184		/**
185		* Retrieve display position for this element
186		*
187		* @return integer
188		*/
189		public function getPosition()
190		{
191		return isset($this[Specs::POSITION]) ? $this[Specs::POSITION] : 0;
192		}
193
194
195		/**
196		* Prepares the input filter to receive data and be rendered
197		* It attaches the filters, validation rules, upload handler for the element
198		*
199		* @param InputFilter $inputFilter
200		*/
201	9	public function prepareInputFilter(InputFilter $inputFilter)
202		{
203	9	$preparableMethods = array('prepareValidator', 'prepareFiltrator', 'prepareUploadHandlers');
204	9	foreach ($preparableMethods as $method) {
205	9	if (method_exists($this, $method)) {
206	9	call_user_func(array($this, $method), $inputFilter);
207		}
208		}
209	9	}
210
211		}
212

siriusphp / input

Push — master ( 25a367...4e273e )

Element::set() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like