Driver_Simple_Forms - Code Metrics - Inspection of "Update JS errors test" - OpenBuildings/spiderling - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( fc4353...2e8e64 )

by Haralan

created 2017-08-24 22:44 UTC

Driver_Simple_Forms A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	215
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

3.03%

Importance

Changes

Metric	Value
wmc	32
lcom	1
cbo	0
dl	0
loc	215
ccs	3
cts	99
cp	0.0303
rs	9.6
c	0
b	0
f	0

10 Methods

Rating	Name	Size	Complexity
A	__construct()	4	1
C	get_value()	22	7
C	set_value()	29	7
A	set_value_checkbox()	11	2
A	set_value_radio()	12	3
A	set_value_input()	4	1
A	set_value_textarea()	4	1
A	set_value_option()	21	4
A	serialize_files()	13	2
B	serialize_form()	31	4

<?php

namespace Openbuildings\Spiderling;

/**
 * Helper to handle form serialization, modification and posting
 *
 * @package    Openbuildings\Spiderling
 * @author     Ivan Kerin
 * @copyright  (c) 2013 OpenBuildings Ltd.
 * @license    http://spdx.org/licenses/BSD-3-Clause
 */
class Driver_Simple_Forms
{
	/**
	 * DOMXPath object to perform queries with
	 * @var DOMXPath
	 */
	protected $_xpath;

	function __construct($xpath)

	{
		$this->xpath = $xpath;

	}

	/**
	 * Get the value of a DOMElement with a given xpath
	 * @param  string $xpath
	 * @return mixed
	 */
	public function get_value($xpath)
	{
		$node = $this->xpath->find($xpath);


		switch ($node->tagName)
		{
			case 'textarea':
				return $node->textContent;
			break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

			case 'select':
				$options = array();
				foreach ($this->xpath->query(".//option[@selected]", $node) as $option)

				{
					$options[] = $option->hasAttribute('value') ? $option->getAttribute('value') : $option->textContent;
				}
				return $node->hasAttribute('multiple') ? $options : (isset($options[0]) ? $options[0] : NULL);
			break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
			default:
				return $node->getAttribute('value');
		}
	}

	/**
	 * Set the value of a DOMElement, identified by an xpath, calls one of the stter methods
	 * @param string $xpath
	 * @param mixed $value
	 */
	public function set_value($xpath, $value)
	{
		$node = $this->xpath->find($xpath);


		$setter = 'set_value_input';
		$type = $node->getAttribute('type');

		if ($node->tagName == 'input' AND $type == 'checkbox')
		{
			$setter = 'set_value_checkbox';
		}

		elseif ($node->tagName == 'input' AND $type == 'radio')
		{
			$setter = 'set_value_radio';
		}

		elseif ($node->tagName == 'textarea')
		{
			$setter = 'set_value_textarea';
		}

		elseif ($node->tagName == 'option')
		{
			$setter = 'set_value_option';
		}

		$this->{$setter}($node, $value);
	}

	/**
	 * Set the value of a checkbos DOMNode
	 * @param DOMNode $checkbox
	 * @param boolean   $value
	 */
	public function set_value_checkbox(\DOMNode $checkbox, $value)
	{
		if ($value)
		{
			$checkbox->setAttribute('checked', 'checked');
		}
		else
		{
			$checkbox->removeAttribute('checked');
		}
	}

	/**
	 * Set the value of a radio DOMNode, uncheck any other radio input in the same group
	 * @param DOMNode $radio
	 * @param boolean   $value
	 */
	public function set_value_radio(\DOMNode $radio, $value)
	{
		$name = $radio->getAttribute('name');
		foreach ($this->xpath->query("//input[@type='radio' and @name='$name' and @checked]") as $other_radio)

		{
			$other_radio->removeAttribute('checked');
		}
		if ($value)
		{
			$radio->setAttribute('checked', 'checked');
		}
	}

	/**
	 * Set the value of a normal input
	 * @param DOMNode $input
	 * @param string   $value
	 */
	public function set_value_input(\DOMNode $input, $value)
	{
		$input->setAttribute('value', $value);
	}

	/**
	 * Set the value of a normal textarea
	 * @param DOMNode $textarea
	 * @param string   $value
	 */
	public function set_value_textarea(\DOMNode $textarea, $value)
	{
		$textarea->nodeValue = $value;
	}

	/**
	 * Set the value of an option DOMNode, unselect other options in this select, if it is not multiple
	 * @param DOMNode $option
	 * @param boolean   $value
	 */
	public function set_value_option(\DOMNode $option, $value)
	{
		if ($value)
		{
			$select = $this->xpath->find("./ancestor::select", $option);


			if ( ! $select->hasAttribute('multiple'))
			{
				foreach ($this->xpath->query(".//option[@selected]", $select) as $old_option)

				{
					$old_option->removeAttribute('selected');
				}
			}

			$option->setAttribute('selected', 'selected');
		}
		else
		{
			$option->removeAttribute('selected');
		}
	}

	/**
	 * Return all the contents of file inputs in a form, identified by an xpath
	 * @param  string $xpath
	 * @return string
	 */
	public function serialize_files($xpath)
	{
		$form = $this->xpath->find($xpath);


		$fields = ".//*[not(@disabled) and (self::input and @type = 'file')]";
		$data = array();
		foreach ($this->xpath->query($fields, $form) as $field)

		{
			$data[] = $field->getAttribute('name').'='.$field->getAttribute('value');
		}

		return join('&', $data);
	}

	/**
	 * Return the contents of all the inputs from a form, identified by an xpath.
	 * Don't include file inputs or disabled inputs
	 * @param  string $xpath
	 * @return string
	 */
	public function serialize_form($xpath)
	{
		$form = $this->xpath->find($xpath);


		$types['radio']    = "(self::input and @type = 'radio' and @checked)";
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
		$types['checkbox'] = "(self::input and @type = 'checkbox' and @checked)";
		$types['others']   = "(self::input and @type != 'radio' and @type != 'checkbox' and @type != 'file' and @type != 'submit')";
		$types['notype']   = "(self::input and not(@type))";
		$types['select']   = "(self::select)";
		$types['textarea'] = "(self::textarea)";

		$fields = ".//*[not(@disabled) and (".join(' or ', $types).")]";
		$data = array();
		foreach ($this->xpath->query($fields, $form) as $field)

		{
			$value = $this->get_value($field);
			if (is_array($value))
			{
				foreach ($value as $name => $value_item)
				{
					$data[] = $field->getAttribute('name')."[$name]".'='.urlencode($value_item);
				}
			}
			else
			{
				$data[] = $field->getAttribute('name').'='.urlencode($value);
			}
		}

		return join('&', $data);
	}
}


1		<?php
2
3		namespace Openbuildings\Spiderling;
4
5		/**
6		* Helper to handle form serialization, modification and posting
7		*
8		* @package Openbuildings\Spiderling
9		* @author Ivan Kerin
10		* @copyright (c) 2013 OpenBuildings Ltd.
11		* @license http://spdx.org/licenses/BSD-3-Clause
12		*/
13		class Driver_Simple_Forms
14		{
15		/**
16		* DOMXPath object to perform queries with
17		* @var DOMXPath
18		*/
19		protected $_xpath;
20
21	1	function __construct($xpath)
		0 ignored issues – show Best Practice introduced 2016-03-10 09:26 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
22		{
23	1	$this->xpath = $xpath;
		0 ignored issues – show Bug introduced 2016-03-10 09:26 UTC by Report Bug Copy Issue Report The property `xpath` does not seem to exist. Did you mean `_xpath`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
24	1	}
25
26		/**
27		* Get the value of a DOMElement with a given xpath
28		* @param string $xpath
29		* @return mixed
30		*/
31		public function get_value($xpath)
32		{
33		$node = $this->xpath->find($xpath);
		0 ignored issues – show Bug introduced 2016-03-10 09:26 UTC by Report Bug Copy Issue Report The property `xpath` does not seem to exist. Did you mean `_xpath`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
34
35		switch ($node->tagName)
36		{
37		case 'textarea':
38		return $node->textContent;
39		break;
		0 ignored issues – show Unused Code introduced 2016-03-10 09:26 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
40
41		case 'select':
42		$options = array();
43		foreach ($this->xpath->query(".//option[@selected]", $node) as $option)
		0 ignored issues – show Bug introduced 2016-03-10 09:26 UTC by Report Bug Copy Issue Report The property `xpath` does not seem to exist. Did you mean `_xpath`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
44		{
45		$options[] = $option->hasAttribute('value') ? $option->getAttribute('value') : $option->textContent;
46		}
47		return $node->hasAttribute('multiple') ? $options : (isset($options[0]) ? $options[0] : NULL);
48		break;
		0 ignored issues – show Unused Code introduced 2016-03-10 09:26 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
49		default:
50		return $node->getAttribute('value');
51		}
52		}
53
54		/**
55		* Set the value of a DOMElement, identified by an xpath, calls one of the stter methods
56		* @param string $xpath
57		* @param mixed $value
58		*/
59		public function set_value($xpath, $value)
60		{
61		$node = $this->xpath->find($xpath);
		0 ignored issues – show Bug introduced 2016-03-10 09:26 UTC by Report Bug Copy Issue Report The property `xpath` does not seem to exist. Did you mean `_xpath`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
62
63		$setter = 'set_value_input';
64		$type = $node->getAttribute('type');
65
66		if ($node->tagName == 'input' AND $type == 'checkbox')
67		{
68		$setter = 'set_value_checkbox';
69		}
70
71		elseif ($node->tagName == 'input' AND $type == 'radio')
72		{
73		$setter = 'set_value_radio';
74		}
75
76		elseif ($node->tagName == 'textarea')
77		{
78		$setter = 'set_value_textarea';
79		}
80
81		elseif ($node->tagName == 'option')
82		{
83		$setter = 'set_value_option';
84		}
85
86		$this->{$setter}($node, $value);
87		}
88
89		/**
90		* Set the value of a checkbos DOMNode
91		* @param DOMNode $checkbox
92		* @param boolean $value
93		*/
94		public function set_value_checkbox(\DOMNode $checkbox, $value)
95		{
96		if ($value)
97		{
98		$checkbox->setAttribute('checked', 'checked');
99		}
100		else
101		{
102		$checkbox->removeAttribute('checked');
103		}
104		}
105
106		/**
107		* Set the value of a radio DOMNode, uncheck any other radio input in the same group
108		* @param DOMNode $radio
109		* @param boolean $value
110		*/
111		public function set_value_radio(\DOMNode $radio, $value)
112		{
113		$name = $radio->getAttribute('name');
114		foreach ($this->xpath->query("//input[@type='radio' and @name='$name' and @checked]") as $other_radio)
		0 ignored issues – show Bug introduced 2016-03-10 09:26 UTC by Report Bug Copy Issue Report The property `xpath` does not seem to exist. Did you mean `_xpath`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
115		{
116		$other_radio->removeAttribute('checked');
117		}
118		if ($value)
119		{
120		$radio->setAttribute('checked', 'checked');
121		}
122		}
123
124		/**
125		* Set the value of a normal input
126		* @param DOMNode $input
127		* @param string $value
128		*/
129		public function set_value_input(\DOMNode $input, $value)
130		{
131		$input->setAttribute('value', $value);
132		}
133
134		/**
135		* Set the value of a normal textarea
136		* @param DOMNode $textarea
137		* @param string $value
138		*/
139		public function set_value_textarea(\DOMNode $textarea, $value)
140		{
141		$textarea->nodeValue = $value;
142		}
143
144		/**
145		* Set the value of an option DOMNode, unselect other options in this select, if it is not multiple
146		* @param DOMNode $option
147		* @param boolean $value
148		*/
149		public function set_value_option(\DOMNode $option, $value)
150		{
151		if ($value)
152		{
153		$select = $this->xpath->find("./ancestor::select", $option);
		0 ignored issues – show Bug introduced 2016-03-10 09:26 UTC by Report Bug Copy Issue Report The property `xpath` does not seem to exist. Did you mean `_xpath`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
154
155		if ( ! $select->hasAttribute('multiple'))
156		{
157		foreach ($this->xpath->query(".//option[@selected]", $select) as $old_option)
		0 ignored issues – show Bug introduced 2016-03-10 09:26 UTC by Report Bug Copy Issue Report The property `xpath` does not seem to exist. Did you mean `_xpath`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
158		{
159		$old_option->removeAttribute('selected');
160		}
161		}
162
163		$option->setAttribute('selected', 'selected');
164		}
165		else
166		{
167		$option->removeAttribute('selected');
168		}
169		}
170
171		/**
172		* Return all the contents of file inputs in a form, identified by an xpath
173		* @param string $xpath
174		* @return string
175		*/
176		public function serialize_files($xpath)
177		{
178		$form = $this->xpath->find($xpath);
		0 ignored issues – show Bug introduced 2016-03-10 09:26 UTC by Report Bug Copy Issue Report The property `xpath` does not seem to exist. Did you mean `_xpath`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
179
180		$fields = ".//*[not(@disabled) and (self::input and @type = 'file')]";
181		$data = array();
182		foreach ($this->xpath->query($fields, $form) as $field)
		0 ignored issues – show Bug introduced 2016-03-10 09:26 UTC by Report Bug Copy Issue Report The property `xpath` does not seem to exist. Did you mean `_xpath`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
183		{
184		$data[] = $field->getAttribute('name').'='.$field->getAttribute('value');
185		}
186
187		return join('&', $data);
188		}
189
190		/**
191		* Return the contents of all the inputs from a form, identified by an xpath.
192		* Don't include file inputs or disabled inputs
193		* @param string $xpath
194		* @return string
195		*/
196		public function serialize_form($xpath)
197		{
198		$form = $this->xpath->find($xpath);
		0 ignored issues – show Bug introduced 2016-03-10 09:26 UTC by Report Bug Copy Issue Report The property `xpath` does not seem to exist. Did you mean `_xpath`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
199
200		$types['radio'] = "(self::input and @type = 'radio' and @checked)";
		0 ignored issues – show Coding Style Comprehensibility introduced 2016-03-10 09:26 UTC by Report Bug Copy Issue Report `$types` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$types = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
201		$types['checkbox'] = "(self::input and @type = 'checkbox' and @checked)";
202		$types['others'] = "(self::input and @type != 'radio' and @type != 'checkbox' and @type != 'file' and @type != 'submit')";
203		$types['notype'] = "(self::input and not(@type))";
204		$types['select'] = "(self::select)";
205		$types['textarea'] = "(self::textarea)";
206
207		$fields = ".//*[not(@disabled) and (".join(' or ', $types).")]";
208		$data = array();
209		foreach ($this->xpath->query($fields, $form) as $field)
		0 ignored issues – show Bug introduced 2016-03-10 09:26 UTC by Report Bug Copy Issue Report The property `xpath` does not seem to exist. Did you mean `_xpath`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
210		{
211		$value = $this->get_value($field);
212		if (is_array($value))
213		{
214		foreach ($value as $name => $value_item)
215		{
216		$data[] = $field->getAttribute('name')."[$name]".'='.urlencode($value_item);
217		}
218		}
219		else
220		{
221		$data[] = $field->getAttribute('name').'='.urlencode($value);
222		}
223		}
224
225		return join('&', $data);
226		}
227		}
228

OpenBuildings / spiderling

Push — master ( fc4353...2e8e64 )

Driver_Simple_Forms A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

10 Methods

Duplication Side-by-Side

Filter issues like