BaseElement::addValidator() - Code Metrics - Inspection of "#22 fixed" - funivan/form - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#23)

by Vitaliy

created 2016-05-23 13:35 UTC

BaseElement::addValidator() A

↳ Parent: BaseElement

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes	5
Bugs	0	Features	0

Metric	Value
c	5
b	0
f	0
dl	0
loc	4
ccs	3
cts	3
cp	1
rs	10
cc	1
eloc	3
nc	1
nop	1
crap	1

<?php

  namespace Fiv\Form\Element;

  use Fiv\Form\Filter\FilterInterface;
  use Fiv\Form\Validator;
  use Fiv\Form\Validator\ValidatorInterface;

  /**
   * @method addFilters
   * @package Fiv\Form\Element
   * @author Ivan Shcherbak <[email protected]> 2016
   */
  class BaseElement extends \Fiv\Form\Element\Html implements ElementInterface {

    /**
     * @var null|boolean
     */
    protected $validationResult = null;

    /**
     * @var \Fiv\Form\Validator\Base[]
     */
    protected $validators = [];

    /**
     * @var FilterInterface[]
     */
    protected $filters = [];

    /**
     * @var string
     */
    protected $text = '';

    /**
     * @var null|string
     */
    protected $value = null;


    /**
     * Attach validator to current element
     *
     * @param ValidatorInterface $validator
     * @return $this
     */
    public function addValidator(ValidatorInterface $validator) {
      $this->validators[] = $validator;
      return $this;
    }


    /**
     * @return \Fiv\Form\Validator\Base[]
     */
    public function getValidators() {
      return $this->validators;
    }


    /**
     *
     * @param FilterInterface $filter
     * @throws \Exception
     * @return $this
     */
    public function addFilter(FilterInterface $filter) {
      $this->filters[] = $filter;
      return $this;
    }


    /**
     * @return FilterInterface[]
     */
    public function getFilters() {
      return $this->filters;
    }


    /**
     * Alias of setAttribute('value', $value)
     *
     * @param $value
     * @return $this
     */
    public function setValue($value) {
      $this->setAttribute('value', $value);
      return $this;
    }


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


    /**
     * @inheritdoc
     */
    public function setAttribute($name, $value) {
      if ($name === 'value') {

        $this->validationResult = null;

        # apply filters to the value
        $filters = $this->getFilters();
        foreach ($filters as $filter) {
          $value = $filter->apply($value);
        }

        $this->value = $value;
      }

      return parent::setAttribute($name, $value);
    }


    /**
     * Return true if element is valid
     * @return boolean
     */
    public function isValid() {

      if ($this->validationResult !== null) {
        return $this->validationResult;
      }

      $this->validationResult = true;
      $value = $this->getValue();
      foreach ($this->getValidators() as $validator) {
        $validator->flushErrors();
        if (!$validator->isValid($value)) {
          $this->validationResult = false;
        }
      }

      return $this->validationResult;
    }


    /**
     * @return bool
     */
    public function validate() {
      trigger_error('Deprecated. Use isValid', E_USER_DEPRECATED);
      return $this->isValid();
    }


    /**
     * @return array
     */
    public function getValidatorsErrors() {
      $errors = [];
      foreach ($this->validators as $validator) {
        foreach ($validator->getErrors() as $error) {
          $errors[] = $error;
        }
      }

      return $errors;
    }


    /**
     * @inheritdoc
     */
    public function render() {
      $value = $this->getValue();
      $this->attributes['value'] = htmlentities($value, ENT_QUOTES);
      return parent::render();
    }


    /**
     * @deprecated
     * @see addValidator
     * @return $this
     */
    public function required() {
      trigger_error('Deprecated', E_USER_DEPRECATED);
      return $this->addValidator(new \Fiv\Form\Validator\Required());
    }


    /**
     * @param string $text
     * @return $this
     */
    public function setText($text) {
      $this->text = $text;
      return $this;
    }


    /**
     * @return mixed
     */
    public function getText() {
      return $this->text;
    }


    /**
     * @param string $name
     * @return $this
     */
    public function setName($name) {
      $this->setAttribute('name', $name);
      return $this;
    }


    /**
     * @return null|string
     */
    public function getName() {
      return $this->getAttribute('name');
    }


    /**
     * @param string $class
     * @return $this
     */
    public function setClass($class) {
      $this->setAttribute('class', $class);
      return $this;
    }


    /**
     * @return null|string
     */
    public function getClass() {
      return $this->getAttribute('class');
    }


    /**
     * @param string $id
     * @return $this
     */
    public function setId($id) {
      $this->setAttribute('id', $id);
      return $this;
    }


    /**
     * @return null|string
     */
    public function getId() {
      return $this->getAttribute('id');
    }

  }

1		<?php
2
3		namespace Fiv\Form\Element;
4
5		use Fiv\Form\Filter\FilterInterface;
6		use Fiv\Form\Validator;
7		use Fiv\Form\Validator\ValidatorInterface;
8
9		/**
10		* @method addFilters
11		* @package Fiv\Form\Element
12		* @author Ivan Shcherbak <[email protected]> 2016
13		*/
14		class BaseElement extends \Fiv\Form\Element\Html implements ElementInterface {
15
16		/**
17		* @var null\|boolean
18		*/
19		protected $validationResult = null;
20
21		/**
22		* @var \Fiv\Form\Validator\Base[]
23		*/
24		protected $validators = [];
25
26		/**
27		* @var FilterInterface[]
28		*/
29		protected $filters = [];
30
31		/**
32		* @var string
33		*/
34		protected $text = '';
35
36		/**
37		* @var null\|string
38		*/
39		protected $value = null;
40
41
42		/**
43		* Attach validator to current element
44		*
45		* @param ValidatorInterface $validator
46		* @return $this
47		*/
48	7	public function addValidator(ValidatorInterface $validator) {
49	7	$this->validators[] = $validator;
50	7	return $this;
51		}
52
53
54		/**
55		* @return \Fiv\Form\Validator\Base[]
56		*/
57	10	public function getValidators() {
58	10	return $this->validators;
59		}
60
61
62		/**
63		*
64		* @param FilterInterface $filter
65		* @throws \Exception
66		* @return $this
67		*/
68	3	public function addFilter(FilterInterface $filter) {
69	3	$this->filters[] = $filter;
70	3	return $this;
71		}
72
73
74		/**
75		* @return FilterInterface[]
76		*/
77	23	public function getFilters() {
78	23	return $this->filters;
79		}
80
81
82		/**
83		* Alias of setAttribute('value', $value)
84		*
85		* @param $value
86		* @return $this
87		*/
88	2	public function setValue($value) {
89	2	$this->setAttribute('value', $value);
90	2	return $this;
91		}
92
93
94		/**
95		* @return string
96		*/
97	23	public function getValue() {
98	23	return $this->value;
99		}
100
101
102		/**
103		* @inheritdoc
104		*/
105	26	public function setAttribute($name, $value) {
106	26	if ($name === 'value') {
107
108	23	$this->validationResult = null;
109
110		# apply filters to the value
111	23	$filters = $this->getFilters();
112	23	foreach ($filters as $filter) {
113	3	$value = $filter->apply($value);
114		}
115
116	23	$this->value = $value;
117		}
118
119	26	return parent::setAttribute($name, $value);
120		}
121
122
123		/**
124		* Return true if element is valid
125		* @return boolean
126		*/
127	10	public function isValid() {
128
129	10	if ($this->validationResult !== null) {
130	1	return $this->validationResult;
131		}
132
133	10	$this->validationResult = true;
134	10	$value = $this->getValue();
135	10	foreach ($this->getValidators() as $validator) {
136	7	$validator->flushErrors();
137	7	if (!$validator->isValid($value)) {
138	7	$this->validationResult = false;
139		}
140		}
141
142	10	return $this->validationResult;
143		}
144
145
146		/**
147		* @return bool
148		*/
149		public function validate() {
150		trigger_error('Deprecated. Use isValid', E_USER_DEPRECATED);
151		return $this->isValid();
152		}
153
154
155		/**
156		* @return array
157		*/
158	6	public function getValidatorsErrors() {
159	6	$errors = [];
160	6	foreach ($this->validators as $validator) {
161	6	foreach ($validator->getErrors() as $error) {
162	6	$errors[] = $error;
163		}
164		}
165
166	6	return $errors;
167		}
168
169
170		/**
171		* @inheritdoc
172		*/
173	6	public function render() {
174	6	$value = $this->getValue();
175	6	$this->attributes['value'] = htmlentities($value, ENT_QUOTES);
176	6	return parent::render();
177		}
178
179
180		/**
181		* @deprecated
182		* @see addValidator
183		* @return $this
184		*/
185		public function required() {
186		trigger_error('Deprecated', E_USER_DEPRECATED);
187		return $this->addValidator(new \Fiv\Form\Validator\Required());
188		}
189
190
191		/**
192		* @param string $text
193		* @return $this
194		*/
195	14	public function setText($text) {
196	14	$this->text = $text;
197	14	return $this;
198		}
199
200
201		/**
202		* @return mixed
203		*/
204	1	public function getText() {
205	1	return $this->text;
206		}
207
208
209		/**
210		* @param string $name
211		* @return $this
212		*/
213	25	public function setName($name) {
214	25	$this->setAttribute('name', $name);
215	25	return $this;
216		}
217
218
219		/**
220		* @return null\|string
221		*/
222	23	public function getName() {
223	23	return $this->getAttribute('name');
224		}
225
226
227		/**
228		* @param string $class
229		* @return $this
230		*/
231	1	public function setClass($class) {
232	1	$this->setAttribute('class', $class);
233	1	return $this;
234		}
235
236
237		/**
238		* @return null\|string
239		*/
240	1	public function getClass() {
241	1	return $this->getAttribute('class');
242		}
243
244
245		/**
246		* @param string $id
247		* @return $this
248		*/
249		public function setId($id) {
250		$this->setAttribute('id', $id);
251		return $this;
252		}
253
254
255		/**
256		* @return null\|string
257		*/
258		public function getId() {
259		return $this->getAttribute('id');
260		}
261
262		}

funivan / form

Pull Request — master (#23)

BaseElement::addValidator() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like