API Documentation

Controller/Action/Helper/AutoCompleteDojo.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Controller  
subpackage
Zend_Controller_Action_Helper  
version
$Id: AutoCompleteDojo.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Controller_Action_Helper_AutoCompleteDojo

Create and send Dojo-compatible autocompletion lists

Extends from
\Zend_Controller_Action_Helper_AutoComplete_Abstract
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Controller  
subpackage
Zend_Controller_Action_Helper  
uses
\Zend_Controller_Action_Helper_AutoComplete_Abstract  

Methods

methodpublicdirect( 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.

Parameters
Name Type Description
$data mixed
$sendNow bool
$keepLayouts bool
Returns
Type Description
stringvoid
methodpublicdisableLayouts( ) : \Zend_Controller_Action_Helper_AutoComplete_Abstract

Disable layouts and view renderer

Inherited from: \Zend_Controller_Action_Helper_AutoComplete_Abstract::disableLayouts()
Returns
Type Description
\Zend_Controller_Action_Helper_AutoComplete_Abstract Provides a fluent interface
methodpublicencodeJson( mixed $data, bool $keepLayouts = false ) : string
Parameters
Name Type Description
$data mixed
$keepLayouts bool
Returns
Type Description
string
Throws
Exception Description
\Zend_Controller_Action_Exception
methodpublicgetActionController( ) : \Zend_Controller_Action

Retrieve current action controller

Inherited from: \Zend_Controller_Action_Helper_Abstract::getActionController()
Returns
Type Description
\Zend_Controller_Action
methodpublicgetFrontController( ) : \Zend_Controller_Front

Retrieve front controller instance

Inherited from: \Zend_Controller_Action_Helper_Abstract::getFrontController()
Returns
Type Description
\Zend_Controller_Front
methodpublicgetName( ) : string
Returns
Type Description
string
methodpublicgetRequest( ) : \Zend_Controller_Request_Abstract
Returns
Type Description
\Zend_Controller_Request_Abstract $request
methodpublicgetResponse( ) : \Zend_Controller_Response_Abstract
Returns
Type Description
\Zend_Controller_Response_Abstract $response
methodpublicinit( ) : void

Hook into action controller initialization

Inherited from: \Zend_Controller_Action_Helper_Abstract::init()
methodpublicpostDispatch( ) : void

Hook into action controller postDispatch() workflow

Inherited from: \Zend_Controller_Action_Helper_Abstract::postDispatch()
methodpublicpreDispatch( ) : void

Hook into action controller preDispatch() workflow

Inherited from: \Zend_Controller_Action_Helper_Abstract::preDispatch()
methodpublicprepareAutoCompletion( mixed $data, boolean $keepLayouts = false ) : string

Prepare data for autocompletion

Parameters
Name Type Description
$data mixed
$keepLayouts boolean
Returns
Type Description
string
methodpublicsendAutoCompletion( mixed $data, bool $keepLayouts = false ) : string|void

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

Parameters
Name Type Description
$data mixed
$keepLayouts bool
Returns
Type Description
stringvoid
methodpublicsetActionController( \Zend_Controller_Action $actionController = null ) : \Zend_Controller_ActionHelper_Abstract
Parameters
Name Type Description
$actionController \Zend_Controller_Action
Returns
Type Description
\Zend_Controller_ActionHelper_Abstract Provides a fluent interface
methodpublicvalidateData( mixed $data ) : boolean

Validate data for autocompletion

Stub; unused

Parameters
Name Type Description
$data mixed
Returns
Type Description
boolean
Documentation was generated by DocBlox 0.13.3.