Controller/Action/Helper/AutoCompleteDojo.php

Show:

inherited

Classes
- \Zend_Controller_Action_Helper_AutoCompleteDojo

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 [email protected] 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: AutoCompleteDojo.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Controller_Action_Helper_AutoCompleteDojo
jump to top

Package: Zend\Controller\Zend\Controller\Action\Helper

Create and send Dojo-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

\Zend_Controller_Action $_actionController = null

inherited

$_actionController

Inherited from: \Zend_Controller_Action_Helper_Abstract::$$_actionController \Zend_Controller_Action_Helper_AutoComplete_Abstract::$$_actionController

Default valuenullDetails

Type: \Zend_Controller_Action
Inherited_from: \Zend_Controller_Action_Helper_Abstract::$$_actionController
Inherited_from: \Zend_Controller_Action_Helper_AutoComplete_Abstract::$$_actionController

mixed $_frontController = null

inherited

Inherited from: \Zend_Controller_Action_Helper_Abstract::$$_frontController \Zend_Controller_Action_Helper_AutoComplete_Abstract::$$_frontController

Default valuenullDetails

Type: mixed
Inherited_from: \Zend_Controller_Action_Helper_Abstract::$$_frontController
Inherited_from: \Zend_Controller_Action_Helper_AutoComplete_Abstract::$$_frontController

boolean $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

direct(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

Name	Type	Description
$data	mixed
$sendNow	bool
$keepLayouts	bool

Returns

Type	Description
string \| void

disableLayouts() : \Zend_Controller_Action_Helper_AutoComplete_Abstract

inherited

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

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

inherited

Encode data to JSON

Inherited from: \Zend_Controller_Action_Helper_AutoComplete_Abstract::encodeJson()

Parameters

Name	Type	Description
$data	mixed
$keepLayouts	bool

Returns

Type	Description
string

Throws

Exception	Description
\Zend_Controller_Action_Exception

getActionController() : \Zend_Controller_Action

inherited

Retrieve current action controller

Inherited from: \Zend_Controller_Action_Helper_Abstract::getActionController()\Zend_Controller_Action_Helper_AutoComplete_Abstract::getActionController()

Returns

Type	Description
\Zend_Controller_Action

getFrontController() : \Zend_Controller_Front

inherited

Retrieve front controller instance

Inherited from: \Zend_Controller_Action_Helper_Abstract::getFrontController()\Zend_Controller_Action_Helper_AutoComplete_Abstract::getFrontController()

Returns

Type	Description
\Zend_Controller_Front

getName() : string

inherited

getName()

Inherited from: \Zend_Controller_Action_Helper_Abstract::getName()\Zend_Controller_Action_Helper_AutoComplete_Abstract::getName()

Returns

Type	Description
string

getRequest() : \Zend_Controller_Request_Abstract

inherited

getRequest() -

Inherited from: \Zend_Controller_Action_Helper_Abstract::getRequest()\Zend_Controller_Action_Helper_AutoComplete_Abstract::getRequest()

Returns

Type	Description
\Zend_Controller_Request_Abstract	$request

getResponse() : \Zend_Controller_Response_Abstract

inherited

getResponse() -

Inherited from: \Zend_Controller_Action_Helper_Abstract::getResponse()\Zend_Controller_Action_Helper_AutoComplete_Abstract::getResponse()

Returns

Type	Description
\Zend_Controller_Response_Abstract	$response

init() : void

inherited

Hook into action controller initialization

Inherited from: \Zend_Controller_Action_Helper_Abstract::init()\Zend_Controller_Action_Helper_AutoComplete_Abstract::init()

postDispatch() : void

inherited

Hook into action controller postDispatch() workflow

Inherited from: \Zend_Controller_Action_Helper_Abstract::postDispatch()\Zend_Controller_Action_Helper_AutoComplete_Abstract::postDispatch()

preDispatch() : void

inherited

Hook into action controller preDispatch() workflow

Inherited from: \Zend_Controller_Action_Helper_Abstract::preDispatch()\Zend_Controller_Action_Helper_AutoComplete_Abstract::preDispatch()

prepareAutoCompletion(mixed $data, boolean $keepLayouts = false) : string

Prepare data for autocompletion

Parameters

Name	Type	Description
$data	mixed
$keepLayouts	boolean

Returns

Type	Description
string

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

inherited

Send autocompletion data

Inherited from: \Zend_Controller_Action_Helper_AutoComplete_Abstract::sendAutoCompletion()

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

Parameters

Name	Type	Description
$data	mixed
$keepLayouts	bool

Returns

Type	Description
string \| void

setActionController(\Zend_Controller_Action $actionController = null) : \Zend_Controller_ActionHelper_Abstract

inherited

setActionController()

Inherited from: \Zend_Controller_Action_Helper_Abstract::setActionController()\Zend_Controller_Action_Helper_AutoComplete_Abstract::setActionController()

Parameters

Name	Type	Description
$actionController	\Zend_Controller_Action

Returns

Type	Description
\Zend_Controller_ActionHelper_Abstract	Provides a fluent interface

validateData(mixed $data) : boolean

Validate data for autocompletion

Stub; unused

Parameters

Name	Type	Description
$data	mixed

Returns

Type	Description
boolean

Controller/Action/Helper/AutoCompleteDojo.php

\Zend_Controller_Action_Helper_AutoCompleteDojojump to top

Properties

Methods

\Zend_Controller_Action_Helper_AutoCompleteDojo
jump to top