Class flRouterRoute

flRouterRoute Class

Class to match a route against a passed path extracting variables.

Package: fusionLib
Copyright: Copyright (c) 2011 - 2013 fusionLib. All rights reserved.
Located at system/libs/Router/flRouterRoute.php

Methods summary

`public`	# `__construct( string $route, array $defaults = array(), array $varReq = array(), flRequest $request = null )` Initialise the route object. Initialise the route object. Parameters `$route` The route string to match, exact/:var/* `$defaults` Array of defaults. `$varReq` Array of variables and the regular expressions they must match. `$request` Optional request object to provide base path during assemble.
`public`	# `setRequest( flRequest $request )` Set the request object to use. Set the request object to use. Parameters `$request` The request object.
`public`	# `setDefaultExt( string $ext )` Set the default extension to use. Set the default extension to use. Parameters `$ext` The default extension.
`public array`	# `match( array $path )` Match a path to the route. Match a path to the route. Parameters `$path` Array of path segments to match against. Returns array Parameters extracted from the root or false if route does not match.
`public string`	# `assemble( array $params, boolean $absolute = false, boolean $secure = null )` Assemble passed parameters into URI of the route pattern. Assemble passed parameters into URI of the route pattern. Parameters `$params` Associative array of parameters. `$absolute` true if an absolute path is required; else false. `$secure` true for https, false for http, null for as per request. Returns string The assembled URI. Throws `flRouterException`
`public string`	# `toString( )` Get the route as a string. Get the route as a string. Returns string The route string.
`public string`	# `__toString( )` Get the route as a string. Get the route as a string. Returns string The route string.

Properties summary

`protected array`	`$route` The route to match. The route to match.	#
`protected array`	`$defaults` Array of variable defaults. Array of variable defaults.	#
`protected array`	`$varReq` Variable requirements. Variable requirements.	#
`protected string`	`$ext` The file extension. The file extension.	#
`protected string`	`$defaultExt` The default extension when route ends .* The default extension when route ends .*	# `'/'`
`protected flRequest`	`$request` The request object. The request object.	#