API Documentation

Zend/Controller/Action/Helper/AutoComplete/Abstract.php

Show: inherited
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 24594 2012-01-05 21:27:01Z 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  
Used_by
\Zend_Controller_Action_Helper_AutoCompleteDojo  
Used_by
\Zend_Controller_Action_Helper_AutoCompleteScriptaculous  
Uses
\Zend_Controller_Action_Helper_Abstract  

Properties

Propertypublicboolean  $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
Name Type Description
$data mixed
$sendNow bool
$keepLayouts bool
Returns
Type Description
string|void
methodpublicdisableLayouts( ) : \Zend_Controller_Action_Helper_AutoComplete_Abstract

Disable layouts and view renderer

Returns
Type Description
\Zend_Controller_Action_Helper_AutoComplete_Abstract Provides a fluent interface
methodpublicencodeJson( mixed $data, bool $keepLayouts = false ) : string

Encode data to JSON

Parameters
Name Type Description
$data mixed
$keepLayouts bool
Returns
Type Description
string
Throws
Exception Description
\Zend_Controller_Action_Exception
methodpublicprepareAutoCompletion( mixed $data, boolean $keepLayouts = false ) : mixed
abstract

Prepare autocompletion data

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

Send autocompletion data

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

Parameters
Name Type Description
$data mixed
$keepLayouts bool
Returns
Type Description
string|void
methodpublicvalidateData( mixed $data ) : boolean
abstract

Validate autocompletion data

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