Moodle PHP Documentation 5.1
Moodle 5.1dev (Build: 20250605) (9223e346c3e)
mod_bigbluebuttonbn\form\text_with_copy_element Class Reference
Inheritance diagram for mod_bigbluebuttonbn\form\text_with_copy_element:
MoodleQuickForm_text

Public Member Functions

 accept (&$renderer, $required=false, $error=null)
 Accepts a renderer.
 
 freeze ()
 Freeze the element so that only its value is returned and set persistantfreeze to false.
 
 get_force_ltr ()
 Get force LTR option.
 
 getFrozenHtml ()
 Returns the html to be used when the element is frozen.
 
 getHelpButton ()
 get html for help button
 
 MoodleQuickForm_text ($elementName=null, $elementLabel=null, $attributes=null)
 Old syntax of class constructor.
 
 set_force_ltr ($value)
 Force the field to flow left-to-right.
 
 setHiddenLabel ($hiddenLabel)
 Sets label to be hidden.
 
 toHtml ()
 Returns HTML for this form element.
 

Public Attributes

string $_groupElementTemplate
 an element template.
 
string $_helpbutton =''
 html for help button, if empty then no help
 
bool $_hiddenLabel =false
 if true label will be hidden
 

Protected Attributes

bool $forceltr = false
 Whether to force the display of this element to flow LTR.
 

Member Function Documentation

◆ accept()

mod_bigbluebuttonbn\form\text_with_copy_element::accept ( & $renderer,
$required = false,
$error = null )

Accepts a renderer.

Parameters
object$rendererAn HTML_QuickForm_Renderer object
bool$requiredWhether an element is required
string$errorAn error message associated with an element
Return values
void

◆ freeze()

MoodleQuickForm_text::freeze ( )
inherited

Freeze the element so that only its value is returned and set persistantfreeze to false.

Since
Moodle 2.4
Return values
void

◆ get_force_ltr()

MoodleQuickForm_text::get_force_ltr ( )
inherited

Get force LTR option.

Return values
bool

◆ getFrozenHtml()

MoodleQuickForm_text::getFrozenHtml ( )
inherited

Returns the html to be used when the element is frozen.

Since
Moodle 2.4
Return values
stringFrozen html

◆ getHelpButton()

MoodleQuickForm_text::getHelpButton ( )
inherited

get html for help button

Return values
stringhtml for help button

◆ MoodleQuickForm_text()

MoodleQuickForm_text::MoodleQuickForm_text ( $elementName = null,
$elementLabel = null,
$attributes = null )
inherited

Old syntax of class constructor.

Deprecated in PHP7.

Deprecated
since Moodle 3.1

◆ set_force_ltr()

MoodleQuickForm_text::set_force_ltr ( $value)
inherited

Force the field to flow left-to-right.

This is useful for fields such as URLs, passwords, settings, etc...

Parameters
bool$valueThe value to set the option to.

◆ setHiddenLabel()

MoodleQuickForm_text::setHiddenLabel ( $hiddenLabel)
inherited

Sets label to be hidden.

Parameters
bool$hiddenLabelsets if label should be hidden

◆ toHtml()

MoodleQuickForm_text::toHtml ( )
inherited

Returns HTML for this form element.

Return values
string

Reimplemented in tool_mfa\local\form\verification_field.


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