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