API Documentation

Controller/Router/Route/Static.php

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.

category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Controller  
subpackage
Router  
version
$Id: Static.php 24182 2011-07-03 13:43:05Z adamlundrigan $  

\Zend_Controller_Router_Route_Static

StaticRoute is used for managing static URIs.

It's a lot faster compared to the standard Route implementation.

Extends from
\Zend_Controller_Router_Route_Abstract
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Controller  
subpackage
Router  

Properties

Propertyprotected  $_defaults= 'array'
Default valuearrayDetails
Type
Propertyprotected  $_route= 'null'
Default valuenullDetails
Type

Methods

methodpublic__construct( string $route, array $defaults = array ) : void

Prepares 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
methodpublicassemble( array $data = array,  $reset = false,  $encode = false,  $partial = false ) : string

Assembles a URL path defined by this route

Parameters
Name Type Description
$data array An array of variable and value pairs used as parameters
$reset
$encode
$partial
Returns
Type Description
string Route path with user submitted parameters
methodpublicchain( \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()
Parameters
Name Type Description
$route \Zend_Controller_Router_Route_Abstract
$separator string
Returns
Type Description
\Zend_Controller_Router_Route_Chain
methodpublicgetDefault( string $name ) : string

Return a single parameter of route's defaults

Parameters
Name Type Description
$name string Array key of the parameter
Returns
Type Description
string Previously set default
methodpublicgetDefaults( ) : array

Return an array of defaults

Returns
Type Description
array Route defaults
methodpublicgetInstance( \Zend_Config $config ) : void
static

Instantiates route based on passed Zend_Config structure

Parameters
Name Type Description
$config \Zend_Config Configuration object
methodpublicgetMatchedPath( ) : string

Get partially matched path

Inherited from: \Zend_Controller_Router_Route_Abstract::getMatchedPath()
Returns
Type Description
string
methodpublicgetVersion( ) : integer

Get the version of the route

Returns
Type Description
integer
methodpublicisAbstract( boolean $flag = null ) : boolean

Check or set wether this is an abstract route or not

Inherited from: \Zend_Controller_Router_Route_Abstract::isAbstract()
Parameters
Name Type Description
$flag boolean
Returns
Type Description
boolean
methodpublicmatch( string $path,  $partial = false ) : array|false

Matches 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
Returns
Type Description
arrayfalse An array of assigned values or a false on a mismatch
methodpublicsetMatchedPath( string $path ) : void

Set partially matched path

Inherited from: \Zend_Controller_Router_Route_Abstract::setMatchedPath()
Parameters
Name Type Description
$path string
Documentation was generated by DocBlox 0.13.3.