Class Zend_Controller_Router_Route_Hostname

Description

Hostname Route

Located in /Controller/Router/Route/Hostname.php (line 35)

Zend_Controller_Router_Route_Abstract
   |
   --Zend_Controller_Router_Route_Hostname
Variable Summary
Method Summary
 static void getInstance ( $config)
 Zend_Controller_Router_Route_Hostname __construct (string $route, [array $defaults = array()], [array $reqs = array()], [string $scheme = null])
 string assemble ([array $data = array()], [boolean $reset = false], [ $encode = false], [ $partial = false])
 string getDefault (string $name)
 array getDefaults ()
 array getVariables ()
 array|false match (Zend_Controller_Request_Http $request)
 void setRequest ([Zend_Controller_Request_Abstract $request = null])
Variables
mixed $_defaultRegex = null (line 40)
  • access: protected
array $_defaults = array() (line 59)

Holds user submitted default values for route's variables. Name and value pairs.

  • access: protected
mixed $_hostVariable = ':' (line 38)
  • access: protected
array $_parts = array() (line 53)

Holds Route patterns for all host parts. In case of a variable it stores it's regex requirement or null. In case of a static part, it holds only it's direct value.

  • access: protected
mixed $_regexDelimiter = '#' (line 39)
  • access: protected
Zend_Controller_Request_Abstract $_request (line 86)

Current request object

  • access: protected
array $_requirements = array() (line 66)

Holds user submitted regular expression patterns for route's variables' values.

Name and value pairs.

  • access: protected
string $_scheme = null (line 72)

Default scheme

  • access: protected
array $_values = array() (line 79)

Associative array filled on match() that holds matched path values for given variable names.

  • access: protected
array $_variables = array() (line 46)

Holds names of all route's pattern variable names. Array index holds a position in host.

  • access: protected

Inherited Variables

Inherited from Zend_Controller_Router_Route_Abstract

Zend_Controller_Router_Route_Abstract::$_isAbstract
Zend_Controller_Router_Route_Abstract::$_matchedPath
Methods
static getInstance (line 126)

Instantiates route based on passed Zend_Config structure

  • access: public
static void getInstance ( $config)
Constructor __construct (line 144)

Prepares the route for mapping by splitting (exploding) it to a corresponding atomic parts. These parts are assigned a position which is later used for matching and preparing values.

  • access: public
Zend_Controller_Router_Route_Hostname __construct (string $route, [array $defaults = array()], [array $reqs = array()], [string $scheme = null])
  • string $route: Map used to match with later submitted hostname
  • array $defaults: Defaults for map variables with keys as variable names
  • array $reqs: Regular expression requirements for variables (keys as variable names)
  • string $scheme
assemble (line 252)

Assembles user submitted parameters forming a hostname defined by this route

  • return: Route path with user submitted parameters
  • access: public
string assemble ([array $data = array()], [boolean $reset = false], [ $encode = false], [ $partial = false])
  • array $data: An array of variable and value pairs used as parameters
  • boolean $reset: Whether or not to set route defaults with those provided in $data
  • $encode
  • $partial
getDefault (line 317)

Return a single parameter of route's defaults

  • return: Previously set default
  • access: public
string getDefault (string $name)
  • string $name: Array key of the parameter
getDefaults (line 329)

Return an array of defaults

  • return: Route defaults
  • access: public
array getDefaults ()
getRequest (line 111)

Get the request object

  • access: public
getVariables (line 338)

Get all variables which are used by the route

  • access: public
array getVariables ()
match (line 172)

Matches a user submitted path with parts defined by a map. Assigns and returns an array of variables on a successful match.

  • return: An array of assigned values or a false on a mismatch
  • access: public
array|false match (Zend_Controller_Request_Http $request)
setRequest (line 101)

Set the request object

  • access: public
void setRequest ([Zend_Controller_Request_Abstract $request = null])

Inherited Methods

Inherited From Zend_Controller_Router_Route_Abstract

 Zend_Controller_Router_Route_Abstract::chain()
 Zend_Controller_Router_Route_Abstract::getMatchedPath()
 Zend_Controller_Router_Route_Abstract::getVersion()
 Zend_Controller_Router_Route_Abstract::isAbstract()
 Zend_Controller_Router_Route_Abstract::setMatchedPath()

Documentation generated on Mon, 21 Jun 2010 15:27:00 -0400 by phpDocumentor 1.4.3