Horde_Core_Ajax_Imple_AutoCompleter_Local
extends Horde_Core_Ajax_Imple_AutoCompleter_Ajax
in package
The local (browser-side) autocompleter.
Copyright 2012-2017 Horde LLC (http://www.horde.org/)
See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Tags
Table of Contents
Properties
- $params : array<string|int, mixed>
- Configuration parameters.
- $_raw : array<string|int, mixed>
- The list of the parameters that are raw javascript.
- $_search : mixed
- The search array to send to the browser.
Methods
- __construct() : mixed
- Constructor.
- generate() : mixed
- Generate the javascript necessary to instantiate the autocompleter object.
- _getOpts() : array<string|int, mixed>
- Return the encode list of options.
Properties
$params
Configuration parameters.
public
array<string|int, mixed>
$params
= array()
$_raw
The list of the parameters that are raw javascript.
protected
array<string|int, mixed>
$_raw
= array('onSelect', 'onShow', 'onType', 'filterCallback')
$_search
The search array to send to the browser.
protected
mixed
$_search
Methods
__construct()
Constructor.
public
__construct(mixed $search[, array<string|int, mixed> $params = array() ]) : mixed
Parameters
- $search : mixed
-
The search array to use. If a string, autocompleter will use this JS variable name to do the search. If an array, this data will be passed to the autocompleter automatically.
- $params : array<string|int, mixed> = array()
-
Configuration options:
- autoSelect: TODO
- choices: (integer) TODO
- frequency: (integer) TODO
- fullSearch: (integer) TODO
- ignoreCase: (integer) TODO
- minChars: (integer) Minimum # of characters before search is made.
- onSelect: (string) Javascript code to run on select.
- onShow: (string) Javascript code to run on show.
- onType: (string) Javascript code to run on type.
- paramName: (string) TODO
- partialChars: (integer) TODO
- partialSearch: (integer) TODO
- score: (integer) TODO
- tokens: (array) Valid token separators.
generate()
Generate the javascript necessary to instantiate the autocompleter object.
public
generate(Horde_Core_Ajax_Imple_AutoCompleter $ac) : mixed
Parameters
- $ac : Horde_Core_Ajax_Imple_AutoCompleter
-
The underlying imple object.
_getOpts()
Return the encode list of options.
protected
_getOpts(Horde_Core_Ajax_Imple_AutoCompleter $ac) : array<string|int, mixed>
Parameters
Return values
array<string|int, mixed> —Options list.