API Documentation

Controller/Router/Route/Module.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: Module.php 24182 2011-07-03 13:43:05Z adamlundrigan $  

\Zend_Controller_Router_Route_Module

Module Route

Default route for module functionality

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

Properties

Propertyprotected  $_actionKey= 'action'
Default valueactionDetails
Type
Propertyprotected  $_controllerKey= 'controller'
Default valuecontrollerDetails
Type
Propertyprotectedarray  $_defaults= ''

Default values for the route (ie. module, controller, action, params)

Details
Type
array
Propertyprotected\Zend_Controller_Dispatcher_Interface  $_dispatcher= ''

Propertyprotected  $_keysSet= 'false'
Default valuefalseDetails
Type
Propertyprotected  $_moduleKey= 'module'
Default valuemoduleDetails
Type
Propertyprotected  $_moduleValid= 'false'
Default valuefalseDetails
Type
Propertyprotected\Zend_Controller_Request_Abstract  $_request= ''

Propertyprotected  $_values= 'array'
Default valuearrayDetails
Type

Methods

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

Constructor

Parameters
Name Type Description
$defaults array 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
Name Type Description
$data array An array of variable and value pairs used as parameters
$reset bool Weither to reset the current params
$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(  $config ) : void
static

Instantiates route based on passed Zend_Config structure

Parameters
Name Type Description
$config
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

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
Name Type Description
$path string Path used to match against this routing map
$partial
Returns
Type Description
array 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.