API Documentation

Controller/Action/Helper/Json.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Controller  
subpackage
Zend_Controller_Action_Helper  
version
$Id: Json.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Controller_Action_Helper_Json

Simplify AJAX context switching based on requested format

Extends from
\Zend_Controller_Action_Helper_Abstract
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Controller  
subpackage
Zend_Controller_Action_Helper  
uses
\Zend_Controller_Action_Helper_Abstract  

Properties

Propertypublicboolean  $suppressExit= 'false'

Suppress exit when sendJson() called

Default valuefalseDetails
Type
boolean

Methods

methodpublicdirect( mixed $data, boolean $sendNow = true, boolean $keepLayouts = false ) : string|void

Strategy pattern: call helper as helper broker method

Allows encoding JSON. If $sendNow is true, immediately sends JSON response.

Parameters
Name Type Description
$data mixed
$sendNow boolean
$keepLayouts boolean
Returns
Type Description
stringvoid
methodpublicencodeJson( mixed $data, boolean|boolean|array $keepLayouts = false ) : string

Create JSON response

Encodes and returns data to JSON. Content-Type header set to 'application/json', and disables layouts and viewRenderer (if being used).

Parameters
Name Type Description
$data mixed
$keepLayouts boolean|boolean|array
Returns
Type Description
string
Throws
Exception Description
\Zend_Controller_Action_Helper_Json
methodpublicgetActionController( ) : \Zend_Controller_Action

Retrieve current action controller

Inherited from: \Zend_Controller_Action_Helper_Abstract::getActionController()
Returns
Type Description
\Zend_Controller_Action
methodpublicgetFrontController( ) : \Zend_Controller_Front

Retrieve front controller instance

Inherited from: \Zend_Controller_Action_Helper_Abstract::getFrontController()
Returns
Type Description
\Zend_Controller_Front
methodpublicgetName( ) : string
Returns
Type Description
string
methodpublicgetRequest( ) : \Zend_Controller_Request_Abstract
Returns
Type Description
\Zend_Controller_Request_Abstract $request
methodpublicgetResponse( ) : \Zend_Controller_Response_Abstract
Returns
Type Description
\Zend_Controller_Response_Abstract $response
methodpublicinit( ) : void

Hook into action controller initialization

Inherited from: \Zend_Controller_Action_Helper_Abstract::init()
methodpublicpostDispatch( ) : void

Hook into action controller postDispatch() workflow

Inherited from: \Zend_Controller_Action_Helper_Abstract::postDispatch()
methodpublicpreDispatch( ) : void

Hook into action controller preDispatch() workflow

Inherited from: \Zend_Controller_Action_Helper_Abstract::preDispatch()
methodpublicsendJson( mixed $data, boolean|array $keepLayouts = false ) : string|void

Encode JSON response and immediately send

Parameters
Name Type Description
$data mixed
$keepLayouts boolean|array

NOTE: if boolean, establish $keepLayouts to true|false if array, admit params for Zend_Json::encode as enableJsonExprFinder=>true|false if $keepLayouts and parmas for Zend_Json::encode are required then, the array can contains a 'keepLayout'=>true|false that will not be passed to Zend_Json::encode method but will be passed to Zend_View_Helper_Json

Returns
Type Description
stringvoid
methodpublicsetActionController( \Zend_Controller_Action $actionController = null ) : \Zend_Controller_ActionHelper_Abstract
Parameters
Name Type Description
$actionController \Zend_Controller_Action
Returns
Type Description
\Zend_Controller_ActionHelper_Abstract Provides a fluent interface
Documentation was generated by DocBlox 0.13.3.