Zend Framework  1.12
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Zend_Controller_Router_Route_Regex Class Reference

Public Member Functions

 __construct ($route, $defaults=array(), $map=array(), $reverse=null)
 
 getVersion ()
 
 match ($path, $partial=false)
 Matches a user submitted path with a previously defined route.
 
 assemble ($data=array(), $reset=false, $encode=false, $partial=false)
 Assembles a URL path defined by this route.
 
 getDefault ($name)
 Return a single parameter of route's defaults.
 
 getDefaults ()
 Return an array of defaults.
 
 getVariables ()
 Get all variables which are used by the route.
 
- Public Member Functions inherited from Zend_Controller_Router_Route_Abstract
 getVersion ()
 Get the version of the route.
 
 setMatchedPath ($path)
 Set partially matched path.
 
 getMatchedPath ()
 Get partially matched path.
 
 isAbstract ($flag=null)
 Check or set wether this is an abstract route or not.
 
 chain (Zend_Controller_Router_Route_Abstract $route, $separator= '/')
 Create a new chain.
 
- Public Member Functions inherited from Zend_Controller_Router_Route_Interface
 match ($path)
 
 assemble ($data=array(), $reset=false, $encode=false)
 

Static Public Member Functions

static getInstance (Zend_Config $config)
 Instantiates route based on passed Zend_Config structure.
 

Protected Member Functions

 _getMappedValues ($values, $reversed=false, $preserve=false)
 Maps numerically indexed array values to it's associative mapped counterpart.
 
 _arrayMergeNumericKeys (Array $array1, Array $array2)
 _arrayMergeNumericKeys() - allows for a strict key (numeric's included) array_merge.
 

Protected Attributes

 $_regex = null
 
 $_defaults = array()
 
 $_reverse = null
 
 $_map = array()
 
 $_values = array()
 
- Protected Attributes inherited from Zend_Controller_Router_Route_Abstract
 $_isAbstract = false
 
 $_matchedPath = null
 

Additional Inherited Members

- Public Attributes inherited from Zend_Controller_Router_Route_Abstract
const URI_DELIMITER = '/'
 URI delimiter.
 

Constructor & Destructor Documentation

__construct (   $route,
  $defaults = array(),
  $map = array(),
  $reverse = null 
)

Member Function Documentation

_arrayMergeNumericKeys ( Array  $array1,
Array  $array2 
)
protected

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

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

Parameters
array$array1
array$array2
Returns
array
_getMappedValues (   $values,
  $reversed = false,
  $preserve = false 
)
protected

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
array$valuesIndexed or associative array of values to map
boolean$reversedFalse means translation of index to association. True means reverse.
boolean$preserveShould wrong type of keys be preserved or stripped.
Returns
array An array of mapped values
assemble (   $data = array(),
  $reset = false,
  $encode = false,
  $partial = false 
)

Assembles a URL path defined by this route.

Parameters
array$dataAn array of name (or index) and value pairs used as parameters
Returns
string Route path with user submitted parameters
getDefault (   $name)

Return a single parameter of route's defaults.

Parameters
string$nameArray key of the parameter
Returns
string Previously set default
getDefaults ( )

Return an array of defaults.

Returns
array Route defaults
static getInstance ( Zend_Config  $config)
static

Instantiates route based on passed Zend_Config structure.

Parameters
Zend_Config$configConfiguration object

Implements Zend_Controller_Router_Route_Interface.

getVariables ( )

Get all variables which are used by the route.

Returns
array
getVersion ( )
match (   $path,
  $partial = false 
)

Matches a user submitted path with a previously defined route.

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

Parameters
string$pathPath used to match against this routing map
Returns
array|false An array of assigned values or a false on a mismatch

Member Data Documentation

$_defaults = array()
protected
$_map = array()
protected
$_regex = null
protected
$_reverse = null
protected
$_values = array()
protected