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

UI element for a text input field. More...

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

Public Member Functions

 __construct (string $name, string $value, string $label, bool $isdisabled=false, bool $isreadonly=false)
 Constructor.
 
 html ()
 Render the html for this field.
 
 is_checkbox ()
 Nasty function used for spreading checkbox logic all around.
 
 is_dropdown ()
 Nasty function used for spreading dropdown logic all around.
 
 is_textbox ()
 Nasty function allowing custom textbox behaviour outside the class.
 
 set_max (?string $max)
 Max attribute setter.
 
 set_min (?string $min)
 Min attribute setter.
 
 set_type (?string $type)
 Input type setter.
 

Public Attributes

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

Detailed Description

UI element for a text input field.

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

Constructor & Destructor Documentation

◆ __construct()

gradereport_singleview\local\ui\text_attribute::__construct ( string $name,
string $value,
string $label,
bool $isdisabled = false,
bool $isreadonly = false )

Constructor.

Parameters
string$nameThe input name (the first bit)
string$valueThe input initial value.
string$labelThe label for this input field.
bool$isdisabledIs this input disabled.
bool$isreadonlyIf this is a read-only input.

Member Function Documentation

◆ html()

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

Render the html for this field.

Return values
stringThe HTML.

Reimplemented from gradereport_singleview\local\ui\element.

◆ is_checkbox()

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

Nasty function used for spreading checkbox logic all around.

Return values
bool

Reimplemented in gradereport_singleview\local\ui\checkbox_attribute.

◆ 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\text_attribute::is_textbox ( )

Nasty function allowing custom textbox behaviour outside the class.

Return values
boolIs this a textbox.

Reimplemented from gradereport_singleview\local\ui\element.

◆ set_max()

gradereport_singleview\local\ui\text_attribute::set_max ( ?string $max)

Max attribute setter.

Parameters
string | null$max
Return values
void

◆ set_min()

gradereport_singleview\local\ui\text_attribute::set_min ( ?string $min)

Min attribute setter.

Parameters
string | null$min
Return values
void

◆ set_type()

gradereport_singleview\local\ui\text_attribute::set_type ( ?string $type)

Input type setter.

Parameters
string | null$type
Return values
void

Member Data Documentation

◆ $label

string gradereport_singleview\local\ui\element::$label
inherited

The form label for this input.

$label

◆ $name

string gradereport_singleview\local\ui\element::$name
inherited

The first bit of the name for this input.

$name

◆ $value

string gradereport_singleview\local\ui\element::$value
inherited

The value for this input.

$value


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