Controller/Action/Helper/AutoComplete/Abstract.php
- category
- Zend
- copyright
- Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license
- http://framework.zend.com/license/new-bsd New BSD License
- package
- Zend_Controller
- subpackage
- Zend_Controller_Action_Helper
- version
- $Id: Abstract.php 20096 2010-01-06 02:05:09Z bkarwin $
- Classes
- Zend_Controller_Action_Helper_AutoComplete_Abstract
Description
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.
Zend_Controller_Action_Helper_AutoComplete_Abstract
- Extends from
- Zend_Controller_Action_Helper_Abstract
- category
- Zend
- copyright
- Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license
- http://framework.zend.com/license/new-bsd New BSD License
- package
- Zend_Controller
- subpackage
- Zend_Controller_Action_Helper
- uses
- Zend_Controller_Action_Helper_Abstract
- Properties
- $suppressExit
- Methods
- validateData
- prepareAutoCompletion
- disableLayouts
- encodeJson
- sendAutoCompletion
- direct
Description
Create and send autocompletion lists
Properties
$suppressExit
boolean $suppressExit = 'false'Suppress exit when sendJson() called
Details
- $suppressExit
- boolean
- visibility
- public
- default
- false
- final
- false
- static
- false
Methods
direct
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.
Arguments
- $data
- mixed
- $sendNow
- bool
- $keepLayouts
- bool
Output
- string|void
Details
- visibility
- public
- final
- false
- static
- false
disableLayouts
disableLayouts(
)
:
Zend_Controller_Action_Helper_AutoComplete_AbstractDisable layouts and view renderer
Output
- Zend_Controller_Action_Helper_AutoComplete_Abstract
- Provides a fluent interface
Details
- visibility
- public
- final
- false
- static
- false
encodeJson
encodeJson(
mixed $data, bool $keepLayouts
=
false
)
:
stringEncode data to JSON
Arguments
- $data
- mixed
- $keepLayouts
- bool
Output
- string
Details
- visibility
- public
- final
- false
- static
- false
- throws
prepareAutoCompletion
prepareAutoCompletion(
mixed $data, boolean $keepLayouts
=
false
)
:
mixedPrepare autocompletion data
Arguments
- $data
- mixed
- $keepLayouts
- boolean
Output
- mixed
Details
- visibility
- public
- final
- false
- static
- false
sendAutoCompletion
sendAutoCompletion(
mixed $data, bool $keepLayouts
=
false
)
:
string|voidSend autocompletion data
Calls prepareAutoCompletion, populates response body with this information, and sends response.
Arguments
- $data
- mixed
- $keepLayouts
- bool
Output
- string|void
Details
- visibility
- public
- final
- false
- static
- false
validateData
validateData(
mixed $data
)
:
booleanValidate autocompletion data
Arguments
- $data
- mixed
Output
- boolean
Details
- visibility
- public
- final
- false
- static
- false