Merge branch 'MDL-26956' of git://github.com/timhunt/moodle
[moodle.git] / lib / formslib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * formslib.php - library of classes for creating forms in Moodle, based on PEAR QuickForms.
19  *
20  * To use formslib then you will want to create a new file purpose_form.php eg. edit_form.php
21  * and you want to name your class something like {modulename}_{purpose}_form. Your class will
22  * extend moodleform overriding abstract classes definition and optionally defintion_after_data
23  * and validation.
24  *
25  * See examples of use of this library in course/edit.php and course/edit_form.php
26  *
27  * A few notes :
28  *      form definition is used for both printing of form and processing and should be the same
29  *              for both or you may lose some submitted data which won't be let through.
30  *      you should be using setType for every form element except select, radio or checkbox
31  *              elements, these elements clean themselves.
32  *
33  * @package   core_form
34  * @copyright 2006 Jamie Pratt <me@jamiep.org>
35  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36  */
38 defined('MOODLE_INTERNAL') || die();
40 /** setup.php includes our hacked pear libs first */
41 require_once 'HTML/QuickForm.php';
42 require_once 'HTML/QuickForm/DHTMLRulesTableless.php';
43 require_once 'HTML/QuickForm/Renderer/Tableless.php';
44 require_once 'HTML/QuickForm/Rule.php';
46 require_once $CFG->libdir.'/filelib.php';
48 /**
49  * EDITOR_UNLIMITED_FILES - hard-coded value for the 'maxfiles' option
50  */
51 define('EDITOR_UNLIMITED_FILES', -1);
53 /**
54  * Callback called when PEAR throws an error
55  *
56  * @param PEAR_Error $error
57  */
58 function pear_handle_error($error){
59     echo '<strong>'.$error->GetMessage().'</strong> '.$error->getUserInfo();
60     echo '<br /> <strong>Backtrace </strong>:';
61     print_object($error->backtrace);
62 }
64 if (!empty($CFG->debug) and ($CFG->debug >= DEBUG_ALL or $CFG->debug == -1)){
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         $module   = 'moodle-form-dateselector';
81         $function = 'M.form.dateselector.init_date_selectors';
82         $config = array(array(
83             'firstdayofweek'    => get_string('firstdayofweek', 'langconfig'),
84             'mon'               => date_format_string(strtotime("Monday"), '%a', 99),
85             'tue'               => date_format_string(strtotime("Tuesday"), '%a', 99),
86             'wed'               => date_format_string(strtotime("Wednesday"), '%a', 99),
87             'thu'               => date_format_string(strtotime("Thursday"), '%a', 99),
88             'fri'               => date_format_string(strtotime("Friday"), '%a', 99),
89             'sat'               => date_format_string(strtotime("Saturday"), '%a', 99),
90             'sun'               => date_format_string(strtotime("Sunday"), '%a', 99),
91             'january'           => date_format_string(strtotime("January 1"), '%B', 99),
92             'february'          => date_format_string(strtotime("February 1"), '%B', 99),
93             'march'             => date_format_string(strtotime("March 1"), '%B', 99),
94             'april'             => date_format_string(strtotime("April 1"), '%B', 99),
95             'may'               => date_format_string(strtotime("May 1"), '%B', 99),
96             'june'              => date_format_string(strtotime("June 1"), '%B', 99),
97             'july'              => date_format_string(strtotime("July 1"), '%B', 99),
98             'august'            => date_format_string(strtotime("August 1"), '%B', 99),
99             'september'         => date_format_string(strtotime("September 1"), '%B', 99),
100             'october'           => date_format_string(strtotime("October 1"), '%B', 99),
101             'november'          => date_format_string(strtotime("November 1"), '%B', 99),
102             'december'          => date_format_string(strtotime("December 1"), '%B', 99)
103         ));
104         $PAGE->requires->yui_module($module, $function, $config);
105         $done = true;
106     }
109 /**
110  * Wrapper that separates quickforms syntax from moodle code
111  *
112  * Moodle specific wrapper that separates quickforms syntax from moodle code. You won't directly
113  * use this class you should write a class definition which extends this class or a more specific
114  * subclass such a moodleform_mod for each form you want to display and/or process with formslib.
115  *
116  * You will write your own definition() method which performs the form set up.
117  *
118  * @package   core_form
119  * @copyright 2006 Jamie Pratt <me@jamiep.org>
120  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
121  * @todo      MDL-19380 rethink the file scanning
122  */
123 abstract class moodleform {
124     /** @var string name of the form */
125     protected $_formname;       // form name
127     /** @var MoodleQuickForm quickform object definition */
128     protected $_form;
130     /** @var array globals workaround */
131     protected $_customdata;
133     /** @var object definition_after_data executed flag */
134     protected $_definition_finalized = false;
136     /**
137      * The constructor function calls the abstract function definition() and it will then
138      * process and clean and attempt to validate incoming data.
139      *
140      * It will call your custom validate method to validate data and will also check any rules
141      * you have specified in definition using addRule
142      *
143      * The name of the form (id attribute of the form) is automatically generated depending on
144      * the name you gave the class extending moodleform. You should call your class something
145      * like
146      *
147      * @param mixed $action the action attribute for the form. If empty defaults to auto detect the
148      *              current url. If a moodle_url object then outputs params as hidden variables.
149      * @param mixed $customdata if your form defintion method needs access to data such as $course
150      *              $cm, etc. to construct the form definition then pass it in this array. You can
151      *              use globals for somethings.
152      * @param string $method if you set this to anything other than 'post' then _GET and _POST will
153      *               be merged and used as incoming data to the form.
154      * @param string $target target frame for form submission. You will rarely use this. Don't use
155      *               it if you don't need to as the target attribute is deprecated in xhtml strict.
156      * @param mixed $attributes you can pass a string of html attributes here or an array.
157      * @param bool $editable
158      */
159     function moodleform($action=null, $customdata=null, $method='post', $target='', $attributes=null, $editable=true) {
160         global $CFG, $FULLME;
161         // no standard mform in moodle should allow autocomplete with the exception of user signup
162         if (empty($attributes)) {
163             $attributes = array('autocomplete'=>'off');
164         } else if (is_array($attributes)) {
165             $attributes['autocomplete'] = 'off';
166         } else {
167             if (strpos($attributes, 'autocomplete') === false) {
168                 $attributes .= ' autocomplete="off" ';
169             }
170         }
172         if (empty($action)){
173             // do not rely on PAGE->url here because dev often do not setup $actualurl properly in admin_externalpage_setup()
174             $action = strip_querystring($FULLME);
175             if (!empty($CFG->sslproxy)) {
176                 // return only https links when using SSL proxy
177                 $action = preg_replace('/^http:/', 'https:', $action, 1);
178             }
179             //TODO: use following instead of FULLME - see MDL-33015
180             //$action = strip_querystring(qualified_me());
181         }
182         // Assign custom data first, so that get_form_identifier can use it.
183         $this->_customdata = $customdata;
184         $this->_formname = $this->get_form_identifier();
186         $this->_form = new MoodleQuickForm($this->_formname, $method, $action, $target, $attributes);
187         if (!$editable){
188             $this->_form->hardFreeze();
189         }
191         $this->definition();
193         $this->_form->addElement('hidden', 'sesskey', null); // automatic sesskey protection
194         $this->_form->setType('sesskey', PARAM_RAW);
195         $this->_form->setDefault('sesskey', sesskey());
196         $this->_form->addElement('hidden', '_qf__'.$this->_formname, null);   // form submission marker
197         $this->_form->setType('_qf__'.$this->_formname, PARAM_RAW);
198         $this->_form->setDefault('_qf__'.$this->_formname, 1);
199         $this->_form->_setDefaultRuleMessages();
201         // we have to know all input types before processing submission ;-)
202         $this->_process_submission($method);
203     }
205     /**
206      * It should returns unique identifier for the form.
207      * Currently it will return class name, but in case two same forms have to be
208      * rendered on same page then override function to get unique form identifier.
209      * e.g This is used on multiple self enrollments page.
210      *
211      * @return string form identifier.
212      */
213     protected function get_form_identifier() {
214         return get_class($this);
215     }
217     /**
218      * To autofocus on first form element or first element with error.
219      *
220      * @param string $name if this is set then the focus is forced to a field with this name
221      * @return string javascript to select form element with first error or
222      *                first element if no errors. Use this as a parameter
223      *                when calling print_header
224      */
225     function focus($name=NULL) {
226         $form =& $this->_form;
227         $elkeys = array_keys($form->_elementIndex);
228         $error = false;
229         if (isset($form->_errors) &&  0 != count($form->_errors)){
230             $errorkeys = array_keys($form->_errors);
231             $elkeys = array_intersect($elkeys, $errorkeys);
232             $error = true;
233         }
235         if ($error or empty($name)) {
236             $names = array();
237             while (empty($names) and !empty($elkeys)) {
238                 $el = array_shift($elkeys);
239                 $names = $form->_getElNamesRecursive($el);
240             }
241             if (!empty($names)) {
242                 $name = array_shift($names);
243             }
244         }
246         $focus = '';
247         if (!empty($name)) {
248             $focus = 'forms[\''.$form->getAttribute('id').'\'].elements[\''.$name.'\']';
249         }
251         return $focus;
252      }
254     /**
255      * Internal method. Alters submitted data to be suitable for quickforms processing.
256      * Must be called when the form is fully set up.
257      *
258      * @param string $method name of the method which alters submitted data
259      */
260     function _process_submission($method) {
261         $submission = array();
262         if ($method == 'post') {
263             if (!empty($_POST)) {
264                 $submission = $_POST;
265             }
266         } else {
267             $submission = array_merge_recursive($_GET, $_POST); // emulate handling of parameters in xxxx_param()
268         }
270         // following trick is needed to enable proper sesskey checks when using GET forms
271         // the _qf__.$this->_formname serves as a marker that form was actually submitted
272         if (array_key_exists('_qf__'.$this->_formname, $submission) and $submission['_qf__'.$this->_formname] == 1) {
273             if (!confirm_sesskey()) {
274                 print_error('invalidsesskey');
275             }
276             $files = $_FILES;
277         } else {
278             $submission = array();
279             $files = array();
280         }
281         $this->detectMissingSetType();
283         $this->_form->updateSubmission($submission, $files);
284     }
286     /**
287      * Internal method. Validates all old-style deprecated uploaded files.
288      * The new way is to upload files via repository api.
289      *
290      * @param array $files list of files to be validated
291      * @return bool|array Success or an array of errors
292      */
293     function _validate_files(&$files) {
294         global $CFG, $COURSE;
296         $files = array();
298         if (empty($_FILES)) {
299             // we do not need to do any checks because no files were submitted
300             // note: server side rules do not work for files - use custom verification in validate() instead
301             return true;
302         }
304         $errors = array();
305         $filenames = array();
307         // now check that we really want each file
308         foreach ($_FILES as $elname=>$file) {
309             $required = $this->_form->isElementRequired($elname);
311             if ($file['error'] == 4 and $file['size'] == 0) {
312                 if ($required) {
313                     $errors[$elname] = get_string('required');
314                 }
315                 unset($_FILES[$elname]);
316                 continue;
317             }
319             if (!empty($file['error'])) {
320                 $errors[$elname] = file_get_upload_error($file['error']);
321                 unset($_FILES[$elname]);
322                 continue;
323             }
325             if (!is_uploaded_file($file['tmp_name'])) {
326                 // TODO: improve error message
327                 $errors[$elname] = get_string('error');
328                 unset($_FILES[$elname]);
329                 continue;
330             }
332             if (!$this->_form->elementExists($elname) or !$this->_form->getElementType($elname)=='file') {
333                 // hmm, this file was not requested
334                 unset($_FILES[$elname]);
335                 continue;
336             }
338 /*
339   // TODO: rethink the file scanning MDL-19380
340             if ($CFG->runclamonupload) {
341                 if (!clam_scan_moodle_file($_FILES[$elname], $COURSE)) {
342                     $errors[$elname] = $_FILES[$elname]['uploadlog'];
343                     unset($_FILES[$elname]);
344                     continue;
345                 }
346             }
347 */
348             $filename = clean_param($_FILES[$elname]['name'], PARAM_FILE);
349             if ($filename === '') {
350                 // TODO: improve error message - wrong chars
351                 $errors[$elname] = get_string('error');
352                 unset($_FILES[$elname]);
353                 continue;
354             }
355             if (in_array($filename, $filenames)) {
356                 // TODO: improve error message - duplicate name
357                 $errors[$elname] = get_string('error');
358                 unset($_FILES[$elname]);
359                 continue;
360             }
361             $filenames[] = $filename;
362             $_FILES[$elname]['name'] = $filename;
364             $files[$elname] = $_FILES[$elname]['tmp_name'];
365         }
367         // return errors if found
368         if (count($errors) == 0){
369             return true;
371         } else {
372             $files = array();
373             return $errors;
374         }
375     }
377     /**
378      * Internal method. Validates filepicker and filemanager files if they are
379      * set as required fields. Also, sets the error message if encountered one.
380      *
381      * @return bool|array with errors
382      */
383     protected function validate_draft_files() {
384         global $USER;
385         $mform =& $this->_form;
387         $errors = array();
388         //Go through all the required elements and make sure you hit filepicker or
389         //filemanager element.
390         foreach ($mform->_rules as $elementname => $rules) {
391             $elementtype = $mform->getElementType($elementname);
392             //If element is of type filepicker then do validation
393             if (($elementtype == 'filepicker') || ($elementtype == 'filemanager')){
394                 //Check if rule defined is required rule
395                 foreach ($rules as $rule) {
396                     if ($rule['type'] == 'required') {
397                         $draftid = (int)$mform->getSubmitValue($elementname);
398                         $fs = get_file_storage();
399                         $context = context_user::instance($USER->id);
400                         if (!$files = $fs->get_area_files($context->id, 'user', 'draft', $draftid, 'id DESC', false)) {
401                             $errors[$elementname] = $rule['message'];
402                         }
403                     }
404                 }
405             }
406         }
407         // Check all the filemanager elements to make sure they do not have too many
408         // files in them.
409         foreach ($mform->_elements as $element) {
410             if ($element->_type == 'filemanager') {
411                 $maxfiles = $element->getMaxfiles();
412                 if ($maxfiles > 0) {
413                     $draftid = (int)$element->getValue();
414                     $fs = get_file_storage();
415                     $context = context_user::instance($USER->id);
416                     $files = $fs->get_area_files($context->id, 'user', 'draft', $draftid, '', false);
417                     if (count($files) > $maxfiles) {
418                         $errors[$element->getName()] = get_string('err_maxfiles', 'form', $maxfiles);
419                     }
420                 }
421             }
422         }
423         if (empty($errors)) {
424             return true;
425         } else {
426             return $errors;
427         }
428     }
430     /**
431      * Load in existing data as form defaults. Usually new entry defaults are stored directly in
432      * form definition (new entry form); this function is used to load in data where values
433      * already exist and data is being edited (edit entry form).
434      *
435      * note: $slashed param removed
436      *
437      * @param stdClass|array $default_values object or array of default values
438      */
439     function set_data($default_values) {
440         if (is_object($default_values)) {
441             $default_values = (array)$default_values;
442         }
443         $this->_form->setDefaults($default_values);
444     }
446     /**
447      * Check that form was submitted. Does not check validity of submitted data.
448      *
449      * @return bool true if form properly submitted
450      */
451     function is_submitted() {
452         return $this->_form->isSubmitted();
453     }
455     /**
456      * Checks if button pressed is not for submitting the form
457      *
458      * @staticvar bool $nosubmit keeps track of no submit button
459      * @return bool
460      */
461     function no_submit_button_pressed(){
462         static $nosubmit = null; // one check is enough
463         if (!is_null($nosubmit)){
464             return $nosubmit;
465         }
466         $mform =& $this->_form;
467         $nosubmit = false;
468         if (!$this->is_submitted()){
469             return false;
470         }
471         foreach ($mform->_noSubmitButtons as $nosubmitbutton){
472             if (optional_param($nosubmitbutton, 0, PARAM_RAW)){
473                 $nosubmit = true;
474                 break;
475             }
476         }
477         return $nosubmit;
478     }
481     /**
482      * Check that form data is valid.
483      * You should almost always use this, rather than {@link validate_defined_fields}
484      *
485      * @return bool true if form data valid
486      */
487     function is_validated() {
488         //finalize the form definition before any processing
489         if (!$this->_definition_finalized) {
490             $this->_definition_finalized = true;
491             $this->definition_after_data();
492         }
494         return $this->validate_defined_fields();
495     }
497     /**
498      * Validate the form.
499      *
500      * You almost always want to call {@link is_validated} instead of this
501      * because it calls {@link definition_after_data} first, before validating the form,
502      * which is what you want in 99% of cases.
503      *
504      * This is provided as a separate function for those special cases where
505      * you want the form validated before definition_after_data is called
506      * for example, to selectively add new elements depending on a no_submit_button press,
507      * but only when the form is valid when the no_submit_button is pressed,
508      *
509      * @param bool $validateonnosubmit optional, defaults to false.  The default behaviour
510      *             is NOT to validate the form when a no submit button has been pressed.
511      *             pass true here to override this behaviour
512      *
513      * @return bool true if form data valid
514      */
515     function validate_defined_fields($validateonnosubmit=false) {
516         static $validated = null; // one validation is enough
517         $mform =& $this->_form;
518         if ($this->no_submit_button_pressed() && empty($validateonnosubmit)){
519             return false;
520         } elseif ($validated === null) {
521             $internal_val = $mform->validate();
523             $files = array();
524             $file_val = $this->_validate_files($files);
525             //check draft files for validation and flag them if required files
526             //are not in draft area.
527             $draftfilevalue = $this->validate_draft_files();
529             if ($file_val !== true && $draftfilevalue !== true) {
530                 $file_val = array_merge($file_val, $draftfilevalue);
531             } else if ($draftfilevalue !== true) {
532                 $file_val = $draftfilevalue;
533             } //default is file_val, so no need to assign.
535             if ($file_val !== true) {
536                 if (!empty($file_val)) {
537                     foreach ($file_val as $element=>$msg) {
538                         $mform->setElementError($element, $msg);
539                     }
540                 }
541                 $file_val = false;
542             }
544             $data = $mform->exportValues();
545             $moodle_val = $this->validation($data, $files);
546             if ((is_array($moodle_val) && count($moodle_val)!==0)) {
547                 // non-empty array means errors
548                 foreach ($moodle_val as $element=>$msg) {
549                     $mform->setElementError($element, $msg);
550                 }
551                 $moodle_val = false;
553             } else {
554                 // anything else means validation ok
555                 $moodle_val = true;
556             }
558             $validated = ($internal_val and $moodle_val and $file_val);
559         }
560         return $validated;
561     }
563     /**
564      * Return true if a cancel button has been pressed resulting in the form being submitted.
565      *
566      * @return bool true if a cancel button has been pressed
567      */
568     function is_cancelled(){
569         $mform =& $this->_form;
570         if ($mform->isSubmitted()){
571             foreach ($mform->_cancelButtons as $cancelbutton){
572                 if (optional_param($cancelbutton, 0, PARAM_RAW)){
573                     return true;
574                 }
575             }
576         }
577         return false;
578     }
580     /**
581      * Return submitted data if properly submitted or returns NULL if validation fails or
582      * if there is no submitted data.
583      *
584      * note: $slashed param removed
585      *
586      * @return object submitted data; NULL if not valid or not submitted or cancelled
587      */
588     function get_data() {
589         $mform =& $this->_form;
591         if (!$this->is_cancelled() and $this->is_submitted() and $this->is_validated()) {
592             $data = $mform->exportValues();
593             unset($data['sesskey']); // we do not need to return sesskey
594             unset($data['_qf__'.$this->_formname]);   // we do not need the submission marker too
595             if (empty($data)) {
596                 return NULL;
597             } else {
598                 return (object)$data;
599             }
600         } else {
601             return NULL;
602         }
603     }
605     /**
606      * Return submitted data without validation or NULL if there is no submitted data.
607      * note: $slashed param removed
608      *
609      * @return object submitted data; NULL if not submitted
610      */
611     function get_submitted_data() {
612         $mform =& $this->_form;
614         if ($this->is_submitted()) {
615             $data = $mform->exportValues();
616             unset($data['sesskey']); // we do not need to return sesskey
617             unset($data['_qf__'.$this->_formname]);   // we do not need the submission marker too
618             if (empty($data)) {
619                 return NULL;
620             } else {
621                 return (object)$data;
622             }
623         } else {
624             return NULL;
625         }
626     }
628     /**
629      * Save verified uploaded files into directory. Upload process can be customised from definition()
630      *
631      * @deprecated since Moodle 2.0
632      * @todo MDL-31294 remove this api
633      * @see moodleform::save_stored_file()
634      * @see moodleform::save_file()
635      * @param string $destination path where file should be stored
636      * @return bool Always false
637      */
638     function save_files($destination) {
639         debugging('Not used anymore, please fix code! Use save_stored_file() or save_file() instead');
640         return false;
641     }
643     /**
644      * Returns name of uploaded file.
645      *
646      * @param string $elname first element if null
647      * @return string|bool false in case of failure, string if ok
648      */
649     function get_new_filename($elname=null) {
650         global $USER;
652         if (!$this->is_submitted() or !$this->is_validated()) {
653             return false;
654         }
656         if (is_null($elname)) {
657             if (empty($_FILES)) {
658                 return false;
659             }
660             reset($_FILES);
661             $elname = key($_FILES);
662         }
664         if (empty($elname)) {
665             return false;
666         }
668         $element = $this->_form->getElement($elname);
670         if ($element instanceof MoodleQuickForm_filepicker || $element instanceof MoodleQuickForm_filemanager) {
671             $values = $this->_form->exportValues($elname);
672             if (empty($values[$elname])) {
673                 return false;
674             }
675             $draftid = $values[$elname];
676             $fs = get_file_storage();
677             $context = context_user::instance($USER->id);
678             if (!$files = $fs->get_area_files($context->id, 'user', 'draft', $draftid, 'id DESC', false)) {
679                 return false;
680             }
681             $file = reset($files);
682             return $file->get_filename();
683         }
685         if (!isset($_FILES[$elname])) {
686             return false;
687         }
689         return $_FILES[$elname]['name'];
690     }
692     /**
693      * Save file to standard filesystem
694      *
695      * @param string $elname name of element
696      * @param string $pathname full path name of file
697      * @param bool $override override file if exists
698      * @return bool success
699      */
700     function save_file($elname, $pathname, $override=false) {
701         global $USER;
703         if (!$this->is_submitted() or !$this->is_validated()) {
704             return false;
705         }
706         if (file_exists($pathname)) {
707             if ($override) {
708                 if (!@unlink($pathname)) {
709                     return false;
710                 }
711             } else {
712                 return false;
713             }
714         }
716         $element = $this->_form->getElement($elname);
718         if ($element instanceof MoodleQuickForm_filepicker || $element instanceof MoodleQuickForm_filemanager) {
719             $values = $this->_form->exportValues($elname);
720             if (empty($values[$elname])) {
721                 return false;
722             }
723             $draftid = $values[$elname];
724             $fs = get_file_storage();
725             $context = context_user::instance($USER->id);
726             if (!$files = $fs->get_area_files($context->id, 'user', 'draft', $draftid, 'id DESC', false)) {
727                 return false;
728             }
729             $file = reset($files);
731             return $file->copy_content_to($pathname);
733         } else if (isset($_FILES[$elname])) {
734             return copy($_FILES[$elname]['tmp_name'], $pathname);
735         }
737         return false;
738     }
740     /**
741      * Returns a temporary file, do not forget to delete after not needed any more.
742      *
743      * @param string $elname name of the elmenet
744      * @return string|bool either string or false
745      */
746     function save_temp_file($elname) {
747         if (!$this->get_new_filename($elname)) {
748             return false;
749         }
750         if (!$dir = make_temp_directory('forms')) {
751             return false;
752         }
753         if (!$tempfile = tempnam($dir, 'tempup_')) {
754             return false;
755         }
756         if (!$this->save_file($elname, $tempfile, true)) {
757             // something went wrong
758             @unlink($tempfile);
759             return false;
760         }
762         return $tempfile;
763     }
765     /**
766      * Get draft files of a form element
767      * This is a protected method which will be used only inside moodleforms
768      *
769      * @param string $elname name of element
770      * @return array|bool|null
771      */
772     protected function get_draft_files($elname) {
773         global $USER;
775         if (!$this->is_submitted()) {
776             return false;
777         }
779         $element = $this->_form->getElement($elname);
781         if ($element instanceof MoodleQuickForm_filepicker || $element instanceof MoodleQuickForm_filemanager) {
782             $values = $this->_form->exportValues($elname);
783             if (empty($values[$elname])) {
784                 return false;
785             }
786             $draftid = $values[$elname];
787             $fs = get_file_storage();
788             $context = context_user::instance($USER->id);
789             if (!$files = $fs->get_area_files($context->id, 'user', 'draft', $draftid, 'id DESC', false)) {
790                 return null;
791             }
792             return $files;
793         }
794         return null;
795     }
797     /**
798      * Save file to local filesystem pool
799      *
800      * @param string $elname name of element
801      * @param int $newcontextid id of context
802      * @param string $newcomponent name of the component
803      * @param string $newfilearea name of file area
804      * @param int $newitemid item id
805      * @param string $newfilepath path of file where it get stored
806      * @param string $newfilename use specified filename, if not specified name of uploaded file used
807      * @param bool $overwrite overwrite file if exists
808      * @param int $newuserid new userid if required
809      * @return mixed stored_file object or false if error; may throw exception if duplicate found
810      */
811     function save_stored_file($elname, $newcontextid, $newcomponent, $newfilearea, $newitemid, $newfilepath='/',
812                               $newfilename=null, $overwrite=false, $newuserid=null) {
813         global $USER;
815         if (!$this->is_submitted() or !$this->is_validated()) {
816             return false;
817         }
819         if (empty($newuserid)) {
820             $newuserid = $USER->id;
821         }
823         $element = $this->_form->getElement($elname);
824         $fs = get_file_storage();
826         if ($element instanceof MoodleQuickForm_filepicker) {
827             $values = $this->_form->exportValues($elname);
828             if (empty($values[$elname])) {
829                 return false;
830             }
831             $draftid = $values[$elname];
832             $context = context_user::instance($USER->id);
833             if (!$files = $fs->get_area_files($context->id, 'user' ,'draft', $draftid, 'id DESC', false)) {
834                 return false;
835             }
836             $file = reset($files);
837             if (is_null($newfilename)) {
838                 $newfilename = $file->get_filename();
839             }
841             if ($overwrite) {
842                 if ($oldfile = $fs->get_file($newcontextid, $newcomponent, $newfilearea, $newitemid, $newfilepath, $newfilename)) {
843                     if (!$oldfile->delete()) {
844                         return false;
845                     }
846                 }
847             }
849             $file_record = array('contextid'=>$newcontextid, 'component'=>$newcomponent, 'filearea'=>$newfilearea, 'itemid'=>$newitemid,
850                                  'filepath'=>$newfilepath, 'filename'=>$newfilename, 'userid'=>$newuserid);
851             return $fs->create_file_from_storedfile($file_record, $file);
853         } else if (isset($_FILES[$elname])) {
854             $filename = is_null($newfilename) ? $_FILES[$elname]['name'] : $newfilename;
856             if ($overwrite) {
857                 if ($oldfile = $fs->get_file($newcontextid, $newcomponent, $newfilearea, $newitemid, $newfilepath, $newfilename)) {
858                     if (!$oldfile->delete()) {
859                         return false;
860                     }
861                 }
862             }
864             $file_record = array('contextid'=>$newcontextid, 'component'=>$newcomponent, 'filearea'=>$newfilearea, 'itemid'=>$newitemid,
865                                  'filepath'=>$newfilepath, 'filename'=>$newfilename, 'userid'=>$newuserid);
866             return $fs->create_file_from_pathname($file_record, $_FILES[$elname]['tmp_name']);
867         }
869         return false;
870     }
872     /**
873      * Get content of uploaded file.
874      *
875      * @param string $elname name of file upload element
876      * @return string|bool false in case of failure, string if ok
877      */
878     function get_file_content($elname) {
879         global $USER;
881         if (!$this->is_submitted() or !$this->is_validated()) {
882             return false;
883         }
885         $element = $this->_form->getElement($elname);
887         if ($element instanceof MoodleQuickForm_filepicker || $element instanceof MoodleQuickForm_filemanager) {
888             $values = $this->_form->exportValues($elname);
889             if (empty($values[$elname])) {
890                 return false;
891             }
892             $draftid = $values[$elname];
893             $fs = get_file_storage();
894             $context = context_user::instance($USER->id);
895             if (!$files = $fs->get_area_files($context->id, 'user', 'draft', $draftid, 'id DESC', false)) {
896                 return false;
897             }
898             $file = reset($files);
900             return $file->get_content();
902         } else if (isset($_FILES[$elname])) {
903             return file_get_contents($_FILES[$elname]['tmp_name']);
904         }
906         return false;
907     }
909     /**
910      * Print html form.
911      */
912     function display() {
913         //finalize the form definition if not yet done
914         if (!$this->_definition_finalized) {
915             $this->_definition_finalized = true;
916             $this->definition_after_data();
917         }
919         $this->detectMissingSetType();
921         $this->_form->display();
922     }
924     /**
925      * Renders the html form (same as display, but returns the result).
926      *
927      * Note that you can only output this rendered result once per page, as
928      * it contains IDs which must be unique.
929      *
930      * @return string HTML code for the form
931      */
932     public function render() {
933         ob_start();
934         $this->display();
935         $out = ob_get_contents();
936         ob_end_clean();
937         return $out;
938     }
940     /**
941      * Form definition. Abstract method - always override!
942      */
943     protected abstract function definition();
945     /**
946      * Dummy stub method - override if you need to setup the form depending on current
947      * values. This method is called after definition(), data submission and set_data().
948      * All form setup that is dependent on form values should go in here.
949      */
950     function definition_after_data(){
951     }
953     /**
954      * Dummy stub method - override if you needed to perform some extra validation.
955      * If there are errors return array of errors ("fieldname"=>"error message"),
956      * otherwise true if ok.
957      *
958      * Server side rules do not work for uploaded files, implement serverside rules here if needed.
959      *
960      * @param array $data array of ("fieldname"=>value) of submitted data
961      * @param array $files array of uploaded files "element_name"=>tmp_file_path
962      * @return array of "element_name"=>"error_description" if there are errors,
963      *         or an empty array if everything is OK (true allowed for backwards compatibility too).
964      */
965     function validation($data, $files) {
966         return array();
967     }
969     /**
970      * Helper used by {@link repeat_elements()}.
971      *
972      * @param int $i the index of this element.
973      * @param HTML_QuickForm_element $elementclone
974      * @param array $namecloned array of names
975      */
976     function repeat_elements_fix_clone($i, $elementclone, &$namecloned) {
977         $name = $elementclone->getName();
978         $namecloned[] = $name;
980         if (!empty($name)) {
981             $elementclone->setName($name."[$i]");
982         }
984         if (is_a($elementclone, 'HTML_QuickForm_header')) {
985             $value = $elementclone->_text;
986             $elementclone->setValue(str_replace('{no}', ($i+1), $value));
988         } else if (is_a($elementclone, 'HTML_QuickForm_submit') || is_a($elementclone, 'HTML_QuickForm_button')) {
989             $elementclone->setValue(str_replace('{no}', ($i+1), $elementclone->getValue()));
991         } else {
992             $value=$elementclone->getLabel();
993             $elementclone->setLabel(str_replace('{no}', ($i+1), $value));
994         }
995     }
997     /**
998      * Method to add a repeating group of elements to a form.
999      *
1000      * @param array $elementobjs Array of elements or groups of elements that are to be repeated
1001      * @param int $repeats no of times to repeat elements initially
1002      * @param array $options Array of options to apply to elements. Array keys are element names.
1003      *     This is an array of arrays. The second sets of keys are the option types for the elements :
1004      *         'default' - default value is value
1005      *         'type' - PARAM_* constant is value
1006      *         'helpbutton' - helpbutton params array is value
1007      *         'disabledif' - last three moodleform::disabledIf()
1008      *         params are value as an array
1009      * @param string $repeathiddenname name for hidden element storing no of repeats in this form
1010      * @param string $addfieldsname name for button to add more fields
1011      * @param int $addfieldsno how many fields to add at a time
1012      * @param string $addstring name of button, {no} is replaced by no of blanks that will be added.
1013      * @param bool $addbuttoninside if true, don't call closeHeaderBefore($addfieldsname). Default false.
1014      * @return int no of repeats of element in this page
1015      */
1016     function repeat_elements($elementobjs, $repeats, $options, $repeathiddenname,
1017             $addfieldsname, $addfieldsno=5, $addstring=null, $addbuttoninside=false){
1018         if ($addstring===null){
1019             $addstring = get_string('addfields', 'form', $addfieldsno);
1020         } else {
1021             $addstring = str_ireplace('{no}', $addfieldsno, $addstring);
1022         }
1023         $repeats = optional_param($repeathiddenname, $repeats, PARAM_INT);
1024         $addfields = optional_param($addfieldsname, '', PARAM_TEXT);
1025         if (!empty($addfields)){
1026             $repeats += $addfieldsno;
1027         }
1028         $mform =& $this->_form;
1029         $mform->registerNoSubmitButton($addfieldsname);
1030         $mform->addElement('hidden', $repeathiddenname, $repeats);
1031         $mform->setType($repeathiddenname, PARAM_INT);
1032         //value not to be overridden by submitted value
1033         $mform->setConstants(array($repeathiddenname=>$repeats));
1034         $namecloned = array();
1035         for ($i = 0; $i < $repeats; $i++) {
1036             foreach ($elementobjs as $elementobj){
1037                 $elementclone = fullclone($elementobj);
1038                 $this->repeat_elements_fix_clone($i, $elementclone, $namecloned);
1040                 if ($elementclone instanceof HTML_QuickForm_group && !$elementclone->_appendName) {
1041                     foreach ($elementclone->getElements() as $el) {
1042                         $this->repeat_elements_fix_clone($i, $el, $namecloned);
1043                     }
1044                     $elementclone->setLabel(str_replace('{no}', $i + 1, $elementclone->getLabel()));
1045                 }
1047                 $mform->addElement($elementclone);
1048             }
1049         }
1050         for ($i=0; $i<$repeats; $i++) {
1051             foreach ($options as $elementname => $elementoptions){
1052                 $pos=strpos($elementname, '[');
1053                 if ($pos!==FALSE){
1054                     $realelementname = substr($elementname, 0, $pos)."[$i]";
1055                     $realelementname .= substr($elementname, $pos);
1056                 }else {
1057                     $realelementname = $elementname."[$i]";
1058                 }
1059                 foreach ($elementoptions as  $option => $params){
1061                     switch ($option){
1062                         case 'default' :
1063                             $mform->setDefault($realelementname, str_replace('{no}', $i + 1, $params));
1064                             break;
1065                         case 'helpbutton' :
1066                             $params = array_merge(array($realelementname), $params);
1067                             call_user_func_array(array(&$mform, 'addHelpButton'), $params);
1068                             break;
1069                         case 'disabledif' :
1070                             foreach ($namecloned as $num => $name){
1071                                 if ($params[0] == $name){
1072                                     $params[0] = $params[0]."[$i]";
1073                                     break;
1074                                 }
1075                             }
1076                             $params = array_merge(array($realelementname), $params);
1077                             call_user_func_array(array(&$mform, 'disabledIf'), $params);
1078                             break;
1079                         case 'rule' :
1080                             if (is_string($params)){
1081                                 $params = array(null, $params, null, 'client');
1082                             }
1083                             $params = array_merge(array($realelementname), $params);
1084                             call_user_func_array(array(&$mform, 'addRule'), $params);
1085                             break;
1086                         case 'type' :
1087                             //Type should be set only once
1088                             if (!isset($mform->_types[$elementname])) {
1089                                 $mform->setType($elementname, $params);
1090                             }
1091                             break;
1093                         case 'expanded':
1094                             $mform->setExpanded($realelementname, $params);
1095                             break;
1097                         case 'advanced' :
1098                             $mform->setAdvanced($realelementname, $params);
1099                             break;
1100                     }
1101                 }
1102             }
1103         }
1104         $mform->addElement('submit', $addfieldsname, $addstring);
1106         if (!$addbuttoninside) {
1107             $mform->closeHeaderBefore($addfieldsname);
1108         }
1110         return $repeats;
1111     }
1113     /**
1114      * Adds a link/button that controls the checked state of a group of checkboxes.
1115      *
1116      * @param int $groupid The id of the group of advcheckboxes this element controls
1117      * @param string $text The text of the link. Defaults to selectallornone ("select all/none")
1118      * @param array $attributes associative array of HTML attributes
1119      * @param int $originalValue The original general state of the checkboxes before the user first clicks this element
1120      */
1121     function add_checkbox_controller($groupid, $text = null, $attributes = null, $originalValue = 0) {
1122         global $CFG, $PAGE;
1124         // Name of the controller button
1125         $checkboxcontrollername = 'nosubmit_checkbox_controller' . $groupid;
1126         $checkboxcontrollerparam = 'checkbox_controller'. $groupid;
1127         $checkboxgroupclass = 'checkboxgroup'.$groupid;
1129         // Set the default text if none was specified
1130         if (empty($text)) {
1131             $text = get_string('selectallornone', 'form');
1132         }
1134         $mform = $this->_form;
1135         $selectvalue = optional_param($checkboxcontrollerparam, null, PARAM_INT);
1136         $contollerbutton = optional_param($checkboxcontrollername, null, PARAM_ALPHAEXT);
1138         $newselectvalue = $selectvalue;
1139         if (is_null($selectvalue)) {
1140             $newselectvalue = $originalValue;
1141         } else if (!is_null($contollerbutton)) {
1142             $newselectvalue = (int) !$selectvalue;
1143         }
1144         // set checkbox state depending on orignal/submitted value by controoler button
1145         if (!is_null($contollerbutton) || is_null($selectvalue)) {
1146             foreach ($mform->_elements as $element) {
1147                 if (($element instanceof MoodleQuickForm_advcheckbox) &&
1148                         $element->getAttribute('class') == $checkboxgroupclass &&
1149                         !$element->isFrozen()) {
1150                     $mform->setConstants(array($element->getName() => $newselectvalue));
1151                 }
1152             }
1153         }
1155         $mform->addElement('hidden', $checkboxcontrollerparam, $newselectvalue, array('id' => "id_".$checkboxcontrollerparam));
1156         $mform->setType($checkboxcontrollerparam, PARAM_INT);
1157         $mform->setConstants(array($checkboxcontrollerparam => $newselectvalue));
1159         $PAGE->requires->yui_module('moodle-form-checkboxcontroller', 'M.form.checkboxcontroller',
1160                 array(
1161                     array('groupid' => $groupid,
1162                         'checkboxclass' => $checkboxgroupclass,
1163                         'checkboxcontroller' => $checkboxcontrollerparam,
1164                         'controllerbutton' => $checkboxcontrollername)
1165                     )
1166                 );
1168         require_once("$CFG->libdir/form/submit.php");
1169         $submitlink = new MoodleQuickForm_submit($checkboxcontrollername, $attributes);
1170         $mform->addElement($submitlink);
1171         $mform->registerNoSubmitButton($checkboxcontrollername);
1172         $mform->setDefault($checkboxcontrollername, $text);
1173     }
1175     /**
1176      * Use this method to a cancel and submit button to the end of your form. Pass a param of false
1177      * if you don't want a cancel button in your form. If you have a cancel button make sure you
1178      * check for it being pressed using is_cancelled() and redirecting if it is true before trying to
1179      * get data with get_data().
1180      *
1181      * @param bool $cancel whether to show cancel button, default true
1182      * @param string $submitlabel label for submit button, defaults to get_string('savechanges')
1183      */
1184     function add_action_buttons($cancel = true, $submitlabel=null){
1185         if (is_null($submitlabel)){
1186             $submitlabel = get_string('savechanges');
1187         }
1188         $mform =& $this->_form;
1189         if ($cancel){
1190             //when two elements we need a group
1191             $buttonarray=array();
1192             $buttonarray[] = &$mform->createElement('submit', 'submitbutton', $submitlabel);
1193             $buttonarray[] = &$mform->createElement('cancel');
1194             $mform->addGroup($buttonarray, 'buttonar', '', array(' '), false);
1195             $mform->closeHeaderBefore('buttonar');
1196         } else {
1197             //no group needed
1198             $mform->addElement('submit', 'submitbutton', $submitlabel);
1199             $mform->closeHeaderBefore('submitbutton');
1200         }
1201     }
1203     /**
1204      * Adds an initialisation call for a standard JavaScript enhancement.
1205      *
1206      * This function is designed to add an initialisation call for a JavaScript
1207      * enhancement that should exist within javascript-static M.form.init_{enhancementname}.
1208      *
1209      * Current options:
1210      *  - Selectboxes
1211      *      - smartselect:  Turns a nbsp indented select box into a custom drop down
1212      *                      control that supports multilevel and category selection.
1213      *                      $enhancement = 'smartselect';
1214      *                      $options = array('selectablecategories' => true|false)
1215      *
1216      * @since Moodle 2.0
1217      * @param string|element $element form element for which Javascript needs to be initalized
1218      * @param string $enhancement which init function should be called
1219      * @param array $options options passed to javascript
1220      * @param array $strings strings for javascript
1221      */
1222     function init_javascript_enhancement($element, $enhancement, array $options=array(), array $strings=null) {
1223         global $PAGE;
1224         if (is_string($element)) {
1225             $element = $this->_form->getElement($element);
1226         }
1227         if (is_object($element)) {
1228             $element->_generateId();
1229             $elementid = $element->getAttribute('id');
1230             $PAGE->requires->js_init_call('M.form.init_'.$enhancement, array($elementid, $options));
1231             if (is_array($strings)) {
1232                 foreach ($strings as $string) {
1233                     if (is_array($string)) {
1234                         call_user_method_array('string_for_js', $PAGE->requires, $string);
1235                     } else {
1236                         $PAGE->requires->string_for_js($string, 'moodle');
1237                     }
1238                 }
1239             }
1240         }
1241     }
1243     /**
1244      * Returns a JS module definition for the mforms JS
1245      *
1246      * @return array
1247      */
1248     public static function get_js_module() {
1249         global $CFG;
1250         return array(
1251             'name' => 'mform',
1252             'fullpath' => '/lib/form/form.js',
1253             'requires' => array('base', 'node')
1254         );
1255     }
1257     /**
1258      * Detects elements with missing setType() declerations.
1259      *
1260      * Finds elements in the form which should a PARAM_ type set and throws a
1261      * developer debug warning for any elements without it. This is to reduce the
1262      * risk of potential security issues by developers mistakenly forgetting to set
1263      * the type.
1264      *
1265      * @return void
1266      */
1267     private function detectMissingSetType() {
1268         if (!debugging('', DEBUG_DEVELOPER)) {
1269             // Only for devs.
1270             return;
1271         }
1273         $mform = $this->_form;
1274         foreach ($mform->_elements as $element) {
1275             switch ($element->getType()) {
1276                 case 'hidden':
1277                 case 'text':
1278                 case 'url':
1279                     $key = $element->getName();
1280                     // For repeated elements we need to look for
1281                     // the "main" type, not for the one present
1282                     // on each repetition. All the stuff in formslib
1283                     // (repeat_elements(), updateSubmission()... seems
1284                     // to work that way.
1285                     $pos = strpos($key, '[');
1286                     if ($pos !== false) {
1287                         $key = substr($key, 0, $pos);
1288                     }
1289                     if (!array_key_exists($key, $mform->_types)) {
1290                         debugging("Did you remember to call setType() for '$key'? ".
1291                             'Defaulting to PARAM_RAW cleaning.', DEBUG_DEVELOPER);
1292                     }
1293                     break;
1294             }
1295         }
1296     }
1299 /**
1300  * MoodleQuickForm implementation
1301  *
1302  * You never extend this class directly. The class methods of this class are available from
1303  * the private $this->_form property on moodleform and its children. You generally only
1304  * call methods on this class from within abstract methods that you override on moodleform such
1305  * as definition and definition_after_data
1306  *
1307  * @package   core_form
1308  * @category  form
1309  * @copyright 2006 Jamie Pratt <me@jamiep.org>
1310  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1311  */
1312 class MoodleQuickForm extends HTML_QuickForm_DHTMLRulesTableless {
1313     /** @var array type (PARAM_INT, PARAM_TEXT etc) of element value */
1314     var $_types = array();
1316     /** @var array dependent state for the element/'s */
1317     var $_dependencies = array();
1319     /** @var array Array of buttons that if pressed do not result in the processing of the form. */
1320     var $_noSubmitButtons=array();
1322     /** @var array Array of buttons that if pressed do not result in the processing of the form. */
1323     var $_cancelButtons=array();
1325     /** @var array Array whose keys are element names. If the key exists this is a advanced element */
1326     var $_advancedElements = array();
1328     /**
1329      * Array whose keys are element names and values are the desired collapsible state.
1330      * True for collapsed, False for expanded. If not present, set to default in
1331      * {@link self::accept()}.
1332      *
1333      * @var array
1334      */
1335     var $_collapsibleElements = array();
1337     /**
1338      * Whether to enable shortforms for this form
1339      *
1340      * @var boolean
1341      */
1342     var $_disableShortforms = false;
1344     /** @var bool whether to automatically initialise M.formchangechecker for this form. */
1345     protected $_use_form_change_checker = true;
1347     /**
1348      * The form name is derived from the class name of the wrapper minus the trailing form
1349      * It is a name with words joined by underscores whereas the id attribute is words joined by underscores.
1350      * @var string
1351      */
1352     var $_formName = '';
1354     /**
1355      * String with the html for hidden params passed in as part of a moodle_url
1356      * object for the action. Output in the form.
1357      * @var string
1358      */
1359     var $_pageparams = '';
1361     /**
1362      * Class constructor - same parameters as HTML_QuickForm_DHTMLRulesTableless
1363      *
1364      * @staticvar int $formcounter counts number of forms
1365      * @param string $formName Form's name.
1366      * @param string $method Form's method defaults to 'POST'
1367      * @param string|moodle_url $action Form's action
1368      * @param string $target (optional)Form's target defaults to none
1369      * @param mixed $attributes (optional)Extra attributes for <form> tag
1370      */
1371     function MoodleQuickForm($formName, $method, $action, $target='', $attributes=null){
1372         global $CFG, $OUTPUT;
1374         static $formcounter = 1;
1376         HTML_Common::HTML_Common($attributes);
1377         $target = empty($target) ? array() : array('target' => $target);
1378         $this->_formName = $formName;
1379         if (is_a($action, 'moodle_url')){
1380             $this->_pageparams = html_writer::input_hidden_params($action);
1381             $action = $action->out_omit_querystring();
1382         } else {
1383             $this->_pageparams = '';
1384         }
1385         // No 'name' atttribute for form in xhtml strict :
1386         $attributes = array('action' => $action, 'method' => $method, 'accept-charset' => 'utf-8') + $target;
1387         if (is_null($this->getAttribute('id'))) {
1388             $attributes['id'] = 'mform' . $formcounter;
1389         }
1390         $formcounter++;
1391         $this->updateAttributes($attributes);
1393         // This is custom stuff for Moodle :
1394         $oldclass=   $this->getAttribute('class');
1395         if (!empty($oldclass)){
1396             $this->updateAttributes(array('class'=>$oldclass.' mform'));
1397         }else {
1398             $this->updateAttributes(array('class'=>'mform'));
1399         }
1400         $this->_reqHTML = '<img class="req" title="'.get_string('requiredelement', 'form').'" alt="'.get_string('requiredelement', 'form').'" src="'.$OUTPUT->pix_url('req') .'" />';
1401         $this->_advancedHTML = '<img class="adv" title="'.get_string('advancedelement', 'form').'" alt="'.get_string('advancedelement', 'form').'" src="'.$OUTPUT->pix_url('adv') .'" />';
1402         $this->setRequiredNote(get_string('somefieldsrequired', 'form', '<img alt="'.get_string('requiredelement', 'form').'" src="'.$OUTPUT->pix_url('req') .'" />'));
1403     }
1405     /**
1406      * Use this method to indicate an element in a form is an advanced field. If items in a form
1407      * are marked as advanced then 'Hide/Show Advanced' buttons will automatically be displayed in the
1408      * form so the user can decide whether to display advanced form controls.
1409      *
1410      * If you set a header element to advanced then all elements it contains will also be set as advanced.
1411      *
1412      * @param string $elementName group or element name (not the element name of something inside a group).
1413      * @param bool $advanced default true sets the element to advanced. False removes advanced mark.
1414      */
1415     function setAdvanced($elementName, $advanced = true) {
1416         if ($advanced){
1417             $this->_advancedElements[$elementName]='';
1418         } elseif (isset($this->_advancedElements[$elementName])) {
1419             unset($this->_advancedElements[$elementName]);
1420         }
1421     }
1423     /**
1424      * Use this method to indicate that the fieldset should be shown as expanded.
1425      * The method is applicable to header elements only.
1426      *
1427      * @param string $headername header element name
1428      * @param boolean $expanded default true sets the element to expanded. False makes the element collapsed.
1429      * @param boolean $ignoreuserstate override the state regardless of the state it was on when
1430      *                                 the form was submitted.
1431      * @return void
1432      */
1433     function setExpanded($headername, $expanded = true, $ignoreuserstate = false) {
1434         if (empty($headername)) {
1435             return;
1436         }
1437         $element = $this->getElement($headername);
1438         if ($element->getType() != 'header') {
1439             debugging('Cannot use setExpanded on non-header elements', DEBUG_DEVELOPER);
1440             return;
1441         }
1442         if (!$headerid = $element->getAttribute('id')) {
1443             $element->_generateId();
1444             $headerid = $element->getAttribute('id');
1445         }
1446         if ($this->getElementType('mform_isexpanded_' . $headerid) === false) {
1447             // See if the form has been submitted already.
1448             $formexpanded = optional_param('mform_isexpanded_' . $headerid, -1, PARAM_INT);
1449             if (!$ignoreuserstate && $formexpanded != -1) {
1450                 // Override expanded state with the form variable.
1451                 $expanded = $formexpanded;
1452             }
1453             // Create the form element for storing expanded state.
1454             $this->addElement('hidden', 'mform_isexpanded_' . $headerid);
1455             $this->setType('mform_isexpanded_' . $headerid, PARAM_INT);
1456             $this->setConstant('mform_isexpanded_' . $headerid, (int) $expanded);
1457         }
1458         $this->_collapsibleElements[$headername] = !$expanded;
1459     }
1461     /**
1462      * Use this method to add show more/less status element required for passing
1463      * over the advanced elements visibility status on the form submission.
1464      *
1465      * @param string $headerName header element name.
1466      * @param boolean $showmore default false sets the advanced elements to be hidden.
1467      */
1468     function addAdvancedStatusElement($headerid, $showmore=false){
1469         // Add extra hidden element to store advanced items state for each section.
1470         if ($this->getElementType('mform_showmore_' . $headerid) === false) {
1471             // See if we the form has been submitted already.
1472             $formshowmore = optional_param('mform_showmore_' . $headerid, -1, PARAM_INT);
1473             if (!$showmore && $formshowmore != -1) {
1474                 // Override showmore state with the form variable.
1475                 $showmore = $formshowmore;
1476             }
1477             // Create the form element for storing advanced items state.
1478             $this->addElement('hidden', 'mform_showmore_' . $headerid);
1479             $this->setType('mform_showmore_' . $headerid, PARAM_INT);
1480             $this->setConstant('mform_showmore_' . $headerid, (int)$showmore);
1481         }
1482     }
1484     /**
1485      * This function has been deprecated. Show advanced has been replaced by
1486      * "Show more.../Show less..." in the shortforms javascript module.
1487      *
1488      * @deprecated since Moodle 2.5
1489      * @param bool $showadvancedNow if true will show advanced elements.
1490       */
1491     function setShowAdvanced($showadvancedNow = null){
1492         debugging('Call to deprecated function setShowAdvanced. See "Show more.../Show less..." in shortforms yui module.');
1493     }
1495     /**
1496      * This function has been deprecated. Show advanced has been replaced by
1497      * "Show more.../Show less..." in the shortforms javascript module.
1498      *
1499      * @deprecated since Moodle 2.5
1500      * @return bool (Always false)
1501       */
1502     function getShowAdvanced(){
1503         debugging('Call to deprecated function setShowAdvanced. See "Show more.../Show less..." in shortforms yui module.');
1504         return false;
1505     }
1507     /**
1508      * Use this method to indicate that the form will not be using shortforms.
1509      *
1510      * @param boolean $disable default true, controls if the shortforms are disabled.
1511      */
1512     function setDisableShortforms ($disable = true) {
1513         $this->_disableShortforms = $disable;
1514     }
1516     /**
1517      * Call this method if you don't want the formchangechecker JavaScript to be
1518      * automatically initialised for this form.
1519      */
1520     public function disable_form_change_checker() {
1521         $this->_use_form_change_checker = false;
1522     }
1524     /**
1525      * If you have called {@link disable_form_change_checker()} then you can use
1526      * this method to re-enable it. It is enabled by default, so normally you don't
1527      * need to call this.
1528      */
1529     public function enable_form_change_checker() {
1530         $this->_use_form_change_checker = true;
1531     }
1533     /**
1534      * @return bool whether this form should automatically initialise
1535      *      formchangechecker for itself.
1536      */
1537     public function is_form_change_checker_enabled() {
1538         return $this->_use_form_change_checker;
1539     }
1541     /**
1542     * Accepts a renderer
1543     *
1544     * @param HTML_QuickForm_Renderer $renderer An HTML_QuickForm_Renderer object
1545     */
1546     function accept(&$renderer) {
1547         if (method_exists($renderer, 'setAdvancedElements')){
1548             //Check for visible fieldsets where all elements are advanced
1549             //and mark these headers as advanced as well.
1550             //Also mark all elements in a advanced header as advanced.
1551             $stopFields = $renderer->getStopFieldSetElements();
1552             $lastHeader = null;
1553             $lastHeaderAdvanced = false;
1554             $anyAdvanced = false;
1555             $anyError = false;
1556             foreach (array_keys($this->_elements) as $elementIndex){
1557                 $element =& $this->_elements[$elementIndex];
1559                 // if closing header and any contained element was advanced then mark it as advanced
1560                 if ($element->getType()=='header' || in_array($element->getName(), $stopFields)){
1561                     if ($anyAdvanced && !is_null($lastHeader)) {
1562                         $lastHeader->_generateId();
1563                         $this->setAdvanced($lastHeader->getName());
1564                         $this->addAdvancedStatusElement($lastHeader->getAttribute('id'), $anyError);
1565                     }
1566                     $lastHeaderAdvanced = false;
1567                     unset($lastHeader);
1568                     $lastHeader = null;
1569                 } elseif ($lastHeaderAdvanced) {
1570                     $this->setAdvanced($element->getName());
1571                 }
1573                 if ($element->getType()=='header'){
1574                     $lastHeader =& $element;
1575                     $anyAdvanced = false;
1576                     $anyError = false;
1577                     $lastHeaderAdvanced = isset($this->_advancedElements[$element->getName()]);
1578                 } elseif (isset($this->_advancedElements[$element->getName()])){
1579                     $anyAdvanced = true;
1580                     if (isset($this->_errors[$element->getName()])) {
1581                         $anyError = true;
1582                     }
1583                 }
1584             }
1585             // the last header may not be closed yet...
1586             if ($anyAdvanced && !is_null($lastHeader)){
1587                 $this->setAdvanced($lastHeader->getName());
1588                 $lastHeader->_generateId();
1589                 $this->addAdvancedStatusElement($lastHeader->getAttribute('id'), $anyError);
1590             }
1591             $renderer->setAdvancedElements($this->_advancedElements);
1592         }
1593         if (method_exists($renderer, 'setCollapsibleElements') && !$this->_disableShortforms) {
1595             // Count the number of sections.
1596             $headerscount = 0;
1597             foreach (array_keys($this->_elements) as $elementIndex){
1598                 $element =& $this->_elements[$elementIndex];
1599                 if ($element->getType() == 'header') {
1600                     $headerscount++;
1601                 }
1602             }
1604             $anyrequiredorerror = false;
1605             $headercounter = 0;
1606             $headername = null;
1607             foreach (array_keys($this->_elements) as $elementIndex){
1608                 $element =& $this->_elements[$elementIndex];
1610                 if ($element->getType() == 'header') {
1611                     $headercounter++;
1612                     $element->_generateId();
1613                     $headername = $element->getName();
1614                     $anyrequiredorerror = false;
1615                 } else if (in_array($element->getName(), $this->_required) || isset($this->_errors[$element->getName()])) {
1616                     $anyrequiredorerror = true;
1617                 } else {
1618                     // Do not reset $anyrequiredorerror to false because we do not want any other element
1619                     // in this header (fieldset) to possibly revert the state given.
1620                 }
1622                 if ($element->getType() == 'header') {
1623                     if ($headercounter === 1 && !isset($this->_collapsibleElements[$headername])) {
1624                         // By default the first section is always expanded, except if a state has already been set.
1625                         $this->setExpanded($headername, true);
1626                     } else if (($headercounter === 2 && $headerscount === 2) && !isset($this->_collapsibleElements[$headername])) {
1627                         // The second section is always expanded if the form only contains 2 sections),
1628                         // except if a state has already been set.
1629                         $this->setExpanded($headername, true);
1630                     }
1631                 } else if ($anyrequiredorerror) {
1632                     // If any error or required field are present within the header, we need to expand it.
1633                     $this->setExpanded($headername, true, true);
1634                 } else if (!isset($this->_collapsibleElements[$headername])) {
1635                     // Define element as collapsed by default.
1636                     $this->setExpanded($headername, false);
1637                 }
1638             }
1640             // Pass the array to renderer object.
1641             $renderer->setCollapsibleElements($this->_collapsibleElements);
1642         }
1643         parent::accept($renderer);
1644     }
1646     /**
1647      * Adds one or more element names that indicate the end of a fieldset
1648      *
1649      * @param string $elementName name of the element
1650      */
1651     function closeHeaderBefore($elementName){
1652         $renderer =& $this->defaultRenderer();
1653         $renderer->addStopFieldsetElements($elementName);
1654     }
1656     /**
1657      * Should be used for all elements of a form except for select, radio and checkboxes which
1658      * clean their own data.
1659      *
1660      * @param string $elementname
1661      * @param int $paramtype defines type of data contained in element. Use the constants PARAM_*.
1662      *        {@link lib/moodlelib.php} for defined parameter types
1663      */
1664     function setType($elementname, $paramtype) {
1665         $this->_types[$elementname] = $paramtype;
1666     }
1668     /**
1669      * This can be used to set several types at once.
1670      *
1671      * @param array $paramtypes types of parameters.
1672      * @see MoodleQuickForm::setType
1673      */
1674     function setTypes($paramtypes) {
1675         $this->_types = $paramtypes + $this->_types;
1676     }
1678     /**
1679      * Updates submitted values
1680      *
1681      * @param array $submission submitted values
1682      * @param array $files list of files
1683      */
1684     function updateSubmission($submission, $files) {
1685         $this->_flagSubmitted = false;
1687         if (empty($submission)) {
1688             $this->_submitValues = array();
1689         } else {
1690             foreach ($submission as $key=>$s) {
1691                 if (array_key_exists($key, $this->_types)) {
1692                     $type = $this->_types[$key];
1693                 } else {
1694                     $type = PARAM_RAW;
1695                 }
1696                 if (is_array($s)) {
1697                     $submission[$key] = clean_param_array($s, $type, true);
1698                 } else {
1699                     $submission[$key] = clean_param($s, $type);
1700                 }
1701             }
1702             $this->_submitValues = $submission;
1703             $this->_flagSubmitted = true;
1704         }
1706         if (empty($files)) {
1707             $this->_submitFiles = array();
1708         } else {
1709             $this->_submitFiles = $files;
1710             $this->_flagSubmitted = true;
1711         }
1713         // need to tell all elements that they need to update their value attribute.
1714          foreach (array_keys($this->_elements) as $key) {
1715              $this->_elements[$key]->onQuickFormEvent('updateValue', null, $this);
1716          }
1717     }
1719     /**
1720      * Returns HTML for required elements
1721      *
1722      * @return string
1723      */
1724     function getReqHTML(){
1725         return $this->_reqHTML;
1726     }
1728     /**
1729      * Returns HTML for advanced elements
1730      *
1731      * @return string
1732      */
1733     function getAdvancedHTML(){
1734         return $this->_advancedHTML;
1735     }
1737     /**
1738      * Initializes a default form value. Used to specify the default for a new entry where
1739      * no data is loaded in using moodleform::set_data()
1740      *
1741      * note: $slashed param removed
1742      *
1743      * @param string $elementName element name
1744      * @param mixed $defaultValue values for that element name
1745      */
1746     function setDefault($elementName, $defaultValue){
1747         $this->setDefaults(array($elementName=>$defaultValue));
1748     }
1750     /**
1751      * Add a help button to element, only one button per element is allowed.
1752      *
1753      * This is new, simplified and preferable method of setting a help icon on form elements.
1754      * It uses the new $OUTPUT->help_icon().
1755      *
1756      * Typically, you will provide the same identifier and the component as you have used for the
1757      * label of the element. The string identifier with the _help suffix added is then used
1758      * as the help string.
1759      *
1760      * There has to be two strings defined:
1761      *   1/ get_string($identifier, $component) - the title of the help page
1762      *   2/ get_string($identifier.'_help', $component) - the actual help page text
1763      *
1764      * @since Moodle 2.0
1765      * @param string $elementname name of the element to add the item to
1766      * @param string $identifier help string identifier without _help suffix
1767      * @param string $component component name to look the help string in
1768      * @param string $linktext optional text to display next to the icon
1769      * @param bool $suppresscheck set to true if the element may not exist
1770      */
1771     function addHelpButton($elementname, $identifier, $component = 'moodle', $linktext = '', $suppresscheck = false) {
1772         global $OUTPUT;
1773         if (array_key_exists($elementname, $this->_elementIndex)) {
1774             $element = $this->_elements[$this->_elementIndex[$elementname]];
1775             $element->_helpbutton = $OUTPUT->help_icon($identifier, $component, $linktext);
1776         } else if (!$suppresscheck) {
1777             debugging(get_string('nonexistentformelements', 'form', $elementname));
1778         }
1779     }
1781     /**
1782      * Set constant value not overridden by _POST or _GET
1783      * note: this does not work for complex names with [] :-(
1784      *
1785      * @param string $elname name of element
1786      * @param mixed $value
1787      */
1788     function setConstant($elname, $value) {
1789         $this->_constantValues = HTML_QuickForm::arrayMerge($this->_constantValues, array($elname=>$value));
1790         $element =& $this->getElement($elname);
1791         $element->onQuickFormEvent('updateValue', null, $this);
1792     }
1794     /**
1795      * export submitted values
1796      *
1797      * @param string $elementList list of elements in form
1798      * @return array
1799      */
1800     function exportValues($elementList = null){
1801         $unfiltered = array();
1802         if (null === $elementList) {
1803             // iterate over all elements, calling their exportValue() methods
1804             foreach (array_keys($this->_elements) as $key) {
1805                 if ($this->_elements[$key]->isFrozen() && !$this->_elements[$key]->_persistantFreeze) {
1806                     $varname = $this->_elements[$key]->_attributes['name'];
1807                     $value = '';
1808                     // If we have a default value then export it.
1809                     if (isset($this->_defaultValues[$varname])) {
1810                         $value = $this->prepare_fixed_value($varname, $this->_defaultValues[$varname]);
1811                     }
1812                 } else {
1813                     $value = $this->_elements[$key]->exportValue($this->_submitValues, true);
1814                 }
1816                 if (is_array($value)) {
1817                     // This shit throws a bogus warning in PHP 4.3.x
1818                     $unfiltered = HTML_QuickForm::arrayMerge($unfiltered, $value);
1819                 }
1820             }
1821         } else {
1822             if (!is_array($elementList)) {
1823                 $elementList = array_map('trim', explode(',', $elementList));
1824             }
1825             foreach ($elementList as $elementName) {
1826                 $value = $this->exportValue($elementName);
1827                 if (@PEAR::isError($value)) {
1828                     return $value;
1829                 }
1830                 //oh, stock QuickFOrm was returning array of arrays!
1831                 $unfiltered = HTML_QuickForm::arrayMerge($unfiltered, $value);
1832             }
1833         }
1835         if (is_array($this->_constantValues)) {
1836             $unfiltered = HTML_QuickForm::arrayMerge($unfiltered, $this->_constantValues);
1837         }
1838         return $unfiltered;
1839     }
1841     /**
1842      * This is a bit of a hack, and it duplicates the code in
1843      * HTML_QuickForm_element::_prepareValue, but I could not think of a way or
1844      * reliably calling that code. (Think about date selectors, for example.)
1845      * @param string $name the element name.
1846      * @param mixed $value the fixed value to set.
1847      * @return mixed the appropriate array to add to the $unfiltered array.
1848      */
1849     protected function prepare_fixed_value($name, $value) {
1850         if (null === $value) {
1851             return null;
1852         } else {
1853             if (!strpos($name, '[')) {
1854                 return array($name => $value);
1855             } else {
1856                 $valueAry = array();
1857                 $myIndex  = "['" . str_replace(array(']', '['), array('', "']['"), $name) . "']";
1858                 eval("\$valueAry$myIndex = \$value;");
1859                 return $valueAry;
1860             }
1861         }
1862     }
1864     /**
1865      * Adds a validation rule for the given field
1866      *
1867      * If the element is in fact a group, it will be considered as a whole.
1868      * To validate grouped elements as separated entities,
1869      * use addGroupRule instead of addRule.
1870      *
1871      * @param string $element Form element name
1872      * @param string $message Message to display for invalid data
1873      * @param string $type Rule type, use getRegisteredRules() to get types
1874      * @param string $format (optional)Required for extra rule data
1875      * @param string $validation (optional)Where to perform validation: "server", "client"
1876      * @param bool $reset Client-side validation: reset the form element to its original value if there is an error?
1877      * @param bool $force Force the rule to be applied, even if the target form element does not exist
1878      */
1879     function addRule($element, $message, $type, $format=null, $validation='server', $reset = false, $force = false)
1880     {
1881         parent::addRule($element, $message, $type, $format, $validation, $reset, $force);
1882         if ($validation == 'client') {
1883             $this->updateAttributes(array('onsubmit' => 'try { var myValidator = validate_' . $this->_formName . '; } catch(e) { return true; } return myValidator(this);'));
1884         }
1886     }
1888     /**
1889      * Adds a validation rule for the given group of elements
1890      *
1891      * Only groups with a name can be assigned a validation rule
1892      * Use addGroupRule when you need to validate elements inside the group.
1893      * Use addRule if you need to validate the group as a whole. In this case,
1894      * the same rule will be applied to all elements in the group.
1895      * Use addRule if you need to validate the group against a function.
1896      *
1897      * @param string $group Form group name
1898      * @param array|string $arg1 Array for multiple elements or error message string for one element
1899      * @param string $type (optional)Rule type use getRegisteredRules() to get types
1900      * @param string $format (optional)Required for extra rule data
1901      * @param int $howmany (optional)How many valid elements should be in the group
1902      * @param string $validation (optional)Where to perform validation: "server", "client"
1903      * @param bool $reset Client-side: whether to reset the element's value to its original state if validation failed.
1904      */
1905     function addGroupRule($group, $arg1, $type='', $format=null, $howmany=0, $validation = 'server', $reset = false)
1906     {
1907         parent::addGroupRule($group, $arg1, $type, $format, $howmany, $validation, $reset);
1908         if (is_array($arg1)) {
1909              foreach ($arg1 as $rules) {
1910                 foreach ($rules as $rule) {
1911                     $validation = (isset($rule[3]) && 'client' == $rule[3])? 'client': 'server';
1913                     if ('client' == $validation) {
1914                         $this->updateAttributes(array('onsubmit' => 'try { var myValidator = validate_' . $this->_formName . '; } catch(e) { return true; } return myValidator(this);'));
1915                     }
1916                 }
1917             }
1918         } elseif (is_string($arg1)) {
1920             if ($validation == 'client') {
1921                 $this->updateAttributes(array('onsubmit' => 'try { var myValidator = validate_' . $this->_formName . '; } catch(e) { return true; } return myValidator(this);'));
1922             }
1923         }
1924     }
1926     /**
1927      * Returns the client side validation script
1928      *
1929      * The code here was copied from HTML_QuickForm_DHTMLRulesTableless who copied it from  HTML_QuickForm
1930      * and slightly modified to run rules per-element
1931      * Needed to override this because of an error with client side validation of grouped elements.
1932      *
1933      * @return string Javascript to perform validation, empty string if no 'client' rules were added
1934      */
1935     function getValidationScript()
1936     {
1937         if (empty($this->_rules) || empty($this->_attributes['onsubmit'])) {
1938             return '';
1939         }
1941         include_once('HTML/QuickForm/RuleRegistry.php');
1942         $registry =& HTML_QuickForm_RuleRegistry::singleton();
1943         $test = array();
1944         $js_escape = array(
1945             "\r"    => '\r',
1946             "\n"    => '\n',
1947             "\t"    => '\t',
1948             "'"     => "\\'",
1949             '"'     => '\"',
1950             '\\'    => '\\\\'
1951         );
1953         foreach ($this->_rules as $elementName => $rules) {
1954             foreach ($rules as $rule) {
1955                 if ('client' == $rule['validation']) {
1956                     unset($element); //TODO: find out how to properly initialize it
1958                     $dependent  = isset($rule['dependent']) && is_array($rule['dependent']);
1959                     $rule['message'] = strtr($rule['message'], $js_escape);
1961                     if (isset($rule['group'])) {
1962                         $group    =& $this->getElement($rule['group']);
1963                         // No JavaScript validation for frozen elements
1964                         if ($group->isFrozen()) {
1965                             continue 2;
1966                         }
1967                         $elements =& $group->getElements();
1968                         foreach (array_keys($elements) as $key) {
1969                             if ($elementName == $group->getElementName($key)) {
1970                                 $element =& $elements[$key];
1971                                 break;
1972                             }
1973                         }
1974                     } elseif ($dependent) {
1975                         $element   =  array();
1976                         $element[] =& $this->getElement($elementName);
1977                         foreach ($rule['dependent'] as $elName) {
1978                             $element[] =& $this->getElement($elName);
1979                         }
1980                     } else {
1981                         $element =& $this->getElement($elementName);
1982                     }
1983                     // No JavaScript validation for frozen elements
1984                     if (is_object($element) && $element->isFrozen()) {
1985                         continue 2;
1986                     } elseif (is_array($element)) {
1987                         foreach (array_keys($element) as $key) {
1988                             if ($element[$key]->isFrozen()) {
1989                                 continue 3;
1990                             }
1991                         }
1992                     }
1993                     //for editor element, [text] is appended to the name.
1994                     if ($element->getType() == 'editor') {
1995                         $elementName .= '[text]';
1996                         //Add format to rule as moodleform check which format is supported by browser
1997                         //it is not set anywhere... So small hack to make sure we pass it down to quickform
1998                         if (is_null($rule['format'])) {
1999                             $rule['format'] = $element->getFormat();
2000                         }
2001                     }
2002                     // Fix for bug displaying errors for elements in a group
2003                     $test[$elementName][0][] = $registry->getValidationScript($element, $elementName, $rule);
2004                     $test[$elementName][1]=$element;
2005                     //end of fix
2006                 }
2007             }
2008         }
2010         // Fix for MDL-9524. If you don't do this, then $element may be left as a reference to one of the fields in
2011         // the form, and then that form field gets corrupted by the code that follows.
2012         unset($element);
2014         $js = '
2015 <script type="text/javascript">
2016 //<![CDATA[
2018 var skipClientValidation = false;
2020 function qf_errorHandler(element, _qfMsg) {
2021   div = element.parentNode;
2023   if ((div == undefined) || (element.name == undefined)) {
2024     //no checking can be done for undefined elements so let server handle it.
2025     return true;
2026   }
2028   if (_qfMsg != \'\') {
2029     var errorSpan = document.getElementById(\'id_error_\'+element.name);
2030     if (!errorSpan) {
2031       errorSpan = document.createElement("span");
2032       errorSpan.id = \'id_error_\'+element.name;
2033       errorSpan.className = "error";
2034       element.parentNode.insertBefore(errorSpan, element.parentNode.firstChild);
2035     }
2037     while (errorSpan.firstChild) {
2038       errorSpan.removeChild(errorSpan.firstChild);
2039     }
2041     errorSpan.appendChild(document.createTextNode(_qfMsg.substring(3)));
2042     errorSpan.appendChild(document.createElement("br"));
2044     if (div.className.substr(div.className.length - 6, 6) != " error"
2045         && div.className != "error") {
2046       div.className += " error";
2047     }
2049     return false;
2050   } else {
2051     var errorSpan = document.getElementById(\'id_error_\'+element.name);
2052     if (errorSpan) {
2053       errorSpan.parentNode.removeChild(errorSpan);
2054     }
2056     if (div.className.substr(div.className.length - 6, 6) == " error") {
2057       div.className = div.className.substr(0, div.className.length - 6);
2058     } else if (div.className == "error") {
2059       div.className = "";
2060     }
2062     return true;
2063   }
2064 }';
2065         $validateJS = '';
2066         foreach ($test as $elementName => $jsandelement) {
2067             // Fix for bug displaying errors for elements in a group
2068             //unset($element);
2069             list($jsArr,$element)=$jsandelement;
2070             //end of fix
2071             $escapedElementName = preg_replace_callback(
2072                 '/[_\[\]-]/',
2073                 create_function('$matches', 'return sprintf("_%2x",ord($matches[0]));'),
2074                 $elementName);
2075             $js .= '
2076 function validate_' . $this->_formName . '_' . $escapedElementName . '(element) {
2077   if (undefined == element) {
2078      //required element was not found, then let form be submitted without client side validation
2079      return true;
2080   }
2081   var value = \'\';
2082   var errFlag = new Array();
2083   var _qfGroups = {};
2084   var _qfMsg = \'\';
2085   var frm = element.parentNode;
2086   if ((undefined != element.name) && (frm != undefined)) {
2087       while (frm && frm.nodeName.toUpperCase() != "FORM") {
2088         frm = frm.parentNode;
2089       }
2090     ' . join("\n", $jsArr) . '
2091       return qf_errorHandler(element, _qfMsg);
2092   } else {
2093     //element name should be defined else error msg will not be displayed.
2094     return true;
2095   }
2097 ';
2098             $validateJS .= '
2099   ret = validate_' . $this->_formName . '_' . $escapedElementName.'(frm.elements[\''.$elementName.'\']) && ret;
2100   if (!ret && !first_focus) {
2101     first_focus = true;
2102     frm.elements[\''.$elementName.'\'].focus();
2103   }
2104 ';
2106             // Fix for bug displaying errors for elements in a group
2107             //unset($element);
2108             //$element =& $this->getElement($elementName);
2109             //end of fix
2110             $valFunc = 'validate_' . $this->_formName . '_' . $escapedElementName . '(this)';
2111             $onBlur = $element->getAttribute('onBlur');
2112             $onChange = $element->getAttribute('onChange');
2113             $element->updateAttributes(array('onBlur' => $onBlur . $valFunc,
2114                                              'onChange' => $onChange . $valFunc));
2115         }
2116 //  do not rely on frm function parameter, because htmlarea breaks it when overloading the onsubmit method
2117         $js .= '
2118 function validate_' . $this->_formName . '(frm) {
2119   if (skipClientValidation) {
2120      return true;
2121   }
2122   var ret = true;
2124   var frm = document.getElementById(\''. $this->_attributes['id'] .'\')
2125   var first_focus = false;
2126 ' . $validateJS . ';
2127   return ret;
2129 //]]>
2130 </script>';
2131         return $js;
2132     } // end func getValidationScript
2134     /**
2135      * Sets default error message
2136      */
2137     function _setDefaultRuleMessages(){
2138         foreach ($this->_rules as $field => $rulesarr){
2139             foreach ($rulesarr as $key => $rule){
2140                 if ($rule['message']===null){
2141                     $a=new stdClass();
2142                     $a->format=$rule['format'];
2143                     $str=get_string('err_'.$rule['type'], 'form', $a);
2144                     if (strpos($str, '[[')!==0){
2145                         $this->_rules[$field][$key]['message']=$str;
2146                     }
2147                 }
2148             }
2149         }
2150     }
2152     /**
2153      * Get list of attributes which have dependencies
2154      *
2155      * @return array
2156      */
2157     function getLockOptionObject(){
2158         $result = array();
2159         foreach ($this->_dependencies as $dependentOn => $conditions){
2160             $result[$dependentOn] = array();
2161             foreach ($conditions as $condition=>$values) {
2162                 $result[$dependentOn][$condition] = array();
2163                 foreach ($values as $value=>$dependents) {
2164                     $result[$dependentOn][$condition][$value] = array();
2165                     $i = 0;
2166                     foreach ($dependents as $dependent) {
2167                         $elements = $this->_getElNamesRecursive($dependent);
2168                         if (empty($elements)) {
2169                             // probably element inside of some group
2170                             $elements = array($dependent);
2171                         }
2172                         foreach($elements as $element) {
2173                             if ($element == $dependentOn) {
2174                                 continue;
2175                             }
2176                             $result[$dependentOn][$condition][$value][] = $element;
2177                         }
2178                     }
2179                 }
2180             }
2181         }
2182         return array($this->getAttribute('id'), $result);
2183     }
2185     /**
2186      * Get names of element or elements in a group.
2187      *
2188      * @param HTML_QuickForm_group|element $element element group or element object
2189      * @return array
2190      */
2191     function _getElNamesRecursive($element) {
2192         if (is_string($element)) {
2193             if (!$this->elementExists($element)) {
2194                 return array();
2195             }
2196             $element = $this->getElement($element);
2197         }
2199         if (is_a($element, 'HTML_QuickForm_group')) {
2200             $elsInGroup = $element->getElements();
2201             $elNames = array();
2202             foreach ($elsInGroup as $elInGroup){
2203                 if (is_a($elInGroup, 'HTML_QuickForm_group')) {
2204                     // not sure if this would work - groups nested in groups
2205                     $elNames = array_merge($elNames, $this->_getElNamesRecursive($elInGroup));
2206                 } else {
2207                     $elNames[] = $element->getElementName($elInGroup->getName());
2208                 }
2209             }
2211         } else if (is_a($element, 'HTML_QuickForm_header')) {
2212             return array();
2214         } else if (is_a($element, 'HTML_QuickForm_hidden')) {
2215             return array();
2217         } else if (method_exists($element, 'getPrivateName') &&
2218                 !($element instanceof HTML_QuickForm_advcheckbox)) {
2219             // The advcheckbox element implements a method called getPrivateName,
2220             // but in a way that is not compatible with the generic API, so we
2221             // have to explicitly exclude it.
2222             return array($element->getPrivateName());
2224         } else {
2225             $elNames = array($element->getName());
2226         }
2228         return $elNames;
2229     }
2231     /**
2232      * Adds a dependency for $elementName which will be disabled if $condition is met.
2233      * If $condition = 'notchecked' (default) then the condition is that the $dependentOn element
2234      * is not checked. If $condition = 'checked' then the condition is that the $dependentOn element
2235      * is checked. If $condition is something else (like "eq" for equals) then it is checked to see if the value
2236      * of the $dependentOn element is $condition (such as equal) to $value.
2237      *
2238      * @param string $elementName the name of the element which will be disabled
2239      * @param string $dependentOn the name of the element whose state will be checked for condition
2240      * @param string $condition the condition to check
2241      * @param mixed $value used in conjunction with condition.
2242      */
2243     function disabledIf($elementName, $dependentOn, $condition = 'notchecked', $value='1'){
2244         if (!array_key_exists($dependentOn, $this->_dependencies)) {
2245             $this->_dependencies[$dependentOn] = array();
2246         }
2247         if (!array_key_exists($condition, $this->_dependencies[$dependentOn])) {
2248             $this->_dependencies[$dependentOn][$condition] = array();
2249         }
2250         if (!array_key_exists($value, $this->_dependencies[$dependentOn][$condition])) {
2251             $this->_dependencies[$dependentOn][$condition][$value] = array();
2252         }
2253         $this->_dependencies[$dependentOn][$condition][$value][] = $elementName;
2254     }
2256     /**
2257      * Registers button as no submit button
2258      *
2259      * @param string $buttonname name of the button
2260      */
2261     function registerNoSubmitButton($buttonname){
2262         $this->_noSubmitButtons[]=$buttonname;
2263     }
2265     /**
2266      * Checks if button is a no submit button, i.e it doesn't submit form
2267      *
2268      * @param string $buttonname name of the button to check
2269      * @return bool
2270      */
2271     function isNoSubmitButton($buttonname){
2272         return (array_search($buttonname, $this->_noSubmitButtons)!==FALSE);
2273     }
2275     /**
2276      * Registers a button as cancel button
2277      *
2278      * @param string $addfieldsname name of the button
2279      */
2280     function _registerCancelButton($addfieldsname){
2281         $this->_cancelButtons[]=$addfieldsname;
2282     }
2284     /**
2285      * Displays elements without HTML input tags.
2286      * This method is different to freeze() in that it makes sure no hidden
2287      * elements are included in the form.
2288      * Note: If you want to make sure the submitted value is ignored, please use setDefaults().
2289      *
2290      * This function also removes all previously defined rules.
2291      *
2292      * @param string|array $elementList array or string of element(s) to be frozen
2293      * @return object|bool if element list is not empty then return error object, else true
2294      */
2295     function hardFreeze($elementList=null)
2296     {
2297         if (!isset($elementList)) {
2298             $this->_freezeAll = true;
2299             $elementList = array();
2300         } else {
2301             if (!is_array($elementList)) {
2302                 $elementList = preg_split('/[ ]*,[ ]*/', $elementList);
2303             }
2304             $elementList = array_flip($elementList);
2305         }
2307         foreach (array_keys($this->_elements) as $key) {
2308             $name = $this->_elements[$key]->getName();
2309             if ($this->_freezeAll || isset($elementList[$name])) {
2310                 $this->_elements[$key]->freeze();
2311                 $this->_elements[$key]->setPersistantFreeze(false);
2312                 unset($elementList[$name]);
2314                 // remove all rules
2315                 $this->_rules[$name] = array();
2316                 // if field is required, remove the rule
2317                 $unset = array_search($name, $this->_required);
2318                 if ($unset !== false) {
2319                     unset($this->_required[$unset]);
2320                 }
2321             }
2322         }
2324         if (!empty($elementList)) {
2325             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);
2326         }
2327         return true;
2328     }
2330     /**
2331      * Hard freeze all elements in a form except those whose names are in $elementList or hidden elements in a form.
2332      *
2333      * This function also removes all previously defined rules of elements it freezes.
2334      *
2335      * @throws HTML_QuickForm_Error
2336      * @param array $elementList array or string of element(s) not to be frozen
2337      * @return bool returns true
2338      */
2339     function hardFreezeAllVisibleExcept($elementList)
2340     {
2341         $elementList = array_flip($elementList);
2342         foreach (array_keys($this->_elements) as $key) {
2343             $name = $this->_elements[$key]->getName();
2344             $type = $this->_elements[$key]->getType();
2346             if ($type == 'hidden'){
2347                 // leave hidden types as they are
2348             } elseif (!isset($elementList[$name])) {
2349                 $this->_elements[$key]->freeze();
2350                 $this->_elements[$key]->setPersistantFreeze(false);
2352                 // remove all rules
2353                 $this->_rules[$name] = array();
2354                 // if field is required, remove the rule
2355                 $unset = array_search($name, $this->_required);
2356                 if ($unset !== false) {
2357                     unset($this->_required[$unset]);
2358                 }
2359             }
2360         }
2361         return true;
2362     }
2364    /**
2365     * Tells whether the form was already submitted
2366     *
2367     * This is useful since the _submitFiles and _submitValues arrays
2368     * may be completely empty after the trackSubmit value is removed.
2369     *
2370     * @return bool
2371     */
2372     function isSubmitted()
2373     {
2374         return parent::isSubmitted() && (!$this->isFrozen());
2375     }
2378 /**
2379  * MoodleQuickForm renderer
2380  *
2381  * A renderer for MoodleQuickForm that only uses XHTML and CSS and no
2382  * table tags, extends PEAR class HTML_QuickForm_Renderer_Tableless
2383  *
2384  * Stylesheet is part of standard theme and should be automatically included.
2385  *
2386  * @package   core_form
2387  * @copyright 2007 Jamie Pratt <me@jamiep.org>
2388  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2389  */
2390 class MoodleQuickForm_Renderer extends HTML_QuickForm_Renderer_Tableless{
2392     /** @var array Element template array */
2393     var $_elementTemplates;
2395     /**
2396      * Template used when opening a hidden fieldset
2397      * (i.e. a fieldset that is opened when there is no header element)
2398      * @var string
2399      */
2400     var $_openHiddenFieldsetTemplate = "\n\t<fieldset class=\"hidden\"><div>";
2402     /** @var string Header Template string */
2403     var $_headerTemplate =
2404        "\n\t\t<legend class=\"ftoggler\">{header}</legend>\n\t\t<div class=\"fcontainer clearfix\">\n\t\t";
2406     /** @var string Template used when opening a fieldset */
2407     var $_openFieldsetTemplate = "\n\t<fieldset class=\"{classes}\" {id} {aria-live}>";
2409     /** @var string Template used when closing a fieldset */
2410     var $_closeFieldsetTemplate = "\n\t\t</div></fieldset>";
2412     /** @var string Required Note template string */
2413     var $_requiredNoteTemplate =
2414         "\n\t\t<div class=\"fdescription required\">{requiredNote}</div>";
2416     /** @var string Collapsible buttons string template */
2417     var $_collapseButtonsTemplate =
2418         "\n\t<div class=\"collapsible-actions\"><button disabled=\"disabled\" class=\"btn-expandall\">{strexpandall}</button>
2419         <button disabled=\"disabled\" class=\"btn-collapseall\">{strcollapseall}</button></div>";
2421     /**
2422      * Array whose keys are element names. If the key exists this is a advanced element
2423      *
2424      * @var array
2425      */
2426     var $_advancedElements = array();
2428     /**
2429      * Array whose keys are element names and the the boolean values reflect the current state. If the key exists this is a collapsible element.
2430      *
2431      * @var array
2432      */
2433     var $_collapsibleElements = array();
2435     /**
2436      * @var string Contains the collapsible buttons to add to the form.
2437      */
2438     var $_collapseButtons = '';
2440     /**
2441      * Constructor
2442      */
2443     function MoodleQuickForm_Renderer(){
2444         // switch next two lines for ol li containers for form items.
2445         //        $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>');
2446         $this->_elementTemplates = array(
2447         'default'=>"\n\t\t".'<div id="{id}" class="fitem {advanced}<!-- BEGIN required --> required<!-- END required --> fitem_{type}"><div class="fitemtitle"><label>{label}<!-- BEGIN required -->{req}<!-- END required -->{advancedimg}{help} </label></div><div class="felement {type}<!-- BEGIN error --> error<!-- END error -->"><!-- BEGIN error --><span class="error">{error}</span><br /><!-- END error -->{element}</div></div>',
2449         'actionbuttons'=>"\n\t\t".'<div id="{id}" class="fitem fitem_actionbuttons fitem_{type}"><div class="felement {type}">{element}</div></div>',
2451         'fieldset'=>"\n\t\t".'<div id="{id}" class="fitem {advanced}<!-- BEGIN required --> required<!-- END required --> fitem_{type}"><div class="fitemtitle"><div class="fgrouplabel"><label>{label}<!-- BEGIN required -->{req}<!-- END required -->{advancedimg}{help} </label></div></div><fieldset class="felement {type}<!-- BEGIN error --> error<!-- END error -->"><!-- BEGIN error --><span class="error">{error}</span><br /><!-- END error -->{element}</fieldset></div>',
2453         'static'=>"\n\t\t".'<div class="fitem {advanced}"><div class="fitemtitle"><div class="fstaticlabel"><label>{label}<!-- BEGIN required -->{req}<!-- END required -->{advancedimg}{help} </label></div></div><div class="felement fstatic <!-- BEGIN error --> error<!-- END error -->"><!-- BEGIN error --><span class="error">{error}</span><br /><!-- END error -->{element}&nbsp;</div></div>',
2455         'warning'=>"\n\t\t".'<div class="fitem {advanced}">{element}</div>',
2457         'nodisplay'=>'');
2459         parent::HTML_QuickForm_Renderer_Tableless();
2460     }
2462     /**
2463      * Set element's as adavance element
2464      *
2465      * @param array $elements form elements which needs to be grouped as advance elements.
2466      */
2467     function setAdvancedElements($elements){
2468         $this->_advancedElements = $elements;
2469     }
2471     /**
2472      * Setting collapsible elements
2473      *
2474      * @param array $elements
2475      */
2476     function setCollapsibleElements($elements) {
2477         $this->_collapsibleElements = $elements;
2478     }
2480     /**
2481      * What to do when starting the form
2482      *
2483      * @param MoodleQuickForm $form reference of the form
2484      */
2485     function startForm(&$form){
2486         global $PAGE;
2487         $this->_reqHTML = $form->getReqHTML();
2488         $this->_elementTemplates = str_replace('{req}', $this->_reqHTML, $this->_elementTemplates);
2489         $this->_advancedHTML = $form->getAdvancedHTML();
2490         $this->_collapseButtons = '';
2491         $formid = $form->getAttribute('id');
2492         parent::startForm($form);
2493         if ($form->isFrozen()){
2494             $this->_formTemplate = "\n<div class=\"mform frozen\">\n{content}\n</div>";
2495         } else {
2496             $this->_formTemplate = "\n<form{attributes}>\n\t<div style=\"display: none;\">{hidden}</div>\n{collapsebtns}\n{content}\n</form>";
2497             $this->_hiddenHtml .= $form->_pageparams;
2498         }
2500         if ($form->is_form_change_checker_enabled()) {
2501             $PAGE->requires->yui_module('moodle-core-formchangechecker',
2502                     'M.core_formchangechecker.init',
2503                     array(array(
2504                         'formid' => $formid
2505                     ))
2506             );
2507             $PAGE->requires->string_for_js('changesmadereallygoaway', 'moodle');
2508         }
2509         if (!empty($this->_collapsibleElements)) {
2510             if (count($this->_collapsibleElements) > 1) {
2511                 $this->_collapseButtons = $this->_collapseButtonsTemplate;
2512                 $this->_collapseButtons = str_replace('{strcollapseall}', get_string('collapseall'), $this->_collapseButtons);
2513                 $this->_collapseButtons = str_replace('{strexpandall}', get_string('expandall'), $this->_collapseButtons);
2514             }
2515             $PAGE->requires->yui_module('moodle-form-shortforms', 'M.form.shortforms', array(array('formid' => $formid)));
2516         }
2517         if (!empty($this->_advancedElements)){
2518             $PAGE->requires->strings_for_js(array('showmore', 'showless'), 'form');
2519             $PAGE->requires->yui_module('moodle-form-showadvanced', 'M.form.showadvanced', array(array('formid' => $formid)));
2520         }
2521     }
2523     /**
2524      * Create advance group of elements
2525      *
2526      * @param object $group Passed by reference
2527      * @param bool $required if input is required field
2528      * @param string $error error message to display
2529      */
2530     function startGroup(&$group, $required, $error){
2531         // Make sure the element has an id.
2532         $group->_generateId();
2534         if (method_exists($group, 'getElementTemplateType')){
2535             $html = $this->_elementTemplates[$group->getElementTemplateType()];
2536         }else{
2537             $html = $this->_elementTemplates['default'];
2539         }
2541         if (isset($this->_advancedElements[$group->getName()])){
2542             $html =str_replace(' {advanced}', ' advanced', $html);
2543             $html =str_replace('{advancedimg}', $this->_advancedHTML, $html);
2544         } else {
2545             $html =str_replace(' {advanced}', '', $html);
2546             $html =str_replace('{advancedimg}', '', $html);
2547         }
2548         if (method_exists($group, 'getHelpButton')){
2549             $html =str_replace('{help}', $group->getHelpButton(), $html);
2550         }else{
2551             $html =str_replace('{help}', '', $html);
2552         }
2553         $html =str_replace('{id}', 'fgroup_' . $group->getAttribute('id'), $html);
2554         $html =str_replace('{name}', $group->getName(), $html);
2555         $html =str_replace('{type}', 'fgroup', $html);
2557         $this->_templates[$group->getName()]=$html;
2558         // Fix for bug in tableless quickforms that didn't allow you to stop a
2559         // fieldset before a group of elements.
2560         // if the element name indicates the end of a fieldset, close the fieldset
2561         if (   in_array($group->getName(), $this->_stopFieldsetElements)
2562             && $this->_fieldsetsOpen > 0
2563            ) {
2564             $this->_html .= $this->_closeFieldsetTemplate;
2565             $this->_fieldsetsOpen--;
2566         }
2567         parent::startGroup($group, $required, $error);
2568     }
2570     /**
2571      * Renders element
2572      *
2573      * @param HTML_QuickForm_element $element element
2574      * @param bool $required if input is required field
2575      * @param string $error error message to display
2576      */
2577     function renderElement(&$element, $required, $error){
2578         // Make sure the element has an id.
2579         $element->_generateId();
2581         //adding stuff to place holders in template
2582         //check if this is a group element first
2583         if (($this->_inGroup) and !empty($this->_groupElementTemplate)) {
2584             // so it gets substitutions for *each* element
2585             $html = $this->_groupElementTemplate;
2586         }
2587         elseif (method_exists($element, 'getElementTemplateType')){
2588             $html = $this->_elementTemplates[$element->getElementTemplateType()];
2589         }else{
2590             $html = $this->_elementTemplates['default'];
2591         }
2592         if (isset($this->_advancedElements[$element->getName()])){
2593             $html =str_replace(' {advanced}', ' advanced', $html);
2594         } else {
2595             $html =str_replace(' {advanced}', '', $html);
2596         }
2597         if (isset($this->_advancedElements[$element->getName()])||$element->getName() == 'mform_showadvanced'){
2598             $html =str_replace('{advancedimg}', $this->_advancedHTML, $html);
2599         } else {
2600             $html =str_replace('{advancedimg}', '', $html);
2601         }
2602         $html =str_replace('{id}', 'fitem_' . $element->getAttribute('id'), $html);
2603         $html =str_replace('{type}', 'f'.$element->getType(), $html);
2604         $html =str_replace('{name}', $element->getName(), $html);
2605         if (method_exists($element, 'getHelpButton')){
2606             $html = str_replace('{help}', $element->getHelpButton(), $html);
2607         }else{
2608             $html = str_replace('{help}', '', $html);
2610         }
2611         if (($this->_inGroup) and !empty($this->_groupElementTemplate)) {
2612             $this->_groupElementTemplate = $html;
2613         }
2614         elseif (!isset($this->_templates[$element->getName()])) {
2615             $this->_templates[$element->getName()] = $html;
2616         }
2618         parent::renderElement($element, $required, $error);
2619     }
2621     /**
2622      * Called when visiting a form, after processing all form elements
2623      * Adds required note, form attributes, validation javascript and form content.
2624      *
2625      * @global moodle_page $PAGE
2626      * @param moodleform $form Passed by reference
2627      */
2628     function finishForm(&$form){
2629         global $PAGE;
2630         if ($form->isFrozen()){
2631             $this->_hiddenHtml = '';
2632         }
2633         parent::finishForm($form);
2634         $this->_html = str_replace('{collapsebtns}', $this->_collapseButtons, $this->_html);
2635         if (!$form->isFrozen()) {
2636             $args = $form->getLockOptionObject();
2637             if (count($args[1]) > 0) {
2638                 $PAGE->requires->js_init_call('M.form.initFormDependencies', $args, true, moodleform::get_js_module());
2639             }
2640         }
2641     }
2642    /**
2643     * Called when visiting a header element
2644     *
2645     * @param HTML_QuickForm_header $header An HTML_QuickForm_header element being visited
2646     * @global moodle_page $PAGE
2647     */
2648     function renderHeader(&$header) {
2649         global $PAGE;
2651         $header->_generateId();
2652         $name = $header->getName();
2654         $id = empty($name) ? '' : ' id="' . $header->getAttribute('id') . '"';
2655         if (is_null($header->_text)) {
2656             $header_html = '';
2657         } elseif (!empty($name) && isset($this->_templates[$name])) {
2658             $header_html = str_replace('{header}', $header->toHtml(), $this->_templates[$name]);
2659         } else {
2660             $header_html = str_replace('{header}', $header->toHtml(), $this->_headerTemplate);
2661         }
2663         if ($this->_fieldsetsOpen > 0) {
2664             $this->_html .= $this->_closeFieldsetTemplate;
2665             $this->_fieldsetsOpen--;
2666         }
2668         // Define collapsible classes for fieldsets.
2669         $arialive = '';
2670         $fieldsetclasses = array('clearfix');
2671         if (isset($this->_collapsibleElements[$header->getName()])) {
2672             $fieldsetclasses[] = 'collapsible';
2673             $arialive = 'aria-live="polite"';
2674             if ($this->_collapsibleElements[$header->getName()]) {
2675                 $fieldsetclasses[] = 'collapsed';
2676             }
2677         }
2679         if (isset($this->_advancedElements[$name])){
2680             $fieldsetclasses[] = 'containsadvancedelements';
2681         }
2683         $openFieldsetTemplate = str_replace('{id}', $id, $this->_openFieldsetTemplate);
2684         $openFieldsetTemplate = str_replace('{classes}', join(' ', $fieldsetclasses), $openFieldsetTemplate);
2685         $openFieldsetTemplate = str_replace('{aria-live}', $arialive, $openFieldsetTemplate);
2687         $this->_html .= $openFieldsetTemplate . $header_html;
2688         $this->_fieldsetsOpen++;
2689     }
2691     /**
2692      * Return Array of element names that indicate the end of a fieldset
2693      *
2694      * @return array
2695      */
2696     function getStopFieldsetElements(){
2697         return $this->_stopFieldsetElements;
2698     }
2701 /**
2702  * Required elements validation
2703  *
2704  * This class overrides QuickForm validation since it allowed space or empty tag as a value
2705  *
2706  * @package   core_form
2707  * @category  form
2708  * @copyright 2006 Jamie Pratt <me@jamiep.org>
2709  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2710  */
2711 class MoodleQuickForm_Rule_Required extends HTML_QuickForm_Rule {
2712     /**
2713      * Checks if an element is not empty.
2714      * This is a server-side validation, it works for both text fields and editor fields
2715      *
2716      * @param string $value Value to check
2717      * @param int|string|array $options Not used yet
2718      * @return bool true if value is not empty
2719      */
2720     function validate($value, $options = null) {
2721         global $CFG;
2722         if (is_array($value) && array_key_exists('text', $value)) {
2723             $value = $value['text'];
2724         }
2725         if (is_array($value)) {
2726             // nasty guess - there has to be something in the array, hopefully nobody invents arrays in arrays
2727             $value = implode('', $value);
2728         }
2729         $stripvalues = array(
2730             '#</?(?!img|canvas|hr).*?>#im', // all tags except img, canvas and hr
2731             '#(\xc2|\xa0|\s|&nbsp;)#', //any whitespaces actually
2732         );
2733         if (!empty($CFG->strictformsrequired)) {
2734             $value = preg_replace($stripvalues, '', (string)$value);
2735         }
2736         if ((string)$value == '') {
2737             return false;
2738         }
2739         return true;
2740     }
2742     /**
2743      * This function returns Javascript code used to build client-side validation.
2744      * It checks if an element is not empty.
2745      *
2746      * @param int $format format of data which needs to be validated.
2747      * @return array
2748      */
2749     function getValidationScript($format = null) {
2750         global $CFG;
2751         if (!empty($CFG->strictformsrequired)) {
2752             if (!empty($format) && $format == FORMAT_HTML) {
2753                 return array('', "{jsVar}.replace(/(<[^img|hr|canvas]+>)|&nbsp;|\s+/ig, '') == ''");
2754             } else {
2755                 return array('', "{jsVar}.replace(/^\s+$/g, '') == ''");
2756             }
2757         } else {
2758             return array('', "{jsVar} == ''");
2759         }
2760     }
2763 /**
2764  * @global object $GLOBALS['_HTML_QuickForm_default_renderer']
2765  * @name $_HTML_QuickForm_default_renderer
2766  */
2767 $GLOBALS['_HTML_QuickForm_default_renderer'] = new MoodleQuickForm_Renderer();
2769 /** Please keep this list in alphabetical order. */
2770 MoodleQuickForm::registerElementType('advcheckbox', "$CFG->libdir/form/advcheckbox.php", 'MoodleQuickForm_advcheckbox');
2771 MoodleQuickForm::registerElementType('button', "$CFG->libdir/form/button.php", 'MoodleQuickForm_button');
2772 MoodleQuickForm::registerElementType('cancel', "$CFG->libdir/form/cancel.php", 'MoodleQuickForm_cancel');
2773 MoodleQuickForm::registerElementType('searchableselector', "$CFG->libdir/form/searchableselector.php", 'MoodleQuickForm_searchableselector');
2774 MoodleQuickForm::registerElementType('checkbox', "$CFG->libdir/form/checkbox.php", 'MoodleQuickForm_checkbox');
2775 MoodleQuickForm::registerElementType('date_selector', "$CFG->libdir/form/dateselector.php", 'MoodleQuickForm_date_selector');
2776 MoodleQuickForm::registerElementType('date_time_selector', "$CFG->libdir/form/datetimeselector.php", 'MoodleQuickForm_date_time_selector');
2777 MoodleQuickForm::registerElementType('duration', "$CFG->libdir/form/duration.php", 'MoodleQuickForm_duration');
2778 MoodleQuickForm::registerElementType('editor', "$CFG->libdir/form/editor.php", 'MoodleQuickForm_editor');
2779 MoodleQuickForm::registerElementType('filemanager', "$CFG->libdir/form/filemanager.php", 'MoodleQuickForm_filemanager');
2780 MoodleQuickForm::registerElementType('filepicker', "$CFG->libdir/form/filepicker.php", 'MoodleQuickForm_filepicker');
2781 MoodleQuickForm::registerElementType('grading', "$CFG->libdir/form/grading.php", 'MoodleQuickForm_grading');
2782 MoodleQuickForm::registerElementType('group', "$CFG->libdir/form/group.php", 'MoodleQuickForm_group');
2783 MoodleQuickForm::registerElementType('header', "$CFG->libdir/form/header.php", 'MoodleQuickForm_header');
2784 MoodleQuickForm::registerElementType('hidden', "$CFG->libdir/form/hidden.php", 'MoodleQuickForm_hidden');
2785 MoodleQuickForm::registerElementType('htmleditor', "$CFG->libdir/form/htmleditor.php", 'MoodleQuickForm_htmleditor');
2786 MoodleQuickForm::registerElementType('listing', "$CFG->libdir/form/listing.php", 'MoodleQuickForm_listing');
2787 MoodleQuickForm::registerElementType('modgrade', "$CFG->libdir/form/modgrade.php", 'MoodleQuickForm_modgrade');
2788 MoodleQuickForm::registerElementType('modvisible', "$CFG->libdir/form/modvisible.php", 'MoodleQuickForm_modvisible');
2789 MoodleQuickForm::registerElementType('password', "$CFG->libdir/form/password.php", 'MoodleQuickForm_password');
2790 MoodleQuickForm::registerElementType('passwordunmask', "$CFG->libdir/form/passwordunmask.php", 'MoodleQuickForm_passwordunmask');
2791 MoodleQuickForm::registerElementType('questioncategory', "$CFG->libdir/form/questioncategory.php", 'MoodleQuickForm_questioncategory');
2792 MoodleQuickForm::registerElementType('radio', "$CFG->libdir/form/radio.php", 'MoodleQuickForm_radio');
2793 MoodleQuickForm::registerElementType('recaptcha', "$CFG->libdir/form/recaptcha.php", 'MoodleQuickForm_recaptcha');
2794 MoodleQuickForm::registerElementType('select', "$CFG->libdir/form/select.php", 'MoodleQuickForm_select');
2795 MoodleQuickForm::registerElementType('selectgroups', "$CFG->libdir/form/selectgroups.php", 'MoodleQuickForm_selectgroups');
2796 MoodleQuickForm::registerElementType('selectwithlink', "$CFG->libdir/form/selectwithlink.php", 'MoodleQuickForm_selectwithlink');
2797 MoodleQuickForm::registerElementType('selectyesno', "$CFG->libdir/form/selectyesno.php", 'MoodleQuickForm_selectyesno');
2798 MoodleQuickForm::registerElementType('static', "$CFG->libdir/form/static.php", 'MoodleQuickForm_static');
2799 MoodleQuickForm::registerElementType('submit', "$CFG->libdir/form/submit.php", 'MoodleQuickForm_submit');
2800 MoodleQuickForm::registerElementType('submitlink', "$CFG->libdir/form/submitlink.php", 'MoodleQuickForm_submitlink');
2801 MoodleQuickForm::registerElementType('tags', "$CFG->libdir/form/tags.php", 'MoodleQuickForm_tags');
2802 MoodleQuickForm::registerElementType('text', "$CFG->libdir/form/text.php", 'MoodleQuickForm_text');
2803 MoodleQuickForm::registerElementType('textarea', "$CFG->libdir/form/textarea.php", 'MoodleQuickForm_textarea');
2804 MoodleQuickForm::registerElementType('url', "$CFG->libdir/form/url.php", 'MoodleQuickForm_url');
2805 MoodleQuickForm::registerElementType('warning', "$CFG->libdir/form/warning.php", 'MoodleQuickForm_warning');
2807 MoodleQuickForm::registerRule('required', null, 'MoodleQuickForm_Rule_Required', "$CFG->libdir/formslib.php");