API Documentation

Zend/Controller/Action/Helper/ContextSwitch.php

Show: inherited
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 license@zend.com 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
Zend_Controller_Action_Helper  
Version
$Id: ContextSwitch.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Controller_Action_Helper_ContextSwitch

Package: Zend\Controller\Zend\Controller\Action\Helper

Simplify context switching based on requested format

Parent(s)
\Zend_Controller_Action_Helper_Abstract
Children
\Zend_Controller_Action_Helper_AjaxContext
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Uses
\Zend_Controller_Action_Helper_Abstract  

Constants

Constant  TRIGGER_INIT = 'TRIGGER_INIT'

Trigger type constants

Constant  TRIGGER_POST = 'TRIGGER_POST'

Properties

Propertyprotectedboolean  $_autoJsonSerialization= 'true'

JSON auto-serialization flag

Default valuetrueDetails
Type
boolean
Propertyprotectedstring  $_contextKey= ''contexts''

Controller property key to utilize for context switching

Default value'contexts'Details
Type
string
Propertyprotectedstring  $_contextParam= ''format''

Request parameter containing requested context

Default value'format'Details
Type
string
Propertyprotectedarray  $_contexts= 'array()'

Supported contexts

Default valuearray()Details
Type
array
Propertyprotectedstring  $_currentContext= ''

Current context

Details
Type
string
Propertyprotectedstring  $_defaultContext= ''xml''

Default context (xml)

Default value'xml'Details
Type
string
Propertyprotectedboolean  $_disableLayout= 'true'

Whether or not to disable layouts when switching contexts

Default valuetrueDetails
Type
boolean
Propertyprotectedarray  $_specialConfig= 'array( 'setSuffix''

Methods that require special configuration

Default valuearray( 'setSuffix'Details
Type
array
Propertyprotectedarray  $_unconfigurable= 'array( 'setOptions''

Methods that are not configurable via setOptions and setConfig

Default valuearray( 'setOptions'Details
Type
array
Propertyprotected\Zend_Controller_Action_Helper_ViewRenderer  $_viewRenderer= ''

Propertyprotectedstring  $_viewSuffixOrig= ''

Original view suffix prior to detecting context switch

Details
Type
string

Methods

methodpublic__construct( array|\Zend_Config $options = null ) : void

Constructor

Parameters
Name Type Description
$options array|\Zend_Config
methodprotected_getViewRenderer( ) : \Zend_Controller_Action_Helper_ViewRenderer

Retrieve ViewRenderer

Returns
Type Description
\Zend_Controller_Action_Helper_ViewRenderer Provides a fluent interface
methodprotected_setCallbacks( array $options ) : \Zend_Controller_Action_Helper_ContextSwitch

Set callbacks from array of context => callbacks pairs

Parameters
Name Type Description
$options array
Returns
Type Description
\Zend_Controller_Action_Helper_ContextSwitch Provides a fluent interface
methodprotected_setHeaders( array $options ) : \Zend_Controller_Action_Helper_ContextSwitch

Set headers from context => headers pairs

Parameters
Name Type Description
$options array
Returns
Type Description
\Zend_Controller_Action_Helper_ContextSwitch Provides a fluent interface
methodprotected_setSuffix( array $spec ) : \Zend_Controller_Action_Helper_ContextSwitch

Set suffix from array

Parameters
Name Type Description
$spec array
Returns
Type Description
\Zend_Controller_Action_Helper_ContextSwitch Provides a fluent interface
methodprotected_validateTrigger( string $trigger ) : string

Validate trigger and return in normalized form

Parameters
Name Type Description
$trigger string
Returns
Type Description
string
Throws
Exception Description
\Zend_Controller_Action_Exception
methodpublicaddActionContext( string $action, string|array $context ) : \Zend_Controller_Action_Helper_ContextSwitch|void

Add one or more contexts to an action

Parameters
Name Type Description
$action string
$context string|array
Returns
Type Description
\Zend_Controller_Action_Helper_ContextSwitch|void Provides a fluent interface
methodpublicaddActionContexts( array $contexts ) : \Zend_Controller_Action_Helper_ContextSwitch

Add multiple action/context pairs at once

Parameters
Name Type Description
$contexts array
Returns
Type Description
\Zend_Controller_Action_Helper_ContextSwitch Provides a fluent interface
methodpublicaddContext( string $context, array $spec ) : \Zend_Controller_Action_Helper_ContextSwitch

Add new context

Parameters
Name Type Description
$context string

Context type

$spec array

Context specification

Returns
Type Description
\Zend_Controller_Action_Helper_ContextSwitch Provides a fluent interface
Throws
Exception Description
\Zend_Controller_Action_Exception
methodpublicaddContexts( array $contexts ) : \Zend_Controller_Action_Helper_ContextSwitch

Add multiple contexts

Parameters
Name Type Description
$contexts array
Returns
Type Description
\Zend_Controller_Action_Helper_ContextSwitch Provides a fluent interface
methodpublicaddHeader( string $context, string $header, string $content ) : \Zend_Controller_Action_Helper_ContextSwitch

Add header to context

Parameters
Name Type Description
$context string
$header string
$content string
Returns
Type Description
\Zend_Controller_Action_Helper_ContextSwitch Provides a fluent interface
Throws
Exception Description
\Zend_Controller_Action_Exception
methodpublicaddHeaders( string $context, array $headers ) : \Zend_Controller_Action_Helper_ContextSwitch

Add multiple headers at once for a given context

Parameters
Name Type Description
$context string
$headers array
Returns
Type Description
\Zend_Controller_Action_Helper_ContextSwitch Provides a fluent interface
methodpublicclearActionContexts( string $action = null ) : \Zend_Controller_Action_Helper_ContextSwitch

Clear all contexts for a given controller action or all actions

Parameters
Name Type Description
$action string
Returns
Type Description
\Zend_Controller_Action_Helper_ContextSwitch Provides a fluent interface
methodpublicclearCallbacks( string $context ) : \Zend_Controller_Action_Helper_ContextSwitch

Clear all callbacks for a given context

Parameters
Name Type Description
$context string
Returns
Type Description
\Zend_Controller_Action_Helper_ContextSwitch Provides a fluent interface
methodpublicclearContexts( ) : \Zend_Controller_Action_Helper_ContextSwitch

Remove all contexts

Returns
Type Description
\Zend_Controller_Action_Helper_ContextSwitch Provides a fluent interface
methodpublicclearHeaders( string $context ) : \Zend_Controller_Action_Helper_ContextSwitch

Clear all headers for a given context

Parameters
Name Type Description
$context string
Returns
Type Description
\Zend_Controller_Action_Helper_ContextSwitch Provides a fluent interface
methodpublicdirect( ) : \Zend_Controller_Action_Helper_ContextSwitch

Strategy pattern: return object

Returns
Type Description
\Zend_Controller_Action_Helper_ContextSwitch Provides a fluent interface
methodpublicgetActionContexts( string $action = null ) : array

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

Parameters
Name Type Description
$action string
Returns
Type Description
array
methodpublicgetAutoDisableLayout( ) : boolean

Retrieve auto layout disable flag

Returns
Type Description
boolean
methodpublicgetAutoJsonSerialization( ) : boolean

Get JSON context auto-serialization flag

Returns
Type Description
boolean
methodpublicgetCallback( string $context, string $trigger ) : string|array|null

Get a single callback for a given context and trigger

Parameters
Name Type Description
$context string
$trigger string
Returns
Type Description
string|array|null
methodpublicgetCallbacks( string $context ) : array

Get all callbacks for a given context

Parameters
Name Type Description
$context string
Returns
Type Description
array
methodpublicgetContext( string $context ) : array|null

Retrieve context specification

Parameters
Name Type Description
$context string
Returns
Type Description
array|null
methodpublicgetContextParam( ) : string

Return context format request parameter name

Returns
Type Description
string
methodpublicgetContexts( ) : array

Retrieve context definitions

Returns
Type Description
array
methodpublicgetCurrentContext( ) : null|string

Return current context, if any

Returns
Type Description
null|string
methodpublicgetDefaultContext( ) : string

Return default context

Returns
Type Description
string
methodpublicgetHeader( string $context, string $header ) : string|null

Retrieve context header

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

Parameters
Name Type Description
$context string
$header string
Returns
Type Description
string|null
methodpublicgetHeaders( string $context ) : array

Retrieve context headers

Returns all headers for a context as key/value pairs

Parameters
Name Type Description
$context string
Returns
Type Description
array
methodpublicgetSuffix( string $type ) : string

Retrieve suffix for given context type

Parameters
Name Type Description
$type string

Context type

Returns
Type Description
string
Throws
Exception Description
\Zend_Controller_Action_Exception
methodpublichasActionContext( string $action, string|array $context ) : boolean

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

Parameters
Name Type Description
$action string
$context string|array
Returns
Type Description
boolean
Throws
Exception Description
\Zend_Controller_Action_Exception
methodpublichasContext( string $context, boolean $throwException = false ) : bool

Does the given context exist?

Parameters
Name Type Description
$context string
$throwException boolean
Returns
Type Description
bool
Throws
Exception Description
\Zend_Controller_Action_Exception if context does not exist and throwException is true
methodpublicinit( ) : void

Initialize at start of action controller

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

methodpublicinitContext( mixed $format = null ) : void

Initialize context detection and switching

Parameters
Name Type Description
$format mixed
Throws
Exception Description
\Zend_Controller_Action_Exception
methodpublicinitJsonContext( ) : void

JSON context extra initialization

Turns off viewRenderer auto-rendering

methodpublicpostDispatch( ) : void

Post dispatch processing

Execute postDispatch callback for current context, if available

Throws
Exception Description
\Zend_Controller_Action_Exception
methodpublicpostJsonContext( ) : void

JSON post processing

JSON serialize view variables to response body

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

Remove one or more contexts for a given controller action

Parameters
Name Type Description
$action string
$context string|array
Returns
Type Description
boolean
methodpublicremoveCallback( string $context, string $trigger ) : boolean

Clear a callback for a given context and trigger

Parameters
Name Type Description
$context string
$trigger string
Returns
Type Description
boolean
methodpublicremoveContext( string $context ) : boolean

Remove a context

Parameters
Name Type Description
$context string
Returns
Type Description
boolean
methodpublicremoveHeader( string $context, string $header ) : boolean

Remove a single header from a context

Parameters
Name Type Description
$context string
$header string
Returns
Type Description
boolean
methodpublicsetActionContext( string $action, string|array $context ) : \Zend_Controller_Action_Helper_ContextSwitch|void

Set a context as available for a given controller action

Parameters
Name Type Description
$action string
$context string|array
Returns
Type Description
\Zend_Controller_Action_Helper_ContextSwitch|void Provides a fluent interface
methodpublicsetActionContexts( array $contexts ) : \Zend_Controller_Action_Helper_ContextSwitch

Overwrite and set multiple action contexts at once

Parameters
Name Type Description
$contexts array
Returns
Type Description
\Zend_Controller_Action_Helper_ContextSwitch Provides a fluent interface
methodpublicsetAutoDisableLayout( boolean $flag ) : \Zend_Controller_Action_Helper_ContextSwitch

Set flag indicating if layout should be disabled

Parameters
Name Type Description
$flag boolean
Returns
Type Description
\Zend_Controller_Action_Helper_ContextSwitch Provides a fluent interface
methodpublicsetAutoJsonSerialization( boolean $flag ) : \Zend_Controller_Action_Helper_ContextSwitch

Should JSON contexts auto-serialize?

Parameters
Name Type Description
$flag boolean
Returns
Type Description
\Zend_Controller_Action_Helper_ContextSwitch Provides a fluent interface
methodpublicsetCallback( string $context, string $trigger, string|array $callback ) : \Zend_Controller_Action_Helper_ContextSwitch

Set a callback for a given context and trigger

Parameters
Name Type Description
$context string
$trigger string
$callback string|array
Returns
Type Description
\Zend_Controller_Action_Helper_ContextSwitch Provides a fluent interface
Throws
Exception Description
\Zend_Controller_Action_Exception
methodpublicsetCallbacks( string $context, array $callbacks ) : \Zend_Controller_Action_Helper_ContextSwitch

Set callbacks for a given context

Callbacks should be in trigger/callback pairs.

Parameters
Name Type Description
$context string
$callbacks array
Returns
Type Description
\Zend_Controller_Action_Helper_ContextSwitch Provides a fluent interface
methodpublicsetConfig( \Zend_Config $config ) : \Zend_Controller_Action_Helper_ContextSwitch

Set object state from config object

Parameters
Name Type Description
$config \Zend_Config
Returns
Type Description
\Zend_Controller_Action_Helper_ContextSwitch Provides a fluent interface
methodpublicsetContext( string $context, array $spec ) : \Zend_Controller_Action_Helper_ContextSwitch

Overwrite existing context

Parameters
Name Type Description
$context string

Context type

$spec array

Context specification

Returns
Type Description
\Zend_Controller_Action_Helper_ContextSwitch Provides a fluent interface
methodpublicsetContextParam( string $name ) : \Zend_Controller_Action_Helper_ContextSwitch

Set name of parameter to use when determining context format

Parameters
Name Type Description
$name string
Returns
Type Description
\Zend_Controller_Action_Helper_ContextSwitch Provides a fluent interface
methodpublicsetContexts( array $contexts ) : \Zend_Controller_Action_Helper_ContextSwitch

Set multiple contexts, after first removing all

Parameters
Name Type Description
$contexts array
Returns
Type Description
\Zend_Controller_Action_Helper_ContextSwitch Provides a fluent interface
methodpublicsetDefaultContext( string $type ) : \Zend_Controller_Action_Helper_ContextSwitch

Indicate default context to use when no context format provided

Parameters
Name Type Description
$type string
Returns
Type Description
\Zend_Controller_Action_Helper_ContextSwitch Provides a fluent interface
Throws
Exception Description
\Zend_Controller_Action_Exception
methodpublicsetHeader(  $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.

Parameters
Name Type Description
$context
$header string

Header to set

$content string

Header content

Returns
Type Description
\Zend_Controller_Action_Helper_ContextSwitch Provides a fluent interface
methodpublicsetHeaders( string $context, array $headers ) : \Zend_Controller_Action_Helper_ContextSwitch

Set multiple headers at once for a given context

Parameters
Name Type Description
$context string
$headers array
Returns
Type Description
\Zend_Controller_Action_Helper_ContextSwitch Provides a fluent interface
methodpublicsetOptions( array $options ) : \Zend_Controller_Action_Helper_ContextSwitch

Configure object from array of options

Parameters
Name Type Description
$options array
Returns
Type Description
\Zend_Controller_Action_Helper_ContextSwitch Provides a fluent interface
methodpublicsetSuffix( 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.

Parameters
Name Type Description
$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

Returns
Type Description
\Zend_Controller_Action_Helper_ContextSwitch Provides a fluent interface
Throws
Exception Description
\Zend_Controller_Action_Exception
Documentation was generated by DocBlox 0.15.1.