Abstract Class Zend_Controller_Dispatcher_Abstract

Description

Implements interfaces:

  • copyright: Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)
  • abstract:
  • license: New BSD License

Located in /Controller/Dispatcher/Abstract.php (line 41)


	
			
Direct descendents
Variable Summary
Method Summary
Variables
string $_defaultAction = 'index' (line 47)

Default action

  • access: protected
string $_defaultController = 'index' (line 53)

Default controller

  • access: protected
string $_defaultModule = 'default' (line 59)

Default module

  • access: protected
Zend_Controller_Front $_frontController (line 65)

Front Controller instance

  • access: protected
array $_invokeParams = array() (line 72)

Array of invocation parameters to use when instantiating action

controllers

  • access: protected
string $_pathDelimiter = '_' (line 78)

Path delimiter character

  • access: protected
Zend_Controller_Response_Abstract|null $_response = null (line 84)

Response object to pass to action controllers, if any

  • access: protected
array $_wordDelimiter = array('-', '.') (line 90)

Word delimiter characters

  • access: protected
Methods
Constructor __construct (line 97)

Constructor

  • access: public
void __construct ([ $params = array()])
  • array $params

Redefined in descendants as:
clearParams (line 344)

Clear the controller parameter stack

By default, clears all parameters. If a parameter name is given, clears only that parameter; if an array of parameter names is provided, clears each.

  • access: public
Zend_Controller_Dispatcher_Abstract clearParams ([null|string|array $name = null])
  • null|string|array $name: single key or array of keys for params to clear

Implementation of:
Zend_Controller_Dispatcher_Interface::clearParams()
Clear the controller parameter stack
formatActionName (line 125)

Formats a string into an action name. This is used to take a raw action name, such as one that would be stored inside a Zend_Controller_Request_Abstract object, and reformat into a proper method name that would be found inside a class extending Zend_Controller_Action.

  • access: public
string formatActionName (string $unformatted)
  • string $unformatted

Implementation of:
Zend_Controller_Dispatcher_Interface::formatActionName()
Formats a string into an action name. This is used to take a raw action name, such as one that would be packaged inside a request object, and reformat into a proper method name that would be found inside a class extending Zend_Controller_Action.
formatControllerName (line 111)

Formats a string into a controller name. This is used to take a raw controller name, such as one stored inside a Zend_Controller_Request_Abstract object, and reformat it to a proper class name that a class extending Zend_Controller_Action would use.

  • access: public
string formatControllerName (string $unformatted)
  • string $unformatted

Implementation of:
Zend_Controller_Dispatcher_Interface::formatControllerName()
Formats a string into a controller name. This is used to take a raw controller name, such as one that would be packaged inside a request object, and reformat it to a proper class name that a class extending Zend_Controller_Action would use.
getDefaultAction (line 422)

Retrieve the default action name (minus formatting)

  • access: public
string getDefaultAction ()
getDefaultControllerName (line 400)

Retrieve the default controller name (minus formatting)

  • access: public
string getDefaultControllerName ()
getDefaultModule (line 444)

Retrieve the default module

  • access: public
string getDefaultModule ()
getFrontController (line 261)

Retrieve front controller instance

  • access: public
Zend_Controller_Front getFrontController ()
getParam (line 315)

Retrieve a single parameter from the controller parameter stack

  • access: public
mixed getParam (string $name)
  • string $name

Implementation of:
Zend_Controller_Dispatcher_Interface::getParam()
Retrieve a single parameter from the controller parameter stack
getParams (line 329)

Retrieve action controller instantiation parameters

  • access: public
array getParams ()

Implementation of:
Zend_Controller_Dispatcher_Interface::getParams()
Retrieve the parameters to pass to the Action Controller constructor
getPathDelimiter (line 200)

Retrieve the path delimiter character(s) used in controller names

  • access: public
array getPathDelimiter ()
getResponse (line 378)

Return the registered response object

  • access: public
Zend_Controller_Response_Abstract|null getResponse ()

Implementation of:
Zend_Controller_Dispatcher_Interface::getResponse()
Retrieve the response object, if any
getWordDelimiter (line 172)

Retrieve the word delimiter character(s) used in controller or action names

  • access: public
array getWordDelimiter ()
setDefaultAction (line 411)

Set the default action (minus any formatting)

  • access: public
Zend_Controller_Dispatcher_Abstract setDefaultAction (string $action)
  • string $action
setDefaultControllerName (line 389)

Set the default controller (minus any formatting)

  • access: public
Zend_Controller_Dispatcher_Abstract setDefaultControllerName (string $controller)
  • string $controller
setDefaultModule (line 433)

Set the default module

  • access: public
Zend_Controller_Dispatcher_Abstract setDefaultModule (string $module)
  • string $module
setFrontController (line 277)

Set front controller instance

  • access: public
setParam (line 290)

Add or modify a parameter to use when instantiating an action controller

  • access: public
Zend_Controller_Dispatcher_Abstract setParam (string $name, mixed $value)
  • string $name
  • mixed $value

Implementation of:
Zend_Controller_Dispatcher_Interface::setParam()
Add or modify a parameter with which to instantiate an Action Controller
setParams (line 303)

Set parameters to pass to action controller constructors

  • access: public
Zend_Controller_Dispatcher_Abstract setParams ( $params)
  • array $params

Implementation of:
Zend_Controller_Dispatcher_Interface::setParams()
Set an array of a parameters to pass to the Action Controller constructor
setPathDelimiter (line 214)

Set path delimiter

Set the path delimiter to use in controllers. May be a single string or an array of strings.

  • access: public
Zend_Controller_Dispatcher_Abstract setPathDelimiter (string|array $spec)
  • string|array $spec
setResponse (line 367)

Set response object to pass to action controllers

  • access: public

Implementation of:
Zend_Controller_Dispatcher_Interface::setResponse()
Set the response object to use, if any
setWordDelimiter (line 186)

Set word delimiter

Set the word delimiter to use in controllers and actions. May be a single string or an array of strings.

  • access: public
Zend_Controller_Dispatcher_Abstract setWordDelimiter (string|array $spec)
  • string|array $spec
_formatName (line 238)

Formats a string from a URI into a PHP-friendly name.

By default, replaces words separated by the word separator character(s) with camelCaps. If $isAction is false, it also preserves replaces words separated by the path separation character with an underscore, making the following word Title cased. All non-alphanumeric characters are removed.

  • access: protected
string _formatName (string $unformatted, [boolean $isAction = false])
  • string $unformatted
  • boolean $isAction: Defaults to false
_verifyDelimiter (line 141)

Verify delimiter

Verify a delimiter to use in controllers or actions. May be a single string or an array of strings.

  • throws: Zend_Controller_Dispatcher_Exception with invalid delimiters
  • access: public
array _verifyDelimiter (string|array $spec)
  • string|array $spec

Documentation generated on Sun, 27 May 2007 23:20:06 -0700 by phpDocumentor 1.3.2