Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
MoodleQuickForm_textarea Class Reference

Textarea type form element. More...

Inheritance diagram for MoodleQuickForm_textarea:
templatable MoodleQuickForm_wikieditor

Public Member Functions

 __construct ($elementName=null, $elementLabel=null, $attributes=null)
 constructor
 
 export_for_template (renderer_base $output)
 Function to export the renderer data in a format that is suitable for a mustache template.
 
 get_force_ltr ()
 Get force LTR option.
 
 getElementTemplateType ()
 Slightly different container template when frozen.
 
 getHelpButton ()
 get html for help button
 
 MoodleQuickForm_textarea ($elementName=null, $elementLabel=null, $attributes=null)
 Old syntax of class constructor.
 
 onQuickFormEvent ($event, $arg, &$caller)
 Called by HTML_QuickForm whenever form event is made on this element.
 
 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 $_formid = ''
 Need to store id of form as we may need it for helpbutton.
 
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.
 

Detailed Description

Textarea type form element.

HTML class for a textarea type element

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

Constructor & Destructor Documentation

◆ __construct()

MoodleQuickForm_textarea::__construct ( $elementName = null,
$elementLabel = null,
$attributes = null )

constructor

Parameters
string$elementName(optional) name of the text field
string$elementLabel(optional) text field label
string$attributes(optional) Either a typical HTML attribute string or an associative array

Reimplemented in MoodleQuickForm_wikieditor.

Member Function Documentation

◆ export_for_template()

MoodleQuickForm_textarea::export_for_template ( renderer_base $output)

Function to export the renderer data in a format that is suitable for a mustache template.

This means:

  1. No complex types - only stdClass, array, int, string, float, bool
  2. Any additional info that is required for the template is pre-calculated (e.g. capability checks).
Parameters
renderer_base$outputUsed to do a final render of any components that need to be rendered for export.
Return values
stdClass|array

Implements templatable.

Reimplemented in MoodleQuickForm_wikieditor.

◆ get_force_ltr()

MoodleQuickForm_textarea::get_force_ltr ( )

Get force LTR option.

Return values
bool

◆ getElementTemplateType()

MoodleQuickForm_textarea::getElementTemplateType ( )

Slightly different container template when frozen.

Return values
string

◆ getHelpButton()

MoodleQuickForm_textarea::getHelpButton ( )

get html for help button

Return values
stringhtml for help button

◆ MoodleQuickForm_textarea()

MoodleQuickForm_textarea::MoodleQuickForm_textarea ( $elementName = null,
$elementLabel = null,
$attributes = null )

Old syntax of class constructor.

Deprecated in PHP7.

Deprecated
since Moodle 3.1

◆ onQuickFormEvent()

MoodleQuickForm_textarea::onQuickFormEvent ( $event,
$arg,
& $caller )

Called by HTML_QuickForm whenever form event is made on this element.

Parameters
string$eventName of event
mixed$argevent arguments
object$callercalling object

◆ set_force_ltr()

MoodleQuickForm_textarea::set_force_ltr ( $value)

Force the field to flow left-to-right.

This is useful for fields such as code or configuration snippets.

Parameters
bool$valueThe value to set the option to.

◆ setHiddenLabel()

MoodleQuickForm_textarea::setHiddenLabel ( $hiddenLabel)

Sets label to be hidden.

Parameters
bool$hiddenLabelsets if label should be hidden

◆ toHtml()

MoodleQuickForm_textarea::toHtml ( )

Returns HTML for this form element.

Return values
string

Reimplemented in MoodleQuickForm_wikieditor.


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