WhereFilter - Code Metrics - Inspection of "Make sure all objects given to Twig are jailed" - stakx-io/stakx - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#31)

by Vladimir

created 2017-01-17 20:40 UTC

WhereFilter A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	88
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
dl	0
loc	88
ccs	33
cts	33
cp	1
rs	10
c	2
b	0
f	0
wmc	19
lcom	0
cbo	2

5 Methods

Rating	Name	Size	Complexity
A	__invoke()	7	1
A	get()	4	1
B	search_r()	17	5
B	compare()	16	8
A	contains()	5	4

<?php

namespace allejo\stakx\Twig;

use Twig_Error_Syntax;

class WhereFilter
{
    /**
     * @param  array|\ArrayAccess[] $array      The elements to filter through
     * @param  string               $key        The key value in an associative array or FrontMatter
     * @param  string               $comparison The actual comparison symbols being used
     * @param  mixed                $value      The value we're searching for
     *
     * @return array
     */
    public function __invoke ($array, $key, $comparison, $value)
    {
        $results = array();
        $this->search_r($array, $key, $comparison, $value, $results);

        return $results;
    }

    /**
     * @return \Twig_SimpleFilter
     */
    public static function get ()
    {
        return new \Twig_SimpleFilter('where', new self());
    }

    /**
     * Recursive searching calling our comparison
     *
     * @param array|\ArrayAccess[] $array      The elements to filter through
     * @param string               $key        The key value in an associative array or FrontMatter
     * @param string               $comparison The actual comparison symbols being used
     * @param string               $value      The value we're searching for
     * @param array                $results    The reference to where to keep the filtered elements
     */
    private function search_r ($array, $key, $comparison, $value, &$results)

    {
        if (!is_array($array) && !($array instanceof \ArrayAccess))
        {
            return;
        }

        if ($this->compare($array, $key, $comparison, $value))
        {
            $results[] = $array;
        }

        foreach ($array as $subarray)
        {
            $this->search_r($subarray, $key, $comparison, $value, $results);
        }
    }

    /**
     * The logic for determining if an element matches the filter
     *
     * @param  array|\ArrayAccess[] $array      The elements to filter through
     * @param  string               $key        The key value in an associative array or FrontMatter
     * @param  string               $comparison The actual comparison symbols being used
     * @param  mixed                $value      The value we're searching for
     *
     * @return bool
     *
     * @throws Twig_Error_Syntax
     */
    private function compare ($array, $key, $comparison, $value)
    {
        switch ($comparison)
        {
            case "==": return ($array[$key] === $value);
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case "!=": return ($array[$key] !== $value);
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case ">" : return ($array[$key] > $value);
switch ($selector) {
    case "A": //right
        doSomething();
        break;
    case "B" : //wrong
        doSomethingElse();
        break;
}
            case ">=": return ($array[$key] >= $value);
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case "<" : return ($array[$key] < $value);
switch ($selector) {
    case "A": //right
        doSomething();
        break;
    case "B" : //wrong
        doSomethingElse();
        break;
}
            case "<=": return ($array[$key] <= $value);
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case "~=": return ($this->contains($array[$key], $value));
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;

            default:
                throw new Twig_Error_Syntax("Invalid where comparison ({$comparison})");
        }
    }

    private function contains ($haystack, $needle)
    {
        return ((is_array($haystack) && in_array($needle, $haystack)) ||
                (is_string($haystack) && strpos($haystack, $needle) !== false));
    }
}

1		<?php
2
3		namespace allejo\stakx\Twig;
4
5		use Twig_Error_Syntax;
6
7		class WhereFilter
8		{
9		/**
10		* @param array\|\ArrayAccess[] $array The elements to filter through
11		* @param string $key The key value in an associative array or FrontMatter
12		* @param string $comparison The actual comparison symbols being used
13		* @param mixed $value The value we're searching for
14		*
15		* @return array
16		*/
17		public function __invoke ($array, $key, $comparison, $value)
18	21	{
19		$results = array();
20	21	$this->search_r($array, $key, $comparison, $value, $results);
21	21
22		return $results;
23	20	}
24
25		/**
26		* @return \Twig_SimpleFilter
27		*/
28		public static function get ()
29	2	{
30		return new \Twig_SimpleFilter('where', new self());
31	2	}
32
33		/**
34		* Recursive searching calling our comparison
35		*
36		* @param array\|\ArrayAccess[] $array The elements to filter through
37		* @param string $key The key value in an associative array or FrontMatter
38		* @param string $comparison The actual comparison symbols being used
39		* @param string $value The value we're searching for
40		* @param array $results The reference to where to keep the filtered elements
41		*/
42		private function search_r ($array, $key, $comparison, $value, &$results)
		0 ignored issues – show Coding Style introduced 2016-08-21 19:38 UTC by Report Bug Copy Issue Report This method is not in camel caps format. This check looks for method names that are not written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection seeker becomes `databaseConnectionSeeker`. Loading history...
43	21	{
44		if (!is_array($array) && !($array instanceof \ArrayAccess))
45	21	{
46	21	return;
47	19	}
48
49		if ($this->compare($array, $key, $comparison, $value))
50	21	{
51	21	$results[] = $array;
52	15	}
53	15
54		foreach ($array as $subarray)
55	21	{
56		$this->search_r($subarray, $key, $comparison, $value, $results);
57	21	}
58	20	}
59	20
60		/**
61		* The logic for determining if an element matches the filter
62		*
63		* @param array\|\ArrayAccess[] $array The elements to filter through
64		* @param string $key The key value in an associative array or FrontMatter
65		* @param string $comparison The actual comparison symbols being used
66		* @param mixed $value The value we're searching for
67		*
68		* @return bool
69		*
70		* @throws Twig_Error_Syntax
71		*/
72		private function compare ($array, $key, $comparison, $value)
73	21	{
74		switch ($comparison)
75	21	{
76		case "==": return ($array[$key] === $value);
		0 ignored issues – show Coding Style introduced 2016-09-08 06:16 UTC by Report Bug Copy Issue Report The case body in a switch statement must start on the line following the statement. According to the PSR-2, the body of a case statement must start on the line immediately following the case statement. switch ($expr) { case "A": doSomething(); //right break; case "B": doSomethingElse(); //wrong break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history... Coding Style introduced 2016-09-08 06:16 UTC by Report Bug Copy Issue Report Terminating statement must be on a line by itself As per the PSR-2 coding standard, the `break` (or other terminating) statement must be on a line of its own. switch ($expr) { case "A": doSomething(); break; //wrong case "B": doSomething(); break; //right case "C:": doSomething(); return true; //right } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
77	21	case "!=": return ($array[$key] !== $value);
		0 ignored issues – show Coding Style introduced 2016-09-08 06:16 UTC by Report Bug Copy Issue Report The case body in a switch statement must start on the line following the statement. According to the PSR-2, the body of a case statement must start on the line immediately following the case statement. switch ($expr) { case "A": doSomething(); //right break; case "B": doSomethingElse(); //wrong break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history... Coding Style introduced 2016-09-08 06:16 UTC by Report Bug Copy Issue Report Terminating statement must be on a line by itself As per the PSR-2 coding standard, the `break` (or other terminating) statement must be on a line of its own. switch ($expr) { case "A": doSomething(); break; //wrong case "B": doSomething(); break; //right case "C:": doSomething(); return true; //right } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
78	21	case ">" : return ($array[$key] > $value);
		0 ignored issues – show Coding Style introduced 2016-09-08 06:16 UTC by Report Bug Copy Issue Report There must be no space before the colon in a CASE statement As per the PSR-2 coding standard, there must not be a space in front of the colon in case statements. switch ($selector) { case "A": //right doSomething(); break; case "B" : //wrong doSomethingElse(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history... Coding Style introduced 2016-09-08 06:16 UTC by Report Bug Copy Issue Report The case body in a switch statement must start on the line following the statement. According to the PSR-2, the body of a case statement must start on the line immediately following the case statement. switch ($expr) { case "A": doSomething(); //right break; case "B": doSomethingElse(); //wrong break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history... Coding Style introduced 2016-09-08 06:16 UTC by Report Bug Copy Issue Report Terminating statement must be on a line by itself As per the PSR-2 coding standard, the `break` (or other terminating) statement must be on a line of its own. switch ($expr) { case "A": doSomething(); break; //wrong case "B": doSomething(); break; //right case "C:": doSomething(); return true; //right } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
79	1	case ">=": return ($array[$key] >= $value);
		0 ignored issues – show Coding Style introduced 2016-09-08 06:16 UTC by Report Bug Copy Issue Report The case body in a switch statement must start on the line following the statement. According to the PSR-2, the body of a case statement must start on the line immediately following the case statement. switch ($expr) { case "A": doSomething(); //right break; case "B": doSomethingElse(); //wrong break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history... Coding Style introduced 2016-09-08 06:16 UTC by Report Bug Copy Issue Report Terminating statement must be on a line by itself As per the PSR-2 coding standard, the `break` (or other terminating) statement must be on a line of its own. switch ($expr) { case "A": doSomething(); break; //wrong case "B": doSomething(); break; //right case "C:": doSomething(); return true; //right } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
80	1	case "<" : return ($array[$key] < $value);
		0 ignored issues – show Coding Style introduced 2016-09-08 06:16 UTC by Report Bug Copy Issue Report There must be no space before the colon in a CASE statement As per the PSR-2 coding standard, there must not be a space in front of the colon in case statements. switch ($selector) { case "A": //right doSomething(); break; case "B" : //wrong doSomethingElse(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history... Coding Style introduced 2016-09-08 06:16 UTC by Report Bug Copy Issue Report The case body in a switch statement must start on the line following the statement. According to the PSR-2, the body of a case statement must start on the line immediately following the case statement. switch ($expr) { case "A": doSomething(); //right break; case "B": doSomethingElse(); //wrong break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history... Coding Style introduced 2016-09-08 06:16 UTC by Report Bug Copy Issue Report Terminating statement must be on a line by itself As per the PSR-2 coding standard, the `break` (or other terminating) statement must be on a line of its own. switch ($expr) { case "A": doSomething(); break; //wrong case "B": doSomething(); break; //right case "C:": doSomething(); return true; //right } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
81	1	case "<=": return ($array[$key] <= $value);
		0 ignored issues – show Coding Style introduced 2016-09-08 06:16 UTC by Report Bug Copy Issue Report The case body in a switch statement must start on the line following the statement. According to the PSR-2, the body of a case statement must start on the line immediately following the case statement. switch ($expr) { case "A": doSomething(); //right break; case "B": doSomethingElse(); //wrong break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history... Coding Style introduced 2016-09-08 06:16 UTC by Report Bug Copy Issue Report Terminating statement must be on a line by itself As per the PSR-2 coding standard, the `break` (or other terminating) statement must be on a line of its own. switch ($expr) { case "A": doSomething(); break; //wrong case "B": doSomething(); break; //right case "C:": doSomething(); return true; //right } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
82		case "~=": return ($this->contains($array[$key], $value));
		0 ignored issues – show Coding Style introduced 2016-09-08 06:16 UTC by Report Bug Copy Issue Report The case body in a switch statement must start on the line following the statement. According to the PSR-2, the body of a case statement must start on the line immediately following the case statement. switch ($expr) { case "A": doSomething(); //right break; case "B": doSomethingElse(); //wrong break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history... Coding Style introduced 2016-09-08 06:16 UTC by Report Bug Copy Issue Report Terminating statement must be on a line by itself As per the PSR-2 coding standard, the `break` (or other terminating) statement must be on a line of its own. switch ($expr) { case "A": doSomething(); break; //wrong case "B": doSomething(); break; //right case "C:": doSomething(); return true; //right } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
83	21
84	21	default:
85	21	throw new Twig_Error_Syntax("Invalid where comparison ({$comparison})");
86		}
87		}
88
89		private function contains ($haystack, $needle)
90	20	{
91	14	return ((is_array($haystack) && in_array($needle, $haystack)) \|\|
92	11	(is_string($haystack) && strpos($haystack, $needle) !== false));
93		}
94		}

stakx-io / stakx

Pull Request — master (#31)

WhereFilter A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

5 Methods

Duplication Side-by-Side

Filter issues like