AbstractForm::getErrors() - Code Metrics - Inspection of "WebHemi\Form: add unit tests" - Gixx/WebHemi - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c7f806...9f6188 )

by Gabor

created 2016-09-23 13:56 UTC

AbstractForm::getErrors() A

↳ Parent: AbstractForm

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php
/**
 * WebHemi.
 *
 * PHP version 5.6
 *
 * @copyright 2012 - 2016 Gixx-web (http://www.gixx-web.com)
 * @license   https://opensource.org/licenses/MIT The MIT License (MIT)
 *
 * @link      http://www.gixx-web.com
 */
namespace WebHemi\Form;

use Iterator;
use WebHemi\Form\Element\NestedElementInterface;
use WebHemi\Form\Element\Traits\IteratorTrait;

/**
 * Class AbstractForm
 */
abstract class AbstractForm implements FormInterface, Iterator
{
    /** @var NestedElementInterface */
    protected $form;
    /** @var string */
    protected $name;
    /** @var string */
    protected $salt;

    // The implementation of the Iterator interface.
    use IteratorTrait;

    /**
     * AbstractForm constructor.
     *
     * @param string $name
     * @param string $action
     * @param string $method
     */
    final public function __construct($name, $action = '', $method = 'POST')
    {
        $this->form = $this->getFormContainer();
        $this->form->setName($name)
            ->setAttributes(
                [
                    'action' => $action,
                    'method' => strtoupper($method)
                ]
            );

        // For simplicity in rendering (twig macro), we store it in an array.
        $this->nodes[0] =& $this->form;
        // Set a default salt for the form name. If the AutoComplete attribute is 'off', it will be added to the form's
        // name attribute. The default salt will change every hour.
        $this->salt = md5(gmdate('YmdH'));

        $this->initForm();
    }

    /**
     * Returns the form container element. E.g.: for HTML forms it is the <form> tag.
     *
     * @return NestedElementInterface
     */
    abstract protected function getFormContainer();

    /**
     * Initialize form.
     *
     * @return void
     */
    abstract protected function initForm();

    /**
     * Gets form name.
     *
     * @return string
     */
    public function getName()
    {
        return $this->form->getName();
    }

    /**
     * Set unique identifier for the form.
     *
     * @param string $salt
     * @return AbstractForm
     */
    public function setNameSalt($salt)
    {
        $this->salt = md5($salt);

        return $this;
    }

    /**
     * Sets form action.
     *
     * @param string $action
     * @return AbstractForm
     */
    final public function setAction($action)
    {
        $this->setAttribute('action', $action);

        return $this;
    }

    /**
     * Sets form submit.
     *
     * @param string $method
     * @return AbstractForm
     */
    final public function setMethod($method = 'POST')
    {
        $this->setAttribute('method', $method);

        return $this;
    }

    /**
     * Sets form encoding type.
     *
     * @param string $encodingType
     * @return AbstractForm
     */
    final protected function setEnctype($encodingType = 'application/x-www-form-urlencoded')
    {
        $this->setAttribute('enctype', $encodingType);

        return $this;
    }

    /**
     * Sets form auto-complete option.
     *
     * @param bool $autoComplete
     * @return AbstractForm
     */
    final public function setAutoComplete($autoComplete = true)
    {
        $name = $this->form->getName(false);
        $md5Match = [];

        // Search for the unique form prefix.
        preg_match('/^[a-z0-9\_\-\[\]]+\_(?P<md5>[a-f0-9]{32}).*$/', $name, $md5Match);

        // When it's necessary, add/remove the salt to/from the name
        if ($autoComplete && !empty($md5Match)) {
            $name = str_replace('_'.$md5Match['md5'], '', $name);
        } elseif (!$autoComplete && empty($md5Match)) {
            $name = $name.'_'.$this->salt;
        }

        $this->form->setName($name);

        $this->setAttribute('autocomplete', $autoComplete);

        return $this;
    }

    /**
     * Sets specific form attributes.
     *
     * @param $name
     * @param $value
     */
    private function setAttribute($name, $value)
    {
        $attributes = $this->form->getAttributes();
        $attributes[$name] = $value;

        $this->form->setAttributes($attributes);
    }

    /**
     * Adds a form element to the form.
     *
     * @param array<FormElementInterface> $nodes
     * @return AbstractForm
     */
    protected function setNodes(array $nodes)
    {
        $this->form->setNodes($nodes);

        return $this;
    }

    /**
     * Gets the form elements.
     *
     * @return array<FormElementInterface>
     */
    protected function getNodes()
    {
        return $this->form->getNodes();
    }

    /**
     * Validates the form.
     *
     * @param bool $reValidate
     * @return bool
     */
    public function isValid($reValidate = false)
    {
        return $this->form->isValid($reValidate);
    }

    /**
     * Gets validation errors.
     *
     * @return array
     */
    public function getErrors()
    {
        return $this->form->getErrors();
    }

    /**
     * Sets form data.
     *
     * @param array $data
     * @return FormInterface
     */
    public function setData(array $data)
    {
        if (isset($data[$this->form->getName()])) {
            $data = $data[$this->form->getName()];
        }

        $this->form->setValue($data);

        return $this;
    }

    /**
     * Returns the form data.
     *
     * @return array
     */
    public function getData()
    {
        return $this->form->getValue();
    }
}


1		<?php
2		/**
3		* WebHemi.
4		*
5		* PHP version 5.6
6		*
7		* @copyright 2012 - 2016 Gixx-web (http://www.gixx-web.com)
8		* @license https://opensource.org/licenses/MIT The MIT License (MIT)
9		*
10		* @link http://www.gixx-web.com
11		*/
12		namespace WebHemi\Form;
13
14		use Iterator;
15		use WebHemi\Form\Element\NestedElementInterface;
16		use WebHemi\Form\Element\Traits\IteratorTrait;
17
18		/**
19		* Class AbstractForm
20		*/
21		abstract class AbstractForm implements FormInterface, Iterator
22		{
23		/** @var NestedElementInterface */
24		protected $form;
25		/** @var string */
26		protected $name;
27		/** @var string */
28		protected $salt;
29
30		// The implementation of the Iterator interface.
31		use IteratorTrait;
32
33		/**
34		* AbstractForm constructor.
35		*
36		* @param string $name
37		* @param string $action
38		* @param string $method
39		*/
40	8	final public function __construct($name, $action = '', $method = 'POST')
41		{
42	8	$this->form = $this->getFormContainer();
43	8	$this->form->setName($name)
44	8	->setAttributes(
45		[
46	8	'action' => $action,
47	8	'method' => strtoupper($method)
48	8	]
49	8	);
50
51		// For simplicity in rendering (twig macro), we store it in an array.
52	8	$this->nodes[0] =& $this->form;
53		// Set a default salt for the form name. If the AutoComplete attribute is 'off', it will be added to the form's
54		// name attribute. The default salt will change every hour.
55	8	$this->salt = md5(gmdate('YmdH'));
56
57	8	$this->initForm();
58	8	}
59
60		/**
61		* Returns the form container element. E.g.: for HTML forms it is the <form> tag.
62		*
63		* @return NestedElementInterface
64		*/
65		abstract protected function getFormContainer();
66
67		/**
68		* Initialize form.
69		*
70		* @return void
71		*/
72		abstract protected function initForm();
73
74		/**
75		* Gets form name.
76		*
77		* @return string
78		*/
79	2	public function getName()
80		{
81	2	return $this->form->getName();
82		}
83
84		/**
85		* Set unique identifier for the form.
86		*
87		* @param string $salt
88		* @return AbstractForm
89		*/
90	3	public function setNameSalt($salt)
91		{
92	3	$this->salt = md5($salt);
93
94	3	return $this;
95		}
96
97		/**
98		* Sets form action.
99		*
100		* @param string $action
101		* @return AbstractForm
102		*/
103	1	final public function setAction($action)
104		{
105	1	$this->setAttribute('action', $action);
106
107	1	return $this;
108		}
109
110		/**
111		* Sets form submit.
112		*
113		* @param string $method
114		* @return AbstractForm
115		*/
116	1	final public function setMethod($method = 'POST')
117		{
118	1	$this->setAttribute('method', $method);
119
120	1	return $this;
121		}
122
123		/**
124		* Sets form encoding type.
125		*
126		* @param string $encodingType
127		* @return AbstractForm
128		*/
129	1	final protected function setEnctype($encodingType = 'application/x-www-form-urlencoded')
130		{
131	1	$this->setAttribute('enctype', $encodingType);
132
133	1	return $this;
134		}
135
136		/**
137		* Sets form auto-complete option.
138		*
139		* @param bool $autoComplete
140		* @return AbstractForm
141		*/
142	2	final public function setAutoComplete($autoComplete = true)
143		{
144	2	$name = $this->form->getName(false);
145	2	$md5Match = [];
146
147		// Search for the unique form prefix.
148	2	preg_match('/^[a-z0-9\_\-\[\]]+\_(?P<md5>[a-f0-9]{32}).*$/', $name, $md5Match);
149
150		// When it's necessary, add/remove the salt to/from the name
151	2	if ($autoComplete && !empty($md5Match)) {
152	1	$name = str_replace('_'.$md5Match['md5'], '', $name);
153	2	} elseif (!$autoComplete && empty($md5Match)) {
154	2	$name = $name.'_'.$this->salt;
155	2	}
156
157	2	$this->form->setName($name);
158
159	2	$this->setAttribute('autocomplete', $autoComplete);
160
161	2	return $this;
162		}
163
164		/**
165		* Sets specific form attributes.
166		*
167		* @param $name
168		* @param $value
169		*/
170	3	private function setAttribute($name, $value)
171		{
172	3	$attributes = $this->form->getAttributes();
173	3	$attributes[$name] = $value;
174
175	3	$this->form->setAttributes($attributes);
176	3	}
177
178		/**
179		* Adds a form element to the form.
180		*
181		* @param array<FormElementInterface> $nodes
182		* @return AbstractForm
183		*/
184	8	protected function setNodes(array $nodes)
185		{
186	8	$this->form->setNodes($nodes);
187
188	8	return $this;
189		}
190
191		/**
192		* Gets the form elements.
193		*
194		* @return array<FormElementInterface>
195		*/
196	1	protected function getNodes()
197		{
198	1	return $this->form->getNodes();
199		}
200
201		/**
202		* Validates the form.
203		*
204		* @param bool $reValidate
205		* @return bool
206		*/
207	2	public function isValid($reValidate = false)
208		{
209	2	return $this->form->isValid($reValidate);
210		}
211
212		/**
213		* Gets validation errors.
214		*
215		* @return array
216		*/
217	1	public function getErrors()
218		{
219	1	return $this->form->getErrors();
220		}
221
222		/**
223		* Sets form data.
224		*
225		* @param array $data
226		* @return FormInterface
227		*/
228	1	public function setData(array $data)
229		{
230	1	if (isset($data[$this->form->getName()])) {
231	1	$data = $data[$this->form->getName()];
232	1	}
233
234	1	$this->form->setValue($data);
235
236	1	return $this;
237		}
238
239		/**
240		* Returns the form data.
241		*
242		* @return array
243		*/
244	1	public function getData()
245		{
246	1	return $this->form->getValue();
247		}
248		}
249

Gixx / WebHemi

Push — master ( c7f806...9f6188 )

AbstractForm::getErrors() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like