Del\Form\Renderer\AbstractFormRenderer

Complexity

Total Complexity

18

Size/Duplication

Total Lines	155
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

100%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	resetDom()	0	5	1
A	render()	0	13	1
A	setFormAttributes()	0	14	2
A	getMethod()	0	4	2
A	getId()	0	4	2
A	processFields()	0	15	3
A	renderError()	0	9	3
A	createLabelElement()	0	9	2
A	addRequiredAsterisk()	0	9	1

<?php
/**
 * User: delboy1978uk
 * Date: 07/12/2016
 * Time: 01:54
 */

namespace Del\Form\Renderer;

use Del\Form\Collection\FieldCollection;
use Del\Form\AbstractForm;
use Del\Form\Field\FieldInterface;
use Del\Form\FormInterface;
use Del\Form\Renderer\Error\DefaultErrorRender;
use Del\Form\Renderer\Error\ErrorRendererInterface;
use DOMDocument;
use DomElement;
use DOMText;

abstract class AbstractFormRenderer implements FormRendererInterface
{
    /** @var DOMDocument $dom */
    protected $dom;

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

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

    /** @var ErrorRendererInterface $errorRenderer */
    protected $errorRenderer;

    /** @var DomElement $label The label element*/
    protected $label;

    /** @var DomElement $element the field element */
    protected $element;

    /** @var DomElement $errors The error block html*/
    protected $errors;

    /** @var DomElement $block The containing html block */
    protected $block;

    /** @var FieldInterface $field The current field being processed */
    protected $field;

    public function __construct()
    {
        $this->resetDom();
        $this->errorRenderer = new DefaultErrorRender($this->dom);
    }

    /**
     *  resets dom
     */
    private function resetDom()
    {
        $this->dom = new DOMDocument();
        $this->form = $this->dom->createElement('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);
        $html = $this->dom->saveHTML();
        $this->resetDom();
        return $html;
    }

    /**
     * @param FormInterface $form
     */
    private function setFormAttributes(FormInterface $form)
    {
        $attributes = $form->getAttributes();
        foreach ($attributes as $key => $value) {
            $this->form->setAttribute($key, $value);
        }

        // set Id as name or method as post if not set
        $method = $this->getMethod($form);
        $id = $this->getId($form);

        $this->form->setAttribute('id', $id);
        $this->form->setAttribute('method', $method);
    }

    /**
     * @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');
    }

    private function processFields(FieldCollection $fields)
    {
        $fields->rewind();
        while ($fields->valid()) {
            $this->block = $this->dom->createElement('div');
            $this->field = $fields->current();
            $this->label = $this->renderFieldLabel();
            $this->element = $this->field->getRenderer()->render($this->dom, $this->field);
            $this->errors = $this->field->isValid() ? null : $this->renderError();
            $this->block = $this->renderFieldBlock();
            $this->form->appendChild($this->block);
            $fields->next();
        }
        $fields->rewind();
    }



    /**
     * @return \DOMElement|null
     */
    public function renderError()
    {
        $errorBlock = null;
        if ($this->errorRenderer->shouldRender($this->field) && $this->displayErrors === true) {
            $this->block->setAttribute('class', 'has-error ');
            $errorBlock = $this->errorRenderer->render($this->field);
        }
        return $errorBlock;
    }

    /**
     * @return \DOMElement
     */
    protected function createLabelElement()
    {
        $label = $this->dom->createElement('label');
        $label->setAttribute('for', $this->field->getId());
        if ($this->field->isRequired()) {
            $label = $this->addRequiredAsterisk($label);
        }
        return $label;
    }


    public function addRequiredAsterisk(DomElement $label)
    {
        $span = $this->dom->createElement('span');
        $span->setAttribute('class', 'text-danger');
        $text = new DOMText('* ');
        $span->appendChild($text);
        $label->appendChild($span);
        return $label;
    }

}