Controller/Router/Route/Module.php

Show: PublicProtectedPrivateinherited
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: Module.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Controller_Router_Route_Module

Package: Zend\Controller\Router
Module Route

Default route for module functionality

Parent(s)
\Zend_Controller_Router_Route_Abstract
Children
\Zend_Rest_Route
See
\global\http://manuals.rubyonrails.com/read/chapter/65  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

>VConstant  URI_DELIMITER = '/'
inherited
URI delimiter
Inherited from: \Zend_Controller_Router_Route_Abstract::URI_DELIMITER

Properties

>VPropertyprotected$_actionKey = 'action'
Default value'action'Details
Type
n/a
>VPropertyprotected$_controllerKey = 'controller'
Default value'controller'Details
Type
n/a
>VPropertyprotectedarray $_defaults
Default values for the route (ie.

module, controller, action, params)

Details
Type
array
>VPropertyprotected\Zend_Controller_Dispatcher_Interface $_dispatcher
>VPropertyprotectedboolean $_isAbstract = false
inherited
Wether this route is abstract or not
Inherited from: \Zend_Controller_Router_Route_Abstract::$$_isAbstract
Default valuefalseDetails
Type
boolean
Inherited_from
\Zend_Controller_Router_Route_Abstract::$$_isAbstract  
>VPropertyprotected$_keysSet = false
Default valuefalseDetails
Type
n/a
>VPropertyprotectedstring $_matchedPath = null
inherited
Path matched by this route
Inherited from: \Zend_Controller_Router_Route_Abstract::$$_matchedPath
Default valuenullDetails
Type
string
Inherited_from
\Zend_Controller_Router_Route_Abstract::$$_matchedPath  
>VPropertyprotected$_moduleKey = 'module'
Default value'module'Details
Type
n/a
>VPropertyprotected$_moduleValid = false
Default valuefalseDetails
Type
n/a
>VPropertyprotected\Zend_Controller_Request_Abstract $_request
>VPropertyprotected$_values = array()
Default valuearray()Details
Type
n/a

Methods

methodpublic__construct(array $defaults = array(), \Zend_Controller_Dispatcher_Interface $dispatcher = null, \Zend_Controller_Request_Abstract $request = null) : void

Constructor

Parameters
NameTypeDescription
$defaultsarray

Defaults for map variables with keys as variable names

$dispatcher\Zend_Controller_Dispatcher_Interface

Dispatcher object

$request\Zend_Controller_Request_Abstract

Request object

methodprotected_setRequestKeys() : void

Set request keys based on values in request object

methodpublicassemble(array $data = array(), bool $reset = false,  $encode = true,  $partial = false) : string

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

Parameters
NameTypeDescription
$dataarray

An array of variable and value pairs used as parameters

$resetbool

Weither to reset the current params

$encode
$partial
Returns
TypeDescription
stringRoute path with user submitted parameters
methodpublicchain(\Zend_Controller_Router_Route_Abstract $route, string $separator = '/') : \Zend_Controller_Router_Route_Chain
inherited

Create a new chain

Inherited from: \Zend_Controller_Router_Route_Abstract::chain()
Parameters
NameTypeDescription
$route\Zend_Controller_Router_Route_Abstract
$separatorstring
Returns
TypeDescription
\Zend_Controller_Router_Route_Chain
methodpublicgetDefault(string $name) : string

Return a single parameter of route's defaults

Parameters
NameTypeDescription
$namestring

Array key of the parameter

Returns
TypeDescription
stringPreviously set default
methodpublicgetDefaults() : array

Return an array of defaults

Returns
TypeDescription
arrayRoute defaults
methodpublicgetInstance( $config) : void
static

Instantiates route based on passed Zend_Config structure

Parameters
NameTypeDescription
$config
methodpublicgetMatchedPath() : string
inherited

Get partially matched path

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

Get the version of the route

Returns
TypeDescription
integer
methodpublicisAbstract(boolean $flag = null) : boolean
inherited

Check or set wether this is an abstract route or not

Inherited from: \Zend_Controller_Router_Route_Abstract::isAbstract()
Parameters
NameTypeDescription
$flagboolean
Returns
TypeDescription
boolean
methodpublicmatch(string $path,  $partial = false) : array

Matches a user submitted path.

Assigns and returns an array of variables on a successful match.

If a request object is registered, it uses its setModuleName(), setControllerName(), and setActionName() accessors to set those values. Always returns the values as an array.

Parameters
NameTypeDescription
$pathstring

Path used to match against this routing map

$partial
Returns
TypeDescription
arrayAn array of assigned values or a false on a mismatch
methodpublicsetMatchedPath(string $path) : void
inherited

Set partially matched path

Inherited from: \Zend_Controller_Router_Route_Abstract::setMatchedPath()
Parameters
NameTypeDescription
$pathstring
Documentation was generated by phpDocumentor 2.0.0a12.