Controller/Action/Helper/ContextSwitch.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: Zend_Controller_Action_Helper
version: $Id: ContextSwitch.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Controller_Action_Helper_ContextSwitch

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

Extends from: Zend_Controller_Action_Helper_Abstract
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: Zend_Controller_Action_Helper
uses: Zend_Controller_Action_Helper_Abstract
Constants: TRIGGER_INIT; TRIGGER_POST
Properties: $_contexts; $_autoJsonSerialization; $_contextKey; $_contextParam; $_currentContext; $_defaultContext; $_disableLayout; $_specialConfig; $_unconfigurable; $_viewRenderer; $_viewSuffixOrig
Methods: __construct; init; setOptions; setConfig; direct; initContext; initJsonContext; setAutoJsonSerialization; getAutoJsonSerialization; _setSuffix; setSuffix; getSuffix; hasContext; addHeader; setHeader; addHeaders; _setHeaders; setHeaders; getHeader; getHeaders; removeHeader; clearHeaders; _validateTrigger; setCallback; _setCallbacks; setCallbacks; getCallback; getCallbacks; removeCallback; clearCallbacks; setContextParam; getContextParam; setDefaultContext; getDefaultContext; setAutoDisableLayout; getAutoDisableLayout; addContext; setContext; addContexts; setContexts; getContext; getContexts; removeContext; clearContexts; getCurrentContext; postDispatch; postJsonContext; addActionContext; setActionContext; addActionContexts; setActionContexts; hasActionContext; getActionContexts; removeActionContext; clearActionContexts; _getViewRenderer

Description

Simplify context switching based on requested format

Constants

TRIGGER_INIT
jump to class

 TRIGGER_INIT = 'TRIGGER_INIT'

Trigger type constants

Details

value: TRIGGER_INIT

TRIGGER_POST
jump to class

 TRIGGER_POST = 'TRIGGER_POST'

Details

value: TRIGGER_POST

Properties

$_autoJsonSerialization
jump to class

boolean $_autoJsonSerialization = 'true'

JSON auto-serialization flag

Details

$_autoJsonSerialization: boolean
visibility: protected
default: true
final: false
static: false

$_contextKey
jump to class

string $_contextKey = 'contexts'

Controller property key to utilize for context switching

Details

$_contextKey: string
visibility: protected
default: contexts
final: false
static: false

$_contextParam
jump to class

string $_contextParam = 'format'

Request parameter containing requested context

Details

$_contextParam: string
visibility: protected
default: format
final: false
static: false

$_contexts
jump to class

array $_contexts = 'array'

Supported contexts

Details

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

$_currentContext
jump to class

string $_currentContext = ''

Current context

Details

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

$_defaultContext
jump to class

string $_defaultContext = 'xml'

Default context (xml)

Details

$_defaultContext: string
visibility: protected
default: xml
final: false
static: false

$_disableLayout
jump to class

boolean $_disableLayout = 'true'

Whether or not to disable layouts when switching contexts

Details

$_disableLayout: boolean
visibility: protected
default: true
final: false
static: false

$_specialConfig
jump to class

array $_specialConfig = 'array'

Methods that require special configuration

Details

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

$_unconfigurable
jump to class

array $_unconfigurable = 'array'

Methods that are not configurable via setOptions and setConfig

Details

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

$_viewRenderer
jump to class

Zend_Controller_Action_Helper_ViewRenderer $_viewRenderer = ''

Details

$_viewRenderer: Zend_Controller_Action_Helper_ViewRenderer
visibility: protected
default
final: false
static: false

$_viewSuffixOrig
jump to class

string $_viewSuffixOrig = ''

Original view suffix prior to detecting context switch

Details

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

Methods

__construct
jump to class

__construct(
          array|Zend_Config $options
              =
              null
          )
        
        :
        void

Constructor

Arguments

$options: arrayZend_Config

Details

visibility: public
final: false
static: false

_getViewRenderer
jump to class

_getViewRenderer(
          
          )
        
        :
        Zend_Controller_Action_Helper_ViewRenderer

Retrieve ViewRenderer

Output

Zend_Controller_Action_Helper_ViewRenderer: Provides a fluent interface

Details

visibility: protected
final: false
static: false

_setCallbacks
jump to class

_setCallbacks(
          array $options
          )
        
        :
        Zend_Controller_Action_Helper_ContextSwitch

Set callbacks from array of context => callbacks pairs

Arguments

$options: array

Output

Zend_Controller_Action_Helper_ContextSwitch: Provides a fluent interface

Details

visibility: protected
final: false
static: false

_setHeaders
jump to class

_setHeaders(
          array $options
          )
        
        :
        Zend_Controller_Action_Helper_ContextSwitch

Set headers from context => headers pairs

Arguments

$options: array

Output

Zend_Controller_Action_Helper_ContextSwitch: Provides a fluent interface

Details

visibility: protected
final: false
static: false

_setSuffix
jump to class

_setSuffix(
          array $spec
          )
        
        :
        Zend_Controller_Action_Helper_ContextSwitch

Set suffix from array

Arguments

$spec: array

Output

Zend_Controller_Action_Helper_ContextSwitch: Provides a fluent interface

Details

visibility: protected
final: false
static: false

_validateTrigger
jump to class

_validateTrigger(
          string $trigger
          )
        
        :
        string

Validate trigger and return in normalized form

Arguments

$trigger: string

Output

string

Details

visibility: protected
final: false
static: false
throws

addActionContext
jump to class

addActionContext(
          string $action, string|array $context
          )
        
        :
        Zend_Controller_Action_Helper_ContextSwitch|void

Add one or more contexts to an action

Arguments

$action: string
$context: stringarray

Output

Zend_Controller_Action_Helper_ContextSwitch|void: Provides a fluent interface

Details

visibility: public
final: false
static: false

addActionContexts
jump to class

addActionContexts(
          array $contexts
          )
        
        :
        Zend_Controller_Action_Helper_ContextSwitch

Add multiple action/context pairs at once

Arguments

$contexts: array

Output

Zend_Controller_Action_Helper_ContextSwitch: Provides a fluent interface

Details

visibility: public
final: false
static: false

addContext
jump to class

addContext(
          string $context, array $spec
          )
        
        :
        Zend_Controller_Action_Helper_ContextSwitch

Add new context

Arguments

$context: string
Context type
$spec: array
Context specification

Output

Zend_Controller_Action_Helper_ContextSwitch: Provides a fluent interface

Details

visibility: public
final: false
static: false
throws

addContexts
jump to class

addContexts(
          array $contexts
          )
        
        :
        Zend_Controller_Action_Helper_ContextSwitch

Add multiple contexts

Arguments

$contexts: array

Output

Zend_Controller_Action_Helper_ContextSwitch: Provides a fluent interface

Details

visibility: public
final: false
static: false

addHeader
jump to class

addHeader(
          string $context, string $header, string $content
          )
        
        :
        Zend_Controller_Action_Helper_ContextSwitch

Add header to context

Arguments

$context: string
$header: string
$content: string

Output

Zend_Controller_Action_Helper_ContextSwitch: Provides a fluent interface

Details

visibility: public
final: false
static: false
throws

addHeaders
jump to class

addHeaders(
          string $context, array $headers
          )
        
        :
        Zend_Controller_Action_Helper_ContextSwitch

Add multiple headers at once for a given context

Arguments

$context: string
$headers: array

Output

Zend_Controller_Action_Helper_ContextSwitch: Provides a fluent interface

Details

visibility: public
final: false
static: false

clearActionContexts
jump to class

clearActionContexts(
          string $action
              =
              null
          )
        
        :
        Zend_Controller_Action_Helper_ContextSwitch

Clear all contexts for a given controller action or all actions

Arguments

$action: string

Output

Zend_Controller_Action_Helper_ContextSwitch: Provides a fluent interface

Details

visibility: public
final: false
static: false

clearCallbacks
jump to class

clearCallbacks(
          string $context
          )
        
        :
        Zend_Controller_Action_Helper_ContextSwitch

Clear all callbacks for a given context

Arguments

$context: string

Output

Zend_Controller_Action_Helper_ContextSwitch: Provides a fluent interface

Details

visibility: public
final: false
static: false

clearContexts
jump to class

clearContexts(
          
          )
        
        :
        Zend_Controller_Action_Helper_ContextSwitch

Remove all contexts

Output

Zend_Controller_Action_Helper_ContextSwitch: Provides a fluent interface

Details

visibility: public
final: false
static: false

clearHeaders
jump to class

clearHeaders(
          string $context
          )
        
        :
        Zend_Controller_Action_Helper_ContextSwitch

Clear all headers for a given context

Arguments

$context: string

Output

Zend_Controller_Action_Helper_ContextSwitch: Provides a fluent interface

Details

visibility: public
final: false
static: false

direct
jump to class

direct(
          
          )
        
        :
        Zend_Controller_Action_Helper_ContextSwitch

Strategy pattern: return object

Output

Zend_Controller_Action_Helper_ContextSwitch: Provides a fluent interface

Details

visibility: public
final: false
static: false

getActionContexts
jump to class

getActionContexts(
          string $action
              =
              null
          )
        
        :
        array

Get contexts for a given action or all actions in the controller

Arguments

$action: string

Output

array

Details

visibility: public
final: false
static: false

getAutoDisableLayout
jump to class

getAutoDisableLayout(
          
          )
        
        :
        boolean

Retrieve auto layout disable flag

Output

boolean

Details

visibility: public
final: false
static: false

getAutoJsonSerialization
jump to class

getAutoJsonSerialization(
          
          )
        
        :
        boolean

Get JSON context auto-serialization flag

Output

boolean

Details

visibility: public
final: false
static: false

getCallback
jump to class

getCallback(
          string $context, string $trigger
          )
        
        :
        string|array|null

Get a single callback for a given context and trigger

Arguments

$context: string
$trigger: string

Output

string|array|null

Details

visibility: public
final: false
static: false

getCallbacks
jump to class

getCallbacks(
          string $context
          )
        
        :
        array

Get all callbacks for a given context

Arguments

$context: string

Output

array

Details

visibility: public
final: false
static: false

getContext
jump to class

getContext(
          string $context
          )
        
        :
        array|null

Retrieve context specification

Arguments

$context: string

Output

array|null

Details

visibility: public
final: false
static: false

getContextParam
jump to class

getContextParam(
          
          )
        
        :
        string

Return context format request parameter name

Output

string

Details

visibility: public
final: false
static: false

getContexts
jump to class

getContexts(
          
          )
        
        :
        array

Retrieve context definitions

Output

array

Details

visibility: public
final: false
static: false

getCurrentContext
jump to class

getCurrentContext(
          
          )
        
        :
        null|string

Return current context, if any

Output

null|string

Details

visibility: public
final: false
static: false

getDefaultContext
jump to class

getDefaultContext(
          
          )
        
        :
        string

Return default context

Output

string

Details

visibility: public
final: false
static: false

getHeader
jump to class

getHeader(
          string $context, string $header
          )
        
        :
        string|null

Retrieve context header

Returns the value of a given header for a given context type

Arguments

$context: string
$header: string

Output

string|null

Details

visibility: public
final: false
static: false

getHeaders
jump to class

getHeaders(
          string $context
          )
        
        :
        array

Retrieve context headers

Returns all headers for a context as key/value pairs

Arguments

$context: string

Output

array

Details

visibility: public
final: false
static: false

getSuffix
jump to class

getSuffix(
          string $type
          )
        
        :
        string

Retrieve suffix for given context type

Arguments

$type: string
Context type

Output

string

Details

visibility: public
final: false
static: false
throws

hasActionContext
jump to class

hasActionContext(
          string $action, string|array $context
          )
        
        :
        boolean

Does a particular controller action have the given context(s)?

Arguments

$action: string
$context: stringarray

Output

boolean

Details

visibility: public
final: false
static: false
throws

hasContext
jump to class

hasContext(
          string $context, boolean $throwException
              =
              false
          )
        
        :
        bool

Does the given context exist?

Arguments

$context: string
$throwException: boolean

Output

bool

Details

visibility: public
final: false
static: false
throws: if context does not exist and throwException is true

init
jump to class

Initialize at start of action controller

Reset the view script suffix to the original state, or store the original state.

Details

visibility: public
final: false
static: false

initContext
jump to class

initContext(
          mixed $format
              =
              null
          )
        
        :
        void

Initialize context detection and switching

Arguments

$format: mixed

Details

visibility: public
final: false
static: false
throws

initJsonContext
jump to class

initJsonContext(
          
          )
        
        :
        void

JSON context extra initialization

Turns off viewRenderer auto-rendering

Details

visibility: public
final: false
static: false

postDispatch
jump to class

postDispatch(
          
          )
        
        :
        void

Post dispatch processing

Execute postDispatch callback for current context, if available

Details

visibility: public
final: false
static: false
throws

postJsonContext
jump to class

postJsonContext(
          
          )
        
        :
        void

JSON post processing

JSON serialize view variables to response body

Details

visibility: public
final: false
static: false

removeActionContext
jump to class

removeActionContext(
          string $action, string|array $context
          )
        
        :
        boolean

Remove one or more contexts for a given controller action

Arguments

$action: string
$context: stringarray

Output

boolean

Details

visibility: public
final: false
static: false

removeCallback
jump to class

removeCallback(
          string $context, string $trigger
          )
        
        :
        boolean

Clear a callback for a given context and trigger

Arguments

$context: string
$trigger: string

Output

boolean

Details

visibility: public
final: false
static: false

removeContext
jump to class

removeContext(
          string $context
          )
        
        :
        boolean

Remove a context

Arguments

$context: string

Output

boolean

Details

visibility: public
final: false
static: false

removeHeader
jump to class

removeHeader(
          string $context, string $header
          )
        
        :
        boolean

Remove a single header from a context

Arguments

$context: string
$header: string

Output

boolean

Details

visibility: public
final: false
static: false

setActionContext
jump to class

setActionContext(
          string $action, string|array $context
          )
        
        :
        Zend_Controller_Action_Helper_ContextSwitch|void

Set a context as available for a given controller action

Arguments

$action: string
$context: stringarray

Output

Zend_Controller_Action_Helper_ContextSwitch|void: Provides a fluent interface

Details

visibility: public
final: false
static: false

setActionContexts
jump to class

setActionContexts(
          array $contexts
          )
        
        :
        Zend_Controller_Action_Helper_ContextSwitch

Overwrite and set multiple action contexts at once

Arguments

$contexts: array

Output

Zend_Controller_Action_Helper_ContextSwitch: Provides a fluent interface

Details

visibility: public
final: false
static: false

setAutoDisableLayout
jump to class

setAutoDisableLayout(
          boolean $flag
          )
        
        :
        Zend_Controller_Action_Helper_ContextSwitch

Set flag indicating if layout should be disabled

Arguments

$flag: boolean

Output

Zend_Controller_Action_Helper_ContextSwitch: Provides a fluent interface

Details

visibility: public
final: false
static: false

setAutoJsonSerialization
jump to class

setAutoJsonSerialization(
          boolean $flag
          )
        
        :
        Zend_Controller_Action_Helper_ContextSwitch

Should JSON contexts auto-serialize?

Arguments

$flag: boolean

Output

Zend_Controller_Action_Helper_ContextSwitch: Provides a fluent interface

Details

visibility: public
final: false
static: false

setCallback
jump to class

setCallback(
          string $context, string $trigger, string|array $callback
          )
        
        :
        Zend_Controller_Action_Helper_ContextSwitch

Set a callback for a given context and trigger

Arguments

$context: string
$trigger: string
$callback: stringarray

Output

Zend_Controller_Action_Helper_ContextSwitch: Provides a fluent interface

Details

visibility: public
final: false
static: false
throws

setCallbacks
jump to class

setCallbacks(
          string $context, array $callbacks
          )
        
        :
        Zend_Controller_Action_Helper_ContextSwitch

Set callbacks for a given context

Callbacks should be in trigger/callback pairs.

Arguments

$context: string
$callbacks: array

Output

Zend_Controller_Action_Helper_ContextSwitch: Provides a fluent interface

Details

visibility: public
final: false
static: false

setConfig
jump to class

setConfig(
          Zend_Config $config
          )
        
        :
        Zend_Controller_Action_Helper_ContextSwitch

Set object state from config object

Arguments

$config: Zend_Config

Output

Zend_Controller_Action_Helper_ContextSwitch: Provides a fluent interface

Details

visibility: public
final: false
static: false

setContext
jump to class

setContext(
          string $context, array $spec
          )
        
        :
        Zend_Controller_Action_Helper_ContextSwitch

Overwrite existing context

Arguments

$context: string
Context type
$spec: array
Context specification

Output

Zend_Controller_Action_Helper_ContextSwitch: Provides a fluent interface

Details

visibility: public
final: false
static: false

setContextParam
jump to class

setContextParam(
          string $name
          )
        
        :
        Zend_Controller_Action_Helper_ContextSwitch

Set name of parameter to use when determining context format

Arguments

$name: string

Output

Zend_Controller_Action_Helper_ContextSwitch: Provides a fluent interface

Details

visibility: public
final: false
static: false

setContexts
jump to class

setContexts(
          array $contexts
          )
        
        :
        Zend_Controller_Action_Helper_ContextSwitch

Set multiple contexts, after first removing all

Arguments

$contexts: array

Output

Zend_Controller_Action_Helper_ContextSwitch: Provides a fluent interface

Details

visibility: public
final: false
static: false

setDefaultContext
jump to class

setDefaultContext(
          string $type
          )
        
        :
        Zend_Controller_Action_Helper_ContextSwitch

Indicate default context to use when no context format provided

Arguments

$type: string

Output

Zend_Controller_Action_Helper_ContextSwitch: Provides a fluent interface

Details

visibility: public
final: false
static: false
throws

setHeader
jump to class

setHeader(
           $context, string $header, string $content
          )
        
        :
        Zend_Controller_Action_Helper_ContextSwitch

Customize response header to use when switching context

Passing an empty header value to the setters disables the response header.

Arguments

$context
$header: string
Header to set
$content: string
Header content

Output

Zend_Controller_Action_Helper_ContextSwitch: Provides a fluent interface

Details

visibility: public
final: false
static: false

setHeaders
jump to class

setHeaders(
          string $context, array $headers
          )
        
        :
        Zend_Controller_Action_Helper_ContextSwitch

Set multiple headers at once for a given context

Arguments

$context: string
$headers: array

Output

Zend_Controller_Action_Helper_ContextSwitch: Provides a fluent interface

Details

visibility: public
final: false
static: false

setOptions
jump to class

setOptions(
          array $options
          )
        
        :
        Zend_Controller_Action_Helper_ContextSwitch

Configure object from array of options

Arguments

$options: array

Output

Zend_Controller_Action_Helper_ContextSwitch: Provides a fluent interface

Details

visibility: public
final: false
static: false

setSuffix
jump to class

setSuffix(
          string $context, string $suffix, boolean $prependViewRendererSuffix
              =
              true
          )
        
        :
        Zend_Controller_Action_Helper_ContextSwitch

Customize view script suffix to use when switching context.

Passing an empty suffix value to the setters disables the view script suffix change.

Arguments

$context: string
Context type for which to set suffix
$suffix: string
Suffix to use
$prependViewRendererSuffix: boolean
Whether or not to prepend the new suffix to the viewrenderer suffix

Output

Zend_Controller_Action_Helper_ContextSwitch: Provides a fluent interface

Details

visibility: public
final: false
static: false
throws

API Documentation

Controller/Action/Helper/ContextSwitch.php

Description

Zend_Controller_Action_Helper_ContextSwitchjump to top

Description

Constants

TRIGGER_INITjump to class

Details

TRIGGER_POSTjump to class

Details

Properties

$_autoJsonSerializationjump to class

Details

$_contextKeyjump to class

Details

$_contextParamjump to class

Details

$_contextsjump to class

Details

$_currentContextjump to class

Details

$_defaultContextjump to class

Details

$_disableLayoutjump to class

Details

$_specialConfigjump to class

Details

$_unconfigurablejump to class

Details

$_viewRendererjump to class

Details

$_viewSuffixOrigjump to class

Details

Methods

__constructjump to class

Arguments

Details

_getViewRendererjump to class

Output

Details

_setCallbacksjump to class

Arguments

Output

Details

_setHeadersjump to class

Arguments

Output

Details

_setSuffixjump to class

Arguments

Output

Details

_validateTriggerjump to class

Arguments

Output

Details

addActionContextjump to class

Arguments

Output

Details

addActionContextsjump to class

Arguments

Output

Details

addContextjump to class

Arguments

Output

Details

addContextsjump to class

Arguments

Output

Details

addHeaderjump to class

Arguments

Output

Details

addHeadersjump to class

Arguments

Output

Details

Zend_Controller_Action_Helper_ContextSwitch
jump to top

TRIGGER_INIT
jump to class

TRIGGER_POST
jump to class

$_autoJsonSerialization
jump to class

$_contextKey
jump to class

$_contextParam
jump to class

$_contexts
jump to class

$_currentContext
jump to class

$_defaultContext
jump to class

$_disableLayout
jump to class

$_specialConfig
jump to class

$_unconfigurable
jump to class

$_viewRenderer
jump to class

$_viewSuffixOrig
jump to class

__construct
jump to class

_getViewRenderer
jump to class

_setCallbacks
jump to class

_setHeaders
jump to class

_setSuffix
jump to class

_validateTrigger
jump to class

addActionContext
jump to class

addActionContexts
jump to class

addContext
jump to class

addContexts
jump to class

addHeader
jump to class

addHeaders
jump to class

clearActionContexts
jump to class

clearCallbacks
jump to class

clearContexts
jump to class

clearHeaders
jump to class

direct
jump to class

getActionContexts
jump to class

getAutoDisableLayout
jump to class

getAutoJsonSerialization
jump to class

getCallback
jump to class

getCallbacks
jump to class

getContext
jump to class

getContextParam
jump to class

getContexts
jump to class

getCurrentContext
jump to class

getDefaultContext
jump to class

getHeader
jump to class

getHeaders
jump to class

getSuffix
jump to class

hasActionContext
jump to class

hasContext
jump to class