Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
/lib/pear/HTML/QuickForm/ -> autocomplete.php (source)

[Source view]

(no description)

File Size: 258 lines (9 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 2 classes

HTML_QuickForm_autocomplete:: (2 methods):
  __construct()
  HTML_QuickForm_autocomplete()

name:: (7 methods):
  setOptions()
  toHtml()
  setSelectionRange()
  setCaretToPosition()
  replaceSelection()
  autocompleteMatch()
  autocomplete()


Class: HTML_QuickForm_autocomplete  - X-Ref

Class to dynamically create an HTML input text element that
at every keypressed javascript event, check in an array of options
if there's a match and autocomplete the text in case of match.

Ex:
$autocomplete =& $form->addElement('autocomplete', 'fruit', 'Favourite fruit:');
$options = array("Apple", "Orange", "Pear", "Strawberry");
$autocomplete->setOptions($options);

__construct($elementName = null, $elementLabel = null, $options = null, $attributes = null)   X-Ref
Class constructor

param: string    $elementName    (optional)Input field name attribute
param: string    $elementLabel   (optional)Input field label in form
param: array     $options        (optional)Autocomplete options
param: mixed     $attributes     (optional)Either a typical HTML attribute string
return: void

HTML_QuickForm_autocomplete($elementName = null, $elementLabel = null, $options = null, $attributes = null)   X-Ref
Old syntax of class constructor. Deprecated in PHP7.


Class: name  - X-Ref

setOptions($options)   X-Ref
Sets the options for the autocomplete input text element

param: array    $options    Array of options for the autocomplete input text element
return: void

toHtml()   X-Ref
Returns Html for the autocomplete input text element

return: string

setSelectionRange(input, selectionStart, selectionEnd)   X-Ref
No description

setCaretToPosition(input, position)   X-Ref
No description

replaceSelection(input, replaceString)   X-Ref
No description

autocompleteMatch(text, values)   X-Ref
No description

autocomplete(textbox, event, values)   X-Ref
No description