Controller/Action/Helper/AutoComplete/Abstract.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: Abstract.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Controller_Action_Helper_AutoComplete_Abstract

Package: Zend\Controller\Zend\Controller\Action\Helper
Create and send autocompletion lists
Parent(s)
\Zend_Controller_Action_Helper_Abstract
Children
\Zend_Controller_Action_Helper_AutoCompleteDojo
\Zend_Controller_Action_Helper_AutoCompleteScriptaculous
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_Abstract  

Properties

>VPropertyprotected\Zend_Controller_Action $_actionController = null
inherited
$_actionController
Inherited from: \Zend_Controller_Action_Helper_Abstract::$$_actionController
>VPropertyprotectedmixed $_frontController = null
Default valuenullDetails
Type
mixed
Inherited_from
\Zend_Controller_Action_Helper_Abstract::$$_frontController  
>VPropertypublicboolean $suppressExit = false
Suppress exit when sendJson() called
Default valuefalseDetails
Type
boolean

Methods

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

Strategy pattern: allow calling helper as broker method

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

Disable layouts and view renderer

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

Encode data to JSON

Parameters
NameTypeDescription
$datamixed
$keepLayoutsbool
Returns
TypeDescription
string
Throws
ExceptionDescription
\Zend_Controller_Action_Exception
methodpublicgetActionController() : \Zend_Controller_Action
inherited

Retrieve current action controller

Inherited from: \Zend_Controller_Action_Helper_Abstract::getActionController()
Returns
TypeDescription
\Zend_Controller_Action
methodpublicgetFrontController() : \Zend_Controller_Front
inherited

Retrieve front controller instance

Inherited from: \Zend_Controller_Action_Helper_Abstract::getFrontController()
Returns
TypeDescription
\Zend_Controller_Front
methodpublicgetName() : string
inherited

getName()

Inherited from: \Zend_Controller_Action_Helper_Abstract::getName()
Returns
TypeDescription
string
methodpublicgetRequest() : \Zend_Controller_Request_Abstract
inherited

getRequest() -

Inherited from: \Zend_Controller_Action_Helper_Abstract::getRequest()
Returns
TypeDescription
\Zend_Controller_Request_Abstract$request
methodpublicgetResponse() : \Zend_Controller_Response_Abstract
inherited

getResponse() -

Inherited from: \Zend_Controller_Action_Helper_Abstract::getResponse()
Returns
TypeDescription
\Zend_Controller_Response_Abstract$response
methodpublicinit() : void
inherited

Hook into action controller initialization

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

Hook into action controller postDispatch() workflow

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

Hook into action controller preDispatch() workflow

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

Prepare autocompletion data

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

Send autocompletion data

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
inherited

setActionController()

Inherited from: \Zend_Controller_Action_Helper_Abstract::setActionController()
Parameters
NameTypeDescription
$actionController\Zend_Controller_Action
Returns
TypeDescription
\Zend_Controller_ActionHelper_AbstractProvides a fluent interface
methodpublicvalidateData(mixed $data) : boolean
abstract

Validate autocompletion data

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