Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
MoodleQuickForm_defaultcustom Class Reference

Creates an element with a dropdown Default/Custom and an input for the value (text or date_selector) More...

Inheritance diagram for MoodleQuickForm_defaultcustom:
MoodleQuickForm_group templatable

Public Member Functions

 __construct ($elementname=null, $elementlabel=null, $options=array(), $attributes=null)
 Constructor.
 
 _createElements ()
 This will create all elements in the group.
 
 accept (&$renderer, $required=false, $error=null)
 Accepts a renderer.
 
 createFormElement ()
 Creates an element to add to the group Expects the same arguments as MoodleQuickForm\createElement()
 
 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)
 Output a value.
 
 freeze ()
 
 getAttributesForFormElement ()
 Return attributes suitable for passing to {.
 
 getElementTemplateType ()
 Returns element template, nodisplay/static/fieldset.
 
string getHelpButton ()
 template type, would cause problems with client side validation so will leave for now
 
 MoodleQuickForm_group ($elementName=null, $elementLabel=null, $elements=null, $separator=null, $appendName=true)
 Old syntax of class constructor.
 
 onQuickFormEvent ($event, $arg, &$caller)
 Called by HTML_QuickForm whenever form event is made on this element.
 
 setElements ($elements)
 Sets the grouped elements and hides label.
 
 setHiddenLabel ($hiddenLabel)
 Sets label to be hidden.
 
 setMoodleForm ($mform)
 Stores the form this element was added to This object is later used by MoodleQuickForm_group::createElement().
 
 toHtml ()
 
 validateSubmitValue ($values)
 Calls the validateSubmitValue function for the containing elements and returns an error string as soon as it finds one.
 

Public Attributes

string $_helpbutton =''
 html for help button, if empty then no help
 

Protected Member Functions

 has_customize_switch ()
 Should this element have default/custom switch?
 
 timestamp_to_date_array ($value)
 Converts timestamp to the day/month/year array in the current calendar format.
 

Protected Attributes

bool $_hiddenLabel = false
 if true label will be hidden.
 
MoodleQuickForm $_mform = null
 
array $_options
 
 $_renderedfromtemplate = false
 
null bool $_usedcreateelement = true
 Keeps track of whether the date selector was initialised using createElement or addElement.
 
array $_wrap = array('', '')
 These complement separators, they are appended to the resultant HTML.
 

Detailed Description

Creates an element with a dropdown Default/Custom and an input for the value (text or date_selector)

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

Constructor & Destructor Documentation

◆ __construct()

MoodleQuickForm_defaultcustom::__construct ( $elementname = null,
$elementlabel = null,
$options = array(),
$attributes = null )

Constructor.

Parameters
string$elementnameElement's name
mixed$elementlabelLabel(s) for an element
array$optionsOptions to control the element's display
mixed$attributesEither a typical HTML attribute string or an associative array

Member Function Documentation

◆ accept()

MoodleQuickForm_defaultcustom::accept ( & $renderer,
$required = false,
$error = null )

Accepts a renderer.

Parameters
objectAn HTML_QuickForm_Renderer object
boolWhether a group is required
stringAn error message associated with a group
Return values
void

Reimplemented from MoodleQuickForm_group.

◆ export_for_template()

MoodleQuickForm_group::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$outputUsed to do a final render of any components that need to be rendered for export.
Return values
stdClass|array

Implements templatable.

Reimplemented in MoodleQuickForm_date_selector, and MoodleQuickForm_date_time_selector.

◆ exportValue()

MoodleQuickForm_defaultcustom::exportValue ( & $submitvalues,
$assoc = false )

Output a value.

Give it the name of the group. In case of "default" return false.

Parameters
array$submitvaluesvalues submitted.
bool$assocspecifies if returned array is associative
Return values
array

◆ getAttributesForFormElement()

MoodleQuickForm_group::getAttributesForFormElement ( )
inherited

Return attributes suitable for passing to {.

See also
createFormElement}, comprised of all group attributes without ID in order to ensure uniqueness of that value within the group
Return values
array

◆ getElementTemplateType()

MoodleQuickForm_group::getElementTemplateType ( )
inherited

Returns element template, nodisplay/static/fieldset.

Return values
string

◆ getHelpButton()

string MoodleQuickForm_group::getHelpButton ( )
inherited

template type, would cause problems with client side validation so will leave for now

set html for help button

◆ has_customize_switch()

MoodleQuickForm_defaultcustom::has_customize_switch ( )
protected

Should this element have default/custom switch?

Return values
bool

◆ MoodleQuickForm_group()

MoodleQuickForm_group::MoodleQuickForm_group ( $elementName = null,
$elementLabel = null,
$elements = null,
$separator = null,
$appendName = true )
inherited

Old syntax of class constructor.

Deprecated in PHP7.

Deprecated
since Moodle 3.1

◆ onQuickFormEvent()

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

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

Parameters
string$eventName of event
mixed$argevent arguments
object$callercalling object
Return values
bool

Reimplemented from MoodleQuickForm_group.

◆ setElements()

MoodleQuickForm_group::setElements ( $elements)
inherited

Sets the grouped elements and hides label.

Parameters
array$elements

◆ setHiddenLabel()

MoodleQuickForm_group::setHiddenLabel ( $hiddenLabel)
inherited

Sets label to be hidden.

Parameters
bool$hiddenLabelsets if label should be hidden

◆ setMoodleForm()

MoodleQuickForm_group::setMoodleForm ( $mform)
inherited

Stores the form this element was added to This object is later used by MoodleQuickForm_group::createElement().

Parameters
null | MoodleQuickForm$mform

◆ timestamp_to_date_array()

MoodleQuickForm_defaultcustom::timestamp_to_date_array ( $value)
protected

Converts timestamp to the day/month/year array in the current calendar format.

Parameters
int$value
Return values
array

◆ validateSubmitValue()

MoodleQuickForm_group::validateSubmitValue ( $values)
inherited

Calls the validateSubmitValue function for the containing elements and returns an error string as soon as it finds one.

Parameters
array$valuesValues of the containing elements.
Return values
string|nullValidation error message or null.

Reimplemented in MoodleQuickForm_filetypes.

Member Data Documentation

◆ $_usedcreateelement

null bool MoodleQuickForm_defaultcustom::$_usedcreateelement = true
protected

Keeps track of whether the date selector was initialised using createElement or addElement.

If true, createElement was used signifying the element has been added to a group - see MDL-39187.


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