MDL-53848 form: hide entire group if hideIf test is applied to the group
[moodle.git] / lib / formslib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
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.
8 //
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.
13 //
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/>.
17 /**
18  * formslib.php - library of classes for creating forms in Moodle, based on PEAR QuickForms.
19  *
20  * To use formslib then you will want to create a new file purpose_form.php eg. edit_form.php
21  * and you want to name your class something like {modulename}_{purpose}_form. Your class will
22  * extend moodleform overriding abstract classes definition and optionally defintion_after_data
23  * and validation.
24  *
25  * See examples of use of this library in course/edit.php and course/edit_form.php
26  *
27  * A few notes :
28  *      form definition is used for both printing of form and processing and should be the same
29  *              for both or you may lose some submitted data which won't be let through.
30  *      you should be using setType for every form element except select, radio or checkbox
31  *              elements, these elements clean themselves.
32  *
33  * @package   core_form
34  * @copyright 2006 Jamie Pratt <me@jamiep.org>
35  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36  */
38 defined('MOODLE_INTERNAL') || die();
40 /** setup.php includes our hacked pear libs first */
41 require_once 'HTML/QuickForm.php';
42 require_once 'HTML/QuickForm/DHTMLRulesTableless.php';
43 require_once 'HTML/QuickForm/Renderer/Tableless.php';
44 require_once 'HTML/QuickForm/Rule.php';
46 require_once $CFG->libdir.'/filelib.php';
48 /**
49  * EDITOR_UNLIMITED_FILES - hard-coded value for the 'maxfiles' option
50  */
51 define('EDITOR_UNLIMITED_FILES', -1);
53 /**
54  * Callback called when PEAR throws an error
55  *
56  * @param PEAR_Error $error
57  */
58 function pear_handle_error($error){
59     echo '<strong>'.$error->GetMessage().'</strong> '.$error->getUserInfo();
60     echo '<br /> <strong>Backtrace </strong>:';
61     print_object($error->backtrace);
62 }
64 if ($CFG->debugdeveloper) {
65     //TODO: this is a wrong place to init PEAR!
66     $GLOBALS['_PEAR_default_error_mode'] = PEAR_ERROR_CALLBACK;
67     $GLOBALS['_PEAR_default_error_options'] = 'pear_handle_error';
68 }
70 /**
71  * Initalize javascript for date type form element
72  *
73  * @staticvar bool $done make sure it gets initalize once.
74  * @global moodle_page $PAGE
75  */
76 function form_init_date_js() {
77     global $PAGE;
78     static $done = false;
79     if (!$done) {
80         $calendar = \core_calendar\type_factory::get_calendar_instance();
81         $module   = 'moodle-form-dateselector';
82         $function = 'M.form.dateselector.init_date_selectors';
83         $defaulttimezone = date_default_timezone_get();
85         $config = array(array(
86             'firstdayofweek'    => $calendar->get_starting_weekday(),
87             'mon'               => date_format_string(strtotime("Monday"), '%a', $defaulttimezone),
88             'tue'               => date_format_string(strtotime("Tuesday"), '%a', $defaulttimezone),
89             'wed'               => date_format_string(strtotime("Wednesday"), '%a', $defaulttimezone),
90             'thu'               => date_format_string(strtotime("Thursday"), '%a', $defaulttimezone),
91             'fri'               => date_format_string(strtotime("Friday"), '%a', $defaulttimezone),
92             'sat'               => date_format_string(strtotime("Saturday"), '%a', $defaulttimezone),
93             'sun'               => date_format_string(strtotime("Sunday"), '%a', $defaulttimezone),
94             'january'           => date_format_string(strtotime("January 1"), '%B', $defaulttimezone),
95             'february'          => date_format_string(strtotime("February 1"), '%B', $defaulttimezone),
96             'march'             => date_format_string(strtotime("March 1"), '%B', $defaulttimezone),
97             'april'             => date_format_string(strtotime("April 1"), '%B', $defaulttimezone),
98             'may'               => date_format_string(strtotime("May 1"), '%B', $defaulttimezone),
99             'june'              => date_format_string(strtotime("June 1"), '%B', $defaulttimezone),
100             'july'              => date_format_string(strtotime("July 1"), '%B', $defaulttimezone),
101             'august'            => date_format_string(strtotime("August 1"), '%B', $defaulttimezone),
102             'september'         => date_format_string(strtotime("September 1"), '%B', $defaulttimezone),
103             'october'           => date_format_string(strtotime("October 1"), '%B', $defaulttimezone),
104             'november'          => date_format_string(strtotime("November 1"), '%B', $defaulttimezone),
105             'december'          => date_format_string(strtotime("December 1"), '%B', $defaulttimezone)
106         ));
107         $PAGE->requires->yui_module($module, $function, $config);
108         $done = true;
109     }
112 /**
113  * Wrapper that separates quickforms syntax from moodle code
114  *
115  * Moodle specific wrapper that separates quickforms syntax from moodle code. You won't directly
116  * use this class you should write a class definition which extends this class or a more specific
117  * subclass such a moodleform_mod for each form you want to display and/or process with formslib.
118  *
119  * You will write your own definition() method which performs the form set up.
120  *
121  * @package   core_form
122  * @copyright 2006 Jamie Pratt <me@jamiep.org>
123  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
124  * @todo      MDL-19380 rethink the file scanning
125  */
126 abstract class moodleform {
127     /** @var string name of the form */
128     protected $_formname;       // form name
130     /** @var MoodleQuickForm quickform object definition */
131     protected $_form;
133     /** @var array globals workaround */
134     protected $_customdata;
136     /** @var array submitted form data when using mforms with ajax */
137     protected $_ajaxformdata;
139     /** @var object definition_after_data executed flag */
140     protected $_definition_finalized = false;
142     /** @var bool|null stores the validation result of this form or null if not yet validated */
143     protected $_validated = null;
145     /**
146      * The constructor function calls the abstract function definition() and it will then
147      * process and clean and attempt to validate incoming data.
148      *
149      * It will call your custom validate method to validate data and will also check any rules
150      * you have specified in definition using addRule
151      *
152      * The name of the form (id attribute of the form) is automatically generated depending on
153      * the name you gave the class extending moodleform. You should call your class something
154      * like
155      *
156      * @param mixed $action the action attribute for the form. If empty defaults to auto detect the
157      *              current url. If a moodle_url object then outputs params as hidden variables.
158      * @param mixed $customdata if your form defintion method needs access to data such as $course
159      *              $cm, etc. to construct the form definition then pass it in this array. You can
160      *              use globals for somethings.
161      * @param string $method if you set this to anything other than 'post' then _GET and _POST will
162      *               be merged and used as incoming data to the form.
163      * @param string $target target frame for form submission. You will rarely use this. Don't use
164      *               it if you don't need to as the target attribute is deprecated in xhtml strict.
165      * @param mixed $attributes you can pass a string of html attributes here or an array.
166      * @param bool $editable
167      * @param array $ajaxformdata Forms submitted via ajax, must pass their data here, instead of relying on _GET and _POST.
168      */
169     public function __construct($action=null, $customdata=null, $method='post', $target='', $attributes=null, $editable=true,
170                                 $ajaxformdata=null) {
171         global $CFG, $FULLME;
172         // no standard mform in moodle should allow autocomplete with the exception of user signup
173         if (empty($attributes)) {
174             $attributes = array('autocomplete'=>'off');
175         } else if (is_array($attributes)) {
176             $attributes['autocomplete'] = 'off';
177         } else {
178             if (strpos($attributes, 'autocomplete') === false) {
179                 $attributes .= ' autocomplete="off" ';
180             }
181         }
184         if (empty($action)){
185             // do not rely on PAGE->url here because dev often do not setup $actualurl properly in admin_externalpage_setup()
186             $action = strip_querystring($FULLME);
187             if (!empty($CFG->sslproxy)) {
188                 // return only https links when using SSL proxy
189                 $action = preg_replace('/^http:/', 'https:', $action, 1);
190             }
191             //TODO: use following instead of FULLME - see MDL-33015
192             //$action = strip_querystring(qualified_me());
193         }
194         // Assign custom data first, so that get_form_identifier can use it.
195         $this->_customdata = $customdata;
196         $this->_formname = $this->get_form_identifier();
197         $this->_ajaxformdata = $ajaxformdata;
199         $this->_form = new MoodleQuickForm($this->_formname, $method, $action, $target, $attributes);
200         if (!$editable){
201             $this->_form->hardFreeze();
202         }
204         $this->definition();
206         $this->_form->addElement('hidden', 'sesskey', null); // automatic sesskey protection
207         $this->_form->setType('sesskey', PARAM_RAW);
208         $this->_form->setDefault('sesskey', sesskey());
209         $this->_form->addElement('hidden', '_qf__'.$this->_formname, null);   // form submission marker
210         $this->_form->setType('_qf__'.$this->_formname, PARAM_RAW);
211         $this->_form->setDefault('_qf__'.$this->_formname, 1);
212         $this->_form->_setDefaultRuleMessages();
214         // Hook to inject logic after the definition was provided.
215         $this->after_definition();
217         // we have to know all input types before processing submission ;-)
218         $this->_process_submission($method);
219     }
221     /**
222      * Old syntax of class constructor. Deprecated in PHP7.
223      *
224      * @deprecated since Moodle 3.1
225      */
226     public function moodleform($action=null, $customdata=null, $method='post', $target='', $attributes=null, $editable=true) {
227         debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);
228         self::__construct($action, $customdata, $method, $target, $attributes, $editable);
229     }
231     /**
232      * It should returns unique identifier for the form.
233      * Currently it will return class name, but in case two same forms have to be
234      * rendered on same page then override function to get unique form identifier.
235      * e.g This is used on multiple self enrollments page.
236      *
237      * @return string form identifier.
238      */
239     protected function get_form_identifier() {
240         $class = get_class($this);
242         return preg_replace('/[^a-z0-9_]/i', '_', $class);
243     }
245     /**
246      * To autofocus on first form element or first element with error.
247      *
248      * @param string $name if this is set then the focus is forced to a field with this name
249      * @return string javascript to select form element with first error or
250      *                first element if no errors. Use this as a parameter
251      *                when calling print_header
252      */
253     function focus($name=NULL) {
254         $form =& $this->_form;
255         $elkeys = array_keys($form->_elementIndex);
256         $error = false;
257         if (isset($form->_errors) &&  0 != count($form->_errors)){
258             $errorkeys = array_keys($form->_errors);
259             $elkeys = array_intersect($elkeys, $errorkeys);
260             $error = true;
261         }
263         if ($error or empty($name)) {
264             $names = array();
265             while (empty($names) and !empty($elkeys)) {
266                 $el = array_shift($elkeys);
267                 $names = $form->_getElNamesRecursive($el);
268             }
269             if (!empty($names)) {
270                 $name = array_shift($names);
271             }
272         }
274         $focus = '';
275         if (!empty($name)) {
276             $focus = 'forms[\''.$form->getAttribute('id').'\'].elements[\''.$name.'\']';
277         }
279         return $focus;
280      }
282     /**
283      * Internal method. Alters submitted data to be suitable for quickforms processing.
284      * Must be called when the form is fully set up.
285      *
286      * @param string $method name of the method which alters submitted data
287      */
288     function _process_submission($method) {
289         $submission = array();
290         if (!empty($this->_ajaxformdata)) {
291             $submission = $this->_ajaxformdata;
292         } else if ($method == 'post') {
293             if (!empty($_POST)) {
294                 $submission = $_POST;
295             }
296         } else {
297             $submission = $_GET;
298             merge_query_params($submission, $_POST); // Emulate handling of parameters in xxxx_param().
299         }
301         // following trick is needed to enable proper sesskey checks when using GET forms
302         // the _qf__.$this->_formname serves as a marker that form was actually submitted
303         if (array_key_exists('_qf__'.$this->_formname, $submission) and $submission['_qf__'.$this->_formname] == 1) {
304             if (!confirm_sesskey()) {
305                 print_error('invalidsesskey');
306             }
307             $files = $_FILES;
308         } else {
309             $submission = array();
310             $files = array();
311         }
312         $this->detectMissingSetType();
314         $this->_form->updateSubmission($submission, $files);
315     }
317     /**
318      * Internal method - should not be used anywhere.
319      * @deprecated since 2.6
320      * @return array $_POST.
321      */
322     protected function _get_post_params() {
323         return $_POST;
324     }
326     /**
327      * Internal method. Validates all old-style deprecated uploaded files.
328      * The new way is to upload files via repository api.
329      *
330      * @param array $files list of files to be validated
331      * @return bool|array Success or an array of errors
332      */
333     function _validate_files(&$files) {
334         global $CFG, $COURSE;
336         $files = array();
338         if (empty($_FILES)) {
339             // we do not need to do any checks because no files were submitted
340             // note: server side rules do not work for files - use custom verification in validate() instead
341             return true;
342         }
344         $errors = array();
345         $filenames = array();
347         // now check that we really want each file
348         foreach ($_FILES as $elname=>$file) {
349             $required = $this->_form->isElementRequired($elname);
351             if ($file['error'] == 4 and $file['size'] == 0) {
352                 if ($required) {
353                     $errors[$elname] = get_string('required');
354                 }
355                 unset($_FILES[$elname]);
356                 continue;
357             }
359             if (!empty($file['error'])) {
360                 $errors[$elname] = file_get_upload_error($file['error']);
361                 unset($_FILES[$elname]);
362                 continue;
363             }
365             if (!is_uploaded_file($file['tmp_name'])) {
366                 // TODO: improve error message
367                 $errors[$elname] = get_string('error');
368                 unset($_FILES[$elname]);
369                 continue;
370             }
372             if (!$this->_form->elementExists($elname) or !$this->_form->getElementType($elname)=='file') {
373                 // hmm, this file was not requested
374                 unset($_FILES[$elname]);
375                 continue;
376             }
378             // NOTE: the viruses are scanned in file picker, no need to deal with them here.
380             $filename = clean_param($_FILES[$elname]['name'], PARAM_FILE);
381             if ($filename === '') {
382                 // TODO: improve error message - wrong chars
383                 $errors[$elname] = get_string('error');
384                 unset($_FILES[$elname]);
385                 continue;
386             }
387             if (in_array($filename, $filenames)) {
388                 // TODO: improve error message - duplicate name
389                 $errors[$elname] = get_string('error');
390                 unset($_FILES[$elname]);
391                 continue;
392             }
393             $filenames[] = $filename;
394             $_FILES[$elname]['name'] = $filename;
396             $files[$elname] = $_FILES[$elname]['tmp_name'];
397         }
399         // return errors if found
400         if (count($errors) == 0){
401             return true;
403         } else {
404             $files = array();
405             return $errors;
406         }
407     }
409     /**
410      * Internal method. Validates filepicker and filemanager files if they are
411      * set as required fields. Also, sets the error message if encountered one.
412      *
413      * @return bool|array with errors
414      */
415     protected function validate_draft_files() {
416         global $USER;
417         $mform =& $this->_form;
419         $errors = array();
420         //Go through all the required elements and make sure you hit filepicker or
421         //filemanager element.
422         foreach ($mform->_rules as $elementname => $rules) {
423             $elementtype = $mform->getElementType($elementname);
424             //If element is of type filepicker then do validation
425             if (($elementtype == 'filepicker') || ($elementtype == 'filemanager')){
426                 //Check if rule defined is required rule
427                 foreach ($rules as $rule) {
428                     if ($rule['type'] == 'required') {
429                         $draftid = (int)$mform->getSubmitValue($elementname);
430                         $fs = get_file_storage();
431                         $context = context_user::instance($USER->id);
432                         if (!$files = $fs->get_area_files($context->id, 'user', 'draft', $draftid, 'id DESC', false)) {
433                             $errors[$elementname] = $rule['message'];
434                         }
435                     }
436                 }
437             }
438         }
439         // Check all the filemanager elements to make sure they do not have too many
440         // files in them.
441         foreach ($mform->_elements as $element) {
442             if ($element->_type == 'filemanager') {
443                 $maxfiles = $element->getMaxfiles();
444                 if ($maxfiles > 0) {
445                     $draftid = (int)$element->getValue();
446                     $fs = get_file_storage();
447                     $context = context_user::instance($USER->id);
448                     $files = $fs->get_area_files($context->id, 'user', 'draft', $draftid, '', false);
449                     if (count($files) > $maxfiles) {
450                         $errors[$element->getName()] = get_string('err_maxfiles', 'form', $maxfiles);
451                     }
452                 }
453             }
454         }
455         if (empty($errors)) {
456             return true;
457         } else {
458             return $errors;
459         }
460     }
462     /**
463      * Load in existing data as form defaults. Usually new entry defaults are stored directly in
464      * form definition (new entry form); this function is used to load in data where values
465      * already exist and data is being edited (edit entry form).
466      *
467      * note: $slashed param removed
468      *
469      * @param stdClass|array $default_values object or array of default values
470      */
471     function set_data($default_values) {
472         if (is_object($default_values)) {
473             $default_values = (array)$default_values;
474         }
475         $this->_form->setDefaults($default_values);
476     }
478     /**
479      * Check that form was submitted. Does not check validity of submitted data.
480      *
481      * @return bool true if form properly submitted
482      */
483     function is_submitted() {
484         return $this->_form->isSubmitted();
485     }
487     /**
488      * Checks if button pressed is not for submitting the form
489      *
490      * @staticvar bool $nosubmit keeps track of no submit button
491      * @return bool
492      */
493     function no_submit_button_pressed(){
494         static $nosubmit = null; // one check is enough
495         if (!is_null($nosubmit)){
496             return $nosubmit;
497         }
498         $mform =& $this->_form;
499         $nosubmit = false;
500         if (!$this->is_submitted()){
501             return false;
502         }
503         foreach ($mform->_noSubmitButtons as $nosubmitbutton){
504             if (optional_param($nosubmitbutton, 0, PARAM_RAW)){
505                 $nosubmit = true;
506                 break;
507             }
508         }
509         return $nosubmit;
510     }
513     /**
514      * Check that form data is valid.
515      * You should almost always use this, rather than {@link validate_defined_fields}
516      *
517      * @return bool true if form data valid
518      */
519     function is_validated() {
520         //finalize the form definition before any processing
521         if (!$this->_definition_finalized) {
522             $this->_definition_finalized = true;
523             $this->definition_after_data();
524         }
526         return $this->validate_defined_fields();
527     }
529     /**
530      * Validate the form.
531      *
532      * You almost always want to call {@link is_validated} instead of this
533      * because it calls {@link definition_after_data} first, before validating the form,
534      * which is what you want in 99% of cases.
535      *
536      * This is provided as a separate function for those special cases where
537      * you want the form validated before definition_after_data is called
538      * for example, to selectively add new elements depending on a no_submit_button press,
539      * but only when the form is valid when the no_submit_button is pressed,
540      *
541      * @param bool $validateonnosubmit optional, defaults to false.  The default behaviour
542      *             is NOT to validate the form when a no submit button has been pressed.
543      *             pass true here to override this behaviour
544      *
545      * @return bool true if form data valid
546      */
547     function validate_defined_fields($validateonnosubmit=false) {
548         $mform =& $this->_form;
549         if ($this->no_submit_button_pressed() && empty($validateonnosubmit)){
550             return false;
551         } elseif ($this->_validated === null) {
552             $internal_val = $mform->validate();
554             $files = array();
555             $file_val = $this->_validate_files($files);
556             //check draft files for validation and flag them if required files
557             //are not in draft area.
558             $draftfilevalue = $this->validate_draft_files();
560             if ($file_val !== true && $draftfilevalue !== true) {
561                 $file_val = array_merge($file_val, $draftfilevalue);
562             } else if ($draftfilevalue !== true) {
563                 $file_val = $draftfilevalue;
564             } //default is file_val, so no need to assign.
566             if ($file_val !== true) {
567                 if (!empty($file_val)) {
568                     foreach ($file_val as $element=>$msg) {
569                         $mform->setElementError($element, $msg);
570                     }
571                 }
572                 $file_val = false;
573             }
575             // Give the elements a chance to perform an implicit validation.
576             $element_val = true;
577             foreach ($mform->_elements as $element) {
578                 if (method_exists($element, 'validateSubmitValue')) {
579                     $value = $mform->getSubmitValue($element->getName());
580                     $result = $element->validateSubmitValue($value);
581                     if (!empty($result) && is_string($result)) {
582                         $element_val = false;
583                         $mform->setElementError($element->getName(), $result);
584                     }
585                 }
586             }
588             // Let the form instance validate the submitted values.
589             $data = $mform->exportValues();
590             $moodle_val = $this->validation($data, $files);
591             if ((is_array($moodle_val) && count($moodle_val)!==0)) {
592                 // non-empty array means errors
593                 foreach ($moodle_val as $element=>$msg) {
594                     $mform->setElementError($element, $msg);
595                 }
596                 $moodle_val = false;
598             } else {
599                 // anything else means validation ok
600                 $moodle_val = true;
601             }
603             $this->_validated = ($internal_val and $element_val and $moodle_val and $file_val);
604         }
605         return $this->_validated;
606     }
608     /**
609      * Return true if a cancel button has been pressed resulting in the form being submitted.
610      *
611      * @return bool true if a cancel button has been pressed
612      */
613     function is_cancelled(){
614         $mform =& $this->_form;
615         if ($mform->isSubmitted()){
616             foreach ($mform->_cancelButtons as $cancelbutton){
617                 if (optional_param($cancelbutton, 0, PARAM_RAW)){
618                     return true;
619                 }
620             }
621         }
622         return false;
623     }
625     /**
626      * Return submitted data if properly submitted or returns NULL if validation fails or
627      * if there is no submitted data.
628      *
629      * note: $slashed param removed
630      *
631      * @return object submitted data; NULL if not valid or not submitted or cancelled
632      */
633     function get_data() {
634         $mform =& $this->_form;
636         if (!$this->is_cancelled() and $this->is_submitted() and $this->is_validated()) {
637             $data = $mform->exportValues();
638             unset($data['sesskey']); // we do not need to return sesskey
639             unset($data['_qf__'.$this->_formname]);   // we do not need the submission marker too
640             if (empty($data)) {
641                 return NULL;
642             } else {
643                 return (object)$data;
644             }
645         } else {
646             return NULL;
647         }
648     }
650     /**
651      * Return submitted data without validation or NULL if there is no submitted data.
652      * note: $slashed param removed
653      *
654      * @return object submitted data; NULL if not submitted
655      */
656     function get_submitted_data() {
657         $mform =& $this->_form;
659         if ($this->is_submitted()) {
660             $data = $mform->exportValues();
661             unset($data['sesskey']); // we do not need to return sesskey
662             unset($data['_qf__'.$this->_formname]);   // we do not need the submission marker too
663             if (empty($data)) {
664                 return NULL;
665             } else {
666                 return (object)$data;
667             }
668         } else {
669             return NULL;
670         }
671     }
673     /**
674      * Save verified uploaded files into directory. Upload process can be customised from definition()
675      *
676      * @deprecated since Moodle 2.0
677      * @todo MDL-31294 remove this api
678      * @see moodleform::save_stored_file()
679      * @see moodleform::save_file()
680      * @param string $destination path where file should be stored
681      * @return bool Always false
682      */
683     function save_files($destination) {
684         debugging('Not used anymore, please fix code! Use save_stored_file() or save_file() instead');
685         return false;
686     }
688     /**
689      * Returns name of uploaded file.
690      *
691      * @param string $elname first element if null
692      * @return string|bool false in case of failure, string if ok
693      */
694     function get_new_filename($elname=null) {
695         global $USER;
697         if (!$this->is_submitted() or !$this->is_validated()) {
698             return false;
699         }
701         if (is_null($elname)) {
702             if (empty($_FILES)) {
703                 return false;
704             }
705             reset($_FILES);
706             $elname = key($_FILES);
707         }
709         if (empty($elname)) {
710             return false;
711         }
713         $element = $this->_form->getElement($elname);
715         if ($element instanceof MoodleQuickForm_filepicker || $element instanceof MoodleQuickForm_filemanager) {
716             $values = $this->_form->exportValues($elname);
717             if (empty($values[$elname])) {
718                 return false;
719             }
720             $draftid = $values[$elname];
721             $fs = get_file_storage();
722             $context = context_user::instance($USER->id);
723             if (!$files = $fs->get_area_files($context->id, 'user', 'draft', $draftid, 'id DESC', false)) {
724                 return false;
725             }
726             $file = reset($files);
727             return $file->get_filename();
728         }
730         if (!isset($_FILES[$elname])) {
731             return false;
732         }
734         return $_FILES[$elname]['name'];
735     }
737     /**
738      * Save file to standard filesystem
739      *
740      * @param string $elname name of element
741      * @param string $pathname full path name of file
742      * @param bool $override override file if exists
743      * @return bool success
744      */
745     function save_file($elname, $pathname, $override=false) {
746         global $USER;
748         if (!$this->is_submitted() or !$this->is_validated()) {
749             return false;
750         }
751         if (file_exists($pathname)) {
752             if ($override) {
753                 if (!@unlink($pathname)) {
754                     return false;
755                 }
756             } else {
757                 return false;
758             }
759         }
761         $element = $this->_form->getElement($elname);
763         if ($element instanceof MoodleQuickForm_filepicker || $element instanceof MoodleQuickForm_filemanager) {
764             $values = $this->_form->exportValues($elname);
765             if (empty($values[$elname])) {
766                 return false;
767             }
768             $draftid = $values[$elname];
769             $fs = get_file_storage();
770             $context = context_user::instance($USER->id);
771             if (!$files = $fs->get_area_files($context->id, 'user', 'draft', $draftid, 'id DESC', false)) {
772                 return false;
773             }
774             $file = reset($files);
776             return $file->copy_content_to($pathname);
778         } else if (isset($_FILES[$elname])) {
779             return copy($_FILES[$elname]['tmp_name'], $pathname);
780         }
782         return false;
783     }
785     /**
786      * Returns a temporary file, do not forget to delete after not needed any more.
787      *
788      * @param string $elname name of the elmenet
789      * @return string|bool either string or false
790      */
791     function save_temp_file($elname) {
792         if (!$this->get_new_filename($elname)) {
793             return false;
794         }
795         if (!$dir = make_temp_directory('forms')) {
796             return false;
797         }
798         if (!$tempfile = tempnam($dir, 'tempup_')) {
799             return false;
800         }
801         if (!$this->save_file($elname, $tempfile, true)) {
802             // something went wrong
803             @unlink($tempfile);
804             return false;
805         }
807         return $tempfile;
808     }
810     /**
811      * Get draft files of a form element
812      * This is a protected method which will be used only inside moodleforms
813      *
814      * @param string $elname name of element
815      * @return array|bool|null
816      */
817     protected function get_draft_files($elname) {
818         global $USER;
820         if (!$this->is_submitted()) {
821             return false;
822         }
824         $element = $this->_form->getElement($elname);
826         if ($element instanceof MoodleQuickForm_filepicker || $element instanceof MoodleQuickForm_filemanager) {
827             $values = $this->_form->exportValues($elname);
828             if (empty($values[$elname])) {
829                 return false;
830             }
831             $draftid = $values[$elname];
832             $fs = get_file_storage();
833             $context = context_user::instance($USER->id);
834             if (!$files = $fs->get_area_files($context->id, 'user', 'draft', $draftid, 'id DESC', false)) {
835                 return null;
836             }
837             return $files;
838         }
839         return null;
840     }
842     /**
843      * Save file to local filesystem pool
844      *
845      * @param string $elname name of element
846      * @param int $newcontextid id of context
847      * @param string $newcomponent name of the component
848      * @param string $newfilearea name of file area
849      * @param int $newitemid item id
850      * @param string $newfilepath path of file where it get stored
851      * @param string $newfilename use specified filename, if not specified name of uploaded file used
852      * @param bool $overwrite overwrite file if exists
853      * @param int $newuserid new userid if required
854      * @return mixed stored_file object or false if error; may throw exception if duplicate found
855      */
856     function save_stored_file($elname, $newcontextid, $newcomponent, $newfilearea, $newitemid, $newfilepath='/',
857                               $newfilename=null, $overwrite=false, $newuserid=null) {
858         global $USER;
860         if (!$this->is_submitted() or !$this->is_validated()) {
861             return false;
862         }
864         if (empty($newuserid)) {
865             $newuserid = $USER->id;
866         }
868         $element = $this->_form->getElement($elname);
869         $fs = get_file_storage();
871         if ($element instanceof MoodleQuickForm_filepicker) {
872             $values = $this->_form->exportValues($elname);
873             if (empty($values[$elname])) {
874                 return false;
875             }
876             $draftid = $values[$elname];
877             $context = context_user::instance($USER->id);
878             if (!$files = $fs->get_area_files($context->id, 'user' ,'draft', $draftid, 'id DESC', false)) {
879                 return false;
880             }
881             $file = reset($files);
882             if (is_null($newfilename)) {
883                 $newfilename = $file->get_filename();
884             }
886             if ($overwrite) {
887                 if ($oldfile = $fs->get_file($newcontextid, $newcomponent, $newfilearea, $newitemid, $newfilepath, $newfilename)) {
888                     if (!$oldfile->delete()) {
889                         return false;
890                     }
891                 }
892             }
894             $file_record = array('contextid'=>$newcontextid, 'component'=>$newcomponent, 'filearea'=>$newfilearea, 'itemid'=>$newitemid,
895                                  'filepath'=>$newfilepath, 'filename'=>$newfilename, 'userid'=>$newuserid);
896             return $fs->create_file_from_storedfile($file_record, $file);
898         } else if (isset($_FILES[$elname])) {
899             $filename = is_null($newfilename) ? $_FILES[$elname]['name'] : $newfilename;
901             if ($overwrite) {
902                 if ($oldfile = $fs->get_file($newcontextid, $newcomponent, $newfilearea, $newitemid, $newfilepath, $newfilename)) {
903                     if (!$oldfile->delete()) {
904                         return false;
905                     }
906                 }
907             }
909             $file_record = array('contextid'=>$newcontextid, 'component'=>$newcomponent, 'filearea'=>$newfilearea, 'itemid'=>$newitemid,
910                                  'filepath'=>$newfilepath, 'filename'=>$newfilename, 'userid'=>$newuserid);
911             return $fs->create_file_from_pathname($file_record, $_FILES[$elname]['tmp_name']);
912         }
914         return false;
915     }
917     /**
918      * Get content of uploaded file.
919      *
920      * @param string $elname name of file upload element
921      * @return string|bool false in case of failure, string if ok
922      */
923     function get_file_content($elname) {
924         global $USER;
926         if (!$this->is_submitted() or !$this->is_validated()) {
927             return false;
928         }
930         $element = $this->_form->getElement($elname);
932         if ($element instanceof MoodleQuickForm_filepicker || $element instanceof MoodleQuickForm_filemanager) {
933             $values = $this->_form->exportValues($elname);
934             if (empty($values[$elname])) {
935                 return false;
936             }
937             $draftid = $values[$elname];
938             $fs = get_file_storage();
939             $context = context_user::instance($USER->id);
940             if (!$files = $fs->get_area_files($context->id, 'user', 'draft', $draftid, 'id DESC', false)) {
941                 return false;
942             }
943             $file = reset($files);
945             return $file->get_content();
947         } else if (isset($_FILES[$elname])) {
948             return file_get_contents($_FILES[$elname]['tmp_name']);
949         }
951         return false;
952     }
954     /**
955      * Print html form.
956      */
957     function display() {
958         //finalize the form definition if not yet done
959         if (!$this->_definition_finalized) {
960             $this->_definition_finalized = true;
961             $this->definition_after_data();
962         }
964         $this->_form->display();
965     }
967     /**
968      * Renders the html form (same as display, but returns the result).
969      *
970      * Note that you can only output this rendered result once per page, as
971      * it contains IDs which must be unique.
972      *
973      * @return string HTML code for the form
974      */
975     public function render() {
976         ob_start();
977         $this->display();
978         $out = ob_get_contents();
979         ob_end_clean();
980         return $out;
981     }
983     /**
984      * Form definition. Abstract method - always override!
985      */
986     protected abstract function definition();
988     /**
989      * After definition hook.
990      *
991      * This is useful for intermediate classes to inject logic after the definition was
992      * provided without requiring developers to call the parent {{@link self::definition()}}
993      * as it's not obvious by design. The 'intermediate' class is 'MyClass extends
994      * IntermediateClass extends moodleform'.
995      *
996      * Classes overriding this method should always call the parent. We may not add
997      * anything specifically in this instance of the method, but intermediate classes
998      * are likely to do so, and so it is a good practice to always call the parent.
999      *
1000      * @return void
1001      */
1002     protected function after_definition() {
1003     }
1005     /**
1006      * Dummy stub method - override if you need to setup the form depending on current
1007      * values. This method is called after definition(), data submission and set_data().
1008      * All form setup that is dependent on form values should go in here.
1009      */
1010     function definition_after_data(){
1011     }
1013     /**
1014      * Dummy stub method - override if you needed to perform some extra validation.
1015      * If there are errors return array of errors ("fieldname"=>"error message"),
1016      * otherwise true if ok.
1017      *
1018      * Server side rules do not work for uploaded files, implement serverside rules here if needed.
1019      *
1020      * @param array $data array of ("fieldname"=>value) of submitted data
1021      * @param array $files array of uploaded files "element_name"=>tmp_file_path
1022      * @return array of "element_name"=>"error_description" if there are errors,
1023      *         or an empty array if everything is OK (true allowed for backwards compatibility too).
1024      */
1025     function validation($data, $files) {
1026         return array();
1027     }
1029     /**
1030      * Helper used by {@link repeat_elements()}.
1031      *
1032      * @param int $i the index of this element.
1033      * @param HTML_QuickForm_element $elementclone
1034      * @param array $namecloned array of names
1035      */
1036     function repeat_elements_fix_clone($i, $elementclone, &$namecloned) {
1037         $name = $elementclone->getName();
1038         $namecloned[] = $name;
1040         if (!empty($name)) {
1041             $elementclone->setName($name."[$i]");
1042         }
1044         if (is_a($elementclone, 'HTML_QuickForm_header')) {
1045             $value = $elementclone->_text;
1046             $elementclone->setValue(str_replace('{no}', ($i+1), $value));
1048         } else if (is_a($elementclone, 'HTML_QuickForm_submit') || is_a($elementclone, 'HTML_QuickForm_button')) {
1049             $elementclone->setValue(str_replace('{no}', ($i+1), $elementclone->getValue()));
1051         } else {
1052             $value=$elementclone->getLabel();
1053             $elementclone->setLabel(str_replace('{no}', ($i+1), $value));
1054         }
1055     }
1057     /**
1058      * Method to add a repeating group of elements to a form.
1059      *
1060      * @param array $elementobjs Array of elements or groups of elements that are to be repeated
1061      * @param int $repeats no of times to repeat elements initially
1062      * @param array $options a nested array. The first array key is the element name.
1063      *    the second array key is the type of option to set, and depend on that option,
1064      *    the value takes different forms.
1065      *         'default'    - default value to set. Can include '{no}' which is replaced by the repeat number.
1066      *         'type'       - PARAM_* type.
1067      *         'helpbutton' - array containing the helpbutton params.
1068      *         'disabledif' - array containing the disabledIf() arguments after the element name.
1069      *         'rule'       - array containing the addRule arguments after the element name.
1070      *         'expanded'   - whether this section of the form should be expanded by default. (Name be a header element.)
1071      *         'advanced'   - whether this element is hidden by 'Show more ...'.
1072      * @param string $repeathiddenname name for hidden element storing no of repeats in this form
1073      * @param string $addfieldsname name for button to add more fields
1074      * @param int $addfieldsno how many fields to add at a time
1075      * @param string $addstring name of button, {no} is replaced by no of blanks that will be added.
1076      * @param bool $addbuttoninside if true, don't call closeHeaderBefore($addfieldsname). Default false.
1077      * @return int no of repeats of element in this page
1078      */
1079     function repeat_elements($elementobjs, $repeats, $options, $repeathiddenname,
1080             $addfieldsname, $addfieldsno=5, $addstring=null, $addbuttoninside=false){
1081         if ($addstring===null){
1082             $addstring = get_string('addfields', 'form', $addfieldsno);
1083         } else {
1084             $addstring = str_ireplace('{no}', $addfieldsno, $addstring);
1085         }
1086         $repeats = optional_param($repeathiddenname, $repeats, PARAM_INT);
1087         $addfields = optional_param($addfieldsname, '', PARAM_TEXT);
1088         if (!empty($addfields)){
1089             $repeats += $addfieldsno;
1090         }
1091         $mform =& $this->_form;
1092         $mform->registerNoSubmitButton($addfieldsname);
1093         $mform->addElement('hidden', $repeathiddenname, $repeats);
1094         $mform->setType($repeathiddenname, PARAM_INT);
1095         //value not to be overridden by submitted value
1096         $mform->setConstants(array($repeathiddenname=>$repeats));
1097         $namecloned = array();
1098         for ($i = 0; $i < $repeats; $i++) {
1099             foreach ($elementobjs as $elementobj){
1100                 $elementclone = fullclone($elementobj);
1101                 $this->repeat_elements_fix_clone($i, $elementclone, $namecloned);
1103                 if ($elementclone instanceof HTML_QuickForm_group && !$elementclone->_appendName) {
1104                     foreach ($elementclone->getElements() as $el) {
1105                         $this->repeat_elements_fix_clone($i, $el, $namecloned);
1106                     }
1107                     $elementclone->setLabel(str_replace('{no}', $i + 1, $elementclone->getLabel()));
1108                 }
1110                 $mform->addElement($elementclone);
1111             }
1112         }
1113         for ($i=0; $i<$repeats; $i++) {
1114             foreach ($options as $elementname => $elementoptions){
1115                 $pos=strpos($elementname, '[');
1116                 if ($pos!==FALSE){
1117                     $realelementname = substr($elementname, 0, $pos)."[$i]";
1118                     $realelementname .= substr($elementname, $pos);
1119                 }else {
1120                     $realelementname = $elementname."[$i]";
1121                 }
1122                 foreach ($elementoptions as  $option => $params){
1124                     switch ($option){
1125                         case 'default' :
1126                             $mform->setDefault($realelementname, str_replace('{no}', $i + 1, $params));
1127                             break;
1128                         case 'helpbutton' :
1129                             $params = array_merge(array($realelementname), $params);
1130                             call_user_func_array(array(&$mform, 'addHelpButton'), $params);
1131                             break;
1132                         case 'disabledif' :
1133                             foreach ($namecloned as $num => $name){
1134                                 if ($params[0] == $name){
1135                                     $params[0] = $params[0]."[$i]";
1136                                     break;
1137                                 }
1138                             }
1139                             $params = array_merge(array($realelementname), $params);
1140                             call_user_func_array(array(&$mform, 'disabledIf'), $params);
1141                             break;
1142                         case 'rule' :
1143                             if (is_string($params)){
1144                                 $params = array(null, $params, null, 'client');
1145                             }
1146                             $params = array_merge(array($realelementname), $params);
1147                             call_user_func_array(array(&$mform, 'addRule'), $params);
1148                             break;
1150                         case 'type':
1151                             $mform->setType($realelementname, $params);
1152                             break;
1154                         case 'expanded':
1155                             $mform->setExpanded($realelementname, $params);
1156                             break;
1158                         case 'advanced' :
1159                             $mform->setAdvanced($realelementname, $params);
1160                             break;
1161                     }
1162                 }
1163             }
1164         }
1165         $mform->addElement('submit', $addfieldsname, $addstring);
1167         if (!$addbuttoninside) {
1168             $mform->closeHeaderBefore($addfieldsname);
1169         }
1171         return $repeats;
1172     }
1174     /**
1175      * Adds a link/button that controls the checked state of a group of checkboxes.
1176      *
1177      * @param int $groupid The id of the group of advcheckboxes this element controls
1178      * @param string $text The text of the link. Defaults to selectallornone ("select all/none")
1179      * @param array $attributes associative array of HTML attributes
1180      * @param int $originalValue The original general state of the checkboxes before the user first clicks this element
1181      */
1182     function add_checkbox_controller($groupid, $text = null, $attributes = null, $originalValue = 0) {
1183         global $CFG, $PAGE;
1185         // Name of the controller button
1186         $checkboxcontrollername = 'nosubmit_checkbox_controller' . $groupid;
1187         $checkboxcontrollerparam = 'checkbox_controller'. $groupid;
1188         $checkboxgroupclass = 'checkboxgroup'.$groupid;
1190         // Set the default text if none was specified
1191         if (empty($text)) {
1192             $text = get_string('selectallornone', 'form');
1193         }
1195         $mform = $this->_form;
1196         $selectvalue = optional_param($checkboxcontrollerparam, null, PARAM_INT);
1197         $contollerbutton = optional_param($checkboxcontrollername, null, PARAM_ALPHAEXT);
1199         $newselectvalue = $selectvalue;
1200         if (is_null($selectvalue)) {
1201             $newselectvalue = $originalValue;
1202         } else if (!is_null($contollerbutton)) {
1203             $newselectvalue = (int) !$selectvalue;
1204         }
1205         // set checkbox state depending on orignal/submitted value by controoler button
1206         if (!is_null($contollerbutton) || is_null($selectvalue)) {
1207             foreach ($mform->_elements as $element) {
1208                 if (($element instanceof MoodleQuickForm_advcheckbox) &&
1209                         $element->getAttribute('class') == $checkboxgroupclass &&
1210                         !$element->isFrozen()) {
1211                     $mform->setConstants(array($element->getName() => $newselectvalue));
1212                 }
1213             }
1214         }
1216         $mform->addElement('hidden', $checkboxcontrollerparam, $newselectvalue, array('id' => "id_".$checkboxcontrollerparam));
1217         $mform->setType($checkboxcontrollerparam, PARAM_INT);
1218         $mform->setConstants(array($checkboxcontrollerparam => $newselectvalue));
1220         $PAGE->requires->yui_module('moodle-form-checkboxcontroller', 'M.form.checkboxcontroller',
1221                 array(
1222                     array('groupid' => $groupid,
1223                         'checkboxclass' => $checkboxgroupclass,
1224                         'checkboxcontroller' => $checkboxcontrollerparam,
1225                         'controllerbutton' => $checkboxcontrollername)
1226                     )
1227                 );
1229         require_once("$CFG->libdir/form/submit.php");
1230         $submitlink = new MoodleQuickForm_submit($checkboxcontrollername, $attributes);
1231         $mform->addElement($submitlink);
1232         $mform->registerNoSubmitButton($checkboxcontrollername);
1233         $mform->setDefault($checkboxcontrollername, $text);
1234     }
1236     /**
1237      * Use this method to a cancel and submit button to the end of your form. Pass a param of false
1238      * if you don't want a cancel button in your form. If you have a cancel button make sure you
1239      * check for it being pressed using is_cancelled() and redirecting if it is true before trying to
1240      * get data with get_data().
1241      *
1242      * @param bool $cancel whether to show cancel button, default true
1243      * @param string $submitlabel label for submit button, defaults to get_string('savechanges')
1244      */
1245     function add_action_buttons($cancel = true, $submitlabel=null){
1246         if (is_null($submitlabel)){
1247             $submitlabel = get_string('savechanges');
1248         }
1249         $mform =& $this->_form;
1250         if ($cancel){
1251             //when two elements we need a group
1252             $buttonarray=array();
1253             $buttonarray[] = &$mform->createElement('submit', 'submitbutton', $submitlabel);
1254             $buttonarray[] = &$mform->createElement('cancel');
1255             $mform->addGroup($buttonarray, 'buttonar', '', array(' '), false);
1256             $mform->closeHeaderBefore('buttonar');
1257         } else {
1258             //no group needed
1259             $mform->addElement('submit', 'submitbutton', $submitlabel);
1260             $mform->closeHeaderBefore('submitbutton');
1261         }
1262     }
1264     /**
1265      * Adds an initialisation call for a standard JavaScript enhancement.
1266      *
1267      * This function is designed to add an initialisation call for a JavaScript
1268      * enhancement that should exist within javascript-static M.form.init_{enhancementname}.
1269      *
1270      * Current options:
1271      *  - Selectboxes
1272      *      - smartselect:  Turns a nbsp indented select box into a custom drop down
1273      *                      control that supports multilevel and category selection.
1274      *                      $enhancement = 'smartselect';
1275      *                      $options = array('selectablecategories' => true|false)
1276      *
1277      * @param string|element $element form element for which Javascript needs to be initalized
1278      * @param string $enhancement which init function should be called
1279      * @param array $options options passed to javascript
1280      * @param array $strings strings for javascript
1281      * @deprecated since Moodle 3.3 MDL-57471
1282      */
1283     function init_javascript_enhancement($element, $enhancement, array $options=array(), array $strings=null) {
1284         debugging('$mform->init_javascript_enhancement() is deprecated and no longer does anything. '.
1285             'smartselect uses should be converted to the searchableselector form element.', DEBUG_DEVELOPER);
1286     }
1288     /**
1289      * Returns a JS module definition for the mforms JS
1290      *
1291      * @return array
1292      */
1293     public static function get_js_module() {
1294         global $CFG;
1295         return array(
1296             'name' => 'mform',
1297             'fullpath' => '/lib/form/form.js',
1298             'requires' => array('base', 'node')
1299         );
1300     }
1302     /**
1303      * Detects elements with missing setType() declerations.
1304      *
1305      * Finds elements in the form which should a PARAM_ type set and throws a
1306      * developer debug warning for any elements without it. This is to reduce the
1307      * risk of potential security issues by developers mistakenly forgetting to set
1308      * the type.
1309      *
1310      * @return void
1311      */
1312     private function detectMissingSetType() {
1313         global $CFG;
1315         if (!$CFG->debugdeveloper) {
1316             // Only for devs.
1317             return;
1318         }
1320         $mform = $this->_form;
1321         foreach ($mform->_elements as $element) {
1322             $group = false;
1323             $elements = array($element);
1325             if ($element->getType() == 'group') {
1326                 $group = $element;
1327                 $elements = $element->getElements();
1328             }
1330             foreach ($elements as $index => $element) {
1331                 switch ($element->getType()) {
1332                     case 'hidden':
1333                     case 'text':
1334                     case 'url':
1335                         if ($group) {
1336                             $name = $group->getElementName($index);
1337                         } else {
1338                             $name = $element->getName();
1339                         }
1340                         $key = $name;
1341                         $found = array_key_exists($key, $mform->_types);
1342                         // For repeated elements we need to look for
1343                         // the "main" type, not for the one present
1344                         // on each repetition. All the stuff in formslib
1345                         // (repeat_elements(), updateSubmission()... seems
1346                         // to work that way.
1347                         while (!$found && strrpos($key, '[') !== false) {
1348                             $pos = strrpos($key, '[');
1349                             $key = substr($key, 0, $pos);
1350                             $found = array_key_exists($key, $mform->_types);
1351                         }
1352                         if (!$found) {
1353                             debugging("Did you remember to call setType() for '$name'? ".
1354                                 'Defaulting to PARAM_RAW cleaning.', DEBUG_DEVELOPER);
1355                         }
1356                         break;
1357                 }
1358             }
1359         }
1360     }
1362     /**
1363      * Used by tests to simulate submitted form data submission from the user.
1364      *
1365      * For form fields where no data is submitted the default for that field as set by set_data or setDefault will be passed to
1366      * get_data.
1367      *
1368      * This method sets $_POST or $_GET and $_FILES with the data supplied. Our unit test code empties all these
1369      * global arrays after each test.
1370      *
1371      * @param array  $simulatedsubmitteddata       An associative array of form values (same format as $_POST).
1372      * @param array  $simulatedsubmittedfiles      An associative array of files uploaded (same format as $_FILES). Can be omitted.
1373      * @param string $method                       'post' or 'get', defaults to 'post'.
1374      * @param null   $formidentifier               the default is to use the class name for this class but you may need to provide
1375      *                                              a different value here for some forms that are used more than once on the
1376      *                                              same page.
1377      */
1378     public static function mock_submit($simulatedsubmitteddata, $simulatedsubmittedfiles = array(), $method = 'post',
1379                                        $formidentifier = null) {
1380         $_FILES = $simulatedsubmittedfiles;
1381         if ($formidentifier === null) {
1382             $formidentifier = get_called_class();
1383             $formidentifier = str_replace('\\', '_', $formidentifier); // See MDL-56233 for more information.
1384         }
1385         $simulatedsubmitteddata['_qf__'.$formidentifier] = 1;
1386         $simulatedsubmitteddata['sesskey'] = sesskey();
1387         if (strtolower($method) === 'get') {
1388             $_GET = $simulatedsubmitteddata;
1389         } else {
1390             $_POST = $simulatedsubmitteddata;
1391         }
1392     }
1395 /**
1396  * MoodleQuickForm implementation
1397  *
1398  * You never extend this class directly. The class methods of this class are available from
1399  * the private $this->_form property on moodleform and its children. You generally only
1400  * call methods on this class from within abstract methods that you override on moodleform such
1401  * as definition and definition_after_data
1402  *
1403  * @package   core_form
1404  * @category  form
1405  * @copyright 2006 Jamie Pratt <me@jamiep.org>
1406  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1407  */
1408 class MoodleQuickForm extends HTML_QuickForm_DHTMLRulesTableless {
1409     /** @var array type (PARAM_INT, PARAM_TEXT etc) of element value */
1410     var $_types = array();
1412     /** @var array dependent state for the element/'s */
1413     var $_dependencies = array();
1415     /**
1416      * @var array elements that will become hidden based on another element
1417      */
1418     protected $_hideifs = array();
1420     /** @var array Array of buttons that if pressed do not result in the processing of the form. */
1421     var $_noSubmitButtons=array();
1423     /** @var array Array of buttons that if pressed do not result in the processing of the form. */
1424     var $_cancelButtons=array();
1426     /** @var array Array whose keys are element names. If the key exists this is a advanced element */
1427     var $_advancedElements = array();
1429     /**
1430      * Array whose keys are element names and values are the desired collapsible state.
1431      * True for collapsed, False for expanded. If not present, set to default in
1432      * {@link self::accept()}.
1433      *
1434      * @var array
1435      */
1436     var $_collapsibleElements = array();
1438     /**
1439      * Whether to enable shortforms for this form
1440      *
1441      * @var boolean
1442      */
1443     var $_disableShortforms = false;
1445     /** @var bool whether to automatically initialise M.formchangechecker for this form. */
1446     protected $_use_form_change_checker = true;
1448     /**
1449      * The form name is derived from the class name of the wrapper minus the trailing form
1450      * It is a name with words joined by underscores whereas the id attribute is words joined by underscores.
1451      * @var string
1452      */
1453     var $_formName = '';
1455     /**
1456      * String with the html for hidden params passed in as part of a moodle_url
1457      * object for the action. Output in the form.
1458      * @var string
1459      */
1460     var $_pageparams = '';
1462     /**
1463      * Whether the form contains any client-side validation or not.
1464      * @var bool
1465      */
1466     protected $clientvalidation = false;
1468     /**
1469      * Is this a 'disableIf' dependency ?
1470      */
1471     const DEP_DISABLE = 0;
1473     /**
1474      * Is this a 'hideIf' dependency?
1475      */
1476     const DEP_HIDE = 1;
1478     /**
1479      * Class constructor - same parameters as HTML_QuickForm_DHTMLRulesTableless
1480      *
1481      * @staticvar int $formcounter counts number of forms
1482      * @param string $formName Form's name.
1483      * @param string $method Form's method defaults to 'POST'
1484      * @param string|moodle_url $action Form's action
1485      * @param string $target (optional)Form's target defaults to none
1486      * @param mixed $attributes (optional)Extra attributes for <form> tag
1487      */
1488     public function __construct($formName, $method, $action, $target='', $attributes=null) {
1489         global $CFG, $OUTPUT;
1491         static $formcounter = 1;
1493         // TODO MDL-52313 Replace with the call to parent::__construct().
1494         HTML_Common::__construct($attributes);
1495         $target = empty($target) ? array() : array('target' => $target);
1496         $this->_formName = $formName;
1497         if (is_a($action, 'moodle_url')){
1498             $this->_pageparams = html_writer::input_hidden_params($action);
1499             $action = $action->out_omit_querystring();
1500         } else {
1501             $this->_pageparams = '';
1502         }
1503         // No 'name' atttribute for form in xhtml strict :
1504         $attributes = array('action' => $action, 'method' => $method, 'accept-charset' => 'utf-8') + $target;
1505         if (is_null($this->getAttribute('id'))) {
1506             $attributes['id'] = 'mform' . $formcounter;
1507         }
1508         $formcounter++;
1509         $this->updateAttributes($attributes);
1511         // This is custom stuff for Moodle :
1512         $oldclass=   $this->getAttribute('class');
1513         if (!empty($oldclass)){
1514             $this->updateAttributes(array('class'=>$oldclass.' mform'));
1515         }else {
1516             $this->updateAttributes(array('class'=>'mform'));
1517         }
1518         $this->_reqHTML = '<span class="req">' . $OUTPUT->pix_icon('req', get_string('requiredelement', 'form')) . '</span>';
1519         $this->_advancedHTML = '<span class="adv">' . $OUTPUT->pix_icon('adv', get_string('advancedelement', 'form')) . '</span>';
1520         $this->setRequiredNote(get_string('somefieldsrequired', 'form', $OUTPUT->pix_icon('req', get_string('requiredelement', 'form'))));
1521     }
1523     /**
1524      * Old syntax of class constructor. Deprecated in PHP7.
1525      *
1526      * @deprecated since Moodle 3.1
1527      */
1528     public function MoodleQuickForm($formName, $method, $action, $target='', $attributes=null) {
1529         debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);
1530         self::__construct($formName, $method, $action, $target, $attributes);
1531     }
1533     /**
1534      * Use this method to indicate an element in a form is an advanced field. If items in a form
1535      * are marked as advanced then 'Hide/Show Advanced' buttons will automatically be displayed in the
1536      * form so the user can decide whether to display advanced form controls.
1537      *
1538      * If you set a header element to advanced then all elements it contains will also be set as advanced.
1539      *
1540      * @param string $elementName group or element name (not the element name of something inside a group).
1541      * @param bool $advanced default true sets the element to advanced. False removes advanced mark.
1542      */
1543     function setAdvanced($elementName, $advanced = true) {
1544         if ($advanced){
1545             $this->_advancedElements[$elementName]='';
1546         } elseif (isset($this->_advancedElements[$elementName])) {
1547             unset($this->_advancedElements[$elementName]);
1548         }
1549     }
1551     /**
1552      * Use this method to indicate that the fieldset should be shown as expanded.
1553      * The method is applicable to header elements only.
1554      *
1555      * @param string $headername header element name
1556      * @param boolean $expanded default true sets the element to expanded. False makes the element collapsed.
1557      * @param boolean $ignoreuserstate override the state regardless of the state it was on when
1558      *                                 the form was submitted.
1559      * @return void
1560      */
1561     function setExpanded($headername, $expanded = true, $ignoreuserstate = false) {
1562         if (empty($headername)) {
1563             return;
1564         }
1565         $element = $this->getElement($headername);
1566         if ($element->getType() != 'header') {
1567             debugging('Cannot use setExpanded on non-header elements', DEBUG_DEVELOPER);
1568             return;
1569         }
1570         if (!$headerid = $element->getAttribute('id')) {
1571             $element->_generateId();
1572             $headerid = $element->getAttribute('id');
1573         }
1574         if ($this->getElementType('mform_isexpanded_' . $headerid) === false) {
1575             // See if the form has been submitted already.
1576             $formexpanded = optional_param('mform_isexpanded_' . $headerid, -1, PARAM_INT);
1577             if (!$ignoreuserstate && $formexpanded != -1) {
1578                 // Override expanded state with the form variable.
1579                 $expanded = $formexpanded;
1580             }
1581             // Create the form element for storing expanded state.
1582             $this->addElement('hidden', 'mform_isexpanded_' . $headerid);
1583             $this->setType('mform_isexpanded_' . $headerid, PARAM_INT);
1584             $this->setConstant('mform_isexpanded_' . $headerid, (int) $expanded);
1585         }
1586         $this->_collapsibleElements[$headername] = !$expanded;
1587     }
1589     /**
1590      * Use this method to add show more/less status element required for passing
1591      * over the advanced elements visibility status on the form submission.
1592      *
1593      * @param string $headerName header element name.
1594      * @param boolean $showmore default false sets the advanced elements to be hidden.
1595      */
1596     function addAdvancedStatusElement($headerid, $showmore=false){
1597         // Add extra hidden element to store advanced items state for each section.
1598         if ($this->getElementType('mform_showmore_' . $headerid) === false) {
1599             // See if we the form has been submitted already.
1600             $formshowmore = optional_param('mform_showmore_' . $headerid, -1, PARAM_INT);
1601             if (!$showmore && $formshowmore != -1) {
1602                 // Override showmore state with the form variable.
1603                 $showmore = $formshowmore;
1604             }
1605             // Create the form element for storing advanced items state.
1606             $this->addElement('hidden', 'mform_showmore_' . $headerid);
1607             $this->setType('mform_showmore_' . $headerid, PARAM_INT);
1608             $this->setConstant('mform_showmore_' . $headerid, (int)$showmore);
1609         }
1610     }
1612     /**
1613      * This function has been deprecated. Show advanced has been replaced by
1614      * "Show more.../Show less..." in the shortforms javascript module.
1615      *
1616      * @deprecated since Moodle 2.5
1617      * @param bool $showadvancedNow if true will show advanced elements.
1618       */
1619     function setShowAdvanced($showadvancedNow = null){
1620         debugging('Call to deprecated function setShowAdvanced. See "Show more.../Show less..." in shortforms yui module.');
1621     }
1623     /**
1624      * This function has been deprecated. Show advanced has been replaced by
1625      * "Show more.../Show less..." in the shortforms javascript module.
1626      *
1627      * @deprecated since Moodle 2.5
1628      * @return bool (Always false)
1629       */
1630     function getShowAdvanced(){
1631         debugging('Call to deprecated function setShowAdvanced. See "Show more.../Show less..." in shortforms yui module.');
1632         return false;
1633     }
1635     /**
1636      * Use this method to indicate that the form will not be using shortforms.
1637      *
1638      * @param boolean $disable default true, controls if the shortforms are disabled.
1639      */
1640     function setDisableShortforms ($disable = true) {
1641         $this->_disableShortforms = $disable;
1642     }
1644     /**
1645      * Call this method if you don't want the formchangechecker JavaScript to be
1646      * automatically initialised for this form.
1647      */
1648     public function disable_form_change_checker() {
1649         $this->_use_form_change_checker = false;
1650     }
1652     /**
1653      * If you have called {@link disable_form_change_checker()} then you can use
1654      * this method to re-enable it. It is enabled by default, so normally you don't
1655      * need to call this.
1656      */
1657     public function enable_form_change_checker() {
1658         $this->_use_form_change_checker = true;
1659     }
1661     /**
1662      * @return bool whether this form should automatically initialise
1663      *      formchangechecker for itself.
1664      */
1665     public function is_form_change_checker_enabled() {
1666         return $this->_use_form_change_checker;
1667     }
1669     /**
1670     * Accepts a renderer
1671     *
1672     * @param HTML_QuickForm_Renderer $renderer An HTML_QuickForm_Renderer object
1673     */
1674     function accept(&$renderer) {
1675         if (method_exists($renderer, 'setAdvancedElements')){
1676             //Check for visible fieldsets where all elements are advanced
1677             //and mark these headers as advanced as well.
1678             //Also mark all elements in a advanced header as advanced.
1679             $stopFields = $renderer->getStopFieldSetElements();
1680             $lastHeader = null;
1681             $lastHeaderAdvanced = false;
1682             $anyAdvanced = false;
1683             $anyError = false;
1684             foreach (array_keys($this->_elements) as $elementIndex){
1685                 $element =& $this->_elements[$elementIndex];
1687                 // if closing header and any contained element was advanced then mark it as advanced
1688                 if ($element->getType()=='header' || in_array($element->getName(), $stopFields)){
1689                     if ($anyAdvanced && !is_null($lastHeader)) {
1690                         $lastHeader->_generateId();
1691                         $this->setAdvanced($lastHeader->getName());
1692                         $this->addAdvancedStatusElement($lastHeader->getAttribute('id'), $anyError);
1693                     }
1694                     $lastHeaderAdvanced = false;
1695                     unset($lastHeader);
1696                     $lastHeader = null;
1697                 } elseif ($lastHeaderAdvanced) {
1698                     $this->setAdvanced($element->getName());
1699                 }
1701                 if ($element->getType()=='header'){
1702                     $lastHeader =& $element;
1703                     $anyAdvanced = false;
1704                     $anyError = false;
1705                     $lastHeaderAdvanced = isset($this->_advancedElements[$element->getName()]);
1706                 } elseif (isset($this->_advancedElements[$element->getName()])){
1707                     $anyAdvanced = true;
1708                     if (isset($this->_errors[$element->getName()])) {
1709                         $anyError = true;
1710                     }
1711                 }
1712             }
1713             // the last header may not be closed yet...
1714             if ($anyAdvanced && !is_null($lastHeader)){
1715                 $this->setAdvanced($lastHeader->getName());
1716                 $lastHeader->_generateId();
1717                 $this->addAdvancedStatusElement($lastHeader->getAttribute('id'), $anyError);
1718             }
1719             $renderer->setAdvancedElements($this->_advancedElements);
1720         }
1721         if (method_exists($renderer, 'setCollapsibleElements') && !$this->_disableShortforms) {
1723             // Count the number of sections.
1724             $headerscount = 0;
1725             foreach (array_keys($this->_elements) as $elementIndex){
1726                 $element =& $this->_elements[$elementIndex];
1727                 if ($element->getType() == 'header') {
1728                     $headerscount++;
1729                 }
1730             }
1732             $anyrequiredorerror = false;
1733             $headercounter = 0;
1734             $headername = null;
1735             foreach (array_keys($this->_elements) as $elementIndex){
1736                 $element =& $this->_elements[$elementIndex];
1738                 if ($element->getType() == 'header') {
1739                     $headercounter++;
1740                     $element->_generateId();
1741                     $headername = $element->getName();
1742                     $anyrequiredorerror = false;
1743                 } else if (in_array($element->getName(), $this->_required) || isset($this->_errors[$element->getName()])) {
1744                     $anyrequiredorerror = true;
1745                 } else {
1746                     // Do not reset $anyrequiredorerror to false because we do not want any other element
1747                     // in this header (fieldset) to possibly revert the state given.
1748                 }
1750                 if ($element->getType() == 'header') {
1751                     if ($headercounter === 1 && !isset($this->_collapsibleElements[$headername])) {
1752                         // By default the first section is always expanded, except if a state has already been set.
1753                         $this->setExpanded($headername, true);
1754                     } else if (($headercounter === 2 && $headerscount === 2) && !isset($this->_collapsibleElements[$headername])) {
1755                         // The second section is always expanded if the form only contains 2 sections),
1756                         // except if a state has already been set.
1757                         $this->setExpanded($headername, true);
1758                     }
1759                 } else if ($anyrequiredorerror) {
1760                     // If any error or required field are present within the header, we need to expand it.
1761                     $this->setExpanded($headername, true, true);
1762                 } else if (!isset($this->_collapsibleElements[$headername])) {
1763                     // Define element as collapsed by default.
1764                     $this->setExpanded($headername, false);
1765                 }
1766             }
1768             // Pass the array to renderer object.
1769             $renderer->setCollapsibleElements($this->_collapsibleElements);
1770         }
1771         parent::accept($renderer);
1772     }
1774     /**
1775      * Adds one or more element names that indicate the end of a fieldset
1776      *
1777      * @param string $elementName name of the element
1778      */
1779     function closeHeaderBefore($elementName){
1780         $renderer =& $this->defaultRenderer();
1781         $renderer->addStopFieldsetElements($elementName);
1782     }
1784     /**
1785      * Set an element to be forced to flow LTR.
1786      *
1787      * The element must exist and support this functionality. Also note that
1788      * when setting the type of a field (@link self::setType} we try to guess the
1789      * whether the field should be force to LTR or not. Make sure you're always
1790      * calling this method last.
1791      *
1792      * @param string $elementname The element name.
1793      * @param bool $value When false, disables force LTR, else enables it.
1794      */
1795     public function setForceLtr($elementname, $value = true) {
1796         $this->getElement($elementname)->set_force_ltr($value);
1797     }
1799     /**
1800      * Should be used for all elements of a form except for select, radio and checkboxes which
1801      * clean their own data.
1802      *
1803      * @param string $elementname
1804      * @param int $paramtype defines type of data contained in element. Use the constants PARAM_*.
1805      *        {@link lib/moodlelib.php} for defined parameter types
1806      */
1807     function setType($elementname, $paramtype) {
1808         $this->_types[$elementname] = $paramtype;
1810         // This will not always get it right, but it should be accurate in most cases.
1811         // When inaccurate use setForceLtr().
1812         if (!is_rtl_compatible($paramtype)
1813                 && $this->elementExists($elementname)
1814                 && ($element =& $this->getElement($elementname))
1815                 && method_exists($element, 'set_force_ltr')) {
1817             $element->set_force_ltr(true);
1818         }
1819     }
1821     /**
1822      * This can be used to set several types at once.
1823      *
1824      * @param array $paramtypes types of parameters.
1825      * @see MoodleQuickForm::setType
1826      */
1827     function setTypes($paramtypes) {
1828         foreach ($paramtypes as $elementname => $paramtype) {
1829             $this->setType($elementname, $paramtype);
1830         }
1831     }
1833     /**
1834      * Return the type(s) to use to clean an element.
1835      *
1836      * In the case where the element has an array as a value, we will try to obtain a
1837      * type defined for that specific key, and recursively until done.
1838      *
1839      * This method does not work reverse, you cannot pass a nested element and hoping to
1840      * fallback on the clean type of a parent. This method intends to be used with the
1841      * main element, which will generate child types if needed, not the other way around.
1842      *
1843      * Example scenario:
1844      *
1845      * You have defined a new repeated element containing a text field called 'foo'.
1846      * By default there will always be 2 occurence of 'foo' in the form. Even though
1847      * you've set the type on 'foo' to be PARAM_INT, for some obscure reason, you want
1848      * the first value of 'foo', to be PARAM_FLOAT, which you set using setType:
1849      * $mform->setType('foo[0]', PARAM_FLOAT).
1850      *
1851      * Now if you call this method passing 'foo', along with the submitted values of 'foo':
1852      * array(0 => '1.23', 1 => '10'), you will get an array telling you that the key 0 is a
1853      * FLOAT and 1 is an INT. If you had passed 'foo[1]', along with its value '10', you would
1854      * get the default clean type returned (param $default).
1855      *
1856      * @param string $elementname name of the element.
1857      * @param mixed $value value that should be cleaned.
1858      * @param int $default default constant value to be returned (PARAM_...)
1859      * @return string|array constant value or array of constant values (PARAM_...)
1860      */
1861     public function getCleanType($elementname, $value, $default = PARAM_RAW) {
1862         $type = $default;
1863         if (array_key_exists($elementname, $this->_types)) {
1864             $type = $this->_types[$elementname];
1865         }
1866         if (is_array($value)) {
1867             $default = $type;
1868             $type = array();
1869             foreach ($value as $subkey => $subvalue) {
1870                 $typekey = "$elementname" . "[$subkey]";
1871                 if (array_key_exists($typekey, $this->_types)) {
1872                     $subtype = $this->_types[$typekey];
1873                 } else {
1874                     $subtype = $default;
1875                 }
1876                 if (is_array($subvalue)) {
1877                     $type[$subkey] = $this->getCleanType($typekey, $subvalue, $subtype);
1878                 } else {
1879                     $type[$subkey] = $subtype;
1880                 }
1881             }
1882         }
1883         return $type;
1884     }
1886     /**
1887      * Return the cleaned value using the passed type(s).
1888      *
1889      * @param mixed $value value that has to be cleaned.
1890      * @param int|array $type constant value to use to clean (PARAM_...), typically returned by {@link self::getCleanType()}.
1891      * @return mixed cleaned up value.
1892      */
1893     public function getCleanedValue($value, $type) {
1894         if (is_array($type) && is_array($value)) {
1895             foreach ($type as $key => $param) {
1896                 $value[$key] = $this->getCleanedValue($value[$key], $param);
1897             }
1898         } else if (!is_array($type) && !is_array($value)) {
1899             $value = clean_param($value, $type);
1900         } else if (!is_array($type) && is_array($value)) {
1901             $value = clean_param_array($value, $type, true);
1902         } else {
1903             throw new coding_exception('Unexpected type or value received in MoodleQuickForm::getCleanedValue()');
1904         }
1905         return $value;
1906     }
1908     /**
1909      * Updates submitted values
1910      *
1911      * @param array $submission submitted values
1912      * @param array $files list of files
1913      */
1914     function updateSubmission($submission, $files) {
1915         $this->_flagSubmitted = false;
1917         if (empty($submission)) {
1918             $this->_submitValues = array();
1919         } else {
1920             foreach ($submission as $key => $s) {
1921                 $type = $this->getCleanType($key, $s);
1922                 $submission[$key] = $this->getCleanedValue($s, $type);
1923             }
1924             $this->_submitValues = $submission;
1925             $this->_flagSubmitted = true;
1926         }
1928         if (empty($files)) {
1929             $this->_submitFiles = array();
1930         } else {
1931             $this->_submitFiles = $files;
1932             $this->_flagSubmitted = true;
1933         }
1935         // need to tell all elements that they need to update their value attribute.
1936          foreach (array_keys($this->_elements) as $key) {
1937              $this->_elements[$key]->onQuickFormEvent('updateValue', null, $this);
1938          }
1939     }
1941     /**
1942      * Returns HTML for required elements
1943      *
1944      * @return string
1945      */
1946     function getReqHTML(){
1947         return $this->_reqHTML;
1948     }
1950     /**
1951      * Returns HTML for advanced elements
1952      *
1953      * @return string
1954      */
1955     function getAdvancedHTML(){
1956         return $this->_advancedHTML;
1957     }
1959     /**
1960      * Initializes a default form value. Used to specify the default for a new entry where
1961      * no data is loaded in using moodleform::set_data()
1962      *
1963      * note: $slashed param removed
1964      *
1965      * @param string $elementName element name
1966      * @param mixed $defaultValue values for that element name
1967      */
1968     function setDefault($elementName, $defaultValue){
1969         $this->setDefaults(array($elementName=>$defaultValue));
1970     }
1972     /**
1973      * Add a help button to element, only one button per element is allowed.
1974      *
1975      * This is new, simplified and preferable method of setting a help icon on form elements.
1976      * It uses the new $OUTPUT->help_icon().
1977      *
1978      * Typically, you will provide the same identifier and the component as you have used for the
1979      * label of the element. The string identifier with the _help suffix added is then used
1980      * as the help string.
1981      *
1982      * There has to be two strings defined:
1983      *   1/ get_string($identifier, $component) - the title of the help page
1984      *   2/ get_string($identifier.'_help', $component) - the actual help page text
1985      *
1986      * @since Moodle 2.0
1987      * @param string $elementname name of the element to add the item to
1988      * @param string $identifier help string identifier without _help suffix
1989      * @param string $component component name to look the help string in
1990      * @param string $linktext optional text to display next to the icon
1991      * @param bool $suppresscheck set to true if the element may not exist
1992      */
1993     function addHelpButton($elementname, $identifier, $component = 'moodle', $linktext = '', $suppresscheck = false) {
1994         global $OUTPUT;
1995         if (array_key_exists($elementname, $this->_elementIndex)) {
1996             $element = $this->_elements[$this->_elementIndex[$elementname]];
1997             $element->_helpbutton = $OUTPUT->help_icon($identifier, $component, $linktext);
1998         } else if (!$suppresscheck) {
1999             debugging(get_string('nonexistentformelements', 'form', $elementname));
2000         }
2001     }
2003     /**
2004      * Set constant value not overridden by _POST or _GET
2005      * note: this does not work for complex names with [] :-(
2006      *
2007      * @param string $elname name of element
2008      * @param mixed $value
2009      */
2010     function setConstant($elname, $value) {
2011         $this->_constantValues = HTML_QuickForm::arrayMerge($this->_constantValues, array($elname=>$value));
2012         $element =& $this->getElement($elname);
2013         $element->onQuickFormEvent('updateValue', null, $this);
2014     }
2016     /**
2017      * export submitted values
2018      *
2019      * @param string $elementList list of elements in form
2020      * @return array
2021      */
2022     function exportValues($elementList = null){
2023         $unfiltered = array();
2024         if (null === $elementList) {
2025             // iterate over all elements, calling their exportValue() methods
2026             foreach (array_keys($this->_elements) as $key) {
2027                 if ($this->_elements[$key]->isFrozen() && !$this->_elements[$key]->_persistantFreeze) {
2028                     $varname = $this->_elements[$key]->_attributes['name'];
2029                     $value = '';
2030                     // If we have a default value then export it.
2031                     if (isset($this->_defaultValues[$varname])) {
2032                         $value = $this->prepare_fixed_value($varname, $this->_defaultValues[$varname]);
2033                     }
2034                 } else {
2035                     $value = $this->_elements[$key]->exportValue($this->_submitValues, true);
2036                 }
2038                 if (is_array($value)) {
2039                     // This shit throws a bogus warning in PHP 4.3.x
2040                     $unfiltered = HTML_QuickForm::arrayMerge($unfiltered, $value);
2041                 }
2042             }
2043         } else {
2044             if (!is_array($elementList)) {
2045                 $elementList = array_map('trim', explode(',', $elementList));
2046             }
2047             foreach ($elementList as $elementName) {
2048                 $value = $this->exportValue($elementName);
2049                 if (@PEAR::isError($value)) {
2050                     return $value;
2051                 }
2052                 //oh, stock QuickFOrm was returning array of arrays!
2053                 $unfiltered = HTML_QuickForm::arrayMerge($unfiltered, $value);
2054             }
2055         }
2057         if (is_array($this->_constantValues)) {
2058             $unfiltered = HTML_QuickForm::arrayMerge($unfiltered, $this->_constantValues);
2059         }
2060         return $unfiltered;
2061     }
2063     /**
2064      * This is a bit of a hack, and it duplicates the code in
2065      * HTML_QuickForm_element::_prepareValue, but I could not think of a way or
2066      * reliably calling that code. (Think about date selectors, for example.)
2067      * @param string $name the element name.
2068      * @param mixed $value the fixed value to set.
2069      * @return mixed the appropriate array to add to the $unfiltered array.
2070      */
2071     protected function prepare_fixed_value($name, $value) {
2072         if (null === $value) {
2073             return null;
2074         } else {
2075             if (!strpos($name, '[')) {
2076                 return array($name => $value);
2077             } else {
2078                 $valueAry = array();
2079                 $myIndex  = "['" . str_replace(array(']', '['), array('', "']['"), $name) . "']";
2080                 eval("\$valueAry$myIndex = \$value;");
2081                 return $valueAry;
2082             }
2083         }
2084     }
2086     /**
2087      * Adds a validation rule for the given field
2088      *
2089      * If the element is in fact a group, it will be considered as a whole.
2090      * To validate grouped elements as separated entities,
2091      * use addGroupRule instead of addRule.
2092      *
2093      * @param string $element Form element name
2094      * @param string $message Message to display for invalid data
2095      * @param string $type Rule type, use getRegisteredRules() to get types
2096      * @param string $format (optional)Required for extra rule data
2097      * @param string $validation (optional)Where to perform validation: "server", "client"
2098      * @param bool $reset Client-side validation: reset the form element to its original value if there is an error?
2099      * @param bool $force Force the rule to be applied, even if the target form element does not exist
2100      */
2101     function addRule($element, $message, $type, $format=null, $validation='server', $reset = false, $force = false)
2102     {
2103         parent::addRule($element, $message, $type, $format, $validation, $reset, $force);
2104         if ($validation == 'client') {
2105             $this->clientvalidation = true;
2106         }
2108     }
2110     /**
2111      * Adds a validation rule for the given group of elements
2112      *
2113      * Only groups with a name can be assigned a validation rule
2114      * Use addGroupRule when you need to validate elements inside the group.
2115      * Use addRule if you need to validate the group as a whole. In this case,
2116      * the same rule will be applied to all elements in the group.
2117      * Use addRule if you need to validate the group against a function.
2118      *
2119      * @param string $group Form group name
2120      * @param array|string $arg1 Array for multiple elements or error message string for one element
2121      * @param string $type (optional)Rule type use getRegisteredRules() to get types
2122      * @param string $format (optional)Required for extra rule data
2123      * @param int $howmany (optional)How many valid elements should be in the group
2124      * @param string $validation (optional)Where to perform validation: "server", "client"
2125      * @param bool $reset Client-side: whether to reset the element's value to its original state if validation failed.
2126      */
2127     function addGroupRule($group, $arg1, $type='', $format=null, $howmany=0, $validation = 'server', $reset = false)
2128     {
2129         parent::addGroupRule($group, $arg1, $type, $format, $howmany, $validation, $reset);
2130         if (is_array($arg1)) {
2131              foreach ($arg1 as $rules) {
2132                 foreach ($rules as $rule) {
2133                     $validation = (isset($rule[3]) && 'client' == $rule[3])? 'client': 'server';
2134                     if ($validation == 'client') {
2135                         $this->clientvalidation = true;
2136                     }
2137                 }
2138             }
2139         } elseif (is_string($arg1)) {
2140             if ($validation == 'client') {
2141                 $this->clientvalidation = true;
2142             }
2143         }
2144     }
2146     /**
2147      * Returns the client side validation script
2148      *
2149      * The code here was copied from HTML_QuickForm_DHTMLRulesTableless who copied it from  HTML_QuickForm
2150      * and slightly modified to run rules per-element
2151      * Needed to override this because of an error with client side validation of grouped elements.
2152      *
2153      * @return string Javascript to perform validation, empty string if no 'client' rules were added
2154      */
2155     function getValidationScript()
2156     {
2157         global $PAGE;
2159         if (empty($this->_rules) || $this->clientvalidation === false) {
2160             return '';
2161         }
2163         include_once('HTML/QuickForm/RuleRegistry.php');
2164         $registry =& HTML_QuickForm_RuleRegistry::singleton();
2165         $test = array();
2166         $js_escape = array(
2167             "\r"    => '\r',
2168             "\n"    => '\n',
2169             "\t"    => '\t',
2170             "'"     => "\\'",
2171             '"'     => '\"',
2172             '\\'    => '\\\\'
2173         );
2175         foreach ($this->_rules as $elementName => $rules) {
2176             foreach ($rules as $rule) {
2177                 if ('client' == $rule['validation']) {
2178                     unset($element); //TODO: find out how to properly initialize it
2180                     $dependent  = isset($rule['dependent']) && is_array($rule['dependent']);
2181                     $rule['message'] = strtr($rule['message'], $js_escape);
2183                     if (isset($rule['group'])) {
2184                         $group    =& $this->getElement($rule['group']);
2185                         // No JavaScript validation for frozen elements
2186                         if ($group->isFrozen()) {
2187                             continue 2;
2188                         }
2189                         $elements =& $group->getElements();
2190                         foreach (array_keys($elements) as $key) {
2191                             if ($elementName == $group->getElementName($key)) {
2192                                 $element =& $elements[$key];
2193                                 break;
2194                             }
2195                         }
2196                     } elseif ($dependent) {
2197                         $element   =  array();
2198                         $element[] =& $this->getElement($elementName);
2199                         foreach ($rule['dependent'] as $elName) {
2200                             $element[] =& $this->getElement($elName);
2201                         }
2202                     } else {
2203                         $element =& $this->getElement($elementName);
2204                     }
2205                     // No JavaScript validation for frozen elements
2206                     if (is_object($element) && $element->isFrozen()) {
2207                         continue 2;
2208                     } elseif (is_array($element)) {
2209                         foreach (array_keys($element) as $key) {
2210                             if ($element[$key]->isFrozen()) {
2211                                 continue 3;
2212                             }
2213                         }
2214                     }
2215                     //for editor element, [text] is appended to the name.
2216                     $fullelementname = $elementName;
2217                     if (is_object($element) && $element->getType() == 'editor') {
2218                         if ($element->getType() == 'editor') {
2219                             $fullelementname .= '[text]';
2220                             // Add format to rule as moodleform check which format is supported by browser
2221                             // it is not set anywhere... So small hack to make sure we pass it down to quickform.
2222                             if (is_null($rule['format'])) {
2223                                 $rule['format'] = $element->getFormat();
2224                             }
2225                         }
2226                     }
2227                     // Fix for bug displaying errors for elements in a group
2228                     $test[$fullelementname][0][] = $registry->getValidationScript($element, $fullelementname, $rule);
2229                     $test[$fullelementname][1]=$element;
2230                     //end of fix
2231                 }
2232             }
2233         }
2235         // Fix for MDL-9524. If you don't do this, then $element may be left as a reference to one of the fields in
2236         // the form, and then that form field gets corrupted by the code that follows.
2237         unset($element);
2239         $js = '
2241 require(["core/event", "jquery"], function(Event, $) {
2243     function qf_errorHandler(element, _qfMsg, escapedName) {
2244         var event = $.Event(Event.Events.FORM_FIELD_VALIDATION);
2245         $(element).trigger(event, _qfMsg);
2246         if (event.isDefaultPrevented()) {
2247             return _qfMsg == \'\';
2248         } else {
2249             // Legacy mforms.
2250             var div = element.parentNode;
2252             if ((div == undefined) || (element.name == undefined)) {
2253                 // No checking can be done for undefined elements so let server handle it.
2254                 return true;
2255             }
2257             if (_qfMsg != \'\') {
2258                 var errorSpan = document.getElementById(\'id_error_\' + escapedName);
2259                 if (!errorSpan) {
2260                     errorSpan = document.createElement("span");
2261                     errorSpan.id = \'id_error_\' + escapedName;
2262                     errorSpan.className = "error";
2263                     element.parentNode.insertBefore(errorSpan, element.parentNode.firstChild);
2264                     document.getElementById(errorSpan.id).setAttribute(\'TabIndex\', \'0\');
2265                     document.getElementById(errorSpan.id).focus();
2266                 }
2268                 while (errorSpan.firstChild) {
2269                     errorSpan.removeChild(errorSpan.firstChild);
2270                 }
2272                 errorSpan.appendChild(document.createTextNode(_qfMsg.substring(3)));
2274                 if (div.className.substr(div.className.length - 6, 6) != " error"
2275                         && div.className != "error") {
2276                     div.className += " error";
2277                     linebreak = document.createElement("br");
2278                     linebreak.className = "error";
2279                     linebreak.id = \'id_error_break_\' + escapedName;
2280                     errorSpan.parentNode.insertBefore(linebreak, errorSpan.nextSibling);
2281                 }
2283                 return false;
2284             } else {
2285                 var errorSpan = document.getElementById(\'id_error_\' + escapedName);
2286                 if (errorSpan) {
2287                     errorSpan.parentNode.removeChild(errorSpan);
2288                 }
2289                 var linebreak = document.getElementById(\'id_error_break_\' + escapedName);
2290                 if (linebreak) {
2291                     linebreak.parentNode.removeChild(linebreak);
2292                 }
2294                 if (div.className.substr(div.className.length - 6, 6) == " error") {
2295                     div.className = div.className.substr(0, div.className.length - 6);
2296                 } else if (div.className == "error") {
2297                     div.className = "";
2298                 }
2300                 return true;
2301             } // End if.
2302         } // End if.
2303     } // End function.
2304     ';
2305         $validateJS = '';
2306         foreach ($test as $elementName => $jsandelement) {
2307             // Fix for bug displaying errors for elements in a group
2308             //unset($element);
2309             list($jsArr,$element)=$jsandelement;
2310             //end of fix
2311             $escapedElementName = preg_replace_callback(
2312                 '/[_\[\]-]/',
2313                 create_function('$matches', 'return sprintf("_%2x",ord($matches[0]));'),
2314                 $elementName);
2315             $valFunc = 'validate_' . $this->_formName . '_' . $escapedElementName . '(ev.target, \''.$escapedElementName.'\')';
2317             if (!is_array($element)) {
2318                 $element = [$element];
2319             }
2320             foreach ($element as $elem) {
2321                 if (key_exists('id', $elem->_attributes)) {
2322                     $js .= '
2323     function validate_' . $this->_formName . '_' . $escapedElementName . '(element, escapedName) {
2324       if (undefined == element) {
2325          //required element was not found, then let form be submitted without client side validation
2326          return true;
2327       }
2328       var value = \'\';
2329       var errFlag = new Array();
2330       var _qfGroups = {};
2331       var _qfMsg = \'\';
2332       var frm = element.parentNode;
2333       if ((undefined != element.name) && (frm != undefined)) {
2334           while (frm && frm.nodeName.toUpperCase() != "FORM") {
2335             frm = frm.parentNode;
2336           }
2337         ' . join("\n", $jsArr) . '
2338           return qf_errorHandler(element, _qfMsg, escapedName);
2339       } else {
2340         //element name should be defined else error msg will not be displayed.
2341         return true;
2342       }
2343     }
2345     document.getElementById(\'' . $elem->_attributes['id'] . '\').addEventListener(\'blur\', function(ev) {
2346         ' . $valFunc . '
2347     });
2348     document.getElementById(\'' . $elem->_attributes['id'] . '\').addEventListener(\'change\', function(ev) {
2349         ' . $valFunc . '
2350     });
2351 ';
2352                 }
2353             }
2354             $validateJS .= '
2355       ret = validate_' . $this->_formName . '_' . $escapedElementName.'(frm.elements[\''.$elementName.'\'], \''.$escapedElementName.'\') && ret;
2356       if (!ret && !first_focus) {
2357         first_focus = true;
2358         Y.use(\'moodle-core-event\', function() {
2359             Y.Global.fire(M.core.globalEvents.FORM_ERROR, {formid: \'' . $this->_attributes['id'] . '\',
2360                                                            elementid: \'id_error_' . $escapedElementName . '\'});
2361             document.getElementById(\'id_error_' . $escapedElementName . '\').focus();
2362         });
2363       }
2364 ';
2366             // Fix for bug displaying errors for elements in a group
2367             //unset($element);
2368             //$element =& $this->getElement($elementName);
2369             //end of fix
2370             //$onBlur = $element->getAttribute('onBlur');
2371             //$onChange = $element->getAttribute('onChange');
2372             //$element->updateAttributes(array('onBlur' => $onBlur . $valFunc,
2373                                              //'onChange' => $onChange . $valFunc));
2374         }
2375 //  do not rely on frm function parameter, because htmlarea breaks it when overloading the onsubmit method
2376         $js .= '
2378     function validate_' . $this->_formName . '() {
2379       if (skipClientValidation) {
2380          return true;
2381       }
2382       var ret = true;
2384       var frm = document.getElementById(\''. $this->_attributes['id'] .'\')
2385       var first_focus = false;
2386     ' . $validateJS . ';
2387       return ret;
2388     }
2391     document.getElementById(\'' . $this->_attributes['id'] . '\').addEventListener(\'submit\', function(ev) {
2392         try {
2393             var myValidator = validate_' . $this->_formName . ';
2394         } catch(e) {
2395             return true;
2396         }
2397         if (typeof window.tinyMCE !== \'undefined\') {
2398             window.tinyMCE.triggerSave();
2399         }
2400         if (!myValidator()) {
2401             ev.preventDefault();
2402         }
2403     });
2405 });
2406 ';
2408         $PAGE->requires->js_amd_inline($js);
2410         // Global variable used to skip the client validation.
2411         return html_writer::tag('script', 'var skipClientValidation = false;');
2412     } // end func getValidationScript
2414     /**
2415      * Sets default error message
2416      */
2417     function _setDefaultRuleMessages(){
2418         foreach ($this->_rules as $field => $rulesarr){
2419             foreach ($rulesarr as $key => $rule){
2420                 if ($rule['message']===null){
2421                     $a=new stdClass();
2422                     $a->format=$rule['format'];
2423                     $str=get_string('err_'.$rule['type'], 'form', $a);
2424                     if (strpos($str, '[[')!==0){
2425                         $this->_rules[$field][$key]['message']=$str;
2426                     }
2427                 }
2428             }
2429         }
2430     }
2432     /**
2433      * Get list of attributes which have dependencies
2434      *
2435      * @return array
2436      */
2437     function getLockOptionObject(){
2438         $result = array();
2439         foreach ($this->_dependencies as $dependentOn => $conditions){
2440             $result[$dependentOn] = array();
2441             foreach ($conditions as $condition=>$values) {
2442                 $result[$dependentOn][$condition] = array();
2443                 foreach ($values as $value=>$dependents) {
2444                     $result[$dependentOn][$condition][$value][self::DEP_DISABLE] = array();
2445                     foreach ($dependents as $dependent) {
2446                         $elements = $this->_getElNamesRecursive($dependent);
2447                         if (empty($elements)) {
2448                             // probably element inside of some group
2449                             $elements = array($dependent);
2450                         }
2451                         foreach($elements as $element) {
2452                             if ($element == $dependentOn) {
2453                                 continue;
2454                             }
2455                             $result[$dependentOn][$condition][$value][self::DEP_DISABLE][] = $element;
2456                         }
2457                     }
2458                 }
2459             }
2460         }
2461         foreach ($this->_hideifs as $dependenton => $conditions) {
2462             $result[$dependenton] = array();
2463             foreach ($conditions as $condition => $values) {
2464                 $result[$dependenton][$condition] = array();
2465                 foreach ($values as $value => $dependents) {
2466                     $result[$dependenton][$condition][$value][self::DEP_HIDE] = array();
2467                     foreach ($dependents as $dependent) {
2468                         $elements = $this->_getElNamesRecursive($dependent);
2469                         if (!in_array($dependent, $elements)) {
2470                             // Always want to hide the main element, even if it contains sub-elements as well.
2471                             $elements[] = $dependent;
2472                         }
2473                         foreach ($elements as $element) {
2474                             if ($element == $dependenton) {
2475                                 continue;
2476                             }
2477                             $result[$dependenton][$condition][$value][self::DEP_HIDE][] = $element;
2478                         }
2479                     }
2480                 }
2481             }
2482         }
2483         return array($this->getAttribute('id'), $result);
2484     }
2486     /**
2487      * Get names of element or elements in a group.
2488      *
2489      * @param HTML_QuickForm_group|element $element element group or element object
2490      * @return array
2491      */
2492     function _getElNamesRecursive($element) {
2493         if (is_string($element)) {
2494             if (!$this->elementExists($element)) {
2495                 return array();
2496             }
2497             $element = $this->getElement($element);
2498         }
2500         if (is_a($element, 'HTML_QuickForm_group')) {
2501             $elsInGroup = $element->getElements();
2502             $elNames = array();
2503             foreach ($elsInGroup as $elInGroup){
2504                 if (is_a($elInGroup, 'HTML_QuickForm_group')) {
2505                     // Groups nested in groups: append the group name to the element and then change it back.
2506                     // We will be appending group name again in MoodleQuickForm_group::export_for_template().
2507                     $oldname = $elInGroup->getName();
2508                     if ($element->_appendName) {
2509                         $elInGroup->setName($element->getName() . '[' . $oldname . ']');
2510                     }
2511                     $elNames = array_merge($elNames, $this->_getElNamesRecursive($elInGroup));
2512                     $elInGroup->setName($oldname);
2513                 } else {
2514                     $elNames[] = $element->getElementName($elInGroup->getName());
2515                 }
2516             }
2518         } else if (is_a($element, 'HTML_QuickForm_header')) {
2519             return array();
2521         } else if (is_a($element, 'HTML_QuickForm_hidden')) {
2522             return array();
2524         } else if (method_exists($element, 'getPrivateName') &&
2525                 !($element instanceof HTML_QuickForm_advcheckbox)) {
2526             // The advcheckbox element implements a method called getPrivateName,
2527             // but in a way that is not compatible with the generic API, so we
2528             // have to explicitly exclude it.
2529             return array($element->getPrivateName());
2531         } else {
2532             $elNames = array($element->getName());
2533         }
2535         return $elNames;
2536     }
2538     /**
2539      * Adds a dependency for $elementName which will be disabled if $condition is met.
2540      * If $condition = 'notchecked' (default) then the condition is that the $dependentOn element
2541      * is not checked. If $condition = 'checked' then the condition is that the $dependentOn element
2542      * is checked. If $condition is something else (like "eq" for equals) then it is checked to see if the value
2543      * of the $dependentOn element is $condition (such as equal) to $value.
2544      *
2545      * When working with multiple selects, the dependentOn has to be the real name of the select, meaning that
2546      * it will most likely end up with '[]'. Also, the value should be an array of required values, or a string
2547      * containing the values separated by pipes: array('red', 'blue') or 'red|blue'.
2548      *
2549      * @param string $elementName the name of the element which will be disabled
2550      * @param string $dependentOn the name of the element whose state will be checked for condition
2551      * @param string $condition the condition to check
2552      * @param mixed $value used in conjunction with condition.
2553      */
2554     function disabledIf($elementName, $dependentOn, $condition = 'notchecked', $value='1') {
2555         // Multiple selects allow for a multiple selection, we transform the array to string here as
2556         // an array cannot be used as a key in an associative array.
2557         if (is_array($value)) {
2558             $value = implode('|', $value);
2559         }
2560         if (!array_key_exists($dependentOn, $this->_dependencies)) {
2561             $this->_dependencies[$dependentOn] = array();
2562         }
2563         if (!array_key_exists($condition, $this->_dependencies[$dependentOn])) {
2564             $this->_dependencies[$dependentOn][$condition] = array();
2565         }
2566         if (!array_key_exists($value, $this->_dependencies[$dependentOn][$condition])) {
2567             $this->_dependencies[$dependentOn][$condition][$value] = array();
2568         }
2569         $this->_dependencies[$dependentOn][$condition][$value][] = $elementName;
2570     }
2572     /**
2573      * Adds a dependency for $elementName which will be hidden if $condition is met.
2574      * If $condition = 'notchecked' (default) then the condition is that the $dependentOn element
2575      * is not checked. If $condition = 'checked' then the condition is that the $dependentOn element
2576      * is checked. If $condition is something else (like "eq" for equals) then it is checked to see if the value
2577      * of the $dependentOn element is $condition (such as equal) to $value.
2578      *
2579      * When working with multiple selects, the dependentOn has to be the real name of the select, meaning that
2580      * it will most likely end up with '[]'. Also, the value should be an array of required values, or a string
2581      * containing the values separated by pipes: array('red', 'blue') or 'red|blue'.
2582      *
2583      * @param string $elementname the name of the element which will be hidden
2584      * @param string $dependenton the name of the element whose state will be checked for condition
2585      * @param string $condition the condition to check
2586      * @param mixed $value used in conjunction with condition.
2587      */
2588     public function hideIf($elementname, $dependenton, $condition = 'notchecked', $value = '1') {
2589         // Multiple selects allow for a multiple selection, we transform the array to string here as
2590         // an array cannot be used as a key in an associative array.
2591         if (is_array($value)) {
2592             $value = implode('|', $value);
2593         }
2594         if (!array_key_exists($dependenton, $this->_hideifs)) {
2595             $this->_hideifs[$dependenton] = array();
2596         }
2597         if (!array_key_exists($condition, $this->_hideifs[$dependenton])) {
2598             $this->_hideifs[$dependenton][$condition] = array();
2599         }
2600         if (!array_key_exists($value, $this->_hideifs[$dependenton][$condition])) {
2601             $this->_hideifs[$dependenton][$condition][$value] = array();
2602         }
2603         $this->_hideifs[$dependenton][$condition][$value][] = $elementname;
2604     }
2606     /**
2607      * Registers button as no submit button
2608      *
2609      * @param string $buttonname name of the button
2610      */
2611     function registerNoSubmitButton($buttonname){
2612         $this->_noSubmitButtons[]=$buttonname;
2613     }
2615     /**
2616      * Checks if button is a no submit button, i.e it doesn't submit form
2617      *
2618      * @param string $buttonname name of the button to check
2619      * @return bool
2620      */
2621     function isNoSubmitButton($buttonname){
2622         return (array_search($buttonname, $this->_noSubmitButtons)!==FALSE);
2623     }
2625     /**
2626      * Registers a button as cancel button
2627      *
2628      * @param string $addfieldsname name of the button
2629      */
2630     function _registerCancelButton($addfieldsname){
2631         $this->_cancelButtons[]=$addfieldsname;
2632     }
2634     /**
2635      * Displays elements without HTML input tags.
2636      * This method is different to freeze() in that it makes sure no hidden
2637      * elements are included in the form.
2638      * Note: If you want to make sure the submitted value is ignored, please use setDefaults().
2639      *
2640      * This function also removes all previously defined rules.
2641      *
2642      * @param string|array $elementList array or string of element(s) to be frozen
2643      * @return object|bool if element list is not empty then return error object, else true
2644      */
2645     function hardFreeze($elementList=null)
2646     {
2647         if (!isset($elementList)) {
2648             $this->_freezeAll = true;
2649             $elementList = array();
2650         } else {
2651             if (!is_array($elementList)) {
2652                 $elementList = preg_split('/[ ]*,[ ]*/', $elementList);
2653             }
2654             $elementList = array_flip($elementList);
2655         }
2657         foreach (array_keys($this->_elements) as $key) {
2658             $name = $this->_elements[$key]->getName();
2659             if ($this->_freezeAll || isset($elementList[$name])) {
2660                 $this->_elements[$key]->freeze();
2661                 $this->_elements[$key]->setPersistantFreeze(false);
2662                 unset($elementList[$name]);
2664                 // remove all rules
2665                 $this->_rules[$name] = array();
2666                 // if field is required, remove the rule
2667                 $unset = array_search($name, $this->_required);
2668                 if ($unset !== false) {
2669                     unset($this->_required[$unset]);
2670                 }
2671             }
2672         }
2674         if (!empty($elementList)) {
2675             return self::raiseError(null, QUICKFORM_NONEXIST_ELEMENT, null, E_USER_WARNING, "Nonexistant element(s): '" . implode("', '", array_keys($elementList)) . "' in HTML_QuickForm::freeze()", 'HTML_QuickForm_Error', true);
2676         }
2677         return true;
2678     }
2680     /**
2681      * Hard freeze all elements in a form except those whose names are in $elementList or hidden elements in a form.
2682      *
2683      * This function also removes all previously defined rules of elements it freezes.
2684      *
2685      * @throws HTML_QuickForm_Error
2686      * @param array $elementList array or string of element(s) not to be frozen
2687      * @return bool returns true
2688      */
2689     function hardFreezeAllVisibleExcept($elementList)
2690     {
2691         $elementList = array_flip($elementList);
2692         foreach (array_keys($this->_elements) as $key) {
2693             $name = $this->_elements[$key]->getName();
2694             $type = $this->_elements[$key]->getType();
2696             if ($type == 'hidden'){
2697                 // leave hidden types as they are
2698             } elseif (!isset($elementList[$name])) {
2699                 $this->_elements[$key]->freeze();
2700                 $this->_elements[$key]->setPersistantFreeze(false);
2702                 // remove all rules
2703                 $this->_rules[$name] = array();
2704                 // if field is required, remove the rule
2705                 $unset = array_search($name, $this->_required);
2706                 if ($unset !== false) {
2707                     unset($this->_required[$unset]);
2708                 }
2709             }
2710         }
2711         return true;
2712     }
2714    /**
2715     * Tells whether the form was already submitted
2716     *
2717     * This is useful since the _submitFiles and _submitValues arrays
2718     * may be completely empty after the trackSubmit value is removed.
2719     *
2720     * @return bool
2721     */
2722     function isSubmitted()
2723     {
2724         return parent::isSubmitted() && (!$this->isFrozen());
2725     }
2728 /**
2729  * MoodleQuickForm renderer
2730  *
2731  * A renderer for MoodleQuickForm that only uses XHTML and CSS and no
2732  * table tags, extends PEAR class HTML_QuickForm_Renderer_Tableless
2733  *
2734  * Stylesheet is part of standard theme and should be automatically included.
2735  *
2736  * @package   core_form
2737  * @copyright 2007 Jamie Pratt <me@jamiep.org>
2738  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2739  */
2740 class MoodleQuickForm_Renderer extends HTML_QuickForm_Renderer_Tableless{
2742     /** @var array Element template array */
2743     var $_elementTemplates;
2745     /**
2746      * Template used when opening a hidden fieldset
2747      * (i.e. a fieldset that is opened when there is no header element)
2748      * @var string
2749      */
2750     var $_openHiddenFieldsetTemplate = "\n\t<fieldset class=\"hidden\"><div>";
2752     /** @var string Header Template string */
2753     var $_headerTemplate =
2754        "\n\t\t<legend class=\"ftoggler\">{header}</legend>\n\t\t<div class=\"fcontainer clearfix\">\n\t\t";
2756     /** @var string Template used when opening a fieldset */
2757     var $_openFieldsetTemplate = "\n\t<fieldset class=\"{classes}\" {id}>";
2759     /** @var string Template used when closing a fieldset */
2760     var $_closeFieldsetTemplate = "\n\t\t</div></fieldset>";
2762     /** @var string Required Note template string */
2763     var $_requiredNoteTemplate =
2764         "\n\t\t<div class=\"fdescription required\">{requiredNote}</div>";
2766     /**
2767      * Collapsible buttons string template.
2768      *
2769      * Note that the <span> will be converted as a link. This is done so that the link is not yet clickable
2770      * until the Javascript has been fully loaded.
2771      *
2772      * @var string
2773      */
2774     var $_collapseButtonsTemplate =
2775         "\n\t<div class=\"collapsible-actions\"><span class=\"collapseexpand\">{strexpandall}</span></div>";
2777     /**
2778      * Array whose keys are element names. If the key exists this is a advanced element
2779      *
2780      * @var array
2781      */
2782     var $_advancedElements = array();
2784     /**
2785      * Array whose keys are element names and the the boolean values reflect the current state. If the key exists this is a collapsible element.
2786      *
2787      * @var array
2788      */
2789     var $_collapsibleElements = array();
2791     /**
2792      * @var string Contains the collapsible buttons to add to the form.
2793      */
2794     var $_collapseButtons = '';
2796     /**
2797      * Constructor
2798      */
2799     public function __construct() {
2800         // switch next two lines for ol li containers for form items.
2801         //        $this->_elementTemplates=array('default'=>"\n\t\t".'<li class="fitem"><label>{label}{help}<!-- BEGIN required -->{req}<!-- END required --></label><div class="qfelement<!-- BEGIN error --> error<!-- END error --> {typeclass}"><!-- BEGIN error --><span class="error">{error}</span><br /><!-- END error -->{element}</div></li>');
2802         $this->_elementTemplates = array(
2803         'default' => "\n\t\t".'<div id="{id}" class="fitem {advanced}<!-- BEGIN required --> required<!-- END required --> fitem_{typeclass} {emptylabel} {class}" {aria-live}><div class="fitemtitle"><label>{label}<!-- BEGIN required -->{req}<!-- END required -->{advancedimg} </label>{help}</div><div class="felement {typeclass}<!-- BEGIN error --> error<!-- END error -->" data-fieldtype="{type}"><!-- BEGIN error --><span class="error" tabindex="0">{error}</span><br /><!-- END error -->{element}</div></div>',
2805         'actionbuttons' => "\n\t\t".'<div id="{id}" class="fitem fitem_actionbuttons fitem_{typeclass} {class}"><div class="felement {typeclass}" data-fieldtype="{type}">{element}</div></div>',
2807         'fieldset' => "\n\t\t".'<div id="{id}" class="fitem {advanced} {class}<!-- BEGIN required --> required<!-- END required --> fitem_{typeclass} {emptylabel}"><div class="fitemtitle"><div class="fgrouplabel"><label>{label}<!-- BEGIN required -->{req}<!-- END required -->{advancedimg} </label>{help}</div></div><fieldset class="felement {typeclass}<!-- BEGIN error --> error<!-- END error -->" data-fieldtype="{type}"><!-- BEGIN error --><span class="error" tabindex="0">{error}</span><br /><!-- END error -->{element}</fieldset></div>',
2809         'static' => "\n\t\t".'<div id="{id}" class="fitem {advanced} {emptylabel} {class}"><div class="fitemtitle"><div class="fstaticlabel">{label}<!-- BEGIN required -->{req}<!-- END required -->{advancedimg} {help}</div></div><div class="felement fstatic <!-- BEGIN error --> error<!-- END error -->" data-fieldtype="static"><!-- BEGIN error --><span class="error" tabindex="0">{error}</span><br /><!-- END error -->{element}</div></div>',
2811         'warning' => "\n\t\t".'<div id="{id}" class="fitem {advanced} {emptylabel} {class}">{element}</div>',
2813         'nodisplay' => '');
2815         parent::__construct();
2816     }
2818     /**
2819      * Old syntax of class constructor. Deprecated in PHP7.
2820      *
2821      * @deprecated since Moodle 3.1
2822      */
2823     public function MoodleQuickForm_Renderer() {
2824         debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);
2825         self::__construct();
2826     }
2828     /**
2829      * Set element's as adavance element
2830      *
2831      * @param array $elements form elements which needs to be grouped as advance elements.
2832      */
2833     function setAdvancedElements($elements){
2834         $this->_advancedElements = $elements;
2835     }
2837     /**
2838      * Setting collapsible elements
2839      *
2840      * @param array $elements
2841      */
2842     function setCollapsibleElements($elements) {
2843         $this->_collapsibleElements = $elements;
2844     }
2846     /**
2847      * What to do when starting the form
2848      *
2849      * @param MoodleQuickForm $form reference of the form
2850      */
2851     function startForm(&$form){
2852         global $PAGE;
2853         $this->_reqHTML = $form->getReqHTML();
2854         $this->_elementTemplates = str_replace('{req}', $this->_reqHTML, $this->_elementTemplates);
2855         $this->_advancedHTML = $form->getAdvancedHTML();
2856         $this->_collapseButtons = '';
2857         $formid = $form->getAttribute('id');
2858         parent::startForm($form);
2859         if ($form->isFrozen()){
2860             $this->_formTemplate = "\n<div class=\"mform frozen\">\n{content}\n</div>";
2861         } else {
2862             $this->_formTemplate = "\n<form{attributes}>\n\t<div style=\"display: none;\">{hidden}</div>\n{collapsebtns}\n{content}\n</form>";
2863             $this->_hiddenHtml .= $form->_pageparams;
2864         }
2866         if ($form->is_form_change_checker_enabled()) {
2867             $PAGE->requires->yui_module('moodle-core-formchangechecker',
2868                     'M.core_formchangechecker.init',
2869                     array(array(
2870                         'formid' => $formid
2871                     ))
2872             );
2873             $PAGE->requires->string_for_js('changesmadereallygoaway', 'moodle');
2874         }
2875         if (!empty($this->_collapsibleElements)) {
2876             if (count($this->_collapsibleElements) > 1) {
2877                 $this->_collapseButtons = $this->_collapseButtonsTemplate;
2878                 $this->_collapseButtons = str_replace('{strexpandall}', get_string('expandall'), $this->_collapseButtons);
2879                 $PAGE->requires->strings_for_js(array('collapseall', 'expandall'), 'moodle');
2880             }
2881             $PAGE->requires->yui_module('moodle-form-shortforms', 'M.form.shortforms', array(array('formid' => $formid)));
2882         }
2883         if (!empty($this->_advancedElements)){
2884             $PAGE->requires->strings_for_js(array('showmore', 'showless'), 'form');
2885             $PAGE->requires->yui_module('moodle-form-showadvanced', 'M.form.showadvanced', array(array('formid' => $formid)));
2886         }
2887     }
2889     /**
2890      * Create advance group of elements
2891      *
2892      * @param MoodleQuickForm_group $group Passed by reference
2893      * @param bool $required if input is required field
2894      * @param string $error error message to display
2895      */
2896     function startGroup(&$group, $required, $error){
2897         global $OUTPUT;
2899         // Make sure the element has an id.
2900         $group->_generateId();
2902         // Prepend 'fgroup_' to the ID we generated.
2903         $groupid = 'fgroup_' . $group->getAttribute('id');
2905         // Update the ID.
2906         $group->updateAttributes(array('id' => $groupid));
2907         $advanced = isset($this->_advancedElements[$group->getName()]);
2909         $html = $OUTPUT->mform_element($group, $required, $advanced, $error, false);
2910         $fromtemplate = !empty($html);
2911         if (!$fromtemplate) {
2912             if (method_exists($group, 'getElementTemplateType')) {
2913                 $html = $this->_elementTemplates[$group->getElementTemplateType()];
2914             } else {
2915                 $html = $this->_elementTemplates['default'];
2916             }
2918             if (isset($this->_advancedElements[$group->getName()])) {
2919                 $html = str_replace(' {advanced}', ' advanced', $html);
2920                 $html = str_replace('{advancedimg}', $this->_advancedHTML, $html);
2921             } else {
2922                 $html = str_replace(' {advanced}', '', $html);
2923                 $html = str_replace('{advancedimg}', '', $html);
2924             }
2925             if (method_exists($group, 'getHelpButton')) {
2926                 $html = str_replace('{help}', $group->getHelpButton(), $html);
2927             } else {
2928                 $html = str_replace('{help}', '', $html);
2929             }
2930             $html = str_replace('{id}', $group->getAttribute('id'), $html);
2931             $html = str_replace('{name}', $group->getName(), $html);
2932             $html = str_replace('{typeclass}', 'fgroup', $html);
2933             $html = str_replace('{type}', 'group', $html);
2934             $html = str_replace('{class}', $group->getAttribute('class'), $html);
2935             $emptylabel = '';
2936             if ($group->getLabel() == '') {
2937                 $emptylabel = 'femptylabel';
2938             }
2939             $html = str_replace('{emptylabel}', $emptylabel, $html);
2940         }
2941         $this->_templates[$group->getName()] = $html;
2942         // Fix for bug in tableless quickforms that didn't allow you to stop a
2943         // fieldset before a group of elements.
2944         // if the element name indicates the end of a fieldset, close the fieldset
2945         if (in_array($group->getName(), $this->_stopFieldsetElements) && $this->_fieldsetsOpen > 0) {
2946             $this->_html .= $this->_closeFieldsetTemplate;
2947             $this->_fieldsetsOpen--;
2948         }
2949         if (!$fromtemplate) {
2950             parent::startGroup($group, $required, $error);
2951         } else {
2952             $this->_html .= $html;
2953         }
2954     }
2956     /**
2957      * Renders element
2958      *
2959      * @param HTML_QuickForm_element $element element
2960      * @param bool $required if input is required field
2961      * @param string $error error message to display
2962      */
2963     function renderElement(&$element, $required, $error){
2964         global $OUTPUT;
2966         // Make sure the element has an id.
2967         $element->_generateId();
2968         $advanced = isset($this->_advancedElements[$element->getName()]);
2970         $html = $OUTPUT->mform_element($element, $required, $advanced, $error, false);
2971         $fromtemplate = !empty($html);
2972         if (!$fromtemplate) {
2973             // Adding stuff to place holders in template
2974             // check if this is a group element first.
2975             if (($this->_inGroup) and !empty($this->_groupElementTemplate)) {
2976                 // So it gets substitutions for *each* element.
2977                 $html = $this->_groupElementTemplate;
2978             } else if (method_exists($element, 'getElementTemplateType')) {
2979                 $html = $this->_elementTemplates[$element->getElementTemplateType()];
2980             } else {
2981                 $html = $this->_elementTemplates['default'];
2982             }
2983             if (isset($this->_advancedElements[$element->getName()])) {
2984                 $html = str_replace(' {advanced}', ' advanced', $html);
2985                 $html = str_replace(' {aria-live}', ' aria-live="polite"', $html);
2986             } else {
2987                 $html = str_replace(' {advanced}', '', $html);
2988                 $html = str_replace(' {aria-live}', '', $html);
2989             }
2990             if (isset($this->_advancedElements[$element->getName()]) || $element->getName() == 'mform_showadvanced') {
2991                 $html = str_replace('{advancedimg}', $this->_advancedHTML, $html);
2992             } else {
2993                 $html = str_replace('{advancedimg}', '', $html);
2994             }
2995             $html = str_replace('{id}', 'fitem_' . $element->getAttribute('id'), $html);
2996             $html = str_replace('{typeclass}', 'f' . $element->getType(), $html);
2997             $html = str_replace('{type}', $element->getType(), $html);
2998             $html = str_replace('{name}', $element->getName(), $html);
2999             $html = str_replace('{class}', $element->getAttribute('class'), $html);
3000             $emptylabel = '';
3001             if ($element->getLabel() == '') {
3002                 $emptylabel = 'femptylabel';
3003             }
3004             $html = str_replace('{emptylabel}', $emptylabel, $html);
3005             if (method_exists($element, 'getHelpButton')) {
3006                 $html = str_replace('{help}', $element->getHelpButton(), $html);
3007             } else {
3008                 $html = str_replace('{help}', '', $html);
3009             }
3010         } else {
3011             if ($this->_inGroup) {
3012                 $this->_groupElementTemplate = $html;
3013             }
3014         }
3015         if (($this->_inGroup) and !empty($this->_groupElementTemplate)) {
3016             $this->_groupElementTemplate = $html;
3017         } else if (!isset($this->_templates[$element->getName()])) {
3018             $this->_templates[$element->getName()] = $html;
3019         }
3021         if (!$fromtemplate) {
3022             parent::renderElement($element, $required, $error);
3023         } else {
3024             if (in_array($element->getName(), $this->_stopFieldsetElements) && $this->_fieldsetsOpen > 0) {
3025                 $this->_html .= $this->_closeFieldsetTemplate;
3026                 $this->_fieldsetsOpen--;
3027             }
3028             $this->_html .= $html;
3029         }
3030     }
3032     /**
3033      * Called when visiting a form, after processing all form elements
3034      * Adds required note, form attributes, validation javascript and form content.
3035      *
3036      * @global moodle_page $PAGE
3037      * @param moodleform $form Passed by reference
3038      */
3039     function finishForm(&$form){
3040         global $PAGE;
3041         if ($form->isFrozen()){
3042             $this->_hiddenHtml = '';
3043         }
3044         parent::finishForm($form);
3045         $this->_html = str_replace('{collapsebtns}', $this->_collapseButtons, $this->_html);
3046         if (!$form->isFrozen()) {
3047             $args = $form->getLockOptionObject();
3048             if (count($args[1]) > 0) {
3049                 $PAGE->requires->js_init_call('M.form.initFormDependencies', $args, true, moodleform::get_js_module());
3050             }
3051         }
3052     }
3053    /**
3054     * Called when visiting a header element
3055     *
3056     * @param HTML_QuickForm_header $header An HTML_QuickForm_header element being visited
3057     * @global moodle_page $PAGE
3058     */
3059     function renderHeader(&$header) {
3060         global $PAGE;
3062         $header->_generateId();
3063         $name = $header->getName();
3065         $id = empty($name) ? '' : ' id="' . $header->getAttribute('id') . '"';
3066         if (is_null($header->_text)) {
3067             $header_html = '';
3068         } elseif (!empty($name) && isset($this->_templates[$name])) {
3069             $header_html = str_replace('{header}', $header->toHtml(), $this->_templates[$name]);
3070         } else {
3071             $header_html = str_replace('{header}', $header->toHtml(), $this->_headerTemplate);
3072         }
3074         if ($this->_fieldsetsOpen > 0) {
3075             $this->_html .= $this->_closeFieldsetTemplate;
3076             $this->_fieldsetsOpen--;
3077         }
3079         // Define collapsible classes for fieldsets.
3080         $arialive = '';
3081         $fieldsetclasses = array('clearfix');
3082         if (isset($this->_collapsibleElements[$header->getName()])) {
3083             $fieldsetclasses[] = 'collapsible';
3084             if ($this->_collapsibleElements[$header->getName()]) {
3085                 $fieldsetclasses[] = 'collapsed';
3086             }
3087         }
3089         if (isset($this->_advancedElements[$name])){
3090             $fieldsetclasses[] = 'containsadvancedelements';
3091         }
3093         $openFieldsetTemplate = str_replace('{id}', $id, $this->_openFieldsetTemplate);
3094         $openFieldsetTemplate = str_replace('{classes}', join(' ', $fieldsetclasses), $openFieldsetTemplate);
3096         $this->_html .= $openFieldsetTemplate . $header_html;
3097         $this->_fieldsetsOpen++;
3098     }
3100     /**
3101      * Return Array of element names that indicate the end of a fieldset
3102      *
3103      * @return array
3104      */
3105     function getStopFieldsetElements(){
3106         return $this->_stopFieldsetElements;
3107     }
3110 /**
3111  * Required elements validation
3112  *
3113  * This class overrides QuickForm validation since it allowed space or empty tag as a value
3114  *
3115  * @package   core_form
3116  * @category  form
3117  * @copyright 2006 Jamie Pratt <me@jamiep.org>
3118  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3119  */
3120 class MoodleQuickForm_Rule_Required extends HTML_QuickForm_Rule {
3121     /**
3122      * Checks if an element is not empty.
3123      * This is a server-side validation, it works for both text fields and editor fields
3124      *
3125      * @param string $value Value to check
3126      * @param int|string|array $options Not used yet
3127      * @return bool true if value is not empty
3128      */
3129     function validate($value, $options = null) {
3130         global $CFG;
3131         if (is_array($value) && array_key_exists('text', $value)) {
3132             $value = $value['text'];
3133         }
3134         if (is_array($value)) {
3135             // nasty guess - there has to be something in the array, hopefully nobody invents arrays in arrays
3136             $value = implode('', $value);
3137         }
3138         $stripvalues = array(
3139             '#</?(?!img|canvas|hr).*?>#im', // all tags except img, canvas and hr
3140             '#(\xc2\xa0|\s|&nbsp;)#', // Any whitespaces actually.
3141         );
3142         if (!empty($CFG->strictformsrequired)) {
3143             $value = preg_replace($stripvalues, '', (string)$value);
3144         }
3145         if ((string)$value == '') {
3146             return false;
3147         }
3148         return true;
3149     }
3151     /**
3152      * This function returns Javascript code used to build client-side validation.
3153      * It checks if an element is not empty.
3154      *
3155      * @param int $format format of data which needs to be validated.
3156      * @return array
3157      */
3158     function getValidationScript($format = null) {
3159         global $CFG;
3160         if (!empty($CFG->strictformsrequired)) {
3161             if (!empty($format) && $format == FORMAT_HTML) {
3162                 return array('', "{jsVar}.replace(/(<(?!img|hr|canvas)[^>]*>)|&nbsp;|\s+/ig, '') == ''");
3163             } else {
3164                 return array('', "{jsVar}.replace(/^\s+$/g, '') == ''");
3165             }
3166         } else {
3167             return array('', "{jsVar} == ''");
3168         }
3169     }
3172 /**
3173  * @global object $GLOBALS['_HTML_QuickForm_default_renderer']
3174  * @name $_HTML_QuickForm_default_renderer
3175  */
3176 $GLOBALS['_HTML_QuickForm_default_renderer'] = new MoodleQuickForm_Renderer();
3178 /** Please keep this list in alphabetical order. */
3179 MoodleQuickForm::registerElementType('advcheckbox', "$CFG->libdir/form/advcheckbox.php", 'MoodleQuickForm_advcheckbox');
3180 MoodleQuickForm::registerElementType('autocomplete', "$CFG->libdir/form/autocomplete.php", 'MoodleQuickForm_autocomplete');
3181 MoodleQuickForm::registerElementType('button', "$CFG->libdir/form/button.php", 'MoodleQuickForm_button');
3182 MoodleQuickForm::registerElementType('cancel', "$CFG->libdir/form/cancel.php", 'MoodleQuickForm_cancel');
3183 MoodleQuickForm::registerElementType('course', "$CFG->libdir/form/course.php", 'MoodleQuickForm_course');
3184 MoodleQuickForm::registerElementType('cohort', "$CFG->libdir/form/cohort.php", 'MoodleQuickForm_cohort');
3185 MoodleQuickForm::registerElementType('searchableselector', "$CFG->libdir/form/searchableselector.php", 'MoodleQuickForm_searchableselector');
3186 MoodleQuickForm::registerElementType('checkbox', "$CFG->libdir/form/checkbox.php", 'MoodleQuickForm_checkbox');
3187 MoodleQuickForm::registerElementType('date_selector', "$CFG->libdir/form/dateselector.php", 'MoodleQuickForm_date_selector');
3188 MoodleQuickForm::registerElementType('date_time_selector', "$CFG->libdir/form/datetimeselector.php", 'MoodleQuickForm_date_time_selector');
3189 MoodleQuickForm::registerElementType('duration', "$CFG->libdir/form/duration.php", 'MoodleQuickForm_duration');
3190 MoodleQuickForm::registerElementType('editor', "$CFG->libdir/form/editor.php", 'MoodleQuickForm_editor');
3191 MoodleQuickForm::registerElementType('filemanager', "$CFG->libdir/form/filemanager.php", 'MoodleQuickForm_filemanager');
3192 MoodleQuickForm::registerElementType('filepicker', "$CFG->libdir/form/filepicker.php", 'MoodleQuickForm_filepicker');
3193 MoodleQuickForm::registerElementType('filetypes', "$CFG->libdir/form/filetypes.php", 'MoodleQuickForm_filetypes');
3194 MoodleQuickForm::registerElementType('grading', "$CFG->libdir/form/grading.php", 'MoodleQuickForm_grading');
3195 MoodleQuickForm::registerElementType('group', "$CFG->libdir/form/group.php", 'MoodleQuickForm_group');
3196 MoodleQuickForm::registerElementType('header', "$CFG->libdir/form/header.php", 'MoodleQuickForm_header');
3197 MoodleQuickForm::registerElementType('hidden', "$CFG->libdir/form/hidden.php", 'MoodleQuickForm_hidden');
3198 MoodleQuickForm::registerElementType('htmleditor', "$CFG->libdir/form/htmleditor.php", 'MoodleQuickForm_htmleditor');
3199 MoodleQuickForm::registerElementType('listing', "$CFG->libdir/form/listing.php", 'MoodleQuickForm_listing');
3200 MoodleQuickForm::registerElementType('defaultcustom', "$CFG->libdir/form/defaultcustom.php", 'MoodleQuickForm_defaultcustom');
3201 MoodleQuickForm::registerElementType('modgrade', "$CFG->libdir/form/modgrade.php", 'MoodleQuickForm_modgrade');
3202 MoodleQuickForm::registerElementType('modvisible', "$CFG->libdir/form/modvisible.php", 'MoodleQuickForm_modvisible');
3203 MoodleQuickForm::registerElementType('password', "$CFG->libdir/form/password.php", 'MoodleQuickForm_password');
3204 MoodleQuickForm::registerElementType('passwordunmask', "$CFG->libdir/form/passwordunmask.php", 'MoodleQuickForm_passwordunmask');
3205 MoodleQuickForm::registerElementType('questioncategory', "$CFG->libdir/form/questioncategory.php", 'MoodleQuickForm_questioncategory');
3206 MoodleQuickForm::registerElementType('radio', "$CFG->libdir/form/radio.php", 'MoodleQuickForm_radio');
3207 MoodleQuickForm::registerElementType('recaptcha', "$CFG->libdir/form/recaptcha.php", 'MoodleQuickForm_recaptcha');
3208 MoodleQuickForm::registerElementType('select', "$CFG->libdir/form/select.php", 'MoodleQuickForm_select');
3209 MoodleQuickForm::registerElementType('selectgroups', "$CFG->libdir/form/selectgroups.php", 'MoodleQuickForm_selectgroups');
3210 MoodleQuickForm::registerElementType('selectwithlink', "$CFG->libdir/form/selectwithlink.php", 'MoodleQuickForm_selectwithlink');
3211 MoodleQuickForm::registerElementType('selectyesno', "$CFG->libdir/form/selectyesno.php", 'MoodleQuickForm_selectyesno');
3212 MoodleQuickForm::registerElementType('static', "$CFG->libdir/form/static.php", 'MoodleQuickForm_static');
3213 MoodleQuickForm::registerElementType('submit', "$CFG->libdir/form/submit.php", 'MoodleQuickForm_submit');
3214 MoodleQuickForm::registerElementType('submitlink', "$CFG->libdir/form/submitlink.php", 'MoodleQuickForm_submitlink');
3215 MoodleQuickForm::registerElementType('tags', "$CFG->libdir/form/tags.php", 'MoodleQuickForm_tags');
3216 MoodleQuickForm::registerElementType('text', "$CFG->libdir/form/text.php", 'MoodleQuickForm_text');
3217 MoodleQuickForm::registerElementType('textarea', "$CFG->libdir/form/textarea.php", 'MoodleQuickForm_textarea');
3218 MoodleQuickForm::registerElementType('url', "$CFG->libdir/form/url.php", 'MoodleQuickForm_url');
3219 MoodleQuickForm::registerElementType('warning', "$CFG->libdir/form/warning.php", 'MoodleQuickForm_warning');
3221 MoodleQuickForm::registerRule('required', null, 'MoodleQuickForm_Rule_Required', "$CFG->libdir/formslib.php");