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