Controller/Router/Route/Module.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: Module.php 20096 2010-01-06 02:05:09Z bkarwin $
- Classes
- Zend_Controller_Router_Route_Module
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_Module
- 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
- Constants
- URI_DELIMITER
- Properties
- $_defaults
- $_values
- $_moduleValid
- $_keysSet
- $_moduleKey
- $_controllerKey
- $_actionKey
- $_dispatcher
- $_request
- Methods
- getVersion
- getInstance
- __construct
- _setRequestKeys
- match
- assemble
- getDefault
- getDefaults
Description
Module Route
Default route for module functionality
Constants
Properties
$_actionKey
$_actionKey = 'action'
Details
- visibility
- protected
- default
- action
- final
- false
- static
- false
$_controllerKey
$_controllerKey = 'controller'
Details
- visibility
- protected
- default
- controller
- final
- false
- static
- false
$_defaults
array $_defaults = ''Default values for the route (ie. module, controller, action, params)
Details
- $_defaults
- array
- visibility
- protected
- default
- final
- false
- static
- false
$_dispatcher
Zend_Controller_Dispatcher_Interface $_dispatcher = ''
Details
- $_dispatcher
-
Zend_Controller_Dispatcher_Interface
- visibility
- protected
- default
- final
- false
- static
- false
$_keysSet
$_keysSet = 'false'
Details
- visibility
- protected
- default
- false
- final
- false
- static
- false
$_moduleKey
$_moduleKey = 'module'
Details
- visibility
- protected
- default
- module
- final
- false
- static
- false
$_moduleValid
$_moduleValid = 'false'
Details
- visibility
- protected
- default
- false
- final
- false
- static
- false
$_request
Zend_Controller_Request_Abstract $_request = ''
Details
- $_request
-
Zend_Controller_Request_Abstract
- visibility
- protected
- default
- final
- false
- static
- false
$_values
$_values = 'array'
Details
- visibility
- protected
- default
- array
- final
- false
- static
- false
Methods
__construct
__construct(
array $defaults
=
array, Zend_Controller_Dispatcher_Interface $dispatcher
=
null, Zend_Controller_Request_Abstract $request
=
null
)
:
Constructor
Arguments
- $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
Details
- visibility
- public
- final
- false
- static
- false
_setRequestKeys
_setRequestKeys(
)
:
voidSet request keys based on values in request object
Details
- visibility
- protected
- final
- false
- static
- false
assemble
assemble(
array $data
=
array, bool $reset
=
false, $encode
=
true, $partial
=
false
)
:
stringAssembles 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
- bool
Weither to reset the current params - $encode
- $partial
Output
- string
- Route path with user submitted parameters
Details
- visibility
- public
- final
- false
- static
- false
getDefault
getDefault(
string $name
)
:
stringReturn 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
getDefaults(
)
:
arrayReturn an array of defaults
Output
- array
- Route defaults
Details
- visibility
- public
- final
- false
- static
- false
getInstance
getInstance(
$config
)
:
Instantiates route based on passed Zend_Config structure
Arguments
- $config
Details
- visibility
- public
- final
- false
- static
- true
getVersion
getVersion(
)
:
Details
- visibility
- public
- final
- false
- static
- false
match
match(
string $path, $partial
=
false
)
:
arrayMatches 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.
Arguments
- $path
- string
Path used to match against this routing map - $partial
Output
- array
- An array of assigned values or a false on a mismatch
Details
- visibility
- public
- final
- false
- static
- false