Create and send autocompletion lists

• copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
• abstract:
• usedby: Zend_Controller_Action_Helper_AutoCompleteDojo
• usedby: Zend_Controller_Action_Helper_AutoCompleteScriptaculous
• license: New BSD License
• uses: Zend_Controller_Action_Helper_Abstract

Located in /Controller/Action/Helper/AutoComplete/Abstract.php (line 38)

Zend_Controller_Action_Helper_Abstract
   |
   --Zend_Controller_Action_Helper_AutoComplete_Abstract

boolean $suppressExit = false (line 45)

Suppress exit when sendJson() called

• access: public

Inherited Variables

Inherited from Zend_Controller_Action_Helper_Abstract

Zend_Controller_Action_Helper_Abstract::$_actionController
Zend_Controller_Action_Helper_Abstract::$_frontController

direct (line 141)

Strategy pattern: allow calling helper as broker method

Prepares autocompletion data and, if $sendNow is true, immediately sends response.

• access: public

string|void direct (mixed $data, [bool $sendNow = true], [bool $keepLayouts = false])

• mixed $data
• bool $sendNow
• bool $keepLayouts

disableLayouts (line 69)

Disable layouts and view renderer

• return: Provides a fluent interface
• access: public

Zend_Controller_Action_Helper_AutoComplete_Abstract disableLayouts ()

encodeJson (line 92)

Encode data to JSON

• throws: Zend_Controller_Action_Exception
• access: public

string encodeJson (mixed $data, [bool $keepLayouts = false])

• mixed $data
• bool $keepLayouts

prepareAutoCompletion (line 62)

Prepare autocompletion data

• abstract:
• access: public

mixed prepareAutoCompletion (mixed $data, [boolean $keepLayouts = false])

• mixed $data
• boolean $keepLayouts

---

Redefined in descendants as:

• Zend_Controller_Action_Helper_AutoCompleteScriptaculous::prepareAutoCompletion() : Prepare data for autocompletion
• Zend_Controller_Action_Helper_AutoCompleteDojo::prepareAutoCompletion() : Prepare data for autocompletion

sendAutoCompletion (line 115)

Send autocompletion data

Calls prepareAutoCompletion, populates response body with this information, and sends response.

• access: public

string|void sendAutoCompletion (mixed $data, [bool $keepLayouts = false])

• mixed $data
• bool $keepLayouts

validateData (line 53)

Validate autocompletion data

• abstract:
• access: public

boolean validateData (mixed $data)

• mixed $data

---

Redefined in descendants as:

• Zend_Controller_Action_Helper_AutoCompleteScriptaculous::validateData() : Validate data for autocompletion
• Zend_Controller_Action_Helper_AutoCompleteDojo::validateData() : Validate data for autocompletion

Inherited Methods

Inherited From Zend_Controller_Action_Helper_Abstract

Zend_Controller_Action_Helper_Abstract::getActionController()
Zend_Controller_Action_Helper_Abstract::getFrontController()
Zend_Controller_Action_Helper_Abstract::getName()
Zend_Controller_Action_Helper_Abstract::getRequest()
Zend_Controller_Action_Helper_Abstract::getResponse()
Zend_Controller_Action_Helper_Abstract::init()
Zend_Controller_Action_Helper_Abstract::postDispatch()
Zend_Controller_Action_Helper_Abstract::preDispatch()
Zend_Controller_Action_Helper_Abstract::setActionController()