AbstractFormRenderer::addDynamicFormJavascript() - Code Metrics - Inspection of "Adding Unit Tests" - delboy1978uk/form - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — dynamicfields (2a748f)

by Derek Stephen

created 2017-03-29 08:47 UTC

AbstractFormRenderer::addDynamicFormJavascript() B

↳ Parent: AbstractFormRenderer

Complexity

Conditions	2
Paths	2

Size

Total Lines	26
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
dl	0
loc	26
ccs	4
cts	4
cp	1
rs	8.8571
c	1
b	0
f	0
cc	2
eloc	4
nc	2
nop	0
crap	2

<?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');
    }

    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	29	private function processFields(FieldCollection $fields, $dynamicTriggerValue = null)
133		{
134	29	$count = $fields->count();
135	29	$x = 1;
136	29	$fields->rewind();
137	29	while ($fields->valid()) {
138	27	$this->field = $fields->current();
139	27	$finaliseDynamicBlock = ($x == $count) ? true : false;
140	27	$this->renderField($dynamicTriggerValue, $finaliseDynamicBlock);
141	21	$x++;
142	21	$fields->next();
143		}
144	23	$fields->rewind();
145	23	}
146
147		/**
148		* @param null $dynamicTriggerValue
149		* @param bool $finaliseDynamicBlock
150		*/
151	27	public function renderField($dynamicTriggerValue = null, $finaliseDynamicBlock = false)
152		{
153	27	$this->createNewDynamicContainerBlockIfNeeded($dynamicTriggerValue);
154
155	27	$this->block = $this->createElement('div');
156	27	$this->label = $this->renderFieldLabel();
157	27	$this->element = $this->field->getRenderer()->render($this->dom, $this->field);
158	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...
159	21	$this->block = $this->renderFieldBlock();
160
161	21	is_null($dynamicTriggerValue)
162	21	? $this->form->appendChild($this->block)
163	1	: $this->dynamicContainerBlock->appendChild($this->block);
164
165	21	$this->dynamicFormCheck();
166	21	$this->finaliseDynamicBlockIfNeeded($finaliseDynamicBlock);
167	21	}
168
169		/**
170		* This creates a containing div for dynamic fields which appear only on another fields value
171		* @param null $dynamicTriggerValue
172		*/
173	27	private function createNewDynamicContainerBlockIfNeeded($dynamicTriggerValue)
174		{
175	27	if (!isset($this->dynamicContainerBlock) && $dynamicTriggerValue !== null) {
176	1	$this->dynamicContainerBlock = $this->createElement('div');
177	1	$this->dynamicContainerBlock->setAttribute('data-dynamic-form', $this->dynamicFormParentName);
178	1	$this->dynamicContainerBlock->setAttribute('data-dynamic-form-trigger-value', $dynamicTriggerValue);
179	1	$this->dynamicContainerBlock->setAttribute('class', 'dynamic-form-block trigger' . $this->dynamicFormParentName);
180	1	$this->dynamicContainerBlock->setAttribute('id', $this->dynamicFormParentName . $dynamicTriggerValue);
181	1	$this->dynamicFormVisible === false ? $this->dynamicContainerBlock->setAttribute('style', 'display: none;') : null;
182		}
183	27	}
184
185		/**
186		* Checks current field being processed for dynamic sub forms
187		*/
188	21	private function dynamicFormCheck()
189		{
190	21	if ($this->field->hasDynamicForms()) {
191	1	$this->dynamicFormParentName = $this->field->getName();
192	1	$value = $this->field->getValue();
193	1	$forms = $this->field->getDynamicForms();
194	1	$this->includeDynamicFormJavascript = true;
195	1	foreach ($forms as $dynamicTriggerValue => $form) {
196	1	$this->dynamicFormVisible = ($value == $dynamicTriggerValue);
197	1	$dynamicFields = $form->getFields();
198	1	$this->processFields($dynamicFields, $dynamicTriggerValue);
199		}
200	1	unset($this->dynamicFormParentName);
201		}
202	21	}
203
204		/**
205		* @param bool $finaliseDynamicBlock
206		*/
207	21	private function finaliseDynamicBlockIfNeeded($finaliseDynamicBlock)
208		{
209	21	if (isset($this->dynamicContainerBlock) && $finaliseDynamicBlock === true) {
210	1	$this->form->appendChild($this->dynamicContainerBlock);
211	1	unset($this->dynamicContainerBlock);
212		}
213	21	}
214
215
216		/**
217		* @return DOMElement\|null
218		*/
219	6	public function renderError()
220		{
221	6	$errorBlock = null;
222	6	if ($this->errorRenderer->shouldRender($this->field) && $this->displayErrors === true) {
223	4	$this->block->setAttribute('class', 'has-error ');
224	4	$errorBlock = $this->errorRenderer->render($this->field);
225		}
226	6	return $errorBlock;
227		}
228
229		/**
230		* @return DOMElement
231		*/
232	27	protected function createLabelElement()
233		{
234	27	$label = $this->createElement('label');
235	27	$label->setAttribute('for', $this->field->getId());
236	27	if ($this->field->isRequired()) {
237	6	$label = $this->addRequiredAsterisk($label);
238		}
239	27	return $label;
240		}
241
242		/**
243		* @param DomElement $label
244		* @return DomElement
245		*/
246	6	public function addRequiredAsterisk(DomElement $label)
247		{
248	6	$span = $this->createElement('span');
249	6	$span->setAttribute('class', 'text-danger');
250	6	$text = $this->createText('* ');
251	6	$span->appendChild($text);
252	6	$label->appendChild($span);
253	6	return $label;
254		}
255
256		/**
257		* @return string
258		*/
259	23	private function addDynamicFormJavascript()
260		{
261	23	if ($this->includeDynamicFormJavascript === true) {
262		return "<script type=\"text/javascript\">
263		$(document).ready(function(){
264		$('.dynamic-form-block').each(function(){
265		var Id = $(this).prop('id');
266		var parentField = $(this).attr('data-dynamic-form');
267		var parentValue = $(this).attr('data-dynamic-form-trigger-value');
268
269		$('input[name=\"'+parentField+'\"]').change(function(){
270		var val = $(this).val();
271		if (val == parentValue) {
272		$('.trigger'+parentField).each(function(){
273		$(this).attr('style', 'display: none;');
274		});
275		$('#'+Id).attr('style', 'display: block;');
276		}
277		});
278		});
279		});
280		</script>
281	1	";
282		}
283	22	return '';
284		}
285		}

delboy1978uk / form

Branch — dynamicfields (2a748f)

AbstractFormRenderer::addDynamicFormJavascript() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like