Docs For Class Controller_Routing

Description

A routing segment that matches a URL based on a regular expression.

Located in /controller/lib/Controller/Routing/RegExSegment.php (line 9)

Controller_Routing_Segment
   |
   --Controller_Routing_RegExSegment

Variable Summary

mixed $pattern

Method Summary

Controller_Routing_RegExSegment __construct (string $pattern, [Controller_Routing_Segment $next = null])

int compare (Controller_Routing_Segment $segment)

boolean match (string $url, array &$params, string &$unmatched)

mixed url_for (array &$params)

string value ()

Variables

mixed $pattern (line 11)

access: protected

Inherited Variables

Inherited from Controller_Routing_Segment

Controller_Routing_Segment::$next

Methods

Constructor __construct (line 19)

Constructor

access: public

Controller_Routing_RegExSegment __construct (string $pattern, [Controller_Routing_Segment $next = null])

string $pattern: The pattern to match
Controller_Routing_Segment $next: The next segment in the route

Redefinition of:

Controller_Routing_Segment::__construct(): Constructor

compare (line 65)

Compares this segment to another segment.

Returns a value of -1, 0, 1 to indicate $segment is less than, equal to, or greater than this segment, respectively. This method is used to construct routing trees. Segments which are equal will all be grouped together in a branch.

access: public

int compare (Controller_Routing_Segment $segment)

Controller_Routing_Segment $segment: The segment to compare

Redefinition of:

Controller_Routing_Segment::compare(): Compares this segment to another segment.

match (line 43)

Test a portion of a URL against this segment. Returns true if this segment matches, false otherwise.

access: public

boolean match (string $url, array &$params, string &$unmatched)

string $url: The URL portion to match
array &$params: Output parameter for any parameters discovered by this segment
string &$unmatched: Output parameter for the portion of the URL that was not matched (to be passed to the next segment

Redefinition of:

Controller_Routing_Segment::match(): Test a portion of a URL against this segment. Returns true if this segment matches, false otherwise.

url_for (line 80)

Essentially the reverse of match(), this method assembles a URL segment from a set of parameters. Note that a RegExSegment is never capable of constructing a URL and so will return false.

access: public

mixed url_for (array &$params)

array &$params: The parameters to use for assembling the URL

Redefinition of:

Controller_Routing_Segment::url_for(): Essentially the reverse of match(), this method assembles a URL segment from a set of parameters. If this segment cannot construct a URL chunk for the parameters, it returns false. Note that upon completion, $params contains only unconsumed parameters.

value (line 30)

Return the value of this segment in human readable form.

access: public

string value ()

Redefinition of:

Controller_Routing_Segment::value(): Return the value of this segment in human readable form.

Inherited Methods

Inherited From Controller_Routing_Segment

Controller_Routing_Segment::__construct()
Controller_Routing_Segment::compare()
Controller_Routing_Segment::match()
Controller_Routing_Segment::next()
Controller_Routing_Segment::next_url_token()
Controller_Routing_Segment::set_next()
Controller_Routing_Segment::url_for()
Controller_Routing_Segment::value()