Class PluginShortRoute

match()source public

match( array $url )

Reverse route plugin shortcut URLs. If the plugin and controller are not the same the match is an auto fail.

Parameters

array $url

Array of parameters to convert to a string.

Returns

Overrides

parse()source public

parse( string $url )

Parses a string URL into an array. If a plugin key is found, it will be copied to the controller parameter

Parameters

string $url

The URL to parse

Returns

Overrides

__construct()source public

__construct( string $template , array $defaults array() , array $options array() )

Constructor for a Route

Parameters

string $template

Template string with parameter placeholders

array $defaults optional array()

Array of defaults for the route.

array $options optional array()

Array of additional options for the Route

__set_state()source public static

__set_state( array $fields )

Set state magic method to support var_export

This method helps for applications that want to implement router caching.

Parameters

array $fields

Key/Value of object attributes

Returns

_matchNamed()source protected

_matchNamed( string $val , array $rule , string $context )

Check if a named parameter matches the current rules.

Return true if a given named $param's $val matches a given $rule depending on $context. Currently implemented rule types are controller, action and match that can be combined with each other.

Parameters

string $val

The value of the named parameter

array $rule

The rule(s) to apply, can also be a match string

string $context

An array with additional context information (controller / action)

Returns

_parseArgs()source protected

_parseArgs( string $args , string $context )

Parse passed and Named parameters into a list of passed args, and a hash of named parameters. The local and global configuration for named parameters will be used.

Parameters

string $args

A string with the passed & named params. eg. /1/page:2

string $context

The current route context, which should contain controller/action keys.

Returns

_writeRoute()source protected

_writeRoute( )

Builds a route regular expression.

Uses the template, defaults and options properties to compile a regular expression that can be used to parse request strings.

_writeUrl()source protected

_writeUrl( array $params )

Converts a matching route array into a URL string.

Composes the string URL using the template used to create the route.

Parameters

array $params

The params to convert to a string URL.

Returns

compile()source public

compile( )

Compiles the route's regular expression.

Modifies defaults property so all necessary keys are set and populates $this->names with the named routing elements.

Returns

compiled()source public

compiled( )

Check if a Route has been compiled into a regular expression.

Returns

persistParams()source public

persistParams( array $url , array $params )

Apply persistent parameters to a URL array. Persistent parameters are a special key used during route creation to force route parameters to persist when omitted from a URL array.

Parameters

array $url

The array to apply persistent parameters to.

array $params

An array of persistent values to replace persistent ones.

Returns