• Home
• lithium
• net
• http
• Router

PHP Class lithium\net\http\Router

Using Route objects, these two operations can be handled in a reciprocally consistent way. For example, if you wanted the /login URL to be routed to myapp\controllers\SessionsController::add(), you could set up a route like the following in config/routes.php: {{{ use lithium\net\http\Router; Router::connect('/login', array('controller' => 'Sessions', 'action' => 'add')); -- or -- Router::connect('/login', 'Sessions::add'); }}} Not only would that correctly route all requests for /login to SessionsController::add(), but any time the framework generated a route with matching parameters, Router would return the correct short URL. While most framework components that work with URLs (and utilize routing) handle calling the Router directly (i.e. controllers doing redirects, or helpers generating links), if you have a scenario where you need to call the Router directly, you can use the match() method. This allows you to keep your application's URL structure nicely decoupled from the underlying software design. For more information on parsing and generating URLs, see the parse() and match() methods. Show file Open project: unionofrad/lithium Class Usage Examples

Protected Properties

Property	Type	Description
$_classes	array	Classes used by Router.
$_configurations	array	An array of loaded Route objects used to match Request objects against.
$_formatters	array	An array of named closures matching up to corresponding route parameter values. Used to format those values.
$_modifiers	array	Array of closures used to format route parameters when parsing URLs.
$_scope	string	If is set to true, the scope of the user's request will be used. saved
$_scopes		Contain the configuration of scopes.
$_unicode		Flag for generating Unicode-capable routes. Turn this off if you don't need it, or if you're using a broken OS distribution (i.e. CentOS).

Public Methods

Method	Description
attach ( $name, $config = null, array $vars = [] )	Attach a scope to a mount point.
attached ( $name = null, array $vars = [] ) : mixed	Returns an attached mount point configuration.
config ( array $config = [] ) : array	Modify Router configuration settings and dependencies.
connect ( string | object $template, array | string $params = [], array | callable $options = [] ) : array	Connects a new route and returns the current routes array. This method creates a new Route object and registers it with the Router. The order in which routes are connected matters, since the order of precedence is taken into account in parsing and matching operations.
formatters ( array $formatters = [] ) : array	Used to get or set an array of named formatter closures, which are used to format route parameters when generating URLs. For example, for controller/action parameters to be dashed instead of underscored or camelBacked, you could do the following:
get ( integer $route = null, string | boolean $scope = null ) : object | array | null	Returns one or multiple connected routes.
match ( array | string $url = [], Request $context = null, array $options = [] ) : string	Attempts to match an array of route parameters (i.e. 'controller', 'action', etc.) against a connected Route object. For example, given the following route:
modifiers ( array $modifiers = [] ) : array	Used to get or set an array of named formatter closures, which are used to format route parameters when parsing URLs. For example, the following would match a posts/index url to a PostsController::indexAction() method.
parse ( object $request ) : array	Accepts an instance of lithium\action\Request (or a subclass) and matches it against each route, in the order that the routes are connected.
process ( Request $request ) : Request	Wrapper method which takes a Request object, parses it through all attached Route objects, assigns the resulting parameters to the Request object, and returns it.
reset ( )	Resets the Router to its default state, unloading all routes.
scope ( string $name = null, Closure $closure = null ) : mixed	Scope getter/setter.

Protected Methods

Method	Description
_compileScope ( array $config ) : array	Compiles the scope into regular expression patterns for matching against request URLs
_compileStack ( $stack )
_formatError ( $url )
_initScopes ( )	Initialize static::$_scopes with a lithium\core\Configuration instance.
_matchOptions ( string | array &$url, Request $context, array $options ) : array	Initialize options for Router::match().
_parseController ( array $params )
_parseScope ( string $name, string $request ) : mixed	Return the unscoped url to route.
_parseString ( string $path, boolean $context, array $options = [] ) : array	Helper function for taking a path string and parsing it into a controller and action array.
_persist ( array $url, Request $context ) : array	Copies persistent parameters (parameters in the request which have been designated to persist) to the current URL, unless the parameter has been explicitly disabled from persisting by setting the value in the URL to null, or by assigning some other value.
_prefix ( string $path, object $context = null, array $options = [] ) : string	Returns the prefix (scheme + hostname) for a URL based on the passed $options and the $context.
_prepareParams ( array | string $url, Request $context, array $options ) : array | string	Prepares URL parameters for matching. Detects and Passes through un-routed URL strings, leaving them untouched.

Method Details

Property Details