Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
gradereport_singleview\local\ui\exclude Class Reference

Class that represents the exclude checkbox on a grade_grade. More...

Inheritance diagram for gradereport_singleview\local\ui\exclude:
gradereport_singleview\local\ui\grade_attribute_format gradereport_singleview\local\ui\be_checked gradereport_singleview\local\ui\be_disabled gradereport_singleview\local\ui\be_readonly gradereport_singleview\local\ui\attribute_format gradereport_singleview\local\ui\unique_name

Public Member Functions

 __toString ()
 Convert this to an element and then to a string.
 
 determine_format ()
 Generate the element used to render the UI.
 
 get_label ()
 Get the label for the form input.
 
 get_name ()
 Get a unique name for this form input.
 
 is_checked ()
 Is it checked?
 
 is_disabled ()
 Is it disabled?
 
 is_readonly ()
 Return true if this is read-only.
 
 set ($value)
 Set the value that was changed in the form.
 

Public Attributes

bool $disabled = false
 Is the checkbox disabled? $disabled.
 
grade_grade $grade
 The grade_grade of the input $grade.
 
null string $label
 The label of the input $label.
 
string $name = 'exclude'
 The name of the input $name.
 

Detailed Description

Class that represents the exclude checkbox on a grade_grade.

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

Member Function Documentation

◆ __toString()

gradereport_singleview\local\ui\attribute_format::__toString ( )
inherited

Convert this to an element and then to a string.

Return values
string

◆ determine_format()

gradereport_singleview\local\ui\exclude::determine_format ( )

Generate the element used to render the UI.

Return values
element

Reimplemented from gradereport_singleview\local\ui\attribute_format.

◆ get_label()

gradereport_singleview\local\ui\exclude::get_label ( )

Get the label for the form input.

Return values
string

◆ get_name()

gradereport_singleview\local\ui\grade_attribute_format::get_name ( )
inherited

Get a unique name for this form input.

Return values
stringThe form input name attribute.

Implements gradereport_singleview\local\ui\unique_name.

◆ is_checked()

gradereport_singleview\local\ui\exclude::is_checked ( )

Is it checked?

Return values
bool

Implements gradereport_singleview\local\ui\be_checked.

◆ is_disabled()

gradereport_singleview\local\ui\exclude::is_disabled ( )

Is it disabled?

Return values
bool

Implements gradereport_singleview\local\ui\be_disabled.

◆ is_readonly()

gradereport_singleview\local\ui\exclude::is_readonly ( )

Return true if this is read-only.

Return values
bool

Implements gradereport_singleview\local\ui\be_readonly.

◆ set()

gradereport_singleview\local\ui\exclude::set ( $value)

Set the value that was changed in the form.

Parameters
string$valueThe value to set.
Return values
mixedstring|bool An error message or false.

Reimplemented from gradereport_singleview\local\ui\grade_attribute_format.


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