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 <?php
/*
* This file is part of the ICanBoogie package.
*
* (c) Olivier Laviale <olivier.laviale@gmail.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace ICanBoogie\Routing;
use ICanBoogie\HTTP\Request;
/**
* The class defines options that can be used to define a route as well as means to normalize and
* validate this definition.
*/
class RouteDefinition
{
/**
* Pattern of the route.
*/
const PATTERN = 'pattern';
/**
* A controller class name (with an optional action) or a callable.
*/
const CONTROLLER = 'controller';
/**
* The controller action.
*/
const ACTION = 'action';
/**
* An identifier.
*/
const ID = 'id';
/**
* A redirection target.
*/
const LOCATION = 'location';
/**
* Request method(s) accepted by the route.
*/
const VIA = 'via';
/**
* Route constructor, a class name for now.
*/
const CONSTRUCTOR = 'class';
/**
* Normalizes a route definition.
*
* @param array $definition
*/
static public function normalize(array &$definition)
{
if (isset($definition[self::CONTROLLER]))
{
$controller = $definition[self::CONTROLLER];
if (is_string($controller) && strpos($controller, RouteMaker::CONTROLLER_ACTION_SEPARATOR))
{
list($controller, $action) = explode(RouteMaker::CONTROLLER_ACTION_SEPARATOR, $controller);
$definition[self::CONTROLLER] = $controller;
$definition[self::ACTION] = $action;
}
}
if (empty($definition[self::VIA]))
{
$definition[self::VIA] = Request::METHOD_ANY;
}
}
/**
* Ensures that a route definition has an identifier and generates one if required.
*
* @param array $definition
*
* @return string The route identifier.
*/
static public function ensure_has_id(array &$definition)
{
if (empty($definition[self::ID]))
{
$definition[self::ID] = self::generate_anonymous_id();
}
return $definition[self::ID];
}
static private $anonymous_id_count;
/**
* Generates an anonymous route identifier.
*
* @return string
*/
static private function generate_anonymous_id()
{
return 'anonymous_route_' . ++self::$anonymous_id_count;
}
/**
* Asserts that a route definition is valid.
*
* @param array $definition
*
* @throws PatternNotDefined when the pattern is not defined
* @throws ControllerNotDefined when both controller and location are not defined.
*/
static public function assert_is_valid(array $definition)
{
if (empty($definition[self::PATTERN]))
{
throw new PatternNotDefined(\ICanBoogie\format("Pattern is not defined: !route", [
'route' => $definition
]));
}
if (empty($definition[self::CONTROLLER]) && empty($definition[self::LOCATION]))
{
throw new ControllerNotDefined(\ICanBoogie\format("Controller is not defined: !route", [
'route' => $definition
]));
}
}
/**
* No instance should be created from this class.
*
* @codeCoverageIgnore
*/
private function __construct()
{
}
}