Fwk\Core\Components\UrlRewriter\Route

Complexity

Total Complexity

32

Size/Duplication

Total Lines	237
Duplicated Lines	0 %

Coupling/Cohesion

Dependencies

2

Test Coverage

Coverage

94.85%

Importance

Changes	10
Bugs	6	Features	4

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	2
A	addParameter()	0	6	1
A	getActionName()	0	4	1
A	getUri()	0	4	1
A	match()	0	5	1
B	toRegularExpr()	0	27	6
A	getParameter()	0	10	2
A	getParameters()	0	4	1
C	getReverse()	0	57	12
A	getCacheKey()	0	15	3
A	__clone()	0	6	2

<?php
/**
 * Fwk
 *
 * Copyright (c) 2011-2014, Julien Ballestracci <julien@nitronet.org>.
 * 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 <julien@nitronet.org>
 * @copyright  2011-2014 Julien Ballestracci <julien@nitronet.org>
 * @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 <julien@nitronet.org>
 * @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

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     */
    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

There is no parameter named $uri. Was it maybe removed?

     * 
     * @return boolean 
     */
    public function match($url) {

function match() does not seem to conform to the naming convention (^(?:is|has|should|may|supports|register|unregister|exists)).

        $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) {

Consider adding a comment why this CATCH block is empty.

                    }
                }
            }

            $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

Should the return type not be string|false?

     */
    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;

$finds was never initialized. Although not strictly required by PHP, it is generally a good practice to add $finds = array(); before regardless.

            $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 ? '' : '&'));
        }

        $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;
        };
    }
}