Controller/Router/Route/Static.php
Show:
inherited
inherited
Classes
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 [email protected] so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Controller
- Subpackage
- Router
- Version
- $Id$
\Zend_Controller_Router_Route_Static
Package: Zend_Controller\Router
Returns
StaticRoute is used for managing static URIs.
It's a lot faster compared to the standard Route implementation.
- Parent(s)
- \Zend_Controller_Router_Route_Abstract
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
Methods
__construct(string $route, array $defaults = array()) : voidPrepares the route for mapping.
Parameters
| Name | Type | Description |
|---|---|---|
| $route | string | Map used to match with later submitted URL path |
| $defaults | array | Defaults for map variables with keys as variable names |
assemble(array $data = array(), $reset = false, $encode = false, $partial = false) : stringAssembles a URL path defined by this route
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $data | array | An array of variable and value pairs used as parameters |
| $reset | ||
| $encode | ||
| $partial |
| Type | Description |
|---|---|
| string | Route path with user submitted parameters |
getDefault(string $name) : stringReturn a single parameter of route's defaults
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $name | string | Array key of the parameter |
| Type | Description |
|---|---|
| string | Previously set default |
getDefaults() : arrayReturn an array of defaults
Returns
| Type | Description |
|---|---|
| array | Route defaults |
getInstance(\Zend_Config $config) : voidstatic
Instantiates route based on passed Zend_Config structure
Parameters
| Name | Type | Description |
|---|---|---|
| $config | \Zend_Config | Configuration object |
getVersion() : voidmatch(string $path, $partial = false) : array | falseMatches a user submitted path with a previously defined route.
Assigns and returns an array of defaults on a successful match.
Parameters| Name | Type | Description |
|---|---|---|
| $path | string | Path used to match against this routing map |
| $partial |
| Type | Description |
|---|---|
| array | false | An array of assigned values or a false on a mismatch |