Overview

Namespaces

  • Coast
    • App
      • Access
      • Executable
    • Controller
    • Csrf
    • Dir
    • Feed
    • File
    • Filter
      • Rule
    • Http
    • Image
    • Model
      • Exception
    • Resolver
    • Router
    • Sitemap
    • Transformer
      • Rule
    • Validator
      • Rule
    • View

Classes

  • Coast\Acl
  • Coast\App
  • Coast\App\Subpath
  • Coast\Coast
  • Coast\Collection
  • Coast\Config
  • Coast\Controller
  • Coast\Controller\Action
  • Coast\Csp
  • Coast\Csrf
  • Coast\Dir
  • Coast\Dir\Iterator
  • Coast\Feed
  • Coast\Feed\Content
  • Coast\Feed\Item
  • Coast\Feed\Person
  • Coast\File
  • Coast\File\Path
  • Coast\Filter
  • Coast\Filter\Rule
  • Coast\Filter\Rule\CamelCase
  • Coast\Filter\Rule\CamelCaseSplit
  • Coast\Filter\Rule\Custom
  • Coast\Filter\Rule\DecimalType
  • Coast\Filter\Rule\EmailAddress
  • Coast\Filter\Rule\EncodeSpecialChars
  • Coast\Filter\Rule\FloatType
  • Coast\Filter\Rule\IntegerType
  • Coast\Filter\Rule\LowerCase
  • Coast\Filter\Rule\NumberType
  • Coast\Filter\Rule\Slugify
  • Coast\Filter\Rule\StripTags
  • Coast\Filter\Rule\TitleCase
  • Coast\Filter\Rule\Trim
  • Coast\Filter\Rule\UpperCase
  • Coast\Filter\Rule\Url
  • Coast\Http
  • Coast\Http\Request
  • Coast\Http\Response
  • Coast\Image
  • Coast\Lazy
  • Coast\Model
  • Coast\Model\Metadata
  • Coast\Path
  • Coast\Request
  • Coast\Resolver
  • Coast\Response
  • Coast\Router
  • Coast\Session
  • Coast\Sitemap
  • Coast\Sitemap\Url
  • Coast\Transformer
  • Coast\Transformer\Rule
  • Coast\Transformer\Rule\BooleanType
  • Coast\Transformer\Rule\Custom
  • Coast\Transformer\Rule\DateTime
  • Coast\Transformer\Rule\IntegerType
  • Coast\Transformer\Rule\NullType
  • Coast\Transformer\Rule\Url
  • Coast\Url
  • Coast\Validator
  • Coast\Validator\Rule
  • Coast\Validator\Rule\ArrayType
  • Coast\Validator\Rule\BooleanType
  • Coast\Validator\Rule\Count
  • Coast\Validator\Rule\Custom
  • Coast\Validator\Rule\DateTime
  • Coast\Validator\Rule\DecimalType
  • Coast\Validator\Rule\EmailAddress
  • Coast\Validator\Rule\Equals
  • Coast\Validator\Rule\File
  • Coast\Validator\Rule\FloatType
  • Coast\Validator\Rule\Func
  • Coast\Validator\Rule\Hostname
  • Coast\Validator\Rule\In
  • Coast\Validator\Rule\IntegerType
  • Coast\Validator\Rule\IpAddress
  • Coast\Validator\Rule\Length
  • Coast\Validator\Rule\Max
  • Coast\Validator\Rule\Min
  • Coast\Validator\Rule\Not
  • Coast\Validator\Rule\NumberType
  • Coast\Validator\Rule\ObjectType
  • Coast\Validator\Rule\Password
  • Coast\Validator\Rule\Range
  • Coast\Validator\Rule\Recaptcha
  • Coast\Validator\Rule\Regex
  • Coast\Validator\Rule\Set
  • Coast\Validator\Rule\StringType
  • Coast\Validator\Rule\Upload
  • Coast\Validator\Rule\Url
  • Coast\View
  • Coast\View\Content
  • Coast\Xml

Interfaces

  • Coast\App\Access
  • Coast\App\Executable
  • Coast\Router\Routable

Traits

  • Coast\App\Access\Implementation
  • Coast\App\Executable\Implementation

Exceptions

  • Coast\App\Exception
  • Coast\Controller\Exception
  • Coast\Controller\Failure
  • Coast\Csrf\Exception
  • Coast\Exception
  • Coast\Http\Exception
  • Coast\Image\Exception
  • Coast\Model\Exception
  • Coast\Model\Exception\NotDefined
  • Coast\Resolver\Exception
  • Coast\Router\Exception
  • Coast\Router\Failure
  • Coast\View\Exception
  • Coast\View\Failure
  • Overview
  • Namespace
  • Class
  • Deprecated
  • Todo
  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 
<?php
/*
 * Copyright 2017 Jack Sleight <http://jacksleight.com/>
 * This source file is subject to the MIT license that is bundled with this package in the file LICENCE. 
 */

namespace Coast;

class Router implements \Coast\App\Access, \Coast\App\Executable
{
    const METHOD_ALL    = 'ALL';
    const METHOD_GET    = \Coast\Request::METHOD_GET;
    const METHOD_POST   = \Coast\Request::METHOD_POST;
    const METHOD_PUT    = \Coast\Request::METHOD_PUT;
    const METHOD_DELETE = \Coast\Request::METHOD_DELETE;

    const TYPE_STATIC = 'static';
    const TYPE_REGEX  = 'regex';

    use \Coast\App\Access\Implementation;
    use \Coast\App\Executable\Implementation;

    protected $_prefix;
    
    protected $_suffix;
    
    protected $_params = [];

    protected $_target;

    protected $_routes = [];

    protected $_aliases = [];

    public function __construct(array $options = array())
    {
        foreach ($options as $name => $value) {
            if ($name[0] == '_') {
                throw new \Coast\Exception("Access to '{$name}' is prohibited");  
            }
            $this->$name($value);
        }
    }

    public function prefix($prefix = null)
    {
        if (func_num_args() > 0) {
            $this->_prefix = $prefix;
            return $this;
        }
        return $this->_prefix;
    }

    public function suffix($suffix = null)
    {
        if (func_num_args() > 0) {
            $this->_suffix = $suffix;
            return $this;
        }
        return $this->_suffix;
    }

    public function params(array $params = null)
    {
        if (func_num_args() > 0) {
            $this->_params = $params;
            return $this;
        }
        return $this->_params;
    }

    public function target(\Coast\Router\Routable $target = null)
    {
        if (func_num_args() > 0) {
            $this->_target = $target;
            return $this;
        }
        return $this->_target;
    }

    public function routes(array $routes = array())
    {
        if (func_num_args() > 0) {
            foreach ($routes as $name => $route) {
                call_user_func_array([$this, 'route'], array_merge([$name], $route));
            }
            return $this;
        }
        return $this->_routes;
    }

    public function route($name, $methods = null, $path = null, $params = null, \Closure $target = null)
    {
        if (func_num_args() > 1) {
            if (!is_array($methods)) {
                $methods = array_map('trim', explode(',', $methods));
            }
            foreach ($methods as $i => $method) {
                $method = strtoupper($method);
                if ($method == self::METHOD_ALL) {
                    $methods = [
                        self::METHOD_GET,
                        self::METHOD_POST,
                        self::METHOD_PUT,
                        self::METHOD_DELETE,
                    ];
                    break;
                }
                $methods[$i] = $method;
            }
            if ($params instanceof \Closure) {
                $target = $params;
                $params = [];
            } if (!isset($params)) {
                $params = [];
            }
            if (isset($target)) {
                $target = $target->bindTo($this);
            }

            $path = ltrim($path, '/');
            if (isset($this->_prefix)) {
                $path = "{$this->_prefix}/{$path}";
            }
            if (isset($this->_suffix)) {
                $path = "{$path}/{$this->_suffix}";
            }
            if (strpos($path, '{') !== false) {
                $parts = explode('/', $path);
                $names = [];
                $stack = [];
                foreach ($parts as $i => $part) {
                    if (preg_match('/^\{([a-zA-Z0-9_-]+)(?::(.*))?\}(\?)?$/', $part, $match)) {
                        $match = \Coast\array_merge_smart(
                            array('', '', '', ''),
                            $match
                        );
                        $names[] = $match[1];    
                        $regex = strlen($match[2])
                            ? "({$match[2]})"
                            : "([^\/]+)";
                        if ($match[3] == '?') {
                            $regex = $i == 0 
                                ? "(?:{$regex})?"
                                : "(?:\/{$regex})?";
                        } else {
                            $regex = $i == 0
                                ? "{$regex}"
                                : "\/{$regex}";
                        }
                    } else {
                        $regex = $i == 0
                            ? preg_quote($part, '/')
                            : "\/" . preg_quote($part, '/');
                    }
                    $stack[] = $regex;
                }
                $type  = self::TYPE_REGEX;
                $value = '/^' . implode($stack) . '$/';
            } else {
                $names = [];
                $type  = self::TYPE_STATIC;
                $value = $path;
            }

            $route = [
                'methods' => $methods,
                'path'    => $path,
                'type'    => $type,
                'value'   => $value,
                'names'   => $names,
                'params'  => $params,
                'target'  => $target,
            ];
            $this->_routes[$name] = $route;
            return $this;
        }
        if (isset($this->_aliases[$name])) {
            $name = $this->_aliases[$name];
        }
        return isset($this->_routes[$name])
            ? $this->_routes[$name]
            : null;
    }

    public function alias($name, $value = null)
    {
        if (func_num_args() > 1) {
            if (isset($value)) {
                $this->_aliases[$name] = $value;
            } else {
                unset($this->_aliases[$name]);
            }
            return $this;
        }
        return isset($this->_aliases[$name])
            ? $this->_aliases[$name]
            : null;
    }

    public function aliases(array $aliases = null)
    {
        if (func_num_args() > 0) {
            foreach ($aliases as $name => $value) {
                $this->alias($name, $value);
            }
            return $this;
        }
        return $this->_aliases;
    }

    public function match($method, $path)
    {
        $method = strtoupper($method);
        end($this->_routes);
        do {
            $name  = key($this->_routes);
            $route = current($this->_routes);
            if (!in_array($method, $route['methods'])) {
                continue;
            }
            if ($route['type'] == self::TYPE_STATIC) {
                if ($path != $route['value']) {
                    continue;
                }
                $match = [];
            } else if ($route['type'] == self::TYPE_REGEX) {
                if (!preg_match($route['value'], $path, $match)) {
                    continue;
                }
                array_shift($match);
            }
            $params = array_merge(
                $route['params'],
                count($match) > 0
                    ? array_combine(array_slice($route['names'], 0, count($match)), $match)
                    : []
            );
            return array_merge($route, [
                'name'   => $name,
                'params' => $params,
            ]);
        } while (prev($this->_routes));

        throw new Router\Failure("Not route matched method '{$method}' and path '{$path}'");
    }

    public function reverse($name, array $params = array())
    {
        if (isset($this->_aliases[$name])) {
            $name = $this->_aliases[$name];
        }
        if (!isset($this->_routes[$name])) {
            throw new Router\Exception("Route '{$name}' does not exist");
        }

        $route    = $this->_routes[$name];
        $defaults = $route['params'] + $this->_params;
        $parts    = explode('/', $route['path']);
        $path     = [];
        $trim     = [];
        foreach ($parts as $i => $part) {
            if (preg_match('/^\{([a-zA-Z0-9_-]+)(?::(.*))?\}(\?)?$/', $part, $match)) {
                $match = \Coast\array_merge_smart(
                    array('', '', '', ''),
                    $match
                );
                if (isset($params[$match[1]])) {
                    $value  = $params[$match[1]];
                } else if (isset($defaults[$match[1]])) {
                    $value  = $defaults[$match[1]];
                    $trim[] = $i;
                } else {
                    $value  = null;
                    $trim[] = $i;
                }
            } else {
                $value = $part;
            }
            $path[$i] = $value;
        }

        for ($i = count($path) - 1; $i >= 0; $i--) {
            if (in_array($i, $trim)) {
                unset($path[$i]);
            } else {
                break;
            }
        }

        return implode('/', $path);
    }

    public function reverseData($name, array $params = array())
    {
        if (isset($this->_aliases[$name])) {
            $name = $this->_aliases[$name];
        }
        if (!isset($this->_routes[$name])) {
            throw new Router\Exception("Route '{$name}' does not exist");
        }

        $route    = $this->_routes[$name];
        $defaults = $route['params'] + $this->_params;

        return [
            'name'   => $name,
            'params' => $params + $defaults,
        ];
    }

    public function execute(\Coast\Request $req, \Coast\Response $res)
    {
        try {
            $route = $this->match($req->method(), $req->path());
        } catch (Router\Failure $e) {
            return;
        }

        $req->param('route', $route);
        $req->pathParams($route['params']);

        if (isset($route['target'])) {
            return $route['target']($req, $res, $route);
        } else if (isset($this->_target)) {
            return $this->_target->route($req, $res, $route);
        } else {
            throw new Router\Exception("There's nothing to route '{$route['name']}' to");
        }
    }
}
Coast API Documentation API documentation generated by ApiGen