Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.
/lib/form/ -> autocomplete.php (source)

[Source view]

Differences Between: [Versions 310 and 402] [Versions 311 and 402] [Versions 39 and 402] [Versions 400 and 402]

autocomplete type form element Contains HTML class for a autocomplete type element

Copyright: 2015 Damyon Wiese <damyon@moodle.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 257 lines (10 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 2 classes

MoodleQuickForm_autocomplete:: (2 methods):
  __construct()
  MoodleQuickForm_autocomplete()

name:: (6 methods):
  toHtml()
  optionExists()
  setValue()
  exportValue()
  onQuickFormEvent()
  export_for_template()


Class: MoodleQuickForm_autocomplete  - X-Ref

Autocomplete as you type form element

HTML class for a autocomplete type element

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

param: string $elementName Select name attribute
param: mixed $elementLabel Label(s) for the select
param: mixed $options Data to be used to populate options
param: mixed $attributes Either a typical HTML attribute string or an associative array. Special options

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


Class: name  - X-Ref

toHtml()   X-Ref
Returns HTML for select form element.

return: string

optionExists($value)   X-Ref
Search the current list of options to see if there are any options with this value.

param: string $value to search
return: boolean

setValue($value)   X-Ref
Set the value of this element. If values can be added or are unknown, we will
make sure they exist in the options array.

param: mixed string|array $value The value to set.
return: boolean

exportValue(&$submitValues, $assoc = false)   X-Ref
Returns a 'safe' element's value

param: array   array of submitted values to search
param: bool    whether to return the value as associative array
return: mixed

onQuickFormEvent($event, $arg, &$caller)   X-Ref
Called by HTML_QuickForm whenever form event is made on this element

param: string $event Name of event
param: mixed $arg event arguments
param: object $caller calling object
return: bool

export_for_template(renderer_base $output)   X-Ref
No description