API Documentation

Zend/Controller/Router/Route/Static.php

Show: inherited
Table of Contents

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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Controller  
Subpackage
Router  
Version
$Id: Static.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Controller_Router_Route_Static

Package: Zend\Controller\Router

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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotected  $_defaults= 'array()'
Default valuearray()Details
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
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

methodpublicgetVersion( ) : void

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
array|false An array of assigned values or a false on a mismatch
Documentation was generated by DocBlox 0.15.1.