\Horde_Core_Ajax_Imple_AutoCompleter_Local

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.

Summary

Methods
Properties
Constants
__construct()
generate()
$params
No constants found
_getOpts()
$_raw
$_search
N/A
No private methods found
No private properties found
N/A

Properties

$params

$params : array

Configuration parameters.

Type

array

$_raw

$_raw : array

The list of the parameters that are raw javascript.

Type

array

$_search

$_search : mixed

The search array to send to the browser.

Type

mixed

Methods

__construct()

__construct(mixed  $search, array  $params = array()) 

Constructor.

Parameters

mixed $search

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.

array $params

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(\Horde_Core_Ajax_Imple_AutoCompleter  $ac) 

Generate the javascript necessary to instantiate the autocompleter object.

Parameters

\Horde_Core_Ajax_Imple_AutoCompleter $ac

The underlying imple object.

_getOpts()

_getOpts(\Horde_Core_Ajax_Imple_AutoCompleter  $ac) : array

Return the encode list of options.

Parameters

\Horde_Core_Ajax_Imple_AutoCompleter $ac

Returns

array —

Options list.