API Documentation

Controller/Router/Route/Regex.php

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Controller  
subpackage
Router  
version
$Id: Regex.php 24182 2011-07-03 13:43:05Z adamlundrigan $  

\Zend_Controller_Router_Route_Regex

Regex Route

Implements interface and provides convenience methods

Extends from
\Zend_Controller_Router_Route_Abstract
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Controller  
subpackage
Router  

Properties

Propertyprotected  $_defaults= 'array'
Default valuearrayDetails
Type
Propertyprotected  $_map= 'array'
Default valuearrayDetails
Type
Propertyprotected  $_regex= 'null'
Default valuenullDetails
Type
Propertyprotected  $_reverse= 'null'
Default valuenullDetails
Type
Propertyprotected  $_values= 'array'
Default valuearrayDetails
Type

Methods

methodpublic__construct(  $route,  $defaults = array,  $map = array,  $reverse = null ) : void

Parameters
Name Type Description
$route
$defaults
$map
$reverse
methodprotected_arrayMergeNumericKeys( array $array1, array $array2 ) : array

_arrayMergeNumericKeys() - allows for a strict key (numeric's included) array_merge.

php's array_merge() lacks the ability to merge with numeric keys.

Parameters
Name Type Description
$array1 array
$array2 array
Returns
Type Description
array
methodprotected_getMappedValues( array $values, boolean $reversed = false, boolean $preserve = false ) : array

Maps numerically indexed array values to it's associative mapped counterpart.

Or vice versa. Uses user provided map array which consists of index => name parameter mapping. If map is not found, it returns original array.

Method strips destination type of keys form source array. Ie. if source array is indexed numerically then every associative key will be stripped. Vice versa if reversed is set to true.

Parameters
Name Type Description
$values array Indexed or associative array of values to map
$reversed boolean False means translation of index to association. True means reverse.
$preserve boolean Should wrong type of keys be preserved or stripped.
Returns
Type Description
array An array of mapped values
methodpublicassemble( array $data = array,  $reset = false,  $encode = false,  $partial = false ) : string

Assembles a URL path defined by this route

Parameters
Name Type Description
$data array

An array of name (or index) and value pairs used as parameters

$reset
$encode
$partial
Returns
Type Description
string Route path with user submitted parameters
methodpublicchain( \Zend_Controller_Router_Route_Abstract $route, string $separator = / ) : \Zend_Controller_Router_Route_Chain

Create a new chain

Inherited from: \Zend_Controller_Router_Route_Abstract::chain()
Parameters
Name Type Description
$route \Zend_Controller_Router_Route_Abstract
$separator string
Returns
Type Description
\Zend_Controller_Router_Route_Chain
methodpublicgetDefault( string $name ) : string

Return a single parameter of route's defaults

Parameters
Name Type Description
$name string Array key of the parameter
Returns
Type Description
string Previously set default
methodpublicgetDefaults( ) : array

Return an array of defaults

Returns
Type Description
array Route defaults
methodpublicgetInstance( \Zend_Config $config ) : void
static

Instantiates route based on passed Zend_Config structure

Parameters
Name Type Description
$config \Zend_Config Configuration object
methodpublicgetMatchedPath( ) : string

Get partially matched path

Inherited from: \Zend_Controller_Router_Route_Abstract::getMatchedPath()
Returns
Type Description
string
methodpublicgetVariables( ) : array

Get all variables which are used by the route

Returns
Type Description
array
methodpublicgetVersion( ) : integer

Get the version of the route

Returns
Type Description
integer
methodpublicisAbstract( boolean $flag = null ) : boolean

Check or set wether this is an abstract route or not

Inherited from: \Zend_Controller_Router_Route_Abstract::isAbstract()
Parameters
Name Type Description
$flag boolean
Returns
Type Description
boolean
methodpublicmatch( string $path,  $partial = false ) : array|false

Matches a user submitted path with a previously defined route.

Assigns and returns an array of defaults on a successful match.

Parameters
Name Type Description
$path string Path used to match against this routing map
$partial
Returns
Type Description
arrayfalse An array of assigned values or a false on a mismatch
methodpublicsetMatchedPath( string $path ) : void

Set partially matched path

Inherited from: \Zend_Controller_Router_Route_Abstract::setMatchedPath()
Parameters
Name Type Description
$path string
Documentation was generated by DocBlox 0.13.3.