Fiv\Form\Form

Complexity

Total Complexity

56

Size/Duplication

Total Lines	488
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	11

Test Coverage

Coverage

97.92%

Importance

Changes	27
Bugs	9	Features	5

29 Methods

Rating	Name	Duplication	Size	Complexity
A	setName()	0	5	1
A	handleRequestContext()	0	14	4
D	setData()	0	33	9
A	getMethod()	0	7	2
A	setMethod()	0	5	1
A	cleanValidationFlag()	0	4	1
B	isValid()	0	19	5
A	getErrors()	0	3	1
A	addError()	0	8	2
A	isSubmitted()	0	3	1
A	getUid()	0	7	2
A	getElements()	0	3	1
A	getElement()	0	6	2
A	input()	0	7	1
A	password()	0	7	1
A	select()	0	7	1
A	radioList()	0	7	1
A	textarea()	0	7	1
A	hidden()	0	8	1
A	submit()	0	7	1
A	checkbox()	0	7	1
A	checkboxList()	0	7	1
A	setElement()	0	5	1
A	addElement()	0	9	2
A	render()	0	3	1
A	renderElements()	0	17	4
B	renderStart()	0	26	4
A	renderEnd()	0	3	1
A	getData()	0	7	2

<?php


  namespace Fiv\Form;

  use Fiv\Form\Element;
  use Fiv\Form\Element\Checkbox;

This use statement conflicts with another class in this namespace, Fiv\Form\Checkbox.

  use Fiv\Form\Element\CheckboxList;

This use statement conflicts with another class in this namespace, Fiv\Form\CheckboxList.

  use Fiv\Form\Element\Submit;
  use Fiv\Form\Element\TextArea;

This use statement conflicts with another class in this namespace, Fiv\Form\TextArea.

  /**
   * @author Ivan Shcherbak <dev@funivan.com>
   */
  class Form extends Element\Html {

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

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

    /**
     * @var array
     */
    protected $errorList = [];

    /**
     * @var array|null
     */
    protected $data = null;

    /**
     * @var bool
     */
    protected $isSubmitted = false;

    /**
     * @var Element\BaseElement[]
     */
    protected $elements = [];

    /**
     * Default form attributes
     *
     * @var array
     */
    protected $attributes = [
      'method' => 'post',
    ];


    /**
     * @param $name
     * @return $this
     */
    public function setName($name) {
      $this->uid = $name;
      $this->attributes['name'] = $name;
      return $this;
    }


    /**
     * @param RequestContext $requestContext
     * @return $this
     */
    public function handleRequestContext(RequestContext $requestContext) {
      $this->cleanValidationFlag();
      foreach ($this->getElements() as $element) {
        $element->handleRequestContext($requestContext);
      }

      $this->data = $requestContext->getData();
      $this->isSubmitted = false;
      if ($requestContext->isMethod($this->getMethod()) and $requestContext->has($this->getUid())) {
        $this->isSubmitted = true;
      }

      return $this;
    }


    /**
     * @return array
     * @throws \Exception
     */
    public function getData() {
      if ($this->data === null) {
        throw new \Exception('Data does not exist!');
      }

      return $this->data;
    }


    /**
     * @param array|\Iterator $data
     * @throws \Exception
     * @deprecated
     */
    public function setData($data) {
      if ($data instanceof \Iterator) {
        $data = iterator_to_array($data);
      }

      if (!is_array($data)) {
        throw new \Exception('Data should be an array');
      }


      $this->cleanValidationFlag();

      $formData = [];
      foreach ($this->elements as $element) {
        $element->clearValue();
        $name = $element->getName();

        if ($element instanceof Checkbox) {
          $data[$name] = array_key_exists($name, $data) ? 1 : 0;
        } elseif ($element instanceof CheckboxList) {
          $data[$name] = isset($data[$name]) ? $data[$name] : [];
        }

        if (array_key_exists($name, $data)) {
          $element->setValue($data[$name]);
          $formData[$name] = $element->getValue();
        }

      }

      $this->isSubmitted = isset($data[$this->getUid()]);
      $this->data = $formData;
    }


    /**
     * @return string
     */
    public function getMethod() {
      if (!empty($this->attributes['method'])) {
        return strtolower($this->attributes['method']);
      }

      return null;
    }


    /**
     * @param string $method
     * @return $this
     */
    public function setMethod($method) {
      $this->attributes['method'] = $method;

      return $this;
    }


    /**
     *
     */
    protected function cleanValidationFlag() {
      $this->errorList = [];
      $this->validationResult = null;
    }


    /**
     * Check if form is submitted and all elements are valid
     *
     * @return boolean
     */
    public function isValid() {
      if ($this->validationResult !== null) {
        return $this->validationResult;
      }

      if (!$this->isSubmitted()) {
        return false;
      }

      $this->validationResult = true;
      foreach ($this->elements as $element) {
        if (!$element->isValid()) {
          $this->errorList = array_merge($this->errorList, $element->getValidatorsErrors());
          $this->validationResult = false;
        }
      }

      return $this->validationResult;
    }


    /**
     * @return array
     */
    public function getErrors() {
      return $this->errorList;
    }


    /**
     * @param string $error
     * @return $this
     */
    protected function addError($error) {
      if (!is_string($error)) {
        throw new \InvalidArgumentException('Error should be a string, ' . gettype($error) . ' given.');
      }
      $this->validationResult = false;
      $this->errorList[] = $error;
      return $this;
    }


    /**
     * Check if form is submitted
     *
     * @return bool
     */
    public function isSubmitted() {
      return $this->isSubmitted;
    }


    /**
     * Return unique id of form
     *
     * @return string
     */
    public function getUid() {
      if (empty($this->uid)) {
        $this->uid = md5(get_called_class());
      }

      return $this->uid;
    }


    /**
     * @return Element\BaseElement[]
     */
    public function getElements() {
      return $this->elements;
    }


    /**
     * @param string $name
     * @return Element\BaseElement
     * @throws \InvalidArgumentException
     */
    public function getElement($name) {
      if (empty($this->elements[$name])) {
        throw new \InvalidArgumentException('Element with name "' . $name . '" not found');
      }
      return $this->elements[$name];
    }


    /**
     * @param string $name
     * @param string|null $text
     * @return \Fiv\Form\Element\Input
     */
    public function input($name, $text = null) {
      $input = new Element\Input();
      $input->setName($name);
      $input->setText($text);
      $this->addElement($input);
      return $input;
    }


    /**
     * @param string $name
     * @param string|null $text
     * @return \Fiv\Form\Element\Input
     */
    public function password($name, $text = null) {
      $input = new Element\Password();
      $input->setName($name);
      $input->setText($text);
      $this->addElement($input);
      return $input;
    }


    /**
     * @param string $name
     * @param null $text
     * @return Select
     */
    public function select($name, $text = null) {
      $select = new Element\Select();
      $select->setName($name);
      $select->setText($text);
      $this->addElement($select);
      return $select;
    }


    /**
     * @param string $name
     * @param string $text
     * @return RadioList
     */
    public function radioList($name, $text = null) {
      $radio = new Element\RadioList();
      $radio->setName($name);
      $radio->setText($text);
      $this->addElement($radio);
      return $radio;
    }


    /**
     * @param string $name
     * @param null $text
     * @return TextArea
     */
    public function textarea($name, $text = null) {
      $input = new TextArea();
      $input->setName($name);
      $input->setText($text);
      $this->addElement($input);
      return $input;
    }


    /**
     * ```
     * $form->hidden('key', md5($this-user->id . HASH_A);
     * ```
     * @param string $name
     * @param null $value
     * @return \Fiv\Form\Element\Input
     */
    public function hidden($name, $value = null) {
      $hidden = new  \Fiv\Form\Element\Input();
      $hidden->setType('hidden');
      $hidden->setName($name);
      $hidden->setValue($value);
      $this->addElement($hidden);
      return $hidden;
    }


    /**
     * ```
     * $form->submit('register', 'зареєструватись');
     * ```
     * @param string $name
     * @param null $value
     * @return Submit
     */
    public function submit($name, $value = null) {
      $input = new Submit();
      $input->setName($name);
      $input->setValue($value);
      $this->addElement($input);
      return $input;
    }


    /**
     * ```
     * $form->checkbox('subscribe', 'Підписка на новини');
     * ```
     * @param string $name
     * @param string|null $label
     * @return Checkbox
     */
    public function checkbox($name, $label = null) {
      $checkbox = new Checkbox();
      $checkbox->setName($name);
      $checkbox->setLabel($label);
      $this->addElement($checkbox);
      return $checkbox;
    }


    /**
     * @param string $name
     * @param null $text
     * @return CheckboxList
     */
    public function checkboxList($name, $text = null) {
      $checkbox = new CheckboxList();
      $checkbox->setName($name);
      $checkbox->setText($text);
      $this->addElement($checkbox);
      return $checkbox;
    }


    /**
     * Attach element to this form. Overwrite element with same name
     *
     * @param Element\BaseElement $element
     * @return $this
     */
    public function setElement(Element\BaseElement $element) {
      $this->cleanValidationFlag();
      $this->elements[$element->getName()] = $element;
      return $this;
    }


    /**
     * @param Element\BaseElement $element
     * @return $this
     * @throws \Exception
     */
    public function addElement(Element\BaseElement $element) {
      if (isset($this->elements[$element->getName()])) {
        throw new \Exception('Element with name ' . $element->getName() . ' is already added. Use setElement to overwrite it or change name');
      }

      $this->cleanValidationFlag();
      $this->elements[$element->getName()] = $element;
      return $this;
    }


    /**
     * Render full form
     *
     * @return string
     */
    public function render() {
      return $this->renderStart() . $this->renderElements() . $this->renderEnd();
    }


    /**
     * You can easy rewrite this method for custom design of your forms
     *
     * @return string
     */
    protected function renderElements() {
      $formHtml = '<dl>';

      foreach ($this->elements as $element) {
        # skip hidden element
        if ($element instanceof Element\Input and $element->getType() === 'hidden') {
          continue;
        }

        $formHtml .=
          '<dt>' . $element->getText() . '</dt>' .
          '<dd>' . $element->render() . '</dd>';
      }

      $formHtml .= '</dl>';
      return $formHtml;
    }


    /**
     * @return string
     */
    public function renderStart() {
      $hidden = new Element\Input();
      $hidden->setType('hidden');
      $hidden->addAttributes([
        'name' => $this->getUid(),
      ]);
      $hidden->setValue(1);


      # get default attribute
      $method = $this->getMethod();
      $this->setAttribute('method', $method);

      $html = '<form ' . Element\Html::renderAttributes($this->getAttributes()) . '>';
      $html .= $hidden->render();

      # render hidden element
      foreach ($this->elements as $element) {
        if ($element instanceof Element\Input and $element->getType() === 'hidden') {
          $html .= $element->render();
        }
      }


      return $html;
    }


    /**
     * @return string
     */
    public function renderEnd() {
      return '</form>';
    }
  }