JQuery/View/Helper/AutoComplete.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
ZendX  
Copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
ZendX_JQuery  
Subpackage
View  
Version
$Id: AutoComplete.php 20752 2010-01-29 11:31:30Z beberlei $  

\ZendX_JQuery_View_Helper_AutoComplete

Package: ZendX\JQuery\View
jQuery Autocomplete View Helper
Parent(s)
\ZendX_JQuery_View_Helper_UiWidget < \Zend_View_Helper_HtmlElement
Copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Uses
Zend_View_Helper_FormText  

Properties

>VPropertyprotected\ZendX_JQuery_View_Helper_JQuery_Container $jquery
inherited
Contains reference to the jQuery view helper
Inherited from: \ZendX_JQuery_View_Helper_UiWidget::$$jquery

Methods

methodprotected_prepareAttributes(String $id, String $value, Array $attribs) : Array
inherited

Helps with building the correct Attributes Array structure.

Inherited from: \ZendX_JQuery_View_Helper_UiWidget::_prepareAttributes()
Parameters
NameTypeDescription
$idString
$valueString
$attribsArray
Returns
TypeDescription
Array$attribs
methodpublicautoComplete(String $id, String $value = null, array $params = array(), array $attribs = array()) : String

Builds an AutoComplete ready input field.

This view helper builds an input field with the Zend_View_Helper_FormText FormText Helper and adds additional javascript to the jQuery stack to initialize an AutoComplete field. Make sure you have set one out of the two following options: $params['data'] or $params['url']. The first one accepts an array as data input to the autoComplete, the second accepts an url, where the autoComplete content is returned from. For the format see jQuery documentation.

Parameters
NameTypeDescription
$idString
$valueString
$paramsarray
$attribsarray
Returns
TypeDescription
String
Throws
ExceptionDescription
\ZendX_JQuery_Exception
Details
Link
http://docs.jquery.com/UI/Autocomplete  
methodpublicsetView(\Zend_View_Interface $view) : \ZendX_JQuery_View_Helper_Widget
inherited

Set view and enable jQuery Core and UI libraries

Inherited from: \ZendX_JQuery_View_Helper_UiWidget::setView()
Parameters
NameTypeDescription
$view\Zend_View_Interface
Returns
TypeDescription
\ZendX_JQuery_View_Helper_Widget
Documentation was generated by phpDocumentor 2.0.0a12.