Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Public Attributes | List of all members
gradereport_singleview\local\ui\checkbox_attribute Class Reference

A checkbox ui element. More...

Inheritance diagram for gradereport_singleview\local\ui\checkbox_attribute:
gradereport_singleview\local\ui\element

Public Member Functions

 __construct ($name, $label, $ischecked=false, $locked=0)
 Constructor. More...
 
 html ()
 Generate the HTML. More...
 
 is_checkbox ()
 Nasty function allowing checkbox logic to escape the class. More...
 
 is_dropdown ()
 Nasty function used for spreading dropdown logic all around. More...
 
 is_textbox ()
 Nasty function used for spreading textbox logic all around. More...
 

Public Attributes

string $label
 $label The form label for this input.
 
string $name
 $name The first bit of the name for this input.
 
string $value
 $value The value for this input.
 

Detailed Description

A checkbox ui element.

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

Constructor & Destructor Documentation

◆ __construct()

gradereport_singleview\local\ui\checkbox_attribute::__construct (   $name,
  $label,
  $ischecked = false,
  $locked = 0 
)

Constructor.

Parameters
string$nameThe element name
string$labelThe label for the form element
bool$ischeckedIs this thing on?
int$lockedIs this element locked either 0 or a time.

Member Function Documentation

◆ html()

gradereport_singleview\local\ui\checkbox_attribute::html ( )

Generate the HTML.

Return values
string

Reimplemented from gradereport_singleview\local\ui\element.

◆ is_checkbox()

gradereport_singleview\local\ui\checkbox_attribute::is_checkbox ( )

Nasty function allowing checkbox logic to escape the class.

Return values
bool

Reimplemented from gradereport_singleview\local\ui\element.

◆ is_dropdown()

gradereport_singleview\local\ui\element::is_dropdown ( )
inherited

Nasty function used for spreading dropdown logic all around.

Return values
bool

Reimplemented in gradereport_singleview\local\ui\dropdown_attribute.

◆ is_textbox()

gradereport_singleview\local\ui\element::is_textbox ( )
inherited

Nasty function used for spreading textbox logic all around.

Return values
bool

Reimplemented in gradereport_singleview\local\ui\text_attribute.


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