Controller/Action/Helper/Json.php

Show: PublicProtectedPrivateinherited
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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Controller  
Subpackage
Zend_Controller_Action_Helper  
Version
$Id$  

\Zend_Controller_Action_Helper_Json
jump to top

Package: Zend_Controller\Zend_Controller_Action_Helper
Simplify AJAX context switching based on requested format
Parent(s)
\Zend_Controller_Action_Helper_Abstract
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Uses
 

Properties

>VPropertypublicboolean $suppressExit = false
Suppress exit when sendJson() called
Default valuefalseDetails
Type
boolean

Methods

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

Strategy pattern: call helper as helper broker method

Allows encoding JSON. If $sendNow is true, immediately sends JSON response.
Parameters
NameTypeDescription
$datamixed
$sendNowboolean
$keepLayoutsboolean
$encodeDataboolean

Encode $data as JSON?

Returns
TypeDescription
string | void
methodpublicencodeJson(mixed $data, boolean | boolean | array $keepLayouts = false, boolean $encodeData = true) : 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
NameTypeDescription
$datamixed
$keepLayoutsboolean | boolean | array
$encodeDataboolean

Provided data is already JSON 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 and/or 'encodeData'=>true|false
    that will not be passed to Zend_Json::encode method but will be passed
    to Zend_View_Helper_Json
Returns
TypeDescription
string
Throws
ExceptionDescription
\Zend_Controller_Action_Helper_Json
methodpublicsendJson(mixed $data, boolean | array $keepLayouts = false,  $encodeData = true) : string | void

Encode JSON response and immediately send

Parameters
NameTypeDescription
$datamixed
$keepLayoutsboolean | array
$encodeData

Encode $data as JSON? 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 and/or 'encodeData'=>true|false
    that will not be passed to Zend_Json::encode method but will be passed
    to Zend_View_Helper_Json
Returns
TypeDescription
string | void
Documentation was generated by phpDocumentor 2.2.0 .