Controller/Router/Route/Module.php

Show:

inherited

Classes
- \Zend_Controller_Router_Route_Module

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 [email protected] 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
jump to top

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

 
                URI_DELIMITER
                = '/'

inherited

URI delimiter

Inherited from: \Zend_Controller_Router_Route_Abstract::URI_DELIMITER

Inherited_from: \Zend_Controller_Router_Route_Abstract::URI_DELIMITER

Properties

$_actionKey = 'action'

Default value'action'Details

Type: n/a

$_controllerKey = 'controller'

Default value'controller'Details

Type: n/a

array $_defaults =

Default values for the route (ie.

module, controller, action, params)

Details

Type: array

\Zend_Controller_Dispatcher_Interface $_dispatcher =

Details

Type: \Zend_Controller_Dispatcher_Interface

boolean $_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

$_keysSet = false

Default valuefalseDetails

Type: n/a

string $_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

$_moduleKey = 'module'

Default value'module'Details

Type: n/a

$_moduleValid = false

Default valuefalseDetails

Type: n/a

\Zend_Controller_Request_Abstract $_request =

Details

Type: \Zend_Controller_Request_Abstract

$_values = array()

Default valuearray()Details

Type: n/a

Methods

__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

_setRequestKeys() : void

Set request keys based on values in request object

assemble(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

chain(\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

Name	Type	Description
$route	\Zend_Controller_Router_Route_Abstract
$separator	string

Returns

Type	Description
\Zend_Controller_Router_Route_Chain

getDefault(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

getDefaults() : array

Return an array of defaults

Returns

Type	Description
array	Route defaults

getInstance( $config) : void

static

Instantiates route based on passed Zend_Config structure

Parameters

Name	Type	Description
$config

getMatchedPath() : string

inherited

Get partially matched path

Inherited from: \Zend_Controller_Router_Route_Abstract::getMatchedPath()

Returns

Type	Description
string

getVersion() : integer

Get the version of the route

Returns

Type	Description
integer

isAbstract(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

Name	Type	Description
$flag	boolean

Returns

Type	Description
boolean

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

setMatchedPath(string $path) : void

inherited

Set partially matched path

Inherited from: \Zend_Controller_Router_Route_Abstract::setMatchedPath()

Parameters

Name	Type	Description
$path	string

Controller/Router/Route/Module.php

\Zend_Controller_Router_Route_Modulejump to top

Constants

Properties

Methods

\Zend_Controller_Router_Route_Module
jump to top