MoodleQuickForm_cohort Class Reference

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

Inheritance diagram for MoodleQuickForm_cohort:

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.
int	$contextid = 0
	$contextid The context id to fetch cohorts in.
array	$exclude = array()
	$exclude Exclude a list of cohorts from the list (e.g.
boolean	$multiple = false
	$allowmultiple Allow selecting more than one cohort.
string	$noselectionstring = ''
	$noselectionstring String that is shown when there are no selections.
string	$placeholder = ''
	$placeholder Placeholder text for an empty list.
array	$requiredcapabilities = array()
	$requiredcapabilities Array of extra capabilities to check at the cohort context.
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 cohort.

Allows auto-complete ajax searching for cohort.

Copyright

2016 Damyon Wiese damyo.nosp@m.n@mo.nosp@m.odle..nosp@m.com

License

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

Constructor & Destructor Documentation

__construct()

MoodleQuickForm_cohort::__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: 'multiple' - boolean multi select 'exclude' - array or int, list of course ids to never show 'requiredcapabilities' - array of capabilities. Uses ANY to combine them.

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()

MoodleQuickForm_cohort::setValue

(

$value

)

Set the value of this element.

If values can be added or are unknown, we will make sure they exist in the options array.

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.

Member Data Documentation

$exclude

array MoodleQuickForm_cohort::$exclude = array()

protected

$exclude Exclude a list of cohorts from the list (e.g.

the current cohort).

---

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

• lib/form/cohort.php