Controller/Router/Route.php

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: Route.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Controller_Router_Route

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
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
see: http://manuals.rubyonrails.com/read/chapter/65
subpackage: Router
Properties: $_defaultTranslator; $_translator; $_defaultLocale; $_locale; $_isTranslated; $_translatable; $_urlVariable; $_urlDelimiter; $_regexDelimiter; $_defaultRegex; $_variables; $_parts; $_defaults; $_requirements; $_values; $_wildcardData; $_staticCount
Methods: getVersion; getInstance; __construct; match; assemble; getDefault; getDefaults; getVariables; setDefaultTranslator; getDefaultTranslator; setTranslator; getTranslator; setDefaultLocale; getDefaultLocale; setLocale; getLocale

Description

Route

Properties

$_defaultLocale
jump to class

mixed $_defaultLocale = ''

Default locale

Details

$_defaultLocale: mixed
visibility: protected
default
final: false
static: true

$_defaultRegex
jump to class

$_defaultRegex = 'null'

Details

visibility: protected
default: null
final: false
static: false

$_defaultTranslator
jump to class

Zend_Translate $_defaultTranslator = ''

Default translator

Details

$_defaultTranslator: Zend_Translate
visibility: protected
default
final: false
static: true

$_defaults
jump to class

array $_defaults = 'array'

Holds user submitted default values for route's variables. Name and value pairs.

Details

$_defaults: array
visibility: protected
default: array
final: false
static: false

$_isTranslated
jump to class

boolean $_isTranslated = 'false'

Wether this is a translated route or not

Details

$_isTranslated: boolean
visibility: protected
default: false
final: false
static: false

$_locale
jump to class

mixed $_locale = ''

Locale

Details

$_locale: mixed
visibility: protected
default
final: false
static: false

$_parts
jump to class

array $_parts = 'array'

Holds Route patterns for all URL parts. 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.

In case of a wildcard, it stores an asterisk (*)

Details

$_parts: array
visibility: protected
default: array
final: false
static: false

$_regexDelimiter
jump to class

$_regexDelimiter = '#'

Details

visibility: protected
default: #
final: false
static: false

$_requirements
jump to class

array $_requirements = 'array'

Holds user submitted regular expression patterns for route's variables' values.

Name and value pairs.

Details

$_requirements: array
visibility: protected
default: array
final: false
static: false

$_staticCount
jump to class

int $_staticCount = '0'

Helper var that holds a count of route pattern's static parts for validation

Details

$_staticCount: int
visibility: protected
default: 0
final: false
static: false

$_translatable
jump to class

array $_translatable = 'array'

Translatable variables

Details

$_translatable: array
visibility: protected
default: array
final: false
static: false

$_translator
jump to class

Zend_Translate $_translator = ''

Translator

Details

$_translator: Zend_Translate
visibility: protected
default
final: false
static: false

$_urlDelimiter
jump to class

$_urlDelimiter = '/'

Details

visibility: protected
default: /
final: false
static: false

$_urlVariable
jump to class

$_urlVariable = ':'

Details

visibility: protected
default: :
final: false
static: false

$_values
jump to class

array $_values = 'array'

Associative array filled on match() that holds matched path values for given variable names.

Details

$_values: array
visibility: protected
default: array
final: false
static: false

$_variables
jump to class

array $_variables = 'array'

Holds names of all route's pattern variable names. Array index holds a position in URL.

Details

$_variables: array
visibility: protected
default: array
final: false
static: false

$_wildcardData
jump to class

array $_wildcardData = 'array'

Associative array filled on match() that holds wildcard variable names and values.

Details

$_wildcardData: array
visibility: protected
default: array
final: false
static: false

Methods

__construct
jump to class

__construct(
          string $route, array $defaults
              =
              array, array $reqs
              =
              array, Zend_Translate $translator
              =
              null,  $locale
              =
              null
          )
        
        :

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.

Arguments

$route: string
Map used to match with later submitted URL path
$defaults: array
Defaults for map variables with keys as variable names
$reqs: array
Regular expression requirements for variables (keys as variable names)
$translator: Zend_Translate
Translator to use for this instance
$locale

Details

visibility: public
final: false
static: false

assemble
jump to class

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

Assembles user submitted parameters forming a URL path defined by this route

Arguments

$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

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

getDefaultLocale
jump to class

getDefaultLocale(
          
          )
        
        :
        mixed

Get the default locale

Output

mixed

Details

visibility: public
final: false
static: true

getDefaultTranslator
jump to class

getDefaultTranslator(
          
          )
        
        :
        Zend_Translate

Get the default translator

Output

Zend_Translate

Details

visibility: public
final: false
static: true

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

getLocale
jump to class

getLocale(
          
          )
        
        :
        mixed

Get the locale

Output

mixed

Details

visibility: public
final: false
static: false

getTranslator
jump to class

getTranslator(
          
          )
        
        :
        Zend_Translate

Get the translator

Output

Zend_Translate

Details

visibility: public
final: false
static: false
throws: When no translator can be found

getVariables
jump to class

getVariables(
          
          )
        
        :
        array

Get all variables which are used by the route

Output

array

Details

visibility: public
final: false
static: false

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 parts defined by a map. Assigns and returns an array of variables 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

setDefaultLocale
jump to class

setDefaultLocale(
          mixed $locale
              =
              null
          )
        
        :
        void

Set a default locale

Arguments

$locale: mixed

Details

visibility: public
final: false
static: true

setDefaultTranslator
jump to class

setDefaultTranslator(
          Zend_Translate $translator
              =
              null
          )
        
        :
        void

Set a default translator

Arguments

$translator: Zend_Translate

Details

visibility: public
final: false
static: true

setLocale
jump to class

setLocale(
          mixed $locale
          )
        
        :
        void

Set a locale

Arguments

$locale: mixed

Details

visibility: public
final: false
static: false

setTranslator
jump to class

setTranslator(
          Zend_Translate $translator
          )
        
        :
        void

Set a translator

Arguments

$translator: Zend_Translate

Details

visibility: public
final: false
static: false

API Documentation

Controller/Router/Route.php

Description

Zend_Controller_Router_Routejump to top

Description

Properties

$_defaultLocalejump to class

Details

$_defaultRegexjump to class

Details

$_defaultTranslatorjump to class

Details

$_defaultsjump to class

Details

$_isTranslatedjump to class

Details

$_localejump to class

Details

$_partsjump to class

Details

$_regexDelimiterjump to class

Details

$_requirementsjump to class

Details

$_staticCountjump to class

Details

$_translatablejump to class

Details

$_translatorjump to class

Details

$_urlDelimiterjump to class

Details

$_urlVariablejump to class

Details

$_valuesjump to class

Details

$_variablesjump to class

Details

$_wildcardDatajump to class

Details

Methods

__constructjump to class

Arguments

Details

assemblejump to class

Arguments

Output

Details

getDefaultjump to class

Arguments

Output

Details

getDefaultLocalejump to class

Output

Details

getDefaultTranslatorjump to class

Output

Details

getDefaultsjump to class

Output

Details

getInstancejump to class

Arguments

Details

getLocalejump to class

Output

Details

getTranslatorjump to class

Output

Details

getVariablesjump to class

Output

Details

getVersionjump to class

Details

matchjump to class

Arguments

Output

Details

setDefaultLocalejump to class

Zend_Controller_Router_Route
jump to top

$_defaultLocale
jump to class

$_defaultRegex
jump to class

$_defaultTranslator
jump to class

$_defaults
jump to class

$_isTranslated
jump to class

$_locale
jump to class

$_parts
jump to class

$_regexDelimiter
jump to class

$_requirements
jump to class

$_staticCount
jump to class

$_translatable
jump to class

$_translator
jump to class

$_urlDelimiter
jump to class

$_urlVariable
jump to class

$_values
jump to class

$_variables
jump to class

$_wildcardData
jump to class

__construct
jump to class

assemble
jump to class

getDefault
jump to class

getDefaultLocale
jump to class

getDefaultTranslator
jump to class

getDefaults
jump to class

getInstance
jump to class

getLocale
jump to class

getTranslator
jump to class

getVariables
jump to class

getVersion
jump to class

match
jump to class

setDefaultLocale
jump to class

setDefaultTranslator
jump to class

setLocale
jump to class

setTranslator
jump to class