FluidContext::filterQueryResults() - Code Metrics - Inspection of "1.20 pre release." - servo-php/fluidxml - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 60319d...b48e8d )

by Daniele

created 2016-02-21 01:42 UTC

FluidContext::filterQueryResults() B

↳ Parent: FluidContext

Complexity

Conditions	5
Paths	7

Size

Total Lines	18
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	18
rs	8.8571
cc	5
eloc	9
nc	7
nop	1

<?php

namespace FluidXml;

/**
 * @method array array()
 */
class FluidContext implements FluidInterface, \ArrayAccess, \Iterator
{
        use NewableTrait,
            FluidSaveTrait,
            ReservedCallTrait,          // For compatibility with PHP 5.6.
            ReservedCallStaticTrait;    // For compatibility with PHP 5.6.

        private $document;
        private $handler;
        private $nodes = [];
        private $seek = 0;

        public function __construct($document, $handler, $context)
        {
                $this->document = $document;
                $this->handler  = $handler;

                if (! \is_array($context) && ! $context instanceof \Traversable) {
                        // DOMDocument, DOMElement and DOMNode are not iterable.
                        // DOMNodeList and FluidContext are iterable.
                        $context = [ $context ];
                }

                foreach ($context as $n) {
                        if (! $n instanceof \DOMNode) {
                                throw new \Exception('Node type not recognized.');
                        }

                        $this->nodes[] = $n;
                }
        }

        // \ArrayAccess interface.
        public function offsetSet($offset, $value)
        {
                // if (\is_null($offset)) {
                //         $this->nodes[] = $value;
                // } else {
                //         $this->nodes[$offset] = $value;
                // }
                throw new \Exception('Setting a context element is not allowed.');
        }

        // \ArrayAccess interface.
        public function offsetExists($offset)
        {
                return isset($this->nodes[$offset]);
        }

        // \ArrayAccess interface.
        public function offsetUnset($offset)
        {
                // unset($this->nodes[$offset]);
                \array_splice($this->nodes, $offset, 1);
        }

        // \ArrayAccess interface.
        public function offsetGet($offset)
        {
                if (isset($this->nodes[$offset])) {
                        return $this->nodes[$offset];
                }

                return null;
        }

        // \Iterator interface.
        public function rewind()
        {
                $this->seek = 0;
        }

        // \Iterator interface.
        public function current()
        {
                return $this->nodes[$this->seek];
        }

        // \Iterator interface.
        public function key()
        {
                return $this->seek;
        }

        // \Iterator interface.
        public function next()
        {
                ++$this->seek;
        }

        // \Iterator interface.
        public function valid()
        {
                return isset($this->nodes[$this->seek]);
        }

        public function length()
        {
                return \count($this->nodes);
        }

        // Alias of ->length().
        public function size()
        {
                return $this->length();
        }

        public function query(...$query)
        {
                if (\is_array($query[0])) {
                        $query = $query[0];
                }

                $results = [];

                $xp = $this->document->xpath;

                foreach ($this->nodes as $n) {
                        foreach ($query as $q) {
                                $q = $this->resolveQuery($q);

                                // Returns a DOMNodeList.
                                $res = $xp->query($q, $n);

                                // Algorithm 1:
                                // $results = \array_merge($results, \iterator_to_array($res));

                                // Algorithm 2:
                                // It is faster than \iterator_to_array and a lot faster
                                // than \iterator_to_array + \array_merge.
                                foreach ($res as $r) {
                                        $results[] = $r;
                                }

                                // Algorithm 3:
                                // for ($i = 0, $l = $res->length; $i < $l; ++$i) {
                                //         $results[] = $res->item($i);
                                // }
                        }
                }

                // Performing over multiple sibling nodes a query that ascends
                // the xpath, relative (../..) or absolute (//), returns identical
                // matching results that must be collapsed in an unique result
                // otherwise a subsequent operation is performed multiple times.
                $results = $this->filterQueryResults($results);

                return $this->newContext($results);
        }

        public function __invoke(...$query)
        {
                return $this->query(...$query);
        }

        public function times($times, callable $fn = null)
        {
                if ($fn === null) {
                        return new FluidRepeater($this->document, $this->handler, $this, $times);
                }

                for ($i = 0; $i < $times; ++$i) {
                        $this->callfn($fn, [$this, $i]);
                }

                return $this;
        }

        public function each(callable $fn)
        {
                foreach ($this->nodes as $i => $n) {
                        $cx = $this->newContext($n);

                        $this->callfn($fn, [$cx, $i, $n]);
                }

                return $this;
        }

        public function filter(callable $fn)
        {
                $nodes = [];

                foreach ($this->nodes as $i => $n) {
                        $cx = $this->newContext($n);

                        $ret = $this->callfn($fn, [$cx, $i, $n]);

                        if ($ret !== false) {
                                $nodes[] = $n;
                        }
                }

                return $this->newContext($nodes);
        }

        // addChild($child, $value?, $attributes? = [], $switchContext? = false)
        public function addChild($child, ...$optionals)
        {
                return $this->handler->insertElement($this->nodes, $child, $optionals, function ($parent, $element) {
                        return $parent->appendChild($element);
                }, $this);
        }

        // Alias of ->addChild().
        public function add($child, ...$optionals)
        {
                return $this->addChild($child, ...$optionals);
        }

        public function prependSibling($sibling, ...$optionals)
        {
                return $this->handler->insertElement($this->nodes, $sibling, $optionals, function ($sibling, $element) {
                        return $sibling->parentNode->insertBefore($element, $sibling);
                }, $this);
        }

        // Alias of ->prependSibling().
        public function prepend($sibling, ...$optionals)
        {
                return $this->prependSibling($sibling, ...$optionals);
        }

        // Alias of ->prependSibling().
        public function insertSiblingBefore($sibling, ...$optionals)
        {
                return $this->prependSibling($sibling, ...$optionals);
        }

        public function appendSibling($sibling, ...$optionals)
        {
                return $this->handler->insertElement($this->nodes, $sibling, $optionals, function ($sibling, $element) {
                        // If ->nextSibling is null, $element is simply appended as last sibling.
                        return $sibling->parentNode->insertBefore($element, $sibling->nextSibling);
                }, $this);
        }

        // Alias of ->appendSibling().
        public function append($sibling, ...$optionals)
        {
                return $this->appendSibling($sibling, ...$optionals);
        }

        // Arguments can be in the form of:
        // setAttribute($name, $value)
        // setAttribute(['name' => 'value', ...])
        public function setAttribute(...$arguments)
        {
                // Default case is:
                // [ 'name' => 'value', ... ]
                $attrs = $arguments[0];

                // If the first argument is not an array,
                // the user has passed two arguments:
                // 1. is the attribute name
                // 2. is the attribute value
                if (! \is_array($arguments[0])) {
                        $val = isset($arguments[1]) ? $arguments[1]: '';
                        $attrs = [$arguments[0] => $val];
                }

                foreach ($this->nodes as $n) {
                        foreach ($attrs as $k => $v) {
                                if (\is_integer($k)) {
                                        $k = $v;
                                        $v = null;
                                }

                                // Algorithm 1:
                                $n->setAttribute($k, $v);

                                // Algorithm 2:
                                // $n->setAttributeNode(new \DOMAttr($k, $v));

                                // Algorithm 3:
                                // $n->appendChild(new \DOMAttr($k, $v));

                                // Algorithm 2 and 3 have a different behaviour
                                // from Algorithm 1.
                                // The attribute is still created or setted, but
                                // changing the value of an existing attribute
                                // changes even the order of that attribute
                                // in the attribute list.
                        }
                }

                return $this;
        }

        // Alias of ->setAttribute().
        public function attr(...$arguments)
        {
                return $this->setAttribute(...$arguments);
        }

        public function setText($text)
        {
                foreach ($this->nodes as $n) {
                        // Algorithm 1:
                        $n->nodeValue = $text;

                        // Algorithm 2:
                        // foreach ($n->childNodes as $c) {
                        //         $n->removeChild($c);
                        // }
                        // $n->appendChild(new \DOMText($text));

                        // Algorithm 3:
                        // foreach ($n->childNodes as $c) {
                        //         $n->replaceChild(new \DOMText($text), $c);
                        // }
                }

                return $this;
        }

        // Alias of ->setText().
        public function text($text)
        {
                return $this->setText($text);
        }

        public function addText($text)
        {
                foreach ($this->nodes as $n) {
                        $n->appendChild(new \DOMText($text));
                }

                return $this;
        }

        public function setCdata($text)
        {
                foreach ($this->nodes as $n) {
                        $n->nodeValue = '';
                        $n->appendChild(new \DOMCDATASection($text));
                }

                return $this;
        }

        // Alias of ->setCdata().
        public function cdata($text)
        {
                return $this->setCdata($text);
        }

        public function addCdata($text)
        {
                foreach ($this->nodes as $n) {
                        $n->appendChild(new \DOMCDATASection($text));
                }

                return $this;
        }

        public function setComment($text)
        {
                foreach ($this->nodes as $n) {
                        $n->nodeValue = '';
                        $n->appendChild(new \DOMComment($text));
                }

                return $this;
        }

        // Alias of ->setComment().
        public function comment($text)
        {
                return $this->setComment($text);
        }

        public function addComment($text)
        {
                foreach ($this->nodes as $n) {
                        $n->appendChild(new \DOMComment($text));
                }

                return $this;
        }

        public function remove(...$query)
        {
                // Arguments can be empty, a string or an array of strings.

                if (empty($query)) {
                        // The user has requested to remove the nodes of this context.
                        $targets = $this->nodes;
                } else {
                        $targets = $this->query(...$query);
                }

                foreach ($targets as $t) {
                        $t->parentNode->removeChild($t);
                }

                return $this;
        }

        public function dom()
        {
                return $this->document->dom;
        }

        // This method should be called 'array',
        // but for compatibility with PHP 5.6
        // it is shadowed by the __call() method.
        public function array_()
        {
                return $this->nodes;
        }

        public function __toString()
        {
                return $this->xml();
        }

        public function xml($strip = false)
        {
                return FluidHelper::domnodesToString($this->nodes);
        }

        public function html($strip = false)
        {
                return FluidHelper::domnodesToString($this->nodes, true);
        }

        protected function newContext(&$context)
        {
                return new FluidContext($this->document, $this->handler, $context);
        }

        protected function resolveQuery($query)
        {
                $matched = false;

                $is_dot   = $query === '.';
                $matched  = $matched || $is_dot;

                $slash    = ! $matched && $query[0] === '/';
                $matched  = $matched || $slash;

                $dotslash = ! $matched && $query[0] === '.' && $query[1] === '/';
                $matched  = $matched || $dotslash;

                $dotdot   = ! $matched && $query[0] === '.' && $query[1] === '.';
                $matched  = $matched || $dotdot;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

                if ($is_dot || $slash || $dotslash || $dotdot) {
                        return $query;
                }

                return CssTranslator::xpath($query);
        }

        protected function filterQueryResults(&$results)
        {
                $set = [];

                foreach ($results as $r) {
                        $found = false;

                        foreach ($set as $u) {
                                $found = ($r === $u) || $found;
                        }

                        if (! $found) {
                                $set[] = $r;
                        }
                }

                return $set;
        }

        protected function callfn($fn, $args)
        {
                if ($fn instanceof \Closure) {
                        $bind = \array_shift($args);

                        $fn = $fn->bindTo($bind);

                        // It is faster than \call_user_func.
                        return $fn(...$args);
                }

                return \call_user_func($fn, ...$args);
        }
}


1			<?php
2
3			namespace FluidXml;
4
5			/**
6			* @method array array()
7			*/
8			class FluidContext implements FluidInterface, \ArrayAccess, \Iterator
9			{
10			use NewableTrait,
11			FluidSaveTrait,
12			ReservedCallTrait, // For compatibility with PHP 5.6.
13			ReservedCallStaticTrait; // For compatibility with PHP 5.6.
14
15			private $document;
16			private $handler;
17			private $nodes = [];
18			private $seek = 0;
19
20			public function __construct($document, $handler, $context)
21			{
22			$this->document = $document;
23			$this->handler = $handler;
24
25			if (! \is_array($context) && ! $context instanceof \Traversable) {
26			// DOMDocument, DOMElement and DOMNode are not iterable.
27			// DOMNodeList and FluidContext are iterable.
28			$context = [ $context ];
29			}
30
31			foreach ($context as $n) {
32			if (! $n instanceof \DOMNode) {
33			throw new \Exception('Node type not recognized.');
34			}
35
36			$this->nodes[] = $n;
37			}
38			}
39
40			// \ArrayAccess interface.
41			public function offsetSet($offset, $value)
42			{
43			// if (\is_null($offset)) {
44			// $this->nodes[] = $value;
45			// } else {
46			// $this->nodes[$offset] = $value;
47			// }
48			throw new \Exception('Setting a context element is not allowed.');
49			}
50
51			// \ArrayAccess interface.
52			public function offsetExists($offset)
53			{
54			return isset($this->nodes[$offset]);
55			}
56
57			// \ArrayAccess interface.
58			public function offsetUnset($offset)
59			{
60			// unset($this->nodes[$offset]);
61			\array_splice($this->nodes, $offset, 1);
62			}
63
64			// \ArrayAccess interface.
65			public function offsetGet($offset)
66			{
67			if (isset($this->nodes[$offset])) {
68			return $this->nodes[$offset];
69			}
70
71			return null;
72			}
73
74			// \Iterator interface.
75			public function rewind()
76			{
77			$this->seek = 0;
78			}
79
80			// \Iterator interface.
81			public function current()
82			{
83			return $this->nodes[$this->seek];
84			}
85
86			// \Iterator interface.
87			public function key()
88			{
89			return $this->seek;
90			}
91
92			// \Iterator interface.
93			public function next()
94			{
95			++$this->seek;
96			}
97
98			// \Iterator interface.
99			public function valid()
100			{
101			return isset($this->nodes[$this->seek]);
102			}
103
104			public function length()
105			{
106			return \count($this->nodes);
107			}
108
109			// Alias of ->length().
110			public function size()
111			{
112			return $this->length();
113			}
114
115			public function query(...$query)
116			{
117			if (\is_array($query[0])) {
118			$query = $query[0];
119			}
120
121			$results = [];
122
123			$xp = $this->document->xpath;
124
125			foreach ($this->nodes as $n) {
126			foreach ($query as $q) {
127			$q = $this->resolveQuery($q);
128
129			// Returns a DOMNodeList.
130			$res = $xp->query($q, $n);
131
132			// Algorithm 1:
133			// $results = \array_merge($results, \iterator_to_array($res));
134
135			// Algorithm 2:
136			// It is faster than \iterator_to_array and a lot faster
137			// than \iterator_to_array + \array_merge.
138			foreach ($res as $r) {
139			$results[] = $r;
140			}
141
142			// Algorithm 3:
143			// for ($i = 0, $l = $res->length; $i < $l; ++$i) {
144			// $results[] = $res->item($i);
145			// }
146			}
147			}
148
149			// Performing over multiple sibling nodes a query that ascends
150			// the xpath, relative (../..) or absolute (//), returns identical
151			// matching results that must be collapsed in an unique result
152			// otherwise a subsequent operation is performed multiple times.
153			$results = $this->filterQueryResults($results);
154
155			return $this->newContext($results);
156			}
157
158			public function __invoke(...$query)
159			{
160			return $this->query(...$query);
161			}
162
163			public function times($times, callable $fn = null)
164			{
165			if ($fn === null) {
166			return new FluidRepeater($this->document, $this->handler, $this, $times);
167			}
168
169			for ($i = 0; $i < $times; ++$i) {
170			$this->callfn($fn, [$this, $i]);
171			}
172
173			return $this;
174			}
175
176			public function each(callable $fn)
177			{
178			foreach ($this->nodes as $i => $n) {
179			$cx = $this->newContext($n);
180
181			$this->callfn($fn, [$cx, $i, $n]);
182			}
183
184			return $this;
185			}
186
187			public function filter(callable $fn)
188			{
189			$nodes = [];
190
191			foreach ($this->nodes as $i => $n) {
192			$cx = $this->newContext($n);
193
194			$ret = $this->callfn($fn, [$cx, $i, $n]);
195
196			if ($ret !== false) {
197			$nodes[] = $n;
198			}
199			}
200
201			return $this->newContext($nodes);
202			}
203
204			// addChild($child, $value?, $attributes? = [], $switchContext? = false)
205			public function addChild($child, ...$optionals)
206			{
207			return $this->handler->insertElement($this->nodes, $child, $optionals, function ($parent, $element) {
208			return $parent->appendChild($element);
209			}, $this);
210			}
211
212			// Alias of ->addChild().
213			public function add($child, ...$optionals)
214			{
215			return $this->addChild($child, ...$optionals);
216			}
217
218			public function prependSibling($sibling, ...$optionals)
219			{
220			return $this->handler->insertElement($this->nodes, $sibling, $optionals, function ($sibling, $element) {
221			return $sibling->parentNode->insertBefore($element, $sibling);
222			}, $this);
223			}
224
225			// Alias of ->prependSibling().
226			public function prepend($sibling, ...$optionals)
227			{
228			return $this->prependSibling($sibling, ...$optionals);
229			}
230
231			// Alias of ->prependSibling().
232			public function insertSiblingBefore($sibling, ...$optionals)
233			{
234			return $this->prependSibling($sibling, ...$optionals);
235			}
236
237			public function appendSibling($sibling, ...$optionals)
238			{
239			return $this->handler->insertElement($this->nodes, $sibling, $optionals, function ($sibling, $element) {
240			// If ->nextSibling is null, $element is simply appended as last sibling.
241			return $sibling->parentNode->insertBefore($element, $sibling->nextSibling);
242			}, $this);
243			}
244
245			// Alias of ->appendSibling().
246			public function append($sibling, ...$optionals)
247			{
248			return $this->appendSibling($sibling, ...$optionals);
249			}
250
251			// Arguments can be in the form of:
252			// setAttribute($name, $value)
253			// setAttribute(['name' => 'value', ...])
254			public function setAttribute(...$arguments)
255			{
256			// Default case is:
257			// [ 'name' => 'value', ... ]
258			$attrs = $arguments[0];
259
260			// If the first argument is not an array,
261			// the user has passed two arguments:
262			// 1. is the attribute name
263			// 2. is the attribute value
264			if (! \is_array($arguments[0])) {
265			$val = isset($arguments[1]) ? $arguments[1]: '';
266			$attrs = [$arguments[0] => $val];
267			}
268
269			foreach ($this->nodes as $n) {
270			foreach ($attrs as $k => $v) {
271			if (\is_integer($k)) {
272			$k = $v;
273			$v = null;
274			}
275
276			// Algorithm 1:
277			$n->setAttribute($k, $v);
278
279			// Algorithm 2:
280			// $n->setAttributeNode(new \DOMAttr($k, $v));
281
282			// Algorithm 3:
283			// $n->appendChild(new \DOMAttr($k, $v));
284
285			// Algorithm 2 and 3 have a different behaviour
286			// from Algorithm 1.
287			// The attribute is still created or setted, but
288			// changing the value of an existing attribute
289			// changes even the order of that attribute
290			// in the attribute list.
291			}
292			}
293
294			return $this;
295			}
296
297			// Alias of ->setAttribute().
298			public function attr(...$arguments)
299			{
300			return $this->setAttribute(...$arguments);
301			}
302
303			public function setText($text)
304			{
305			foreach ($this->nodes as $n) {
306			// Algorithm 1:
307			$n->nodeValue = $text;
308
309			// Algorithm 2:
310			// foreach ($n->childNodes as $c) {
311			// $n->removeChild($c);
312			// }
313			// $n->appendChild(new \DOMText($text));
314
315			// Algorithm 3:
316			// foreach ($n->childNodes as $c) {
317			// $n->replaceChild(new \DOMText($text), $c);
318			// }
319			}
320
321			return $this;
322			}
323
324			// Alias of ->setText().
325			public function text($text)
326			{
327			return $this->setText($text);
328			}
329
330			public function addText($text)
331			{
332			foreach ($this->nodes as $n) {
333			$n->appendChild(new \DOMText($text));
334			}
335
336			return $this;
337			}
338
339			public function setCdata($text)
340			{
341			foreach ($this->nodes as $n) {
342			$n->nodeValue = '';
343			$n->appendChild(new \DOMCDATASection($text));
344			}
345
346			return $this;
347			}
348
349			// Alias of ->setCdata().
350			public function cdata($text)
351			{
352			return $this->setCdata($text);
353			}
354
355			public function addCdata($text)
356			{
357			foreach ($this->nodes as $n) {
358			$n->appendChild(new \DOMCDATASection($text));
359			}
360
361			return $this;
362			}
363
364			public function setComment($text)
365			{
366			foreach ($this->nodes as $n) {
367			$n->nodeValue = '';
368			$n->appendChild(new \DOMComment($text));
369			}
370
371			return $this;
372			}
373
374			// Alias of ->setComment().
375			public function comment($text)
376			{
377			return $this->setComment($text);
378			}
379
380			public function addComment($text)
381			{
382			foreach ($this->nodes as $n) {
383			$n->appendChild(new \DOMComment($text));
384			}
385
386			return $this;
387			}
388
389			public function remove(...$query)
390			{
391			// Arguments can be empty, a string or an array of strings.
392
393			if (empty($query)) {
394			// The user has requested to remove the nodes of this context.
395			$targets = $this->nodes;
396			} else {
397			$targets = $this->query(...$query);
398			}
399
400			foreach ($targets as $t) {
401			$t->parentNode->removeChild($t);
402			}
403
404			return $this;
405			}
406
407			public function dom()
408			{
409			return $this->document->dom;
410			}
411
412			// This method should be called 'array',
413			// but for compatibility with PHP 5.6
414			// it is shadowed by the __call() method.
415			public function array_()
416			{
417			return $this->nodes;
418			}
419
420			public function __toString()
421			{
422			return $this->xml();
423			}
424
425			public function xml($strip = false)
426			{
427			return FluidHelper::domnodesToString($this->nodes);
428			}
429
430			public function html($strip = false)
431			{
432			return FluidHelper::domnodesToString($this->nodes, true);
433			}
434
435			protected function newContext(&$context)
436			{
437			return new FluidContext($this->document, $this->handler, $context);
438			}
439
440			protected function resolveQuery($query)
441			{
442			$matched = false;
443
444			$is_dot = $query === '.';
445			$matched = $matched \|\| $is_dot;
446
447			$slash = ! $matched && $query[0] === '/';
448			$matched = $matched \|\| $slash;
449
450			$dotslash = ! $matched && $query[0] === '.' && $query[1] === '/';
451			$matched = $matched \|\| $dotslash;
452
453			$dotdot = ! $matched && $query[0] === '.' && $query[1] === '.';
454			$matched = $matched \|\| $dotdot;
			0 ignored issues – show Unused Code introduced 2016-02-21 01:50 UTC by Report Bug Copy Issue Report `$matched` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
455
456			if ($is_dot \|\| $slash \|\| $dotslash \|\| $dotdot) {
457			return $query;
458			}
459
460			return CssTranslator::xpath($query);
461			}
462
463			protected function filterQueryResults(&$results)
464			{
465			$set = [];
466
467			foreach ($results as $r) {
468			$found = false;
469
470			foreach ($set as $u) {
471			$found = ($r === $u) \|\| $found;
472			}
473
474			if (! $found) {
475			$set[] = $r;
476			}
477			}
478
479			return $set;
480			}
481
482			protected function callfn($fn, $args)
483			{
484			if ($fn instanceof \Closure) {
485			$bind = \array_shift($args);
486
487			$fn = $fn->bindTo($bind);
488
489			// It is faster than \call_user_func.
490			return $fn(...$args);
491			}
492
493			return \call_user_func($fn, ...$args);
494			}
495			}
496

servo-php / fluidxml

Push — master ( 60319d...b48e8d )

FluidContext::filterQueryResults() B

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like