Route::getRule() - Code Metrics - Inspection of "intermediate" - canax/router - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f97d4a...febe27 )

by Mikael

created 2017-08-11 04:57 UTC

Route::getRule() A

↳ Parent: Route

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	1
Bugs	0	Features	0

Metric	Value
c	1
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

namespace Anax\Route;

/**
 * A container for routes.
 *
 */
class Route
{
    /**
     * @var string       $name      a name for this route.
     * @var string       $info      description of route.
     * @var string|array $method    the method(s) to support
     * @var string       $rule      the path rule for this route
     * @var callable     $action    the callback to handle this route
     * @var null|array   $arguments arguments for the callback, extracted
     *                              from path
     */
    private $name;
    private $info;
    private $method;
    private $rule;
    private $action;
    private $arguments = [];



    /**
     * Set values for route.
     *
     * @param null|string       $rule   for this route
     * @param callable          $action callable to implement a controller for
     *                                  the route
     * @param null|string|array $method as request method to support
     * @param null|string       $info   description of the route
     *
     * @return $this
     */
    public function set($rule, $action = null, $method = null, $info = null)
    {
        $this->rule = $rule;
        $this->action = $action;
        $this->info = $info;

        $this->method = $method;
        if (is_string($method)) {
            $this->method = array_map("trim", explode("|", $method));
        }
        if (is_array($this->method)) {
            $this->method = array_map("strtoupper", $this->method);
        }

        return $this;
    }



    /**
     * Check if part of route is a argument and optionally match type
     * as a requirement {argument:type}.
     *
     * @param string $rulePart   the rule part to check.
     * @param string $queryPart  the query part to check.
     * @param array  &$args      add argument to args array if matched
     *
     * @return boolean
     */
    private function checkPartAsArgument($rulePart, $queryPart, &$args)
    {
        if (substr($rulePart, -1) == "}"
            && !is_null($queryPart)
        ) {
            $part = substr($rulePart, 1, -1);
            $pos = strpos($part, ":");
            $type = null;
            if ($pos !== false) {
                $type = substr($part, $pos + 1);
                if (! $this->checkPartMatchingType($queryPart, $type)) {
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                    return false;
                }
            }
            $args[] = $this->typeConvertArgument($queryPart, $type);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            return true;
        }
        return false;
    }



    /**
     * Check if value is matching a certain type of values.
     *
     * @param string $value   the value to check.
     * @param array  $type    the expected type to check against.
     *
     * @return boolean
     */
    private function checkPartMatchingType($value, $type)
    {
        switch ($type) {
            case "digit":
                return ctype_digit($value);
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            case "hex":
                return ctype_xdigit($value);
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            case "alpha":
                return ctype_alpha($value);
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            case "alphanum":
                return ctype_alnum($value);
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            default:
                return false;
        }
    }



    /**
     * Check if value is matching a certain type and do type
     * conversion accordingly.
     *
     * @param string $value   the value to check.
     * @param array  $type    the expected type to check against.
     *
     * @return boolean
     */
    private function typeConvertArgument($value, $type)
    {
        switch ($type) {
            case "digit":
                return (int) $value;
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            default:
                return $value;
        }
    }



    /**
     * Match part of rule and query.
     *
     * @param string $rulePart   the rule part to check.
     * @param string $queryPart  the query part to check.
     * @param array  &$args      add argument to args array if matched
     *
     * @return boolean
     */
    private function matchPart($rulePart, $queryPart, &$args)
    {
        $match = false;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        $first = isset($rulePart[0]) ? $rulePart[0] : '';
        switch ($first) {
            case '*':
                $match = true;
                break;

            case '{':
                $match = $this->checkPartAsArgument($rulePart, $queryPart, $args);
                break;

            default:
                $match = ($rulePart == $queryPart);
                break;
        }
        return $match;
    }



    /**
     * Check if the request method matches.
     *
     * @param string $method as request method
     *
     * @return boolean true if request method matches
     */
    public function matchRequestMethod($method)
    {
        if ($method && is_array($this->method) && !in_array($method, $this->method)
            || (is_null($method) && !empty($this->method))
        ) {
            return false;
        }
        return true;
    }



    /**
     * Check if the route matches a query and request method.
     *
     * @param string $query  to match against
     * @param string $method as request method
     *
     * @return boolean true if query matches the route
     */
    public function match($query, $method = null)
    {
        if (!$this->matchRequestMethod($method)) {
            return false;
        }

        // If any/default */** route, match anything
        if (is_null($this->rule)
            || in_array($this->rule, ["*", "**"])
        ) {
            return true;
        }

        // Check all parts to see if they matches
        $ruleParts  = explode('/', $this->rule);
        $queryParts = explode('/', $query);
        $ruleCount = max(count($ruleParts), count($queryParts));
        $args = [];

        for ($i = 0; $i < $ruleCount; $i++) {
            $rulePart  = isset($ruleParts[$i])  ? $ruleParts[$i]  : null;
            $queryPart = isset($queryParts[$i]) ? $queryParts[$i] : null;

            if ($rulePart === "**") {
                break;
            }

            if (!$this->matchPart($rulePart, $queryPart, $args)) {
                return false;
            }
        }

        $this->arguments = $args;
        return true;
    }



    /**
     * Handle the action for the route.
     *
     * @param string $di container with services
     *
     * @return mixed
     */
    public function handle($di = null)
    {
        if (is_callable($this->action)) {
            return call_user_func($this->action, ...$this->arguments);
        }

        // Try to load service from app/di injected container
        if ($di
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            && is_array($this->action)
            && isset($this->action[0])
            && isset($this->action[1])
            && is_string($this->action[0])
            && $di->has($this->action[0])

        ) {
            $service = $di->get($this->action[0]);

            if (is_callable([$service, $this->action[1]])) {
                return call_user_func(
                    [$service, $this->action[1]],
                    ...$this->arguments
                );
            }
        }
    }



    /**
     * Set the name of the route.
     *
     * @param string $name set a name for the route
     *
     * @return $this
     */
    public function setName($name)
    {
        $this->name = $name;
        return $this;
    }



    /**
     * Get information of the route.
     *
     * @return null|string as route information.
     */
    public function getInfo()
    {
        return $this->info;
    }



    /**
     * Get the rule for the route.
     *
     * @return string
     */
    public function getRule()
    {
        return $this->rule;
    }



    /**
     * Get the request method for the route.
     *
     * @return string representing the request method supported
     */
    public function getRequestMethod()
    {
        if (is_array($this->method)) {
            return implode("|", $this->method);
        }

        return $this->method;
    }
}


1		<?php
2
3		namespace Anax\Route;
4
5		/**
6		* A container for routes.
7		*
8		*/
9		class Route
10		{
11		/**
12		* @var string $name a name for this route.
13		* @var string $info description of route.
14		* @var string\|array $method the method(s) to support
15		* @var string $rule the path rule for this route
16		* @var callable $action the callback to handle this route
17		* @var null\|array $arguments arguments for the callback, extracted
18		* from path
19		*/
20		private $name;
21		private $info;
22		private $method;
23		private $rule;
24		private $action;
25		private $arguments = [];
26
27
28
29		/**
30		* Set values for route.
31		*
32		* @param null\|string $rule for this route
33		* @param callable $action callable to implement a controller for
34		* the route
35		* @param null\|string\|array $method as request method to support
36		* @param null\|string $info description of the route
37		*
38		* @return $this
39		*/
40	37	public function set($rule, $action = null, $method = null, $info = null)
41		{
42	37	$this->rule = $rule;
43	37	$this->action = $action;
44	37	$this->info = $info;
45
46	37	$this->method = $method;
47	37	if (is_string($method)) {
48	4	$this->method = array_map("trim", explode("\|", $method));
49	4	}
50	37	if (is_array($this->method)) {
51	9	$this->method = array_map("strtoupper", $this->method);
52	9	}
53
54	37	return $this;
55		}
56
57
58
59		/**
60		* Check if part of route is a argument and optionally match type
61		* as a requirement {argument:type}.
62		*
63		* @param string $rulePart the rule part to check.
64		* @param string $queryPart the query part to check.
65		* @param array &$args add argument to args array if matched
66		*
67		* @return boolean
68		*/
69	7	private function checkPartAsArgument($rulePart, $queryPart, &$args)
70		{
71	7	if (substr($rulePart, -1) == "}"
72	7	&& !is_null($queryPart)
73	7	) {
74	7	$part = substr($rulePart, 1, -1);
75	7	$pos = strpos($part, ":");
76	7	$type = null;
77	7	if ($pos !== false) {
78	2	$type = substr($part, $pos + 1);
79	2	if (! $this->checkPartMatchingType($queryPart, $type)) {
		0 ignored issues – show Documentation introduced 2017-06-27 09:15 UTC by Report Bug Copy Issue Report `$type` is of type `string`, but the function expects a `array`. 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... Bug Best Practice introduced 2017-03-13 17:07 UTC by Report Bug Copy Issue Report The expression `$this->checkPartMatchingType($queryPart, $type)` of type `boolean\|null` is loosely compared to `false`; this is ambiguous if the boolean can be false. You might want to explicitly use `!== null` instead. If an expression can have both `false`, and `null` as possible values. It is generally a good practice to always use strict comparison to clearly distinguish between those two values. $a = canBeFalseAndNull(); // Instead of if ( ! $a) { } // Better use one of the explicit versions: if ($a !== null) { } if ($a !== false) { } if ($a !== null && $a !== false) { } Loading history...
80	2	return false;
81		}
82	2	}
83	7	$args[] = $this->typeConvertArgument($queryPart, $type);
		0 ignored issues – show Documentation introduced 2017-06-27 15:04 UTC by Report Bug Copy Issue Report `$type` is of type `string\|null`, but the function expects a `array`. 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...
84	7	return true;
85		}
86	3	return false;
87		}
88
89
90
91		/**
92		* Check if value is matching a certain type of values.
93		*
94		* @param string $value the value to check.
95		* @param array $type the expected type to check against.
96		*
97		* @return boolean
98		*/
99	2	private function checkPartMatchingType($value, $type)
100		{
101		switch ($type) {
102	2	case "digit":
103	2	return ctype_digit($value);
104		break;
		0 ignored issues – show Unused Code introduced 2017-03-13 17:07 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...
105
106	2	case "hex":
107	1	return ctype_xdigit($value);
108		break;
		0 ignored issues – show Unused Code introduced 2017-04-24 07:31 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...
109
110	2	case "alpha":
111	2	return ctype_alpha($value);
112		break;
		0 ignored issues – show Unused Code introduced 2017-04-24 07:28 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...
113
114	1	case "alphanum":
115	1	return ctype_alnum($value);
116		break;
		0 ignored issues – show Unused Code introduced 2017-03-13 17:07 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...
117
118		default:
119		return false;
120		}
121		}
122
123
124
125		/**
126		* Check if value is matching a certain type and do type
127		* conversion accordingly.
128		*
129		* @param string $value the value to check.
130		* @param array $type the expected type to check against.
131		*
132		* @return boolean
133		*/
134	7	private function typeConvertArgument($value, $type)
135		{
136		switch ($type) {
137	7	case "digit":
138	2	return (int) $value;
139		break;
		0 ignored issues – show Unused Code introduced 2017-06-27 09:15 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...
140
141	7	default:
142	7	return $value;
143	7	}
144		}
145
146
147
148		/**
149		* Match part of rule and query.
150		*
151		* @param string $rulePart the rule part to check.
152		* @param string $queryPart the query part to check.
153		* @param array &$args add argument to args array if matched
154		*
155		* @return boolean
156		*/
157	30	private function matchPart($rulePart, $queryPart, &$args)
158		{
159	30	$match = false;
		0 ignored issues – show Unused Code introduced 2017-03-03 15:59 UTC by Report Bug Copy Issue Report `$match` 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...
160	30	$first = isset($rulePart[0]) ? $rulePart[0] : '';
161		switch ($first) {
162	30	case '*':
163	1	$match = true;
164	1	break;
165
166	30	case '{':
167	7	$match = $this->checkPartAsArgument($rulePart, $queryPart, $args);
168	7	break;
169
170	29	default:
171	29	$match = ($rulePart == $queryPart);
172	29	break;
173	29	}
174	30	return $match;
175		}
176
177
178
179		/**
180		* Check if the request method matches.
181		*
182		* @param string $method as request method
183		*
184		* @return boolean true if request method matches
185		*/
186	36	public function matchRequestMethod($method)
187		{
188	36	if ($method && is_array($this->method) && !in_array($method, $this->method)
189	36	\|\| (is_null($method) && !empty($this->method))
190	36	) {
191	8	return false;
192		}
193	36	return true;
194		}
195
196
197
198		/**
199		* Check if the route matches a query and request method.
200		*
201		* @param string $query to match against
202		* @param string $method as request method
203		*
204		* @return boolean true if query matches the route
205		*/
206	36	public function match($query, $method = null)
207		{
208	36	if (!$this->matchRequestMethod($method)) {
209	8	return false;
210		}
211
212		// If any/default /* route, match anything
213	36	if (is_null($this->rule)
214	33	\|\| in_array($this->rule, ["", "*"])
215	36	) {
216	6	return true;
217		}
218
219		// Check all parts to see if they matches
220	30	$ruleParts = explode('/', $this->rule);
221	30	$queryParts = explode('/', $query);
222	30	$ruleCount = max(count($ruleParts), count($queryParts));
223	30	$args = [];
224
225	30	for ($i = 0; $i < $ruleCount; $i++) {
226	30	$rulePart = isset($ruleParts[$i]) ? $ruleParts[$i] : null;
227	30	$queryPart = isset($queryParts[$i]) ? $queryParts[$i] : null;
228
229	30	if ($rulePart === "**") {
230	2	break;
231		}
232
233	30	if (!$this->matchPart($rulePart, $queryPart, $args)) {
234	14	return false;
235		}
236	29	}
237
238	29	$this->arguments = $args;
239	29	return true;
240		}
241
242
243
244		/**
245		* Handle the action for the route.
246		*
247		* @param string $di container with services
248		*
249		* @return mixed
250		*/
251	26	public function handle($di = null)
252		{
253	26	if (is_callable($this->action)) {
254	26	return call_user_func($this->action, ...$this->arguments);
255		}
256
257		// Try to load service from app/di injected container
258		if ($di
		0 ignored issues – show Bug Best Practice introduced 2017-08-10 15:36 UTC by Report Bug Copy Issue Report The expression `$di` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
259		&& is_array($this->action)
260		&& isset($this->action[0])
261		&& isset($this->action[1])
262		&& is_string($this->action[0])
263		&& $di->has($this->action[0])
		0 ignored issues – show Bug introduced 2017-08-10 15:36 UTC by Report Bug Copy Issue Report The method `has` cannot be called on `$di` (of type `string`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
264		) {
265		$service = $di->get($this->action[0]);
		0 ignored issues – show Bug introduced 2017-08-10 15:36 UTC by Report Bug Copy Issue Report The method `get` cannot be called on `$di` (of type `string`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
266		if (is_callable([$service, $this->action[1]])) {
267		return call_user_func(
268		[$service, $this->action[1]],
269		...$this->arguments
270		);
271		}
272		}
273		}
274
275
276
277		/**
278		* Set the name of the route.
279		*
280		* @param string $name set a name for the route
281		*
282		* @return $this
283		*/
284		public function setName($name)
285		{
286		$this->name = $name;
287		return $this;
288		}
289
290
291
292		/**
293		* Get information of the route.
294		*
295		* @return null\|string as route information.
296		*/
297		public function getInfo()
298		{
299		return $this->info;
300		}
301
302
303
304		/**
305		* Get the rule for the route.
306		*
307		* @return string
308		*/
309	24	public function getRule()
310		{
311	24	return $this->rule;
312		}
313
314
315
316		/**
317		* Get the request method for the route.
318		*
319		* @return string representing the request method supported
320		*/
321		public function getRequestMethod()
322		{
323		if (is_array($this->method)) {
324		return implode("\|", $this->method);
325		}
326
327		return $this->method;
328		}
329		}
330

canax / router

Push — master ( f97d4a...febe27 )

Route::getRule() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like