Fiv\Form\Element\BaseElement

Complexity

Total Complexity

27

Size/Duplication

Total Lines	235
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

96.43%

Importance

Changes	4
Bugs	1	Features	1

15 Methods

Rating	Name	Duplication	Size	Complexity
A	addValidator()	0	7	2
A	addValidators()	0	12	3
A	addFilter()	0	7	2
A	addFilters()	0	10	3
A	setText()	0	4	1
A	getText()	0	3	1
A	setValue()	0	4	1
A	setAttribute()	0	16	3
A	getFilters()	0	3	1
A	validate()	0	17	4
A	getValue()	0	3	1
A	getValidators()	0	3	1
A	render()	0	5	1
A	getValidatorsErrors()	0	8	2
A	required()	0	4	1

<?php

  namespace Fiv\Form\Element;

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

  /**
   * @package Fiv\Form\Element
   * @author Ivan Shcherbak <dev@funivan.com> 2016
   * @method $this setName($name);
   * @method string getName();
   * @method $this setClass($class);
   * @method string getClass();
   * @method $this setId($id);
   * @method string getId();
   */
  class BaseElement extends \Fiv\Form\Element\Html {

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

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

    /**
     * @var \Fiv\Form\Filter\FilterInterface[]
     */
    protected $filters = [];

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

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


    /**
     * Attach validator to current element
     *
     * @deprecated
     * @see addValidators
     *
     * @param \Fiv\Form\Validator\ValidatorInterface[]|\Fiv\Form\Validator\ValidatorInterface $validator
     * @throws \Exception
     * @return $this
     */
    public function addValidator($validator) {
      if (!is_array($validator)) {
        $validator = [$validator];
      }
      $this->addValidators($validator);
      return $this;
    }


    /**
     * Attach validators to current element
     *
     * @param ValidatorInterface[] $validators
     * @return $this
     * @throws \Exception
     */
    public function addValidators(array $validators) {
      $this->validationResult = null;
      foreach ($validators as $validator) {
        if (!($validator instanceof Validator\ValidatorInterface)) {
          throw new \Exception('Invalid validator class: ' . get_class($validator));
        }
        $this->validators[] = $validator;
      }


      return $this;
    }


    /**
     * @deprecated
     * @see addFilters
     *
     * @param \Fiv\Form\Filter\FilterInterface|\Fiv\Form\Filter\FilterInterface[] $filter
     * @throws \Exception
     * @return $this
     */
    public function addFilter($filter) {
      if (!is_array($filter)) {
        $filter = [$filter];
      }
      $this->addFilters($filter);
      return $this;
    }


    /**
     * Attach filters to current element
     *
     * @param FilterInterface[] $filters
     * @return $this
     * @throws \Exception
     */
    public function addFilters(array $filters) {
      foreach ($filters as $filter) {
        if (!($filter instanceof FilterInterface)) {
          throw new \Exception('Invalid filter class: ' . get_class($filter));
        }
        $this->filters[] = $filter;
      }

      return $this;
    }


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


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


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


    /**
     * @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 \Fiv\Form\Filter\FilterInterface[]
     */
    public function getFilters() {
      return $this->filters;
    }


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

      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 string
     */
    public function getValue() {
      return $this->value;
    }


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


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


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

      return $errors;
    }


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

The method Fiv\Form\Element\BaseElement::addValidator() has been deprecated.

    }
  }