2 // This file is part of Moodle - http://moodle.org/
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 // GNU General Public License for more details.
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
19 * Textarea type form element
21 * Contains HTML class for a textarea type element
24 * @copyright 2006 Jamie Pratt <me@jamiep.org>
25 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
28 require_once('HTML/QuickForm/textarea.php');
31 * Textarea type form element
33 * HTML class for a textarea type element
37 * @copyright 2006 Jamie Pratt <me@jamiep.org>
38 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
40 class MoodleQuickForm_textarea
extends HTML_QuickForm_textarea
{
41 /** @var string Need to store id of form as we may need it for helpbutton */
44 /** @var string html for help button, if empty then no help */
47 /** @var bool if true label will be hidden */
48 var $_hiddenLabel=false;
53 * @param string $elementName (optional) name of the text field
54 * @param string $elementLabel (optional) text field label
55 * @param string $attributes (optional) Either a typical HTML attribute string or an associative array
57 public function __construct($elementName=null, $elementLabel=null, $attributes=null) {
58 parent
::__construct($elementName, $elementLabel, $attributes);
62 * Old syntax of class constructor. Deprecated in PHP7.
64 * @deprecated since Moodle 3.1
66 public function MoodleQuickForm_textarea($elementName=null, $elementLabel=null, $attributes=null) {
67 debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER
);
68 self
::__construct($elementName, $elementLabel, $attributes);
72 * get html for help button
74 * @return string html for help button
76 function getHelpButton(){
77 return $this->_helpbutton
;
81 * Sets label to be hidden
83 * @param bool $hiddenLabel sets if label should be hidden
85 function setHiddenLabel($hiddenLabel){
86 $this->_hiddenLabel
= $hiddenLabel;
90 * Returns HTML for this form element.
95 if ($this->_hiddenLabel
){
97 return '<label class="accesshide" for="' . $this->getAttribute('id') . '" >' .
98 $this->getLabel() . '</label>' . parent
::toHtml();
100 return parent
::toHtml();
105 * Called by HTML_QuickForm whenever form event is made on this element
107 * @param string $event Name of event
108 * @param mixed $arg event arguments
109 * @param object $caller calling object
111 function onQuickFormEvent($event, $arg, &$caller)
114 case 'createElement':
115 $this->_formid
= $caller->getAttribute('id');
118 return parent
::onQuickFormEvent($event, $arg, $caller);
122 * Slightly different container template when frozen.
126 function getElementTemplateType(){
127 if ($this->_flagFrozen
){