Route.php

Go to the documentation of this file.

<?php
class Slim_Route {

    protected $pattern;

    protected $callable;

    protected $conditions = array();

    protected static $defaultConditions = array();

    protected $name;

    protected $params = array();

    protected $methods = array();

    protected $router;

    protected $middleware = array();

    public function __construct( $pattern, $callable ) {
        $this->setPattern($pattern);
        $this->setCallable($callable);
        $this->setConditions(self::getDefaultConditions());
    }

    public static function setDefaultConditions( array $defaultConditions ) {
        self::$defaultConditions = $defaultConditions;
    }

    public static function getDefaultConditions() {
        return self::$defaultConditions;
    }

    public function getPattern() {
        return $this->pattern;
    }

    public function setPattern( $pattern ) {
        $this->pattern = str_replace(')', ')?', (string)$pattern);
    }

    public function getCallable() {
        return $this->callable;
    }

    public function setCallable($callable) {
        $this->callable = $callable;
    }

    public function getConditions() {
        return $this->conditions;
    }

    public function setConditions( array $conditions ) {
        $this->conditions = $conditions;
    }

    public function getName() {
        return $this->name;
    }

    public function setName( $name ) {
        $this->name = (string)$name;
        $this->router->cacheNamedRoute($this->name, $this);
    }

    public function getParams() {
        return $this->params;
    }

    public function setHttpMethods() {
        $args = func_get_args();
        $this->methods = $args;
    }

    public function getHttpMethods() {
        return $this->methods;
    }

    public function appendHttpMethods() {
        $args = func_get_args();
        $this->methods = array_merge($this->methods, $args);
    }

    public function via() {
        $args = func_get_args();
        $this->methods = array_merge($this->methods, $args);
        return $this;
    }

    public function supportsHttpMethod( $method ) {
        return in_array($method, $this->methods);
    }

    public function getRouter() {
        return $this->router;
    }

    public function setRouter( Slim_Router $router ) {
        $this->router = $router;
    }

    public function getMiddleware() {
        return $this->middleware;
    }

    public function setMiddleware( $middleware ) {
        if ( is_callable($middleware) ) {
            $this->middleware[] = $middleware;
        } else if ( is_array($middleware) ) {
            $this->middleware = array_merge($this->middleware, $middleware);
        } else {
            throw new InvalidArgumentException('Route middleware must be callable or an array of callables');
        }
        return $this;
    }

    public function matches( $resourceUri ) {
        //Extract URL params
        preg_match_all('@:([\w]+)@', $this->pattern, $paramNames, PREG_PATTERN_ORDER);
        $paramNames = $paramNames[0];

        //Convert URL params into regex patterns, construct a regex for this route
        $patternAsRegex = preg_replace_callback('@:[\w]+@', array($this, 'convertPatternToRegex'), $this->pattern);
        if ( substr($this->pattern, -1) === '/' ) {
            $patternAsRegex = $patternAsRegex . '?';
        }
        $patternAsRegex = '@^' . $patternAsRegex . '$@';

        //Cache URL params' names and values if this route matches the current HTTP request
        if ( preg_match($patternAsRegex, $resourceUri, $paramValues) ) {
            array_shift($paramValues);
            foreach ( $paramNames as $index => $value ) {
                $val = substr($value, 1);
                if ( isset($paramValues[$val]) ) {
                    $this->params[$val] = urldecode($paramValues[$val]);
                }
            }
            return true;
        } else {
            return false;
        }
    }

    protected function convertPatternToRegex( $matches ) {
        $key = str_replace(':', '', $matches[0]);
        if ( array_key_exists($key, $this->conditions) ) {
            return '(?P<' . $key . '>' . $this->conditions[$key] . ')';
        } else {
            return '(?P<' . $key . '>[a-zA-Z0-9_\-\.\!\~\*\\\'\(\)\:\@\&\=\$\+,%]+)';
        }
    }

    public function name( $name ) {
        $this->setName($name);
        return $this;
    }

    public function conditions( array $conditions ) {
        $this->conditions = array_merge($this->conditions, $conditions);
        return $this;
    }

    public function dispatch() {
        if ( substr($this->pattern, -1) === '/' && substr($this->router->getRequest()->getResourceUri(), -1) !== '/' ) {
            throw new Slim_Exception_RequestSlash();
        }
        //Invoke middleware
        foreach ( $this->middleware as $mw ) {
            if ( is_callable($mw) ) {
                call_user_func($mw);
            }
        }
        //Invoke callable
        if ( is_callable($this->getCallable()) ) {
            call_user_func_array($this->callable, array_values($this->params));
            return true;
        }
        return false;
    }

}