Route::getUri() - Code Metrics - fwk/Core - Measure and Improve Code Quality continuously with Scrutinizer

Route::getUri() A
last analyzed 2016-06-03 12:37 UTC

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

Metric	Value
c	2
b	0
f	1
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
cc	1
eloc	2
nc	1
nop	0
crap	1

<?php
/**
 * Fwk
 *
 * Copyright (c) 2011-2014, Julien Ballestracci <[email protected]>.
 * All rights reserved.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * PHP Version 5.3
 * 
 * @category   Core
 * @package    Fwk\Core
 * @subpackage Components
 * @author     Julien Ballestracci <[email protected]>
 * @copyright  2011-2014 Julien Ballestracci <[email protected]>
 * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
 * @link       http://www.fwk.pw
 */
namespace Fwk\Core\Components\UrlRewriter;

/**
 * Route
 * 
 * @category   Utilities
 * @package    Fwk\Core
 * @subpackage Components
 * @author     Julien Ballestracci <[email protected]>
 * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
 * @link       http://www.fwk.pw
 */
class Route
{
    /**
     *
     * @var string 
     */
    protected $actionName;

    /**
     * 
     * @var array
     */
    protected $parameters = array();

    /**
     *
     * @var string 
     */
    protected $uri;

    /**
     *
     * @var string 
     */
    protected $regex;

    /**
     * Cached reverses of this route
     * @var array<string>
     */
    protected $reverseCache = array();

    /**
     * Constructor
     * 
     * @param string $uri 
     * 
     * @return void

     */
    public function __construct($actionName, $uri, array $parameters = array())
    {
        $this->uri          = $uri;
        $this->actionName   = $actionName;
        foreach ($parameters as $param) {
            $this->addParameter($param);
        }
    }

    /**
     *
     * @param RouteParameter $param 
     * 
     * @return Route
     */
    public function addParameter(RouteParameter $param)
    {
        $this->parameters[$param->getName()] = $param;
        
        return $this;
    }

    /**
     *
     * @return string 
     */
    public function getActionName()
    {
        return $this->actionName;
    }

    /**
     *
     * @return string 
     */
    public function getUri()
    {
        return $this->uri;
    }

    /**
     *
     * @param string $uri
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * 
     * @return boolean 
     */
    public function match($url) {

        $regex      = $this->toRegularExpr();
        
        return (preg_match($regex, $url) > 0);
    }

    /**
     *
     * @return string 
     */
    public function toRegularExpr()
    {
        if (!isset($this->regex)) {
            $regex  = sprintf("#^%s/?$#", rtrim($this->uri,'$'));

            if(preg_match_all('#:([a-zA-Z0-9_]+)#', $this->uri, $matches)) {
                foreach($matches[1] as $paramName) {
                    try {
                        $param      = $this->getParameter($paramName);
                        $required   = $param->isRequired();
                        $reg        = '(?P<'. $paramName .'>'. $param->getRegex() .')';

                        if (!$required) {
                            $reg    .= '?';
                        }

                        $regex  = str_replace(':'. $paramName, $reg, $regex);
                    } catch(Exception $e) {

                    }
                }
            }

            $this->regex = $regex;
        }

        return $this->regex;
    }

    /**
     *
     * @param string $name
     * 
     * @return RouteParameter
     */
    public function getParameter($name)
    {
        if(!isset($this->parameters[$name])) {
            throw new Exception(
                sprintf('Undefined route parameter "%s"', $name)
            );
        }
        
        return $this->parameters[$name];
    }

    /**
     *
     * @return array
     */
    public function getParameters()
    {
        return $this->parameters;
    }


    /**
     *
     * @param array $params 
     * 
     * @return string

     */
    public function getReverse(array $params = array(), $escapeAmp = false)
    {
        $cacheKey = $this->getCacheKey($params, $escapeAmp);
        if (isset($this->reverseCache[$cacheKey])) {
            return $this->reverseCache[$cacheKey];
        }

        $finalParams    = array();
        $regs           = array();

        foreach($this->getParameters() as $param) {
            $paramName  = $param->getName();
            $required   = $param->isRequired();
            $regex      = $param->getRegex();
            $value      = $param->getValue();

            if (isset($params[$paramName])) {
                $fValue = $params[$paramName];
                unset($params[$paramName]);
            } else {
                $fValue = $param->getValueOrDefault();
            }
            
            if (!empty($value) && $fValue !== $value) {
                $this->reverseCache[$cacheKey] = false;
                return false;
            }
            
            if(empty($fValue) && $required) {
                $this->reverseCache[$cacheKey] = false;
                return false;
            }
            
            if(!\preg_match(sprintf('#(%s)#', $regex), (string)$fValue)) {
                if ($required) {
                    $this->reverseCache[$cacheKey] = false;
                    return false;
                } else {
                    $fValue = null;
                }
            }

            $finalParams[]  = $fValue;
            $finds[]        = ':'. $paramName;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

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

    // do something with $myArray
}
            $regs[]         = sprintf('#(:%s\??)#', $paramName);
        }

        $cleanUpUri = \ltrim(\rtrim($this->uri,'$'), '^');
        $final      = preg_replace($regs, $finalParams, $cleanUpUri);
        if (count($params)) {
            $final .= '?'. http_build_query($params, '', ($escapeAmp === false ? '' : '&amp;'));
        }

        $this->reverseCache[$cacheKey] = $final;

        return $final;
    }

    public function getCacheKey(array $arguments, $escapeAmp)
    {
        $final = "";
        foreach ($arguments as $arg) {
            if (is_scalar($arg)) {
                $final .= (string)$arg;
            } else {
                $final .= serialize($arg);
            }
        }

        $final .= (string)$escapeAmp;

        return crc32($final);
    }

    public function __clone()
    {
        foreach ($this->parameters as &$param) {
            $param = clone $param;
        };
    }
}

1		<?php
2		/**
3		* Fwk
4		*
5		* Copyright (c) 2011-2014, Julien Ballestracci <[email protected]>.
6		* All rights reserved.
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*
11		* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
12		* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
13		* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
14		* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
15		* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
16		* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
17		* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
18		* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
19		* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
20		* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
21		* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
22		* POSSIBILITY OF SUCH DAMAGE.
23		*
24		* PHP Version 5.3
25		*
26		* @category Core
27		* @package Fwk\Core
28		* @subpackage Components
29		* @author Julien Ballestracci <[email protected]>
30		* @copyright 2011-2014 Julien Ballestracci <[email protected]>
31		* @license http://www.opensource.org/licenses/bsd-license.php BSD License
32		* @link http://www.fwk.pw
33		*/
34		namespace Fwk\Core\Components\UrlRewriter;
35
36		/**
37		* Route
38		*
39		* @category Utilities
40		* @package Fwk\Core
41		* @subpackage Components
42		* @author Julien Ballestracci <[email protected]>
43		* @license http://www.opensource.org/licenses/bsd-license.php BSD License
44		* @link http://www.fwk.pw
45		*/
46		class Route
47		{
48		/**
49		*
50		* @var string
51		*/
52		protected $actionName;
53
54		/**
55		*
56		* @var array
57		*/
58		protected $parameters = array();
59
60		/**
61		*
62		* @var string
63		*/
64		protected $uri;
65
66		/**
67		*
68		* @var string
69		*/
70		protected $regex;
71
72		/**
73		* Cached reverses of this route
74		* @var array<string>
75		*/
76		protected $reverseCache = array();
77
78		/**
79		* Constructor
80		*
81		* @param string $uri
82		*
83		* @return void
		0 ignored issues – show Comprehensibility Best Practice introduced 2016-06-03 12:37 UTC by Report Bug Copy Issue Report Adding a `@return` annotation to constructors is generally not recommended as a constructor does not have a meaningful return value. Adding a `@return` annotation to a constructor is not recommended, since a constructor does not have a meaningful return value. Please refer to the PHP core documentation on constructors. Loading history...
84		*/
85	13	public function __construct($actionName, $uri, array $parameters = array())
86		{
87	13	$this->uri = $uri;
88	13	$this->actionName = $actionName;
89	13	foreach ($parameters as $param) {
90	12	$this->addParameter($param);
91	13	}
92	13	}
93
94		/**
95		*
96		* @param RouteParameter $param
97		*
98		* @return Route
99		*/
100	13	public function addParameter(RouteParameter $param)
101		{
102	13	$this->parameters[$param->getName()] = $param;
103
104	13	return $this;
105		}
106
107		/**
108		*
109		* @return string
110		*/
111	6	public function getActionName()
112		{
113	6	return $this->actionName;
114		}
115
116		/**
117		*
118		* @return string
119		*/
120	1	public function getUri()
121		{
122	1	return $this->uri;
123		}
124
125		/**
126		*
127		* @param string $uri
		0 ignored issues – show Bug introduced 2016-06-03 12:37 UTC by Report Bug Copy Issue Report There is no parameter named `$uri`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
128		*
129		* @return boolean
130		*/
131	4	public function match($url) {
		0 ignored issues – show Coding Style introduced 2016-06-03 12:37 UTC by Report Bug Copy Issue Report `function match()` does not seem to conform to the naming convention (`^(?:is\|has\|should\|may\|su...ster\|unregister\|exists)`). This check examines a number of code elements and verifies that they conform to the given naming conventions. You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods. Loading history...
132	4	$regex = $this->toRegularExpr();
133
134	4	return (preg_match($regex, $url) > 0);
135		}
136
137		/**
138		*
139		* @return string
140		*/
141	4	public function toRegularExpr()
142		{
143	4	if (!isset($this->regex)) {
144	4	$regex = sprintf("#^%s/?$#", rtrim($this->uri,'$'));
145
146	4	if(preg_match_all('#:([a-zA-Z0-9_]+)#', $this->uri, $matches)) {
147	4	foreach($matches[1] as $paramName) {
148		try {
149	4	$param = $this->getParameter($paramName);
150	4	$required = $param->isRequired();
151	4	$reg = '(?P<'. $paramName .'>'. $param->getRegex() .')';
152
153	4	if (!$required) {
154		$reg .= '?';
155		}
156
157	4	$regex = str_replace(':'. $paramName, $reg, $regex);
158	4	} catch(Exception $e) {
		0 ignored issues – show Coding Style Comprehensibility introduced 2016-06-03 12:37 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
159		}
160	4	}
161	4	}
162
163	4	$this->regex = $regex;
164	4	}
165
166	4	return $this->regex;
167		}
168
169		/**
170		*
171		* @param string $name
172		*
173		* @return RouteParameter
174		*/
175	5	public function getParameter($name)
176		{
177	5	if(!isset($this->parameters[$name])) {
178	1	throw new Exception(
179	1	sprintf('Undefined route parameter "%s"', $name)
180	1	);
181		}
182
183	5	return $this->parameters[$name];
184		}
185
186		/**
187		*
188		* @return array
189		*/
190	7	public function getParameters()
191		{
192	7	return $this->parameters;
193		}
194
195
196		/**
197		*
198		* @param array $params
199		*
200		* @return string
		0 ignored issues – show Documentation introduced 2016-06-03 12:37 UTC by Report Bug Copy Issue Report Should the return type not be `string\|false`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
201		*/
202	3	public function getReverse(array $params = array(), $escapeAmp = false)
203		{
204	3	$cacheKey = $this->getCacheKey($params, $escapeAmp);
205	3	if (isset($this->reverseCache[$cacheKey])) {
206		return $this->reverseCache[$cacheKey];
207		}
208
209	3	$finalParams = array();
210	3	$regs = array();
211
212	3	foreach($this->getParameters() as $param) {
213	3	$paramName = $param->getName();
214	3	$required = $param->isRequired();
215	3	$regex = $param->getRegex();
216	3	$value = $param->getValue();
217
218	3	if (isset($params[$paramName])) {
219	3	$fValue = $params[$paramName];
220	3	unset($params[$paramName]);
221	3	} else {
222	2	$fValue = $param->getValueOrDefault();
223		}
224
225	3	if (!empty($value) && $fValue !== $value) {
226	1	$this->reverseCache[$cacheKey] = false;
227	1	return false;
228		}
229
230	3	if(empty($fValue) && $required) {
231	2	$this->reverseCache[$cacheKey] = false;
232	2	return false;
233		}
234
235	3	if(!\preg_match(sprintf('#(%s)#', $regex), (string)$fValue)) {
236	1	if ($required) {
237		$this->reverseCache[$cacheKey] = false;
238		return false;
239		} else {
240	1	$fValue = null;
241		}
242	1	}
243
244	3	$finalParams[] = $fValue;
245	3	$finds[] = ':'. $paramName;
		0 ignored issues – show Coding Style Comprehensibility introduced 2016-06-03 12:37 UTC by Report Bug Copy Issue Report `$finds` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$finds = 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...
246	3	$regs[] = sprintf('#(:%s\??)#', $paramName);
247	3	}
248
249	3	$cleanUpUri = \ltrim(\rtrim($this->uri,'$'), '^');
250	3	$final = preg_replace($regs, $finalParams, $cleanUpUri);
251	3	if (count($params)) {
252	1	$final .= '?'. http_build_query($params, '', ($escapeAmp === false ? '' : '&'));
253	1	}
254
255	3	$this->reverseCache[$cacheKey] = $final;
256
257	3	return $final;
258		}
259
260	3	public function getCacheKey(array $arguments, $escapeAmp)
261		{
262	3	$final = "";
263	3	foreach ($arguments as $arg) {
264	3	if (is_scalar($arg)) {
265	3	$final .= (string)$arg;
266	3	} else {
267	1	$final .= serialize($arg);
268		}
269	3	}
270
271	3	$final .= (string)$escapeAmp;
272
273	3	return crc32($final);
274		}
275
276	3	public function __clone()
277		{
278	3	foreach ($this->parameters as &$param) {
279	2	$param = clone $param;
280	3	};
281		}
282		}

fwk / Core

Route::getUri() A last analyzed 2016-06-03 12:37 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Route::getUri() A
last analyzed 2016-06-03 12:37 UTC