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

Public Member Functions

 getVersion ()
 
 __construct ($route, $defaults=array())
 Prepares the route for mapping.
 
 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.
 
- 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 Attributes

 $_route = null
 
 $_defaults = 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() 
)

Prepares the route for mapping.

Parameters
string$routeMap used to match with later submitted URL path
array$defaultsDefaults for map variables with keys as variable names

Member Function Documentation

assemble (   $data = array(),
  $reset = false,
  $encode = false,
  $partial = false 
)

Assembles a URL path defined by this route.

Parameters
array$dataAn array of variable 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.

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
$_route = null
protected