Controller/Dispatcher/Abstract.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: Dispatcher
version: $Id: Abstract.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Controller_Dispatcher_Abstract

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_Dispatcher_Abstract
jump to top

Implements: Zend_Controller_Dispatcher_Interface
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: Dispatcher
Properties: $_defaultAction; $_defaultController; $_defaultModule; $_frontController; $_invokeParams; $_pathDelimiter; $_response; $_wordDelimiter
Methods: __construct; formatControllerName; formatActionName; _verifyDelimiter; getWordDelimiter; setWordDelimiter; getPathDelimiter; setPathDelimiter; _formatName; getFrontController; setFrontController; setParam; setParams; getParam; getParams; clearParams; setResponse; getResponse; setDefaultControllerName; getDefaultControllerName; setDefaultAction; getDefaultAction; setDefaultModule; getDefaultModule

Description

Properties

$_defaultAction
jump to class

string $_defaultAction = 'index'

Default action

Details

$_defaultAction: string
visibility: protected
default: index
final: false
static: false

$_defaultController
jump to class

string $_defaultController = 'index'

Default controller

Details

$_defaultController: string
visibility: protected
default: index
final: false
static: false

$_defaultModule
jump to class

string $_defaultModule = 'default'

Default module

Details

$_defaultModule: string
visibility: protected
default: default
final: false
static: false

$_frontController
jump to class

Zend_Controller_Front $_frontController = ''

Front Controller instance

Details

$_frontController: Zend_Controller_Front
visibility: protected
default
final: false
static: false

$_invokeParams
jump to class

array $_invokeParams = 'array'

Array of invocation parameters to use when instantiating action controllers

Details

$_invokeParams: array
visibility: protected
default: array
final: false
static: false

$_pathDelimiter
jump to class

string $_pathDelimiter = '_'

Path delimiter character

Details

$_pathDelimiter: string
visibility: protected
default: _
final: false
static: false

$_response
jump to class

Zend_Controller_Response_Abstract|null $_response = 'null'

Response object to pass to action controllers, if any

Details

$_response: Zend_Controller_Response_Abstract|null
visibility: protected
default: null
final: false
static: false

$_wordDelimiter
jump to class

array $_wordDelimiter = 'array'

Word delimiter characters

Details

$_wordDelimiter: array
visibility: protected
default: array
final: false
static: false

Methods

__construct
jump to class

__construct(
           $params
              =
              array
          )
        
        :
        void

Constructor

Arguments

$params

Details

visibility: public
final: false
static: false

_formatName
jump to class

_formatName(
          string $unformatted, boolean $isAction
              =
              false
          )
        
        :
        string

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.

Arguments

$unformatted: string
$isAction: boolean
Defaults to false

Output

string

Details

visibility: protected
final: false
static: false

_verifyDelimiter
jump to class

_verifyDelimiter(
          string|array $spec
          )
        
        :
        array

Verify delimiter

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

Arguments

$spec: stringarray

Output

array

Details

visibility: public
final: false
static: false
throws: with invalid delimiters

clearParams
jump to class

clearParams(
          null|string|array $name
              =
              null
          )
        
        :
        Zend_Controller_Dispatcher_Abstract

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.

Arguments

$name: nullstringarray
single key or array of keys for params to clear

Output

Zend_Controller_Dispatcher_Abstract

Details

visibility: public
final: false
static: false

formatActionName
jump to class

formatActionName(
          string $unformatted
          )
        
        :
        string

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.

Arguments

$unformatted: string

Output

string

Details

visibility: public
final: false
static: false

formatControllerName
jump to class

formatControllerName(
          string $unformatted
          )
        
        :
        string

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.

Arguments

$unformatted: string

Output

string

Details

visibility: public
final: false
static: false

getDefaultAction
jump to class

getDefaultAction(
          
          )
        
        :
        string

Retrieve the default action name (minus formatting)

Output

string

Details

visibility: public
final: false
static: false

getDefaultControllerName
jump to class

getDefaultControllerName(
          
          )
        
        :
        string

Retrieve the default controller name (minus formatting)

Output

string

Details

visibility: public
final: false
static: false

getDefaultModule
jump to class

getDefaultModule(
          
          )
        
        :
        string

Retrieve the default module

Output

string

Details

visibility: public
final: false
static: false

getFrontController
jump to class

getFrontController(
          
          )
        
        :
        Zend_Controller_Front

Retrieve front controller instance

Output

Zend_Controller_Front

Details

visibility: public
final: false
static: false

getParam
jump to class

getParam(
          string $name
          )
        
        :
        mixed

Retrieve a single parameter from the controller parameter stack

Arguments

$name: string

Output

mixed

Details

visibility: public
final: false
static: false

getParams
jump to class

getParams(
          
          )
        
        :
        array

Retrieve action controller instantiation parameters

Output

array

Details

visibility: public
final: false
static: false

getPathDelimiter
jump to class

getPathDelimiter(
          
          )
        
        :
        array

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

Output

array

Details

visibility: public
final: false
static: false

getResponse
jump to class

getResponse(
          
          )
        
        :
        Zend_Controller_Response_Abstract|null

Return the registered response object

Output

Zend_Controller_Response_Abstract|null

Details

visibility: public
final: false
static: false

getWordDelimiter
jump to class

getWordDelimiter(
          
          )
        
        :
        array

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

Output

array

Details

visibility: public
final: false
static: false

setDefaultAction
jump to class

setDefaultAction(
          string $action
          )
        
        :
        Zend_Controller_Dispatcher_Abstract

Set the default action (minus any formatting)

Arguments

$action: string

Output

Zend_Controller_Dispatcher_Abstract

Details

visibility: public
final: false
static: false

setDefaultControllerName
jump to class

setDefaultControllerName(
          string $controller
          )
        
        :
        Zend_Controller_Dispatcher_Abstract

Set the default controller (minus any formatting)

Arguments

$controller: string

Output

Zend_Controller_Dispatcher_Abstract

Details

visibility: public
final: false
static: false

setDefaultModule
jump to class

setDefaultModule(
          string $module
          )
        
        :
        Zend_Controller_Dispatcher_Abstract

Set the default module

Arguments

$module: string

Output

Zend_Controller_Dispatcher_Abstract

Details

visibility: public
final: false
static: false

setFrontController
jump to class

setFrontController(
          Zend_Controller_Front $controller
          )
        
        :
        Zend_Controller_Dispatcher_Abstract

Set front controller instance

Arguments

$controller: Zend_Controller_Front

Output

Zend_Controller_Dispatcher_Abstract

Details

visibility: public
final: false
static: false

setParam
jump to class

setParam(
          string $name, mixed $value
          )
        
        :
        Zend_Controller_Dispatcher_Abstract

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

Arguments

$name: string
$value: mixed

Output

Zend_Controller_Dispatcher_Abstract

Details

visibility: public
final: false
static: false

setParams
jump to class

setParams(
          array $params
          )
        
        :
        Zend_Controller_Dispatcher_Abstract

Set parameters to pass to action controller constructors

Arguments

$params: array

Output

Zend_Controller_Dispatcher_Abstract

Details

visibility: public
final: false
static: false

setPathDelimiter
jump to class

setPathDelimiter(
          string $spec
          )
        
        :
        Zend_Controller_Dispatcher_Abstract

Set path delimiter

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

Arguments

$spec: string

Output

Zend_Controller_Dispatcher_Abstract

Details

visibility: public
final: false
static: false

setResponse
jump to class

setResponse(
          Zend_Controller_Response_Abstract|null $response
              =
              null
          )
        
        :
        Zend_Controller_Dispatcher_Abstract

Set response object to pass to action controllers

Arguments

$response: Zend_Controller_Response_Abstractnull

Output

Zend_Controller_Dispatcher_Abstract

Details

visibility: public
final: false
static: false

setWordDelimiter
jump to class

setWordDelimiter(
          string|array $spec
          )
        
        :
        Zend_Controller_Dispatcher_Abstract

Set word delimiter

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

Arguments

$spec: stringarray

Output

Zend_Controller_Dispatcher_Abstract

Details

visibility: public
final: false
static: false

API Documentation

Controller/Dispatcher/Abstract.php

Description

Zend_Controller_Dispatcher_Abstractjump to top

Description

Properties

$_defaultActionjump to class

Details

$_defaultControllerjump to class

Details

$_defaultModulejump to class

Details

$_frontControllerjump to class

Details

$_invokeParamsjump to class

Details

$_pathDelimiterjump to class

Details

$_responsejump to class

Details

$_wordDelimiterjump to class

Details

Methods

__constructjump to class

Arguments

Details

_formatNamejump to class

Arguments

Output

Details

_verifyDelimiterjump to class

Arguments

Output

Details

clearParamsjump to class

Arguments

Output

Details

formatActionNamejump to class

Arguments

Output

Details

formatControllerNamejump to class

Arguments

Output

Details

getDefaultActionjump to class

Output

Details

getDefaultControllerNamejump to class

Output

Details

getDefaultModulejump to class

Output

Details

getFrontControllerjump to class

Output

Details

getParamjump to class

Arguments

Output

Details

getParamsjump to class

Output

Details

getPathDelimiterjump to class

Output

Details

getResponsejump to class

Output

Details

getWordDelimiterjump to class

Output

Details

setDefaultActionjump to class

Arguments

Output

Details

setDefaultControllerNamejump to class

Arguments

Zend_Controller_Dispatcher_Abstract
jump to top

$_defaultAction
jump to class

$_defaultController
jump to class

$_defaultModule
jump to class

$_frontController
jump to class

$_invokeParams
jump to class

$_pathDelimiter
jump to class

$_response
jump to class

$_wordDelimiter
jump to class

__construct
jump to class

_formatName
jump to class

_verifyDelimiter
jump to class

clearParams
jump to class

formatActionName
jump to class

formatControllerName
jump to class

getDefaultAction
jump to class

getDefaultControllerName
jump to class

getDefaultModule
jump to class

getFrontController
jump to class

getParam
jump to class

getParams
jump to class

getPathDelimiter
jump to class

getResponse
jump to class

getWordDelimiter
jump to class

setDefaultAction
jump to class

setDefaultControllerName
jump to class

setDefaultModule
jump to class

setFrontController
jump to class

setParam
jump to class

setParams
jump to class

setPathDelimiter
jump to class

setResponse
jump to class

setWordDelimiter
jump to class