Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.
/lib/form/ -> textarea.php (source)

[Source view]

Textarea type form element Contains HTML class for a textarea type element

Copyright: 2006 Jamie Pratt <me@jamiep.org>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 178 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 1 file
 lib/form/templatable_form_element.php

Defines 2 classes

MoodleQuickForm_textarea:: (2 methods):
  __construct()
  MoodleQuickForm_textarea()

name:: (8 methods):
  getHelpButton()
  setHiddenLabel()
  toHtml()
  onQuickFormEvent()
  getElementTemplateType()
  get_force_ltr()
  set_force_ltr()
  export_for_template()


Class: MoodleQuickForm_textarea  - X-Ref

Textarea type form element

HTML class for a textarea type element

__construct($elementName=null, $elementLabel=null, $attributes=null)   X-Ref
constructor

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

MoodleQuickForm_textarea($elementName=null, $elementLabel=null, $attributes=null)   X-Ref
Old syntax of class constructor. Deprecated in PHP7.


Class: name  - X-Ref

getHelpButton()   X-Ref
get html for help button

return: string html for help button

setHiddenLabel($hiddenLabel)   X-Ref
Sets label to be hidden

param: bool $hiddenLabel sets if label should be hidden

toHtml()   X-Ref
Returns HTML for this form element.

return: string

onQuickFormEvent($event, $arg, &$caller)   X-Ref
Called by HTML_QuickForm whenever form event is made on this element

param: string $event Name of event
param: mixed $arg event arguments
param: object $caller calling object

getElementTemplateType()   X-Ref
Slightly different container template when frozen.

return: string

get_force_ltr()   X-Ref
Get force LTR option.

return: bool

set_force_ltr($value)   X-Ref
Force the field to flow left-to-right.

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

param: bool $value The value to set the option to.

export_for_template(renderer_base $output)   X-Ref
No description