Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
tool_lp_course_competency_overridegrade_form_element Class Reference

Course competency override grade element. More...

Inheritance diagram for tool_lp_course_competency_overridegrade_form_element:
MoodleQuickForm_advcheckbox templatable

Public Member Functions

 __construct ($elementname=null, $elementlabel=null, $options=[])
 Constructor.
 
 export_for_template (renderer_base $output)
 Function to export the renderer data in a format that is suitable for a mustache template.
 
 getFrozenHtml ()
 Returns the disabled field.
 
 getHelpButton ()
 get html for help button
 
 MoodleQuickForm_advcheckbox ($elementName=null, $elementLabel=null, $text=null, $attributes=null, $values=null)
 Old syntax of class constructor.
 
 toHtml ()
 Returns HTML for advchecbox form element.
 

Public Attributes

string $_group
 Group to which this checkbox belongs (for select all/select none button)
 
string $_helpbutton =''
 html for help button, if empty then no help will icon will be dispalyed.
 

Detailed Description

Course competency override grade element.

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

Constructor & Destructor Documentation

◆ __construct()

tool_lp_course_competency_overridegrade_form_element::__construct ( $elementname = null,
$elementlabel = null,
$options = [] )

Constructor.

Parameters
string$elementnameElement name
mixed$elementlabelLabel(s) for an element
array$optionsOptions to control the element's display

Member Function Documentation

◆ export_for_template()

MoodleQuickForm_advcheckbox::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.

◆ getFrozenHtml()

MoodleQuickForm_advcheckbox::getFrozenHtml ( )
inherited

Returns the disabled field.

Accessibility: the return "[ ]" from parent class is not acceptable for screenreader users, and we DO want a label.

Return values
string

◆ getHelpButton()

MoodleQuickForm_advcheckbox::getHelpButton ( )
inherited

get html for help button

Return values
stringhtml for help button

◆ MoodleQuickForm_advcheckbox()

MoodleQuickForm_advcheckbox::MoodleQuickForm_advcheckbox ( $elementName = null,
$elementLabel = null,
$text = null,
$attributes = null,
$values = null )
inherited

Old syntax of class constructor.

Deprecated in PHP7.

Deprecated
since Moodle 3.1

◆ toHtml()

MoodleQuickForm_advcheckbox::toHtml ( )
inherited

Returns HTML for advchecbox form element.

Return values
string

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