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.
Hostname Route
Implements interface and provides convenience methods

array
$_defaults= 'array'
Holds user submitted default values for route's variables. Name and value pairs.
array
Details
array
$_parts= 'array'
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.
array
Details
array
$_requirements= 'array'
Holds user submitted regular expression patterns for route's variables' values.
Name and value pairs.
array
Details
int
$_staticCount= '0'
Helper var that holds a count of route pattern's static parts for validation
0
Details
array
$_values= 'array'
Associative array filled on match() that holds matched path values for given variable names.
array
Details
__construct(
string $route, array $defaults
=
array, array $reqs
=
array, string $scheme
=
null
)
:
void
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.
Name | Type | Description |
---|---|---|
$route | string | Map used to match with later submitted hostname |
$defaults | array | Defaults for map variables with keys as variable names |
$reqs | array | Regular expression requirements for variables (keys as variable names) |
$scheme | string |

assemble(
array $data
=
array, boolean $reset
=
false, $encode
=
false, $partial
=
false
)
:
string
Assembles user submitted parameters forming a hostname defined by this route
Name | Type | Description |
---|---|---|
$data | array | An array of variable and value pairs used as parameters |
$reset | boolean | Whether or not to set route defaults with those provided in $data |
$encode | ||
$partial |
Type | Description |
---|---|
string | Route path with user submitted parameters |

chain(
\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()Name | Type | Description |
---|---|---|
$route | \Zend_Controller_Router_Route_Abstract | |
$separator | string |
Type | Description |
---|---|
\Zend_Controller_Router_Route_Chain |

getDefault(
string $name
)
:
string
Return a single parameter of route's defaults
Name | Type | Description |
---|---|---|
$name | string | Array key of the parameter |
Type | Description |
---|---|
string | Previously set default |

getInstance(
\Zend_Config $config
)
:
void
Instantiates route based on passed Zend_Config structure
Name | Type | Description |
---|---|---|
$config | \Zend_Config | Configuration object |

getMatchedPath(
)
:
string
Get partially matched path
Inherited from: \Zend_Controller_Router_Route_Abstract::getMatchedPath()Type | Description |
---|---|
string |

getRequest(
)
:
\Zend_Controller_Request_Abstract
Get the request object
Type | Description |
---|---|
\Zend_Controller_Request_Abstract | $request |

getVersion(
)
:
integer
Get the version of the route
Inherited from: \Zend_Controller_Router_Route_Abstract::getVersion()Type | Description |
---|---|
integer |

isAbstract(
boolean $flag
=
null
)
:
boolean
Check or set wether this is an abstract route or not
Inherited from: \Zend_Controller_Router_Route_Abstract::isAbstract()Name | Type | Description |
---|---|---|
$flag | boolean |
Type | Description |
---|---|
boolean |

match(
\Zend_Controller_Request_Http $request
)
:
array|false
Matches a user submitted path with parts defined by a map. Assigns and returns an array of variables on a successful match.
Name | Type | Description |
---|---|---|
$request | \Zend_Controller_Request_Http | Request to get the host from |
Type | Description |
---|---|
arrayfalse | An array of assigned values or a false on a mismatch |

setMatchedPath(
string $path
)
:
void
Set partially matched path
Inherited from: \Zend_Controller_Router_Route_Abstract::setMatchedPath()Name | Type | Description |
---|---|---|
$path | string |

setRequest(
\Zend_Controller_Request_Abstract|null $request
=
null
)
:
void
Set the request object
Name | Type | Description |
---|---|---|
$request | \Zend_Controller_Request_Abstract|null |