Controller/Router/Route/Hostname.php
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-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Controller
- Subpackage
- Router
- Version
- $Id: Hostname.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Controller_Router_Route_Hostname
Implements interface and provides convenience methods
- Parent(s)
- \Zend_Controller_Router_Route_Abstract
- See
- \global\http://manuals.rubyonrails.com/read/chapter/65
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Constants
Properties


array $_defaults = array()
Name and value pairs.
array()
Details- Type
- array


boolean $_isAbstract = false
false
Details- Type
- boolean
- Inherited_from
- \Zend_Controller_Router_Route_Abstract::$$_isAbstract


string $_matchedPath = null
null
Details- Type
- string
- Inherited_from
- \Zend_Controller_Router_Route_Abstract::$$_matchedPath


array $_parts = array()
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- Type
- array


array $_requirements = array()
Name and value pairs.
array()
Details- Type
- array


int $_staticCount = 0
0
Details- Type
- int


array $_values = array()
array()
Details- Type
- array
Methods


__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
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 |
---|---|
array | false | 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 |