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.
Simplify AJAX context switching based on requested format

direct(
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.
Name | Type | Description |
---|---|---|
$data | mixed | |
$sendNow | boolean | |
$keepLayouts | boolean |
Type | Description |
---|---|
stringvoid |

encodeJson(
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).
Name | Type | Description |
---|---|---|
$data | mixed | |
$keepLayouts | boolean|boolean|array |
Type | Description |
---|---|
string |
Exception | Description |
---|---|
\Zend_Controller_Action_Helper_Json |

getActionController(
)
:
\Zend_Controller_Action
Retrieve current action controller
Inherited from: \Zend_Controller_Action_Helper_Abstract::getActionController()Type | Description |
---|---|
\Zend_Controller_Action |

getFrontController(
)
:
\Zend_Controller_Front
Retrieve front controller instance
Inherited from: \Zend_Controller_Action_Helper_Abstract::getFrontController()Type | Description |
---|---|
\Zend_Controller_Front |

getName(
)
:
string
getName()
Inherited from: \Zend_Controller_Action_Helper_Abstract::getName()Type | Description |
---|---|
string |

getRequest(
)
:
\Zend_Controller_Request_Abstract
getRequest() -
Inherited from: \Zend_Controller_Action_Helper_Abstract::getRequest()Type | Description |
---|---|
\Zend_Controller_Request_Abstract | $request |

getResponse(
)
:
\Zend_Controller_Response_Abstract
getResponse() -
Inherited from: \Zend_Controller_Action_Helper_Abstract::getResponse()Type | Description |
---|---|
\Zend_Controller_Response_Abstract | $response |

init(
)
:
void
Hook into action controller initialization
Inherited from: \Zend_Controller_Action_Helper_Abstract::init()
postDispatch(
)
:
void
Hook into action controller postDispatch() workflow
Inherited from: \Zend_Controller_Action_Helper_Abstract::postDispatch()
preDispatch(
)
:
void
Hook into action controller preDispatch() workflow
Inherited from: \Zend_Controller_Action_Helper_Abstract::preDispatch()
sendJson(
mixed $data, boolean|array $keepLayouts
=
false
)
:
string|void
Encode JSON response and immediately send
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 |
Type | Description |
---|---|
stringvoid |

setActionController(
\Zend_Controller_Action $actionController
=
null
)
:
\Zend_Controller_ActionHelper_Abstract
setActionController()
Inherited from: \Zend_Controller_Action_Helper_Abstract::setActionController()Name | Type | Description |
---|---|---|
$actionController | \Zend_Controller_Action |
Type | Description |
---|---|
\Zend_Controller_ActionHelper_Abstract | Provides a fluent interface |