tool_lp\form\framework_autocomplete Class Reference

Form field type for choosing a framework. More...

Inheritance diagram for tool_lp\form\framework_autocomplete:

Public Member Functions
	__construct ($elementName=null, $elementLabel=null, $options=array())
	Constructor.
	export_for_template (renderer_base $output)
	Function to export the renderer data in a format that is suitable for a mustache template.
	exportValue (&$submitValues, $assoc=false)
	Returns a 'safe' element's value.
	getElementTemplateType ()
	Slightly different container template when frozen.
	getHelpButton ()
	get html for help button
	MoodleQuickForm_autocomplete ($elementName=null, $elementLabel=null, $options=null, $attributes=null)
	Old syntax of class constructor.
	MoodleQuickForm_select ($elementName=null, $elementLabel=null, $options=null, $attributes=null)
	Old syntax of class constructor.
	onQuickFormEvent ($event, $arg, &$caller)
	Called by HTML_QuickForm whenever form event is made on this element.
	optionExists ($value)
	Search the current list of options to see if there are any options with this value.
	removeOption ($value)
	Removes an OPTION from the SELECT.
	removeOptions ()
	Removes all OPTIONs from the SELECT.
	setHiddenLabel ($hiddenLabel)
	Sets label to be hidden.
	setValue ($value)
	Set the value of this element.
	toHtml ()
	Returns HTML for select form element.

Public Attributes
string	$_helpbutton =''
	html for help button, if empty then no help
bool	$_hiddenLabel =false
	if true label will be hidden

Protected Attributes
string	$ajax = ''
	$ajax Name of an AMD module to send/process ajax requests.
bool	$casesensitive = false
	$casesensitive Whether the search has to be case-sensitive.
string	$noselectionstring = ''
	$noselectionstring String that is shown when there are no selections.
bool	$onlyvisible = false
	Only visible frameworks?
string	$placeholder = ''
	$placeholder Placeholder text for an empty list.
bool	$showsuggestions = true
	$showsuggestions Show suggestions by default - but this can be turned off.
boolean	$tags = false
	$tags Should we allow typing new entries to the field?
callable null	$valuehtmlcallback = null
	Function to call (with existing value) to render it to HTML.

Detailed Description

Form field type for choosing a framework.

Copyright

2016 Frédéric Massart - FMCorz.net

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Constructor & Destructor Documentation

__construct()

tool_lp\form\framework_autocomplete::__construct	(		$elementName = null,
			$elementLabel = null,
			$options = array() )

Constructor.

Parameters

string	$elementName	Element name
mixed	$elementLabel	Label(s) for an element
array	$options	Options to control the element's display Valid options are: context context The context. contextid int The context id. multiple bool Whether or not the field accepts more than one values. onlyvisible bool Whether or not only visible framework can be listed.

Member Function Documentation

export_for_template()

MoodleQuickForm_autocomplete::export_for_template ( renderer_base $output )

inherited

Function to export the renderer data in a format that is suitable for a mustache template.

This means:

1. No complex types - only stdClass, array, int, string, float, bool
2. Any additional info that is required for the template is pre-calculated (e.g. capability checks).

Parameters

renderer_base

$output

Used to do a final render of any components that need to be rendered for export.

Return values

stdClass|array

Reimplemented from MoodleQuickForm_select.

Reimplemented in MoodleQuickForm_tags.

exportValue()

MoodleQuickForm_autocomplete::exportValue ( & $submitValues, $assoc = false )

inherited

Returns a 'safe' element's value.

Parameters

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

Return values

mixed

Reimplemented from MoodleQuickForm_select.

Reimplemented in MoodleQuickForm_tags.

getElementTemplateType()

MoodleQuickForm_select::getElementTemplateType ( )

inherited

Slightly different container template when frozen.

Don't want to use a label tag with a for attribute in that case for the element label but instead use a div. Templates are defined in renderer constructor.

Return values

string

getHelpButton()

MoodleQuickForm_select::getHelpButton ( )

inherited

get html for help button

Return values

string

html for help button

MoodleQuickForm_autocomplete()

MoodleQuickForm_autocomplete::MoodleQuickForm_autocomplete ( $elementName = null, $elementLabel = null, $options = null, $attributes = null )

inherited

Old syntax of class constructor.

Deprecated in PHP7.

Deprecated

since Moodle 3.1

MoodleQuickForm_select()

MoodleQuickForm_select::MoodleQuickForm_select ( $elementName = null, $elementLabel = null, $options = null, $attributes = null )

inherited

Old syntax of class constructor.

Deprecated in PHP7.

Deprecated

since Moodle 3.1

onQuickFormEvent()

MoodleQuickForm_autocomplete::onQuickFormEvent ( $event, $arg, & $caller )

inherited

Called by HTML_QuickForm whenever form event is made on this element.

Parameters

string	$event	Name of event
mixed	$arg	event arguments
object	$caller	calling object

Return values

bool

Reimplemented in MoodleQuickForm_tags.

optionExists()

MoodleQuickForm_autocomplete::optionExists ( $value )

inherited

Search the current list of options to see if there are any options with this value.

Parameters

string

$value

to search

Return values

boolean

removeOption()

MoodleQuickForm_select::removeOption ( $value )

inherited

Removes an OPTION from the SELECT.

Parameters

string

$value

Value for the OPTION to remove

Return values

void

setHiddenLabel()

MoodleQuickForm_select::setHiddenLabel ( $hiddenLabel )

inherited

Sets label to be hidden.

Parameters

bool

$hiddenLabel

sets if label should be hidden

setValue()

tool_lp\form\framework_autocomplete::setValue

(

$value

)

Set the value of this element.

Parameters

string | array

$value

The value to set.

Return values

boolean

Reimplemented from MoodleQuickForm_autocomplete.

toHtml()

MoodleQuickForm_autocomplete::toHtml ( )

inherited

Returns HTML for select form element.

Return values

string

Reimplemented from MoodleQuickForm_select.

Reimplemented in MoodleQuickForm_tags.

---

The documentation for this class was generated from the following file:

• admin/tool/lp/classes/form/framework_autocomplete.php