API Documentation

Controller/Router/Route/Static.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Controller
subpackage
Router
version
$Id: Static.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Controller_Router_Route_Static

Description

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.

Zend_Controller_Router_Route_Static
jump to top

Extends from
Zend_Controller_Router_Route_Abstract
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Controller
subpackage
Router
Properties
$_route
$_defaults
Methods
getVersion
getInstance
__construct
match
assemble
getDefault
getDefaults

Description

StaticRoute is used for managing static URIs.

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

Properties

$_defaults
jump to class

 $_defaults = 'array'

Details

visibility
protected
default
array
final
false
static
false

$_route
jump to class

 $_route = 'null'

Details

visibility
protected
default
null
final
false
static
false

Methods

__construct
jump to class

__construct( string $route, array $defaults = array ) :

Prepares the route for mapping.

Arguments
$route
string
Map used to match with later submitted URL path
$defaults
array
Defaults for map variables with keys as variable names
Details
visibility
public
final
false
static
false

assemble
jump to class

assemble( array $data = array,  $reset = false,  $encode = false,  $partial = false ) : string

Assembles a URL path defined by this route

Arguments
$data
array
An array of variable and value pairs used as parameters
$reset
$encode
$partial
Output
string
Route path with user submitted parameters
Details
visibility
public
final
false
static
false

getDefault
jump to class

getDefault( string $name ) : string

Return a single parameter of route's defaults

Arguments
$name
string
Array key of the parameter
Output
string
Previously set default
Details
visibility
public
final
false
static
false

getDefaults
jump to class

getDefaults( ) : array

Return an array of defaults

Output
array
Route defaults
Details
visibility
public
final
false
static
false

getInstance
jump to class

getInstance( Zend_Config $config ) :

Instantiates route based on passed Zend_Config structure

Arguments
$config
Zend_Config
Configuration object
Details
visibility
public
final
false
static
true

getVersion
jump to class

getVersion( ) :
Details
visibility
public
final
false
static
false

match
jump to class

match( 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.

Arguments
$path
string
Path used to match against this routing map
$partial
Output
array|false
An array of assigned values or a false on a mismatch
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.