AbstractFormRenderer::renderField() - Code Metrics - Inspection of "Updating README with Dynamic Form instructions" - delboy1978uk/form - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 312f5c...551479 )

by Derek Stephen

created 2017-03-29 09:44 UTC

AbstractFormRenderer::renderField() A

↳ Parent: AbstractFormRenderer

Complexity

Conditions	3
Paths	4

Size

Total Lines	17
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	13
CRAP Score	3

Importance

Changes

Metric	Value
dl	0
loc	17
ccs	13
cts	13
cp	1
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	12
nc	4
nop	2
crap	3

<?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 Del\Form\Traits\HasDomTrait;
use DOMDocument;
use DomElement;

abstract class AbstractFormRenderer implements FormRendererInterface
{
    use HasDomTrait;

    /** @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 DomElement $dynamicContainerBlock */
    protected $dynamicContainerBlock;

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

    /** @var bool $includeDynamicFormJavascript */
    private $includeDynamicFormJavascript = false;

    /** @var string $dynamicFormParentName */
    private $dynamicFormParentName = '';

    /** @var bool $dynamicFormVisible */
    private $dynamicFormVisible = false;

    public function __construct()
    {
        $this->resetDom();
    }

    /**
     *  resets dom
     */
    private function resetDom()
    {
        $this->setDom(new DOMDocument());
        $this->form = $this->getDom()->createElement('form');
        $this->errorRenderer = new DefaultErrorRender($this->dom);
    }

    /**
     * @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->getDom()->appendChild($this->form);
        $html = $this->getDom()->saveHTML();
        $this->resetDom();

        $html .= $this->addDynamicFormJavascript();
        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');
    }

    /**
     * @param FieldCollection $fields
     * @param string $dynamicTriggerValue
     */
    private function processFields(FieldCollection $fields, $dynamicTriggerValue = null)
    {
        $count = $fields->count();
        $x = 1;
        $fields->rewind();
        while ($fields->valid()) {
            $this->field = $fields->current();
            $finaliseDynamicBlock = ($x == $count) ? true : false;
            $this->renderField($dynamicTriggerValue, $finaliseDynamicBlock);

            $x++;
            $fields->next();
        }
        $fields->rewind();
    }

    /**
     * @param null $dynamicTriggerValue
     * @param bool $finaliseDynamicBlock
     */
    public function renderField($dynamicTriggerValue = null, $finaliseDynamicBlock = false)
    {
        $this->createNewDynamicContainerBlockIfNeeded($dynamicTriggerValue);

        $this->block = $this->createElement('div');
        $this->label = $this->renderFieldLabel();
        $this->element = $this->field->getRenderer()->render($this->dom, $this->field);
        $this->errors = $this->field->isValid() ? null : $this->renderError();
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
        $this->block = $this->renderFieldBlock();

        is_null($dynamicTriggerValue)
            ? $this->form->appendChild($this->block)
            : $this->dynamicContainerBlock->appendChild($this->block);

        $this->dynamicFormCheck();
        $this->finaliseDynamicBlockIfNeeded($finaliseDynamicBlock);
    }

    /**
     * This creates a containing div for dynamic fields which appear only on another fields value
     * @param null $dynamicTriggerValue
     */
    private function createNewDynamicContainerBlockIfNeeded($dynamicTriggerValue)
    {
        if (!isset($this->dynamicContainerBlock) && $dynamicTriggerValue !== null) {
            $this->dynamicContainerBlock = $this->createElement('div');
            $this->dynamicContainerBlock->setAttribute('data-dynamic-form', $this->dynamicFormParentName);
            $this->dynamicContainerBlock->setAttribute('data-dynamic-form-trigger-value', $dynamicTriggerValue);
            $this->dynamicContainerBlock->setAttribute('class', 'dynamic-form-block trigger'.$this->dynamicFormParentName);
            $this->dynamicContainerBlock->setAttribute('id', $this->dynamicFormParentName.$dynamicTriggerValue);
            $this->dynamicFormVisible === false ? $this->dynamicContainerBlock->setAttribute('style', 'display: none;') : null;
        }
    }

    /**
     *  Checks current field being processed for dynamic sub forms
     */
    private function dynamicFormCheck()
    {
        if ($this->field->hasDynamicForms()) {
            $this->dynamicFormParentName = $this->field->getName();
            $value = $this->field->getValue();
            $forms = $this->field->getDynamicForms();
            $this->includeDynamicFormJavascript = true;
            foreach ($forms as $dynamicTriggerValue => $form) {
                $this->dynamicFormVisible = ($value == $dynamicTriggerValue);
                $dynamicFields = $form->getFields();
                $this->processFields($dynamicFields, $dynamicTriggerValue);
            }
            unset($this->dynamicFormParentName);
        }
    }

    /**
     * @param bool $finaliseDynamicBlock
     */
    private function finaliseDynamicBlockIfNeeded($finaliseDynamicBlock)
    {
        if (isset($this->dynamicContainerBlock) && $finaliseDynamicBlock === true) {
            $this->form->appendChild($this->dynamicContainerBlock);
            unset($this->dynamicContainerBlock);
        }
    }


    /**
     * @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->createElement('label');
        $label->setAttribute('for', $this->field->getId());
        if ($this->field->isRequired()) {
            $label = $this->addRequiredAsterisk($label);
        }
        return $label;
    }

    /**
     * @param DomElement $label
     * @return DomElement
     */
    public function addRequiredAsterisk(DomElement $label)
    {
        $span = $this->createElement('span');
        $span->setAttribute('class', 'text-danger');
        $text = $this->createText('* ');
        $span->appendChild($text);
        $label->appendChild($span);
        return $label;
    }

    /**
     * @return string
     */
    private function addDynamicFormJavascript()
    {
        if ($this->includeDynamicFormJavascript === true) {
            return "<script type=\"text/javascript\">
                $(document).ready(function(){
                    $('.dynamic-form-block').each(function(){
                        var Id = $(this).prop('id');
                        var parentField = $(this).attr('data-dynamic-form');
                        var parentValue = $(this).attr('data-dynamic-form-trigger-value');
            
                        $('input[name=\"'+parentField+'\"]').change(function(){
                            var val = $(this).val();
                            if (val == parentValue) {
                                $('.trigger'+parentField).each(function(){
                                    $(this).attr('style', 'display: none;');
                                });
                                $('#'+Id).attr('style', 'display: block;');
                            }
                        });
                    });
                });
            </script>
            ";
        }
        return '';
    }
}

1		<?php
2		/**
3		* User: delboy1978uk
4		* Date: 07/12/2016
5		* Time: 01:54
6		*/
7
8		namespace Del\Form\Renderer;
9
10		use Del\Form\Collection\FieldCollection;
11		use Del\Form\AbstractForm;
12		use Del\Form\Field\FieldInterface;
13		use Del\Form\FormInterface;
14		use Del\Form\Renderer\Error\DefaultErrorRender;
15		use Del\Form\Renderer\Error\ErrorRendererInterface;
16		use Del\Form\Traits\HasDomTrait;
17		use DOMDocument;
18		use DomElement;
19
20		abstract class AbstractFormRenderer implements FormRendererInterface
21		{
22		use HasDomTrait;
23
24		/** @var DomElement $form */
25		protected $form;
26
27		/** @var bool $displayErrors */
28		protected $displayErrors;
29
30		/** @var ErrorRendererInterface $errorRenderer */
31		protected $errorRenderer;
32
33		/** @var DomElement $label The label element */
34		protected $label;
35
36		/** @var DomElement $element the field element */
37		protected $element;
38
39		/** @var DomElement $errors The error block html */
40		protected $errors;
41
42		/** @var DomElement $block The containing html block */
43		protected $block;
44
45		/** @var DomElement $dynamicContainerBlock */
46		protected $dynamicContainerBlock;
47
48		/** @var FieldInterface $field The current field being processed */
49		protected $field;
50
51		/** @var bool $includeDynamicFormJavascript */
52		private $includeDynamicFormJavascript = false;
53
54		/** @var string $dynamicFormParentName */
55		private $dynamicFormParentName = '';
56
57		/** @var bool $dynamicFormVisible */
58		private $dynamicFormVisible = false;
59
60	50	public function __construct()
61		{
62	50	$this->resetDom();
63	50	}
64
65		/**
66		* resets dom
67		*/
68	50	private function resetDom()
69		{
70	50	$this->setDom(new DOMDocument());
71	50	$this->form = $this->getDom()->createElement('form');
72	50	$this->errorRenderer = new DefaultErrorRender($this->dom);
73	50	}
74
75		/**
76		* @param FormInterface $form
77		* @param bool $displayErrors
78		* @return string
79		*/
80	29	public function render(FormInterface $form, $displayErrors = true)
81		{
82	29	$this->displayErrors = $displayErrors;
83	29	$this->setFormAttributes($form);
84
85	29	$fields = $form->getFields();
86	29	$this->processFields($fields);
87
88	23	$this->getDom()->appendChild($this->form);
89	23	$html = $this->getDom()->saveHTML();
90	23	$this->resetDom();
91
92	23	$html .= $this->addDynamicFormJavascript();
93	23	return $html;
94		}
95
96		/**
97		* @param FormInterface $form
98		*/
99	29	private function setFormAttributes(FormInterface $form)
100		{
101	29	$attributes = $form->getAttributes();
102	29	foreach ($attributes as $key => $value) {
103	29	$this->form->setAttribute($key, $value);
104		}
105
106		// set Id as name or method as post if not set
107	29	$method = $this->getMethod($form);
108	29	$id = $this->getId($form);
109
110	29	$this->form->setAttribute('id', $id);
111	29	$this->form->setAttribute('method', $method);
112	29	}
113
114		/**
115		* @param FormInterface $form
116		* @return string
117		*/
118	29	private function getMethod(FormInterface $form)
119		{
120	29	return $form->getMethod() ?: AbstractForm::METHOD_POST;
121		}
122
123		/**
124		* @param FormInterface $form
125		* @return string
126		*/
127	29	private function getId(FormInterface $form)
128		{
129	29	return $form->getId() ?: $this->form->getAttribute('name');
130		}
131
132		/**
133		* @param FieldCollection $fields
134		* @param string $dynamicTriggerValue
135		*/
136	29	private function processFields(FieldCollection $fields, $dynamicTriggerValue = null)
137		{
138	29	$count = $fields->count();
139	29	$x = 1;
140	29	$fields->rewind();
141	29	while ($fields->valid()) {
142	27	$this->field = $fields->current();
143	27	$finaliseDynamicBlock = ($x == $count) ? true : false;
144	27	$this->renderField($dynamicTriggerValue, $finaliseDynamicBlock);
		0 ignored issues – show Bug introduced 2017-03-29 09:47 UTC by Report Bug Copy Issue Report It seems like `$dynamicTriggerValue` defined by parameter `$dynamicTriggerValue` on line 136 can also be of type `string`; however, `Del\Form\Renderer\Abstra...Renderer::renderField()` does only seem to accept `null`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
145	21	$x++;
146	21	$fields->next();
147		}
148	23	$fields->rewind();
149	23	}
150
151		/**
152		* @param null $dynamicTriggerValue
153		* @param bool $finaliseDynamicBlock
154		*/
155	27	public function renderField($dynamicTriggerValue = null, $finaliseDynamicBlock = false)
156		{
157	27	$this->createNewDynamicContainerBlockIfNeeded($dynamicTriggerValue);
158
159	27	$this->block = $this->createElement('div');
160	27	$this->label = $this->renderFieldLabel();
161	27	$this->element = $this->field->getRenderer()->render($this->dom, $this->field);
162	21	$this->errors = $this->field->isValid() ? null : $this->renderError();
		0 ignored issues – show Documentation Bug introduced 2016-12-09 01:18 UTC by Report Bug Copy Issue Report It seems like `$this->field->isValid() ... : $this->renderError()` can also be of type `object<Del\Form\Renderer\DOMElement>`. However, the property `$errors` is declared as type `object<DOMElement>`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
163	21	$this->block = $this->renderFieldBlock();
164
165	21	is_null($dynamicTriggerValue)
166	21	? $this->form->appendChild($this->block)
167	1	: $this->dynamicContainerBlock->appendChild($this->block);
168
169	21	$this->dynamicFormCheck();
170	21	$this->finaliseDynamicBlockIfNeeded($finaliseDynamicBlock);
171	21	}
172
173		/**
174		* This creates a containing div for dynamic fields which appear only on another fields value
175		* @param null $dynamicTriggerValue
176		*/
177	27	private function createNewDynamicContainerBlockIfNeeded($dynamicTriggerValue)
178		{
179	27	if (!isset($this->dynamicContainerBlock) && $dynamicTriggerValue !== null) {
180	1	$this->dynamicContainerBlock = $this->createElement('div');
181	1	$this->dynamicContainerBlock->setAttribute('data-dynamic-form', $this->dynamicFormParentName);
182	1	$this->dynamicContainerBlock->setAttribute('data-dynamic-form-trigger-value', $dynamicTriggerValue);
183	1	$this->dynamicContainerBlock->setAttribute('class', 'dynamic-form-block trigger'.$this->dynamicFormParentName);
184	1	$this->dynamicContainerBlock->setAttribute('id', $this->dynamicFormParentName.$dynamicTriggerValue);
185	1	$this->dynamicFormVisible === false ? $this->dynamicContainerBlock->setAttribute('style', 'display: none;') : null;
186		}
187	27	}
188
189		/**
190		* Checks current field being processed for dynamic sub forms
191		*/
192	21	private function dynamicFormCheck()
193		{
194	21	if ($this->field->hasDynamicForms()) {
195	1	$this->dynamicFormParentName = $this->field->getName();
196	1	$value = $this->field->getValue();
197	1	$forms = $this->field->getDynamicForms();
198	1	$this->includeDynamicFormJavascript = true;
199	1	foreach ($forms as $dynamicTriggerValue => $form) {
200	1	$this->dynamicFormVisible = ($value == $dynamicTriggerValue);
201	1	$dynamicFields = $form->getFields();
202	1	$this->processFields($dynamicFields, $dynamicTriggerValue);
203		}
204	1	unset($this->dynamicFormParentName);
205		}
206	21	}
207
208		/**
209		* @param bool $finaliseDynamicBlock
210		*/
211	21	private function finaliseDynamicBlockIfNeeded($finaliseDynamicBlock)
212		{
213	21	if (isset($this->dynamicContainerBlock) && $finaliseDynamicBlock === true) {
214	1	$this->form->appendChild($this->dynamicContainerBlock);
215	1	unset($this->dynamicContainerBlock);
216		}
217	21	}
218
219
220		/**
221		* @return DOMElement\|null
222		*/
223	6	public function renderError()
224		{
225	6	$errorBlock = null;
226	6	if ($this->errorRenderer->shouldRender($this->field) && $this->displayErrors === true) {
227	4	$this->block->setAttribute('class', 'has-error ');
228	4	$errorBlock = $this->errorRenderer->render($this->field);
229		}
230	6	return $errorBlock;
231		}
232
233		/**
234		* @return \DOMElement
235		*/
236	27	protected function createLabelElement()
237		{
238	27	$label = $this->createElement('label');
239	27	$label->setAttribute('for', $this->field->getId());
240	27	if ($this->field->isRequired()) {
241	6	$label = $this->addRequiredAsterisk($label);
242		}
243	27	return $label;
244		}
245
246		/**
247		* @param DomElement $label
248		* @return DomElement
249		*/
250	6	public function addRequiredAsterisk(DomElement $label)
251		{
252	6	$span = $this->createElement('span');
253	6	$span->setAttribute('class', 'text-danger');
254	6	$text = $this->createText('* ');
255	6	$span->appendChild($text);
256	6	$label->appendChild($span);
257	6	return $label;
258		}
259
260		/**
261		* @return string
262		*/
263	23	private function addDynamicFormJavascript()
264		{
265	23	if ($this->includeDynamicFormJavascript === true) {
266		return "<script type=\"text/javascript\">
267		$(document).ready(function(){
268		$('.dynamic-form-block').each(function(){
269		var Id = $(this).prop('id');
270		var parentField = $(this).attr('data-dynamic-form');
271		var parentValue = $(this).attr('data-dynamic-form-trigger-value');
272
273		$('input[name=\"'+parentField+'\"]').change(function(){
274		var val = $(this).val();
275		if (val == parentValue) {
276		$('.trigger'+parentField).each(function(){
277		$(this).attr('style', 'display: none;');
278		});
279		$('#'+Id).attr('style', 'display: block;');
280		}
281		});
282		});
283		});
284		</script>
285	1	";
286		}
287	22	return '';
288		}
289		}

delboy1978uk / form

Push — master ( 312f5c...551479 )

AbstractFormRenderer::renderField() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like