Documentation

Route

in package

• Routes

The Route object holds a route recognition and generation routine.

Table of Contents

$absolute  : bool

Is this an absolute path? (Mapper will not prepend SCRIPT_NAME)

$conditions  : array<string|int, mixed>|null

Array of keyword args for special conditions (method, subDomain, function)

$decodeErrors  : string

What to do on decoding errors? 'ignore' or 'replace'

$defaults  : array<string|int, mixed>

Default keyword arguments for this route

$encoding  : string

Encoding of this route (not yet supported)

$explicit  : bool

Does this route use explicit mode (no implicit defaults)?

$filter  : callable

Filter function to operate on arguments before generation

$hardCoded  : array<string|int, mixed>

Default keywords that don't exist in the path; can't be changed by an incoming URL.

$maxKeys  : array<string|int, mixed>

Maximum keys that this route could utilize.

$minKeys  : array<string|int, mixed>

Minimum keys required to generate this route

$regexp  : string

Regular expression for matching this route

$reqs  : array<string|int, mixed>

Requirements for this route

$routePath  : string

The path for this route, such as ':controller/:action/:id'

$stack  : iteratable<string|int, mixed>|null

An environment of pre and post filters for the route

$static  : string

Is this a static route?

$_collectionName  : null|string

Collection name if this is a RESTful route

$_memberName  : null|string

Member name if this is a RESTful route

$_parentResource  : string

Name of the parent resource, if this is a RESTful route & has a parent

$_reqRegs  : array<string|int, mixed>

Requirements formatted as regexps suitable for preg_match()

$_routeBackwards  : array<string|int, mixed>

Reverse of $routeList

$_splitChars  : array<string|int, mixed>

Characters that split the parts of a URL

$prior  : string

Last path part used by buildNextReg()

$routeList  : array<string|int, mixed>

Route path split by '/'

__construct()  : mixed

Initialize a route, with a given routepath for matching/generation

buildNextReg()  : array<string|int, mixed>

Recursively build a regexp given a path, and a controller list.

generate()  : string|null

Generate a URL from ourself given a set of keyword arguments

makeRegexp()  : void

Create the regular expression for matching.

match()  : array<string|int, mixed>|null

Match a url to our regexp.

_defaults()  : array<string|int, mixed>

Creates a default array of strings

_minKeys()  : array<string|int, mixed>

Utility function to walk the route backwards

_pathKeys()  : array<string|int, mixed>

Utility method to walk the route, and pull out the valid dynamic/wildcard keys

$route = new Horde_Routes_Route('date/:year/:month/:day',
                array('controller'=>'blog', 'action'=>'view'));

$route = new Horde_Routes_Route('archives/:page',
                array('controller'=>'blog', 'action'=>'by_page',
                      'requirements' => array('page'=>'\d{1,2}'));