Del\Form\Renderer\FormRenderer

Complexity

Total Complexity

23

Size/Duplication

Total Lines	206
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	render()	0	11	1
A	setFormAttributes()	0	14	1
A	getMethod()	0	4	2
A	getId()	0	4	2
A	getAction()	0	4	2
A	getEncType()	0	4	2
A	processFields()	0	11	2
A	createFieldDOM()	0	20	3
A	createHelpBlock()	0	14	2
A	addCustomErrorMessage()	0	7	1
A	addErrorMessages()	0	9	2
A	appendMessage()	0	8	1
A	createChildElement()	0	12	1

<?php
/**
 * User: delboy1978uk
 * Date: 29/11/2016
 * Time: 19:44
 */

namespace Del\Form\Renderer;

use Del\Form\Collection\FieldCollection;
use Del\Form\Field\FieldInterface;
use Del\Form\AbstractForm;
use Del\Form\FormInterface;
use DOMDocument;
use DOMElement;
use DOMText;

class FormRenderer
{
    /** @var DOMDocument $dom */
    private $dom;

    /** @var DomElement $form */
    private $form;

    /** @var bool $displayErrors */
    private $displayErrors;

    public function __construct($name)
    {
        $this->dom = new DOMDocument();
        $form = $this->dom->createElement('form');
        $form->setAttribute('name', $name);
        $this->form = $form;

It seems like $form of type object<DOMElement> is incompatible with the declared type object<Del\Form\Renderer\DomElement> of property $form.

    }

    /**
     * @param FormInterface $form
     * @param bool $displayErrors
     * @return string
     */
    public function render(FormInterface $form, $displayErrors = true)
    {
        $this->displayErrors = $displayErrors;
        $this->setFormAttributes($form);

        $fields = $form->getFields();
        $this->processFields($fields);

        $this->dom->appendChild($this->form);
        return $this->dom->saveHTML();
    }

    /**
     * @param FormInterface $form
     */
    private function setFormAttributes(FormInterface $form)
    {
        $method = $this->getMethod($form);
        $id = $this->getId($form);
        $action = $this->getAction($form);
        $encType = $this->getEncType($form);
        $class = $form->getClass();

        $this->form->setAttribute('id', $id);
        $this->form->setAttribute('method', $method);
        $this->form->setAttribute('class', $class);
        $this->form->setAttribute('action', $action);
        $this->form->setAttribute('enctype', $encType);
    }

    /**
     * @param FormInterface $form
     * @return string
     */
    private function getMethod(FormInterface $form)
    {
        return $form->getMethod() ?: AbstractForm::METHOD_POST;
    }

    /**
     * @param FormInterface $form
     * @return string
     */
    private function getId(FormInterface $form)
    {
        return $form->getId() ?: $this->form->getAttribute('name');
    }

    /**
     * @param FormInterface $form
     * @return string
     */
    private function getAction(FormInterface $form)
    {
        return $form->getAction() ?: $this->form->getAttribute('action');
    }

    /**
     * @param FormInterface $form
     * @return string
     */
    private function getEncType(FormInterface $form)
    {
        return $form->getEncType() ?: $this->form->getAttribute('enc-type');
    }

    private function processFields(FieldCollection $fields)
    {
        $fields->rewind();
        while ($fields->valid()) {
            $current = $fields->current();
            $child = $this->createFieldDOM($current);
            $this->form->appendChild($child);
            $fields->next();
        }
        $fields->rewind();
    }

    /**
     * @param FieldInterface $field
     * @return DOMElement
     */
    private function createFieldDOM(FieldInterface $field)
    {
        $formGroup = $this->dom->createElement('div');
        $formGroup->setAttribute('class', 'form-group');

        $label = $this->dom->createElement('label');
        $label->setAttribute('for', $field->getId());
        $label->textContent = $field->getLabel();

        $formField = $this->createChildElement($field);

        $formGroup->appendChild($label);
        $formGroup->appendChild($formField);

        if (!$field->isValid() && $this->displayErrors === true) {
            $formGroup = $this->createHelpBlock($formGroup, $field);
        }

        return $formGroup;
    }

    /**
     * @param DOMElement $formGroup
     * @param FieldInterface $field
     * @return DOMElement]

The doc-type DOMElement] could not be parsed: Expected "|" or "end of type", but got "]" at position 10. (view supported doc-types)

     */
    private function createHelpBlock(DOMElement $formGroup, FieldInterface $field)
    {
        $formGroup->setAttribute('class', 'form-group has-error');
        $helpBlock = $this->dom->createElement('span');
        $helpBlock->setAttribute('class', 'help-block');

        if ($field->hasCustomErrorMessage()) {
            $helpBlock = $this->addCustomErrorMessage($helpBlock, $field);
        } else {
            $helpBlock = $this->addErrorMessages($helpBlock, $field);
        }
        $formGroup->appendChild($helpBlock);
        return $formGroup;
    }

    /**
     * @param DOMElement $helpBlock
     * @param FieldInterface $field
     * @return DOMElement
     */
    private function addCustomErrorMessage(DOMElement $helpBlock, FieldInterface $field)
    {
        $message = $field->getCustomErrorMessage();
        $text = new DOMText($message);
        $helpBlock->appendChild($text);
        return $helpBlock;
    }

    /**
     * @param DOMElement $helpBlock
     * @param FieldInterface $field
     * @return DOMElement]

The doc-type DOMElement] could not be parsed: Expected "|" or "end of type", but got "]" at position 10. (view supported doc-types)

     */
    private function addErrorMessages(DOMElement $helpBlock, FieldInterface $field)
    {
        $messages = $field->getMessages();

        foreach ($messages as $message) {
            $helpBlock = $this->appendMessage($helpBlock, $message);
        }
        return $helpBlock;
    }

    /**
     * @param DOMElement $helpBlock
     * @param $message
     * @return DOMElement
     */
    private function appendMessage(DOMElement $helpBlock, $message)
    {
        $text = new DOMText($message);
        $br = $this->dom->createElement('br');
        $helpBlock->appendChild($text);
        $helpBlock->appendChild($br);
        return $helpBlock;
    }

    /**
     * @param FieldInterface $field
     * @return DOMElement
     */
    private function createChildElement(FieldInterface $field)
    {
        $child = $this->dom->createElement($field->getTag());

        $child->setAttribute('type', $field->getTagType());
        $child->setAttribute('name', $field->getName());
        $child->setAttribute('id', $field->getId());
        $child->setAttribute('value', $field->getValue());
        $child->setAttribute('class', $field->getClass());

        return $child;
    }
}