Controller/Action/Helper/AutoCompleteScriptaculous.php

Show: PublicProtectedPrivateinherited
Table of Contents
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-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

Package: Zend\Controller\Zend\Controller\Action\Helper
Create and send Scriptaculous-compatible autocompletion lists
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

>VPropertypublicboolean $suppressExit = false
inherited
Suppress exit when sendJson() called
Inherited from: \Zend_Controller_Action_Helper_AutoComplete_Abstract::$$suppressExit
Default valuefalseDetails
Type
boolean
Inherited_from
\Zend_Controller_Action_Helper_AutoComplete_Abstract::$$suppressExit  

Methods

methodpublicdirect(mixed $data, bool $sendNow = true, bool $keepLayouts = false) : string | void
inherited

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.

Parameters
NameTypeDescription
$datamixed
$sendNowbool
$keepLayoutsbool
Returns
TypeDescription
string | void
methodpublicdisableLayouts() : \Zend_Controller_Action_Helper_AutoComplete_Abstract
inherited

Disable layouts and view renderer

Inherited from: \Zend_Controller_Action_Helper_AutoComplete_Abstract::disableLayouts()
Returns
TypeDescription
\Zend_Controller_Action_Helper_AutoComplete_AbstractProvides a fluent interface
methodpublicencodeJson(mixed $data, bool $keepLayouts = false) : string
inherited

Encode data to JSON

Inherited from: \Zend_Controller_Action_Helper_AutoComplete_Abstract::encodeJson()
Parameters
NameTypeDescription
$datamixed
$keepLayoutsbool
Returns
TypeDescription
string
Throws
ExceptionDescription
\Zend_Controller_Action_Exception
methodpublicgetName() : string
Returns
TypeDescription
string
methodpublicinit() : void
methodpublicpostDispatch() : void
methodpublicpreDispatch() : void
methodpublicprepareAutoCompletion(mixed $data, boolean $keepLayouts = false) : string

Prepare data for autocompletion

Parameters
NameTypeDescription
$datamixed
$keepLayoutsboolean
Returns
TypeDescription
string
Throws
ExceptionDescription
\Zend_Controller_Action_Exception
methodpublicsendAutoCompletion(mixed $data, bool $keepLayouts = false) : string | void

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

Parameters
NameTypeDescription
$datamixed
$keepLayoutsbool
Returns
TypeDescription
string | void
methodpublicsetActionController(\Zend_Controller_Action $actionController = null) : \Zend_Controller_ActionHelper_Abstract
Parameters
NameTypeDescription
$actionController\Zend_Controller_Action
Returns
TypeDescription
\Zend_Controller_ActionHelper_AbstractProvides a fluent interface
methodpublicvalidateData(mixed $data) : bool

Validate data for autocompletion

Parameters
NameTypeDescription
$datamixed
Returns
TypeDescription
bool
Documentation was generated by phpDocumentor 2.0.0a12.