AbstractForm::setAutocomplete() - Code Metrics - Inspection of "WebHemi\Form: fix element id attributes, fix tabin..." - Gixx/WebHemi - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5978c7...5a86a1 )

by Gabor

created 2016-09-14 15:17 UTC

AbstractForm::setAutocomplete() A

↳ Parent: AbstractForm

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	6
ccs	0
cts	5
cp	0
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	3
nc	1
nop	1
crap	2

<?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;

abstract class AbstractForm implements FormInterface, Iterator
{
    /** @var array<FormElement> */
    protected $form;

    /**
     * FormInterface constructor. Creates <FORM> element automatically.
     *
     * @param string $name
     * @param string $action
     * @param string $method
     */
    public function __construct($name, $action = '', $method = 'POST')
    {
        $form = new FormElement('form', $name);
        $form->setAttribute('action', $action)
            ->setAttribute('method', strtoupper($method));

        // for simplicity in rendering (twig macro), we store it in an array.
        $this->form[0] = $form;

        $this->initForm();
    }

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

    /**
     * Set unique identifier for the form.
     *
     * @param string $uniqueFormNamePostfix
     * @return AbstractForm
     */
    protected function setUniqueFormNamePostfix($uniqueFormNamePostfix)
    {
        $this->form[0]->setUniqueFormNamePostfix($uniqueFormNamePostfix);

        return $this;
    }

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

        return $this;
    }

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

        return $this;
    }

    /**
     * Sets form autocomplete option.
     *
     * @param bool $autocomplete
     * @return AbstractForm
     */
    protected function setAutocomplete($autocomplete = true)
    {
        $this->form[0]->setAttribute('autocomplete', $autocomplete);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        return $this;
    }

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

        return $this;
    }

    /**
     * Adds a form element to the form.
     *
     * @param FormElement $formElement
     * @return AbstractForm
     */
    protected function addChildNode(FormElement $formElement)
    {
        $formElement->setParentNode($this->form[0]);

        $this->form[0]->addChildNode($formElement);

        return $this;
    }

    /**
     * Gets the form elements.
     *
     * @return array<FormElement>
     */
    public function getChildNodes()
    {
        return $this->form[0]->getChildNodes();
    }

    /**
     * Validates the form.
     *
     * @return boolean
     */
    public function isValid()
    {
        $valid = true;

        // TODO: TBD

        return $valid;
    }

    /**
     * Sets form data.
     *
     * @param array $data
     * @return FormInterface
     */
    public function setData(array $data)
    {
        // TODO: TBD

        // fake cotent to avoid phpmd warning until the real function logic is created...
        if (!empty($data)) {
            $this->isValid();
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
        }

        return $this;
    }

    /**
     * Returns the form data.
     *
     * @return array
     */
    public function getData()
    {
        // TODO: TBD
        return [];
    }

    /**
     * Return the current element.
     *
     * @return FormElement
     */
    final public function current()
    {
        return current($this->form);
    }

    /**
     * Moves the pointer forward to next element.
     *
     * @return void
     */
    final public function next()
    {
        next($this->form);
    }

    /**
     * Returns the key of the current element.
     *
     * @return mixed
     */
    final public function key()
    {
        return key($this->form);
    }

    /**
     * Checks if current position is valid.
     *
     * @return boolean
     */
    final public function valid()
    {
        $key = key($this->form);

        return ($key !== null && $key !== false);
    }

    /**
     * Rewinds the Iterator to the first element.
     *
     * @return void
     */
    final public function rewind()
    {
        reset($this->form);
    }
}


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
16			abstract class AbstractForm implements FormInterface, Iterator
17			{
18			/** @var array<FormElement> */
19			protected $form;
20
21			/**
22			* FormInterface constructor. Creates <FORM> element automatically.
23			*
24			* @param string $name
25			* @param string $action
26			* @param string $method
27			*/
28			public function __construct($name, $action = '', $method = 'POST')
29			{
30			$form = new FormElement('form', $name);
31			$form->setAttribute('action', $action)
32			->setAttribute('method', strtoupper($method));
33
34			// for simplicity in rendering (twig macro), we store it in an array.
35			$this->form[0] = $form;
36
37			$this->initForm();
38			}
39
40			/**
41			* Initialize form.
42			*
43			* @return void
44			*/
45			abstract protected function initForm();
46
47			/**
48			* Set unique identifier for the form.
49			*
50			* @param string $uniqueFormNamePostfix
51			* @return AbstractForm
52			*/
53			protected function setUniqueFormNamePostfix($uniqueFormNamePostfix)
54			{
55			$this->form[0]->setUniqueFormNamePostfix($uniqueFormNamePostfix);
56
57			return $this;
58			}
59
60			/**
61			* Sets form action.
62			*
63			* @param string $action
64			* @return AbstractForm
65			*/
66			protected function setAction($action)
67			{
68			$this->form[0]->setAttribute('action', $action);
69
70			return $this;
71			}
72
73			/**
74			* Sets form submit.
75			*
76			* @param string $method
77			* @return AbstractForm
78			*/
79			protected function setMethod($method = 'POST')
80			{
81			$this->form[0]->setAttribute('method', $method);
82
83			return $this;
84			}
85
86			/**
87			* Sets form autocomplete option.
88			*
89			* @param bool $autocomplete
90			* @return AbstractForm
91			*/
92			protected function setAutocomplete($autocomplete = true)
93			{
94			$this->form[0]->setAttribute('autocomplete', $autocomplete);
			0 ignored issues – show Documentation introduced 2016-09-14 15:28 UTC by Report Bug Copy Issue Report `$autocomplete` is of type `boolean`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
95
96			return $this;
97			}
98
99			/**
100			* Sets form encryption type.
101			*
102			* @param string $enctype
103			* @return AbstractForm
104			*/
105			protected function setEnctype($enctype = 'application/x-www-form-urlencoded')
106			{
107			$this->form[0]->setAttribute('enctype', $enctype);
108
109			return $this;
110			}
111
112			/**
113			* Adds a form element to the form.
114			*
115			* @param FormElement $formElement
116			* @return AbstractForm
117			*/
118			protected function addChildNode(FormElement $formElement)
119			{
120			$formElement->setParentNode($this->form[0]);
121
122			$this->form[0]->addChildNode($formElement);
123
124			return $this;
125			}
126
127			/**
128			* Gets the form elements.
129			*
130			* @return array<FormElement>
131			*/
132			public function getChildNodes()
133			{
134			return $this->form[0]->getChildNodes();
135			}
136
137			/**
138			* Validates the form.
139			*
140			* @return boolean
141			*/
142			public function isValid()
143			{
144			$valid = true;
145
146			// TODO: TBD
147
148			return $valid;
149			}
150
151			/**
152			* Sets form data.
153			*
154			* @param array $data
155			* @return FormInterface
156			*/
157			public function setData(array $data)
158			{
159			// TODO: TBD
160
161			// fake cotent to avoid phpmd warning until the real function logic is created...
162			if (!empty($data)) {
163			$this->isValid();
			0 ignored issues – show Unused Code introduced 2016-09-12 19:31 UTC by Report Bug Copy Issue Report The call to the method `WebHemi\Form\AbstractForm::isValid()` seems un-needed as the method has no side-effects. PHP Analyzer performs a side-effects analysis of your code. A side-effect is basically anything that might be visible after the scope of the method is left. Let’s take a look at an example: class User { private $email; public function getEmail() { return $this->email; } public function setEmail($email) { $this->email = $email; } } If we look at the `getEmail()` method, we can see that it has no side-effect. Whether you call this method or not, no future calls to other methods are affected by this. As such code as the following is useless: $user = new User(); $user->getEmail(); // This line could safely be removed as it has no effect. On the hand, if we look at the `setEmail()`, this method _has_ side-effects. In the following case, we could not remove the method call: $user = new User(); $user->setEmail('email@domain'); // This line has a side-effect (it changes an // instance variable). Loading history...
164			}
165
166			return $this;
167			}
168
169			/**
170			* Returns the form data.
171			*
172			* @return array
173			*/
174			public function getData()
175			{
176			// TODO: TBD
177			return [];
178			}
179
180			/**
181			* Return the current element.
182			*
183			* @return FormElement
184			*/
185			final public function current()
186			{
187			return current($this->form);
188			}
189
190			/**
191			* Moves the pointer forward to next element.
192			*
193			* @return void
194			*/
195			final public function next()
196			{
197			next($this->form);
198			}
199
200			/**
201			* Returns the key of the current element.
202			*
203			* @return mixed
204			*/
205			final public function key()
206			{
207			return key($this->form);
208			}
209
210			/**
211			* Checks if current position is valid.
212			*
213			* @return boolean
214			*/
215			final public function valid()
216			{
217			$key = key($this->form);
218
219			return ($key !== null && $key !== false);
220			}
221
222			/**
223			* Rewinds the Iterator to the first element.
224			*
225			* @return void
226			*/
227			final public function rewind()
228			{
229			reset($this->form);
230			}
231			}
232

Gixx / WebHemi

Push — master ( 5978c7...5a86a1 )

AbstractForm::setAutocomplete() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like