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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Controller  
Subpackage
Zend_Controller_Action_Helper  
Version
$Id$  

\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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Uses
 

Properties

>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
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
methodpublicvalidateData(mixed $data) : boolean
abstract

Validate autocompletion data

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