Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
gradereport_singleview\local\ui\grade_attribute_format Class Reference

Abstract class for a form element representing something about a grade_grade. More...

Inheritance diagram for gradereport_singleview\local\ui\grade_attribute_format:
gradereport_singleview\local\ui\attribute_format gradereport_singleview\local\ui\unique_name gradereport_singleview\local\ui\exclude gradereport_singleview\local\ui\feedback gradereport_singleview\local\ui\finalgrade gradereport_singleview\local\ui\override

Public Member Functions

 __construct ($grade=0)
 Constructor.
 
 __toString ()
 Convert this to an element and then to a string.
 
 determine_format ()
 Used to convert this class to an "element" which can be converted to a string.
 
 get_name ()
 Get a unique name for this form input.
 
 set ($value)
 Should be overridden by the child class to save the value returned in this input.
 

Public Attributes

grade_grade $grade
 The grade_grade of the input $grade.
 
null string $label
 The label of the input $label.
 
string $name
 The first part of the name attribute of the form input $name.
 

Detailed Description

Abstract class for a form element representing something about a grade_grade.

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

Constructor & Destructor Documentation

◆ __construct()

gradereport_singleview\local\ui\grade_attribute_format::__construct ( $grade = 0)

Constructor.

Parameters
grade_grade$gradeThe grade_grade we are editing.

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

Used to convert this class to an "element" which can be converted to a string.

Return values
element

Reimplemented in gradereport_singleview\local\ui\exclude, gradereport_singleview\local\ui\feedback, gradereport_singleview\local\ui\finalgrade, gradereport_singleview\local\ui\override, and gradereport_singleview\local\ui\range.

◆ get_name()

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

Get a unique name for this form input.

Return values
stringThe form input name attribute.

Implements gradereport_singleview\local\ui\unique_name.

◆ set()

gradereport_singleview\local\ui\grade_attribute_format::set ( $value)
abstract

Should be overridden by the child class to save the value returned in this input.

Parameters
string$valueThe value from the form.
Return values
stringAny error message

Reimplemented in gradereport_singleview\local\ui\exclude, gradereport_singleview\local\ui\feedback, gradereport_singleview\local\ui\finalgrade, and gradereport_singleview\local\ui\override.


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