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

UI element representing the finalgrade column. More...

Inheritance diagram for gradereport_singleview\local\ui\finalgrade:
gradereport_singleview\local\ui\grade_attribute_format gradereport_singleview\local\ui\unique_value 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 ()
 Create the element for this column.
 
 get_label ()
 Get the label for this input.
 
 get_name ()
 Get a unique name for this form input.
 
 get_value ()
 Get the value for this input.
 
 is_disabled ()
 Is this input field disabled.
 
 is_readonly ()
 Return true if this is read-only.
 
 set ($value)
 Save the altered value for this field.
 

Public Attributes

grade_grade $grade
 The grade_grade of the input $grade.
 
null string $label
 The label of the input $label.
 
string $name = 'finalgrade'
 Name of this input $name.
 

Detailed Description

UI element representing the finalgrade column.

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\finalgrade::determine_format ( )

Create the element for this column.

Return values
element

Reimplemented from gradereport_singleview\local\ui\attribute_format.

◆ get_label()

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

Get the label for this input.

Return values
stringThe label for this form input.

◆ 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.

◆ get_value()

gradereport_singleview\local\ui\finalgrade::get_value ( )

Get the value for this input.

Return values
null|stringThe value based on the grade_grade.

Implements gradereport_singleview\local\ui\unique_value.

◆ is_disabled()

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

Is this input field disabled.

Return values
boolSet disabled on this input or not.

Implements gradereport_singleview\local\ui\be_disabled.

◆ is_readonly()

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

Return true if this is read-only.

Return values
bool

Implements gradereport_singleview\local\ui\be_readonly.

◆ set()

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

Save the altered value for this field.

Parameters
string$valueThe new value.
Return values
stringAny error string

Reimplemented from gradereport_singleview\local\ui\grade_attribute_format.


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