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