Path

ez components / documentation / api reference / 2008.2 / mvctools

eZ Components 2008.2

MvcTools: ezcMvcRegexpRoute

[ Tutorial ] [ Class tree ] [ Element index ] [ ChangeLog ] [ Credits ]

Class: ezcMvcRegexpRoute

Router class that uses regular expressions for matching routes. [source]

Implemented Interfaces

The routes are matched against the uri property of the request object.

Member Variables

protected string $action
Contains the action that the controller should execute.
protected string $controllerClassName
This is the name of the controller class that will be instantiated with the request variables obtained from the route, as well as the default values belonging to a route.
protected array(string) $defaultValues
The default values for the variables that are send to the controller. The route matchers can override those default values
protected string $pattern
This property contains the regular expression.

Method Summary

public ezcMvcRegexpRoute __construct( $pattern, $controllerClassName, [$action = null], [$defaultValues = array()] )
Constructs a new ezcMvcRegexpRoute with $pattern.
public null|ezcMvcRoutingInformation matches( $request )
Evaluates the URI against this route.
public void prefix( $prefix )
Parses the pattern and adds the prefix.
protected bool pregMatch( $request, &$matches, $matches )
This method performs the actual regular expresion match against the $request's URI.

Methods

__construct

ezcMvcRegexpRoute __construct( string $pattern, string $controllerClassName, [string $action = null], [ $defaultValues = array()] )
Constructs a new ezcMvcRegexpRoute with $pattern.
When the route is matched (with the match() method), the route instantiates an object of the class $controllerClassName.

Parameters

Name Type Description
$pattern string  
$controllerClassName string  
$action string  
$defaultValues array(string)  

matches

null|ezcMvcRoutingInformation matches( ezcMvcRequest $request )
Evaluates the URI against this route.
The method first runs the match. If the regular expression matches, it cleans up the variables to only include named parameters. it then creates an object containing routing information and returns it. If the route's pattern did not match it returns null.

Parameters

Name Type Description
$request ezcMvcRequest  

prefix

void prefix( mixed $prefix )
Parses the pattern and adds the prefix.
It's up to the developer to provide a meaningfull prefix. In this case, it needs to be a regular expression just like the pattern.

Parameters

Name Type Description
$prefix mixed  

Throws

ClassDescription
ezcMvcRegexpRouteException if the prefix can not be prepended to the pattern.

pregMatch

bool pregMatch( ezcMvcRequest $request, &$matches, array(string) $matches )
This method performs the actual regular expresion match against the $request's URI.

Parameters

Name Type Description
$request ezcMvcRequest  
$matches array(string)  
&$matches  

Last updated: Mon, 05 Jan 2009