Controller/Action/Helper/AutoCompleteScriptaculous.php
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: AutoCompleteScriptaculous.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Controller_Action_Helper_AutoCompleteScriptaculous
- Parent(s)
- \Zend_Controller_Action_Helper_AutoComplete_Abstract < \Zend_Controller_Action_Helper_Abstract
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Uses
- \global\Zend_Controller_Action_Helper_AutoComplete_Abstract
Properties


\Zend_Controller_Action $_actionController = null
null
Details

mixed $_frontController = null
null
Details- Type
- mixed
- Inherited_from
- \Zend_Controller_Action_Helper_Abstract::$$_frontController
- Inherited_from
- \Zend_Controller_Action_Helper_AutoComplete_Abstract::$$_frontController


boolean $suppressExit = false
false
Details- Type
- boolean
- Inherited_from
- \Zend_Controller_Action_Helper_AutoComplete_Abstract::$$suppressExit
Methods


direct(mixed $data, bool $sendNow = true, bool $keepLayouts = false) : string | void
Strategy pattern: allow calling helper as broker method
Inherited from: \Zend_Controller_Action_Helper_AutoComplete_Abstract::direct()Prepares autocompletion data and, if $sendNow is true, immediately sends response.
Name | Type | Description |
---|---|---|
$data | mixed | |
$sendNow | bool | |
$keepLayouts | bool |
Type | Description |
---|---|
string | void |


disableLayouts() : \Zend_Controller_Action_Helper_AutoComplete_Abstract
Disable layouts and view renderer
Inherited from: \Zend_Controller_Action_Helper_AutoComplete_Abstract::disableLayouts()Type | Description |
---|---|
\Zend_Controller_Action_Helper_AutoComplete_Abstract | Provides a fluent interface |


encodeJson(mixed $data, bool $keepLayouts = false) : string
Encode data to JSON
Inherited from: \Zend_Controller_Action_Helper_AutoComplete_Abstract::encodeJson()Name | Type | Description |
---|---|---|
$data | mixed | |
$keepLayouts | bool |
Type | Description |
---|---|
string |
Exception | Description |
---|---|
\Zend_Controller_Action_Exception |


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


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


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


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


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


init() : void
Hook into action controller initialization
Inherited from: \Zend_Controller_Action_Helper_Abstract::init()\Zend_Controller_Action_Helper_AutoComplete_Abstract::init()

postDispatch() : void
Hook into action controller postDispatch() workflow
Inherited from: \Zend_Controller_Action_Helper_Abstract::postDispatch()\Zend_Controller_Action_Helper_AutoComplete_Abstract::postDispatch()

preDispatch() : void
Hook into action controller preDispatch() workflow
Inherited from: \Zend_Controller_Action_Helper_Abstract::preDispatch()\Zend_Controller_Action_Helper_AutoComplete_Abstract::preDispatch()

prepareAutoCompletion(mixed $data, boolean $keepLayouts = false) : string
Prepare data for autocompletion
Name | Type | Description |
---|---|---|
$data | mixed | |
$keepLayouts | boolean |
Type | Description |
---|---|
string |
Exception | Description |
---|---|
\Zend_Controller_Action_Exception |


sendAutoCompletion(mixed $data, bool $keepLayouts = false) : string | void
Send autocompletion data
Inherited from: \Zend_Controller_Action_Helper_AutoComplete_Abstract::sendAutoCompletion()Calls prepareAutoCompletion, populates response body with this information, and sends response.
Name | Type | Description |
---|---|---|
$data | mixed | |
$keepLayouts | bool |
Type | Description |
---|---|
string | void |


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