Controller/Action/Helper/AutoComplete/Abstract.php
Show:
inherited
inherited
Classes
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_AutoComplete_Abstract
Package: Zend_Controller\Zend_Controller_Action_Helper
Returns
Returns
Create and send autocompletion lists
- Parent(s)
- \Zend_Controller_Action_Helper_Abstract
- Children
- \Zend_Controller_Action_Helper_AutoCompleteDojo
- \Zend_Controller_Action_Helper_AutoCompleteScriptaculous
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Uses
Properties
boolean $suppressExit = falseSuppress exit when sendJson() called
Default value
falseDetails- Type
- boolean
Methods
direct(mixed $data, bool $sendNow = true, bool $keepLayouts = false) : string | voidStrategy pattern: allow calling helper as broker method
Prepares autocompletion data and, if $sendNow is true, immediately sends
response.
Parameters| Name | Type | Description |
|---|---|---|
| $data | mixed | |
| $sendNow | bool | |
| $keepLayouts | bool |
| Type | Description |
|---|---|
| string | void |
disableLayouts() : \Zend_Controller_Action_Helper_AutoComplete_AbstractDisable layouts and view renderer
Returns
| Type | Description |
|---|---|
| \Zend_Controller_Action_Helper_AutoComplete_Abstract | Provides a fluent interface |
encodeJson(mixed $data, bool $keepLayouts = false) : stringEncode data to JSON
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $data | mixed | |
| $keepLayouts | bool |
| Type | Description |
|---|---|
| string |
| Exception | Description |
|---|---|
| \Zend_Controller_Action_Exception |
prepareAutoCompletion(mixed $data, boolean $keepLayouts = false) : mixedabstract
Prepare autocompletion data
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $data | mixed | |
| $keepLayouts | boolean |
| Type | Description |
|---|---|
| mixed |
sendAutoCompletion(mixed $data, bool $keepLayouts = false) : string | voidSend autocompletion data
Calls prepareAutoCompletion, populates response body with this
information, and sends response.
Parameters| Name | Type | Description |
|---|---|---|
| $data | mixed | |
| $keepLayouts | bool |
| Type | Description |
|---|---|
| string | void |
validateData(mixed $data) : booleanabstract
Validate autocompletion data
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $data | mixed |
| Type | Description |
|---|---|
| boolean |