MDL-28972 formslib: Fixed up variable naming
[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){
65     PEAR::setErrorHandling(PEAR_ERROR_CALLBACK, 'pear_handle_error');
66 }
68 /**
69  * Initalize javascript for date type form element
70  *
71  * @staticvar bool $done make sure it gets initalize once.
72  * @global moodle_page $PAGE
73  */
74 function form_init_date_js() {
75     global $PAGE;
76     static $done = false;
77     if (!$done) {
78         $module   = 'moodle-form-dateselector';
79         $function = 'M.form.dateselector.init_date_selectors';
80         $config = array(array('firstdayofweek'=>get_string('firstdayofweek', 'langconfig')));
81         $PAGE->requires->yui_module($module, $function, $config);
82         $done = true;
83     }
84 }
86 /**
87  * Wrapper that separates quickforms syntax from moodle code
88  *
89  * Moodle specific wrapper that separates quickforms syntax from moodle code. You won't directly
90  * use this class you should write a class definition which extends this class or a more specific
91  * subclass such a moodleform_mod for each form you want to display and/or process with formslib.
92  *
93  * You will write your own definition() method which performs the form set up.
94  *
95  * @package   core_form
96  * @copyright 2006 Jamie Pratt <me@jamiep.org>
97  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
98  * @todo      MDL-19380 rethink the file scanning
99  */
100 abstract class moodleform {
101     /** @var string name of the form */
102     protected $_formname;       // form name
104     /** @var MoodleQuickForm quickform object definition */
105     protected $_form;
107     /** @var array globals workaround */
108     protected $_customdata;
110     /** @var object definition_after_data executed flag */
111     protected $_definition_finalized = false;
113     /**
114      * The constructor function calls the abstract function definition() and it will then
115      * process and clean and attempt to validate incoming data.
116      *
117      * It will call your custom validate method to validate data and will also check any rules
118      * you have specified in definition using addRule
119      *
120      * The name of the form (id attribute of the form) is automatically generated depending on
121      * the name you gave the class extending moodleform. You should call your class something
122      * like
123      *
124      * @param mixed $action the action attribute for the form. If empty defaults to auto detect the
125      *              current url. If a moodle_url object then outputs params as hidden variables.
126      * @param mixed $customdata if your form defintion method needs access to data such as $course
127      *              $cm, etc. to construct the form definition then pass it in this array. You can
128      *              use globals for somethings.
129      * @param string $method if you set this to anything other than 'post' then _GET and _POST will
130      *               be merged and used as incoming data to the form.
131      * @param string $target target frame for form submission. You will rarely use this. Don't use
132      *               it if you don't need to as the target attribute is deprecated in xhtml strict.
133      * @param mixed $attributes you can pass a string of html attributes here or an array.
134      * @param bool $editable
135      */
136     function moodleform($action=null, $customdata=null, $method='post', $target='', $attributes=null, $editable=true) {
137         global $CFG;
138         if (empty($CFG->xmlstrictheaders)) {
139             // no standard mform in moodle should allow autocomplete with the exception of user signup
140             // this is valid attribute in html5, sorry, we have to ignore validation errors in legacy xhtml 1.0
141             if (empty($attributes)) {
142                 $attributes = array('autocomplete'=>'off');
143             } else if (is_array($attributes)) {
144                 $attributes['autocomplete'] = 'off';
145             } else {
146                 if (strpos($attributes, 'autocomplete') === false) {
147                     $attributes .= ' autocomplete="off" ';
148                 }
149             }
150         }
152         if (empty($action)){
153             $action = strip_querystring(qualified_me());
154         }
155         // Assign custom data first, so that get_form_identifier can use it.
156         $this->_customdata = $customdata;
157         $this->_formname = $this->get_form_identifier();
159         $this->_form = new MoodleQuickForm($this->_formname, $method, $action, $target, $attributes);
160         if (!$editable){
161             $this->_form->hardFreeze();
162         }
164         $this->definition();
166         $this->_form->addElement('hidden', 'sesskey', null); // automatic sesskey protection
167         $this->_form->setType('sesskey', PARAM_RAW);
168         $this->_form->setDefault('sesskey', sesskey());
169         $this->_form->addElement('hidden', '_qf__'.$this->_formname, null);   // form submission marker
170         $this->_form->setType('_qf__'.$this->_formname, PARAM_RAW);
171         $this->_form->setDefault('_qf__'.$this->_formname, 1);
172         $this->_form->_setDefaultRuleMessages();
174         // we have to know all input types before processing submission ;-)
175         $this->_process_submission($method);
176     }
178     /**
179      * It should returns unique identifier for the form.
180      * Currently it will return class name, but in case two same forms have to be
181      * rendered on same page then override function to get unique form identifier.
182      * e.g This is used on multiple self enrollments page.
183      *
184      * @return string form identifier.
185      */
186     protected function get_form_identifier() {
187         return get_class($this);
188     }
190     /**
191      * To autofocus on first form element or first element with error.
192      *
193      * @param string $name if this is set then the focus is forced to a field with this name
194      * @return string javascript to select form element with first error or
195      *                first element if no errors. Use this as a parameter
196      *                when calling print_header
197      */
198     function focus($name=NULL) {
199         $form =& $this->_form;
200         $elkeys = array_keys($form->_elementIndex);
201         $error = false;
202         if (isset($form->_errors) &&  0 != count($form->_errors)){
203             $errorkeys = array_keys($form->_errors);
204             $elkeys = array_intersect($elkeys, $errorkeys);
205             $error = true;
206         }
208         if ($error or empty($name)) {
209             $names = array();
210             while (empty($names) and !empty($elkeys)) {
211                 $el = array_shift($elkeys);
212                 $names = $form->_getElNamesRecursive($el);
213             }
214             if (!empty($names)) {
215                 $name = array_shift($names);
216             }
217         }
219         $focus = '';
220         if (!empty($name)) {
221             $focus = 'forms[\''.$form->getAttribute('id').'\'].elements[\''.$name.'\']';
222         }
224         return $focus;
225      }
227     /**
228      * Internal method. Alters submitted data to be suitable for quickforms processing.
229      * Must be called when the form is fully set up.
230      *
231      * @param string $method name of the method which alters submitted data
232      */
233     function _process_submission($method) {
234         $submission = array();
235         if ($method == 'post') {
236             if (!empty($_POST)) {
237                 $submission = $_POST;
238             }
239         } else {
240             $submission = array_merge_recursive($_GET, $_POST); // emulate handling of parameters in xxxx_param()
241         }
243         // following trick is needed to enable proper sesskey checks when using GET forms
244         // the _qf__.$this->_formname serves as a marker that form was actually submitted
245         if (array_key_exists('_qf__'.$this->_formname, $submission) and $submission['_qf__'.$this->_formname] == 1) {
246             if (!confirm_sesskey()) {
247                 print_error('invalidsesskey');
248             }
249             $files = $_FILES;
250         } else {
251             $submission = array();
252             $files = array();
253         }
255         $this->_form->updateSubmission($submission, $files);
256     }
258     /**
259      * Internal method. Validates all old-style deprecated uploaded files.
260      * The new way is to upload files via repository api.
261      *
262      * @param array $files list of files to be validated
263      * @return bool|array Success or an array of errors
264      */
265     function _validate_files(&$files) {
266         global $CFG, $COURSE;
268         $files = array();
270         if (empty($_FILES)) {
271             // we do not need to do any checks because no files were submitted
272             // note: server side rules do not work for files - use custom verification in validate() instead
273             return true;
274         }
276         $errors = array();
277         $filenames = array();
279         // now check that we really want each file
280         foreach ($_FILES as $elname=>$file) {
281             $required = $this->_form->isElementRequired($elname);
283             if ($file['error'] == 4 and $file['size'] == 0) {
284                 if ($required) {
285                     $errors[$elname] = get_string('required');
286                 }
287                 unset($_FILES[$elname]);
288                 continue;
289             }
291             if (!empty($file['error'])) {
292                 $errors[$elname] = file_get_upload_error($file['error']);
293                 unset($_FILES[$elname]);
294                 continue;
295             }
297             if (!is_uploaded_file($file['tmp_name'])) {
298                 // TODO: improve error message
299                 $errors[$elname] = get_string('error');
300                 unset($_FILES[$elname]);
301                 continue;
302             }
304             if (!$this->_form->elementExists($elname) or !$this->_form->getElementType($elname)=='file') {
305                 // hmm, this file was not requested
306                 unset($_FILES[$elname]);
307                 continue;
308             }
310 /*
311   // TODO: rethink the file scanning MDL-19380
312             if ($CFG->runclamonupload) {
313                 if (!clam_scan_moodle_file($_FILES[$elname], $COURSE)) {
314                     $errors[$elname] = $_FILES[$elname]['uploadlog'];
315                     unset($_FILES[$elname]);
316                     continue;
317                 }
318             }
319 */
320             $filename = clean_param($_FILES[$elname]['name'], PARAM_FILE);
321             if ($filename === '') {
322                 // TODO: improve error message - wrong chars
323                 $errors[$elname] = get_string('error');
324                 unset($_FILES[$elname]);
325                 continue;
326             }
327             if (in_array($filename, $filenames)) {
328                 // TODO: improve error message - duplicate name
329                 $errors[$elname] = get_string('error');
330                 unset($_FILES[$elname]);
331                 continue;
332             }
333             $filenames[] = $filename;
334             $_FILES[$elname]['name'] = $filename;
336             $files[$elname] = $_FILES[$elname]['tmp_name'];
337         }
339         // return errors if found
340         if (count($errors) == 0){
341             return true;
343         } else {
344             $files = array();
345             return $errors;
346         }
347     }
349     /**
350      * Internal method. Validates filepicker and filemanager files if they are
351      * set as required fields. Also, sets the error message if encountered one.
352      *
353      * @return bool|array with errors
354      */
355     protected function validate_draft_files() {
356         global $USER;
357         $mform =& $this->_form;
359         $errors = array();
360         //Go through all the required elements and make sure you hit filepicker or
361         //filemanager element.
362         foreach ($mform->_rules as $elementname => $rules) {
363             $elementtype = $mform->getElementType($elementname);
364             //If element is of type filepicker then do validation
365             if (($elementtype == 'filepicker') || ($elementtype == 'filemanager')){
366                 //Check if rule defined is required rule
367                 foreach ($rules as $rule) {
368                     if ($rule['type'] == 'required') {
369                         $draftid = (int)$mform->getSubmitValue($elementname);
370                         $fs = get_file_storage();
371                         $context = get_context_instance(CONTEXT_USER, $USER->id);
372                         if (!$files = $fs->get_area_files($context->id, 'user', 'draft', $draftid, 'id DESC', false)) {
373                             $errors[$elementname] = $rule['message'];
374                         }
375                     }
376                 }
377             }
378         }
379         if (empty($errors)) {
380             return true;
381         } else {
382             return $errors;
383         }
384     }
386     /**
387      * Load in existing data as form defaults. Usually new entry defaults are stored directly in
388      * form definition (new entry form); this function is used to load in data where values
389      * already exist and data is being edited (edit entry form).
390      *
391      * note: $slashed param removed
392      *
393      * @param stdClass|array $default_values object or array of default values
394      */
395     function set_data($default_values) {
396         if (is_object($default_values)) {
397             $default_values = (array)$default_values;
398         }
399         $this->_form->setDefaults($default_values);
400     }
402     /**
403      * Sets file upload manager
404      *
405      * @deprecated since Moodle 2.0 Please don't used this API
406      * @todo MDL-31300 this api will be removed.
407      * @see MoodleQuickForm_filepicker
408      * @see MoodleQuickForm_filemanager
409      * @param bool $um upload manager
410      */
411     function set_upload_manager($um=false) {
412         debugging('Old file uploads can not be used any more, please use new filepicker element');
413     }
415     /**
416      * Check that form was submitted. Does not check validity of submitted data.
417      *
418      * @return bool true if form properly submitted
419      */
420     function is_submitted() {
421         return $this->_form->isSubmitted();
422     }
424     /**
425      * Checks if button pressed is not for submitting the form
426      *
427      * @staticvar bool $nosubmit keeps track of no submit button
428      * @return bool
429      */
430     function no_submit_button_pressed(){
431         static $nosubmit = null; // one check is enough
432         if (!is_null($nosubmit)){
433             return $nosubmit;
434         }
435         $mform =& $this->_form;
436         $nosubmit = false;
437         if (!$this->is_submitted()){
438             return false;
439         }
440         foreach ($mform->_noSubmitButtons as $nosubmitbutton){
441             if (optional_param($nosubmitbutton, 0, PARAM_RAW)){
442                 $nosubmit = true;
443                 break;
444             }
445         }
446         return $nosubmit;
447     }
450     /**
451      * Check that form data is valid.
452      * You should almost always use this, rather than {@link validate_defined_fields}
453      *
454      * @return bool true if form data valid
455      */
456     function is_validated() {
457         //finalize the form definition before any processing
458         if (!$this->_definition_finalized) {
459             $this->_definition_finalized = true;
460             $this->definition_after_data();
461         }
463         return $this->validate_defined_fields();
464     }
466     /**
467      * Validate the form.
468      *
469      * You almost always want to call {@link is_validated} instead of this
470      * because it calls {@link definition_after_data} first, before validating the form,
471      * which is what you want in 99% of cases.
472      *
473      * This is provided as a separate function for those special cases where
474      * you want the form validated before definition_after_data is called
475      * for example, to selectively add new elements depending on a no_submit_button press,
476      * but only when the form is valid when the no_submit_button is pressed,
477      *
478      * @param bool $validateonnosubmit optional, defaults to false.  The default behaviour
479      *             is NOT to validate the form when a no submit button has been pressed.
480      *             pass true here to override this behaviour
481      *
482      * @return bool true if form data valid
483      */
484     function validate_defined_fields($validateonnosubmit=false) {
485         static $validated = null; // one validation is enough
486         $mform =& $this->_form;
487         if ($this->no_submit_button_pressed() && empty($validateonnosubmit)){
488             return false;
489         } elseif ($validated === null) {
490             $internal_val = $mform->validate();
492             $files = array();
493             $file_val = $this->_validate_files($files);
494             //check draft files for validation and flag them if required files
495             //are not in draft area.
496             $draftfilevalue = $this->validate_draft_files();
498             if ($file_val !== true && $draftfilevalue !== true) {
499                 $file_val = array_merge($file_val, $draftfilevalue);
500             } else if ($draftfilevalue !== true) {
501                 $file_val = $draftfilevalue;
502             } //default is file_val, so no need to assign.
504             if ($file_val !== true) {
505                 if (!empty($file_val)) {
506                     foreach ($file_val as $element=>$msg) {
507                         $mform->setElementError($element, $msg);
508                     }
509                 }
510                 $file_val = false;
511             }
513             $data = $mform->exportValues();
514             $moodle_val = $this->validation($data, $files);
515             if ((is_array($moodle_val) && count($moodle_val)!==0)) {
516                 // non-empty array means errors
517                 foreach ($moodle_val as $element=>$msg) {
518                     $mform->setElementError($element, $msg);
519                 }
520                 $moodle_val = false;
522             } else {
523                 // anything else means validation ok
524                 $moodle_val = true;
525             }
527             $validated = ($internal_val and $moodle_val and $file_val);
528         }
529         return $validated;
530     }
532     /**
533      * Return true if a cancel button has been pressed resulting in the form being submitted.
534      *
535      * @return bool true if a cancel button has been pressed
536      */
537     function is_cancelled(){
538         $mform =& $this->_form;
539         if ($mform->isSubmitted()){
540             foreach ($mform->_cancelButtons as $cancelbutton){
541                 if (optional_param($cancelbutton, 0, PARAM_RAW)){
542                     return true;
543                 }
544             }
545         }
546         return false;
547     }
549     /**
550      * Return submitted data if properly submitted or returns NULL if validation fails or
551      * if there is no submitted data.
552      *
553      * note: $slashed param removed
554      *
555      * @return object submitted data; NULL if not valid or not submitted or cancelled
556      */
557     function get_data() {
558         $mform =& $this->_form;
560         if (!$this->is_cancelled() and $this->is_submitted() and $this->is_validated()) {
561             $data = $mform->exportValues();
562             unset($data['sesskey']); // we do not need to return sesskey
563             unset($data['_qf__'.$this->_formname]);   // we do not need the submission marker too
564             if (empty($data)) {
565                 return NULL;
566             } else {
567                 return (object)$data;
568             }
569         } else {
570             return NULL;
571         }
572     }
574     /**
575      * Return submitted data without validation or NULL if there is no submitted data.
576      * note: $slashed param removed
577      *
578      * @return object submitted data; NULL if not submitted
579      */
580     function get_submitted_data() {
581         $mform =& $this->_form;
583         if ($this->is_submitted()) {
584             $data = $mform->exportValues();
585             unset($data['sesskey']); // we do not need to return sesskey
586             unset($data['_qf__'.$this->_formname]);   // we do not need the submission marker too
587             if (empty($data)) {
588                 return NULL;
589             } else {
590                 return (object)$data;
591             }
592         } else {
593             return NULL;
594         }
595     }
597     /**
598      * Save verified uploaded files into directory. Upload process can be customised from definition()
599      *
600      * @deprecated since Moodle 2.0
601      * @todo MDL-31294 remove this api
602      * @see moodleform::save_stored_file()
603      * @see moodleform::save_file()
604      * @param string $destination path where file should be stored
605      * @return bool Always false
606      */
607     function save_files($destination) {
608         debugging('Not used anymore, please fix code! Use save_stored_file() or save_file() instead');
609         return false;
610     }
612     /**
613      * Returns name of uploaded file.
614      *
615      * @param string $elname first element if null
616      * @return string|bool false in case of failure, string if ok
617      */
618     function get_new_filename($elname=null) {
619         global $USER;
621         if (!$this->is_submitted() or !$this->is_validated()) {
622             return false;
623         }
625         if (is_null($elname)) {
626             if (empty($_FILES)) {
627                 return false;
628             }
629             reset($_FILES);
630             $elname = key($_FILES);
631         }
633         if (empty($elname)) {
634             return false;
635         }
637         $element = $this->_form->getElement($elname);
639         if ($element instanceof MoodleQuickForm_filepicker || $element instanceof MoodleQuickForm_filemanager) {
640             $values = $this->_form->exportValues($elname);
641             if (empty($values[$elname])) {
642                 return false;
643             }
644             $draftid = $values[$elname];
645             $fs = get_file_storage();
646             $context = get_context_instance(CONTEXT_USER, $USER->id);
647             if (!$files = $fs->get_area_files($context->id, 'user', 'draft', $draftid, 'id DESC', false)) {
648                 return false;
649             }
650             $file = reset($files);
651             return $file->get_filename();
652         }
654         if (!isset($_FILES[$elname])) {
655             return false;
656         }
658         return $_FILES[$elname]['name'];
659     }
661     /**
662      * Save file to standard filesystem
663      *
664      * @param string $elname name of element
665      * @param string $pathname full path name of file
666      * @param bool $override override file if exists
667      * @return bool success
668      */
669     function save_file($elname, $pathname, $override=false) {
670         global $USER;
672         if (!$this->is_submitted() or !$this->is_validated()) {
673             return false;
674         }
675         if (file_exists($pathname)) {
676             if ($override) {
677                 if (!@unlink($pathname)) {
678                     return false;
679                 }
680             } else {
681                 return false;
682             }
683         }
685         $element = $this->_form->getElement($elname);
687         if ($element instanceof MoodleQuickForm_filepicker || $element instanceof MoodleQuickForm_filemanager) {
688             $values = $this->_form->exportValues($elname);
689             if (empty($values[$elname])) {
690                 return false;
691             }
692             $draftid = $values[$elname];
693             $fs = get_file_storage();
694             $context = get_context_instance(CONTEXT_USER, $USER->id);
695             if (!$files = $fs->get_area_files($context->id, 'user', 'draft', $draftid, 'id DESC', false)) {
696                 return false;
697             }
698             $file = reset($files);
700             return $file->copy_content_to($pathname);
702         } else if (isset($_FILES[$elname])) {
703             return copy($_FILES[$elname]['tmp_name'], $pathname);
704         }
706         return false;
707     }
709     /**
710      * Returns a temporary file, do not forget to delete after not needed any more.
711      *
712      * @param string $elname name of the elmenet
713      * @return string|bool either string or false
714      */
715     function save_temp_file($elname) {
716         if (!$this->get_new_filename($elname)) {
717             return false;
718         }
719         if (!$dir = make_temp_directory('forms')) {
720             return false;
721         }
722         if (!$tempfile = tempnam($dir, 'tempup_')) {
723             return false;
724         }
725         if (!$this->save_file($elname, $tempfile, true)) {
726             // something went wrong
727             @unlink($tempfile);
728             return false;
729         }
731         return $tempfile;
732     }
734     /**
735      * Get draft files of a form element
736      * This is a protected method which will be used only inside moodleforms
737      *
738      * @param string $elname name of element
739      * @return array|bool|null
740      */
741     protected function get_draft_files($elname) {
742         global $USER;
744         if (!$this->is_submitted()) {
745             return false;
746         }
748         $element = $this->_form->getElement($elname);
750         if ($element instanceof MoodleQuickForm_filepicker || $element instanceof MoodleQuickForm_filemanager) {
751             $values = $this->_form->exportValues($elname);
752             if (empty($values[$elname])) {
753                 return false;
754             }
755             $draftid = $values[$elname];
756             $fs = get_file_storage();
757             $context = get_context_instance(CONTEXT_USER, $USER->id);
758             if (!$files = $fs->get_area_files($context->id, 'user', 'draft', $draftid, 'id DESC', false)) {
759                 return null;
760             }
761             return $files;
762         }
763         return null;
764     }
766     /**
767      * Save file to local filesystem pool
768      *
769      * @param string $elname name of element
770      * @param int $newcontextid id of context
771      * @param string $newcomponent name of the component
772      * @param string $newfilearea name of file area
773      * @param int $newitemid item id
774      * @param string $newfilepath path of file where it get stored
775      * @param string $newfilename use specified filename, if not specified name of uploaded file used
776      * @param bool $overwrite overwrite file if exists
777      * @param int $newuserid new userid if required
778      * @return mixed stored_file object or false if error; may throw exception if duplicate found
779      */
780     function save_stored_file($elname, $newcontextid, $newcomponent, $newfilearea, $newitemid, $newfilepath='/',
781                               $newfilename=null, $overwrite=false, $newuserid=null) {
782         global $USER;
784         if (!$this->is_submitted() or !$this->is_validated()) {
785             return false;
786         }
788         if (empty($newuserid)) {
789             $newuserid = $USER->id;
790         }
792         $element = $this->_form->getElement($elname);
793         $fs = get_file_storage();
795         if ($element instanceof MoodleQuickForm_filepicker) {
796             $values = $this->_form->exportValues($elname);
797             if (empty($values[$elname])) {
798                 return false;
799             }
800             $draftid = $values[$elname];
801             $context = get_context_instance(CONTEXT_USER, $USER->id);
802             if (!$files = $fs->get_area_files($context->id, 'user' ,'draft', $draftid, 'id DESC', false)) {
803                 return false;
804             }
805             $file = reset($files);
806             if (is_null($newfilename)) {
807                 $newfilename = $file->get_filename();
808             }
810             if ($overwrite) {
811                 if ($oldfile = $fs->get_file($newcontextid, $newcomponent, $newfilearea, $newitemid, $newfilepath, $newfilename)) {
812                     if (!$oldfile->delete()) {
813                         return false;
814                     }
815                 }
816             }
818             $file_record = array('contextid'=>$newcontextid, 'component'=>$newcomponent, 'filearea'=>$newfilearea, 'itemid'=>$newitemid,
819                                  'filepath'=>$newfilepath, 'filename'=>$newfilename, 'userid'=>$newuserid);
820             return $fs->create_file_from_storedfile($file_record, $file);
822         } else if (isset($_FILES[$elname])) {
823             $filename = is_null($newfilename) ? $_FILES[$elname]['name'] : $newfilename;
825             if ($overwrite) {
826                 if ($oldfile = $fs->get_file($newcontextid, $newcomponent, $newfilearea, $newitemid, $newfilepath, $newfilename)) {
827                     if (!$oldfile->delete()) {
828                         return false;
829                     }
830                 }
831             }
833             $file_record = array('contextid'=>$newcontextid, 'component'=>$newcomponent, 'filearea'=>$newfilearea, 'itemid'=>$newitemid,
834                                  'filepath'=>$newfilepath, 'filename'=>$newfilename, 'userid'=>$newuserid);
835             return $fs->create_file_from_pathname($file_record, $_FILES[$elname]['tmp_name']);
836         }
838         return false;
839     }
841     /**
842      * Get content of uploaded file.
843      *
844      * @param string $elname name of file upload element
845      * @return string|bool false in case of failure, string if ok
846      */
847     function get_file_content($elname) {
848         global $USER;
850         if (!$this->is_submitted() or !$this->is_validated()) {
851             return false;
852         }
854         $element = $this->_form->getElement($elname);
856         if ($element instanceof MoodleQuickForm_filepicker || $element instanceof MoodleQuickForm_filemanager) {
857             $values = $this->_form->exportValues($elname);
858             if (empty($values[$elname])) {
859                 return false;
860             }
861             $draftid = $values[$elname];
862             $fs = get_file_storage();
863             $context = get_context_instance(CONTEXT_USER, $USER->id);
864             if (!$files = $fs->get_area_files($context->id, 'user', 'draft', $draftid, 'id DESC', false)) {
865                 return false;
866             }
867             $file = reset($files);
869             return $file->get_content();
871         } else if (isset($_FILES[$elname])) {
872             return file_get_contents($_FILES[$elname]['tmp_name']);
873         }
875         return false;
876     }
878     /**
879      * Print html form.
880      */
881     function display() {
882         //finalize the form definition if not yet done
883         if (!$this->_definition_finalized) {
884             $this->_definition_finalized = true;
885             $this->definition_after_data();
886         }
887         $this->_form->display();
888     }
890     /**
891      * Form definition. Abstract method - always override!
892      */
893     protected abstract function definition();
895     /**
896      * Dummy stub method - override if you need to setup the form depending on current
897      * values. This method is called after definition(), data submission and set_data().
898      * All form setup that is dependent on form values should go in here.
899      */
900     function definition_after_data(){
901     }
903     /**
904      * Dummy stub method - override if you needed to perform some extra validation.
905      * If there are errors return array of errors ("fieldname"=>"error message"),
906      * otherwise true if ok.
907      *
908      * Server side rules do not work for uploaded files, implement serverside rules here if needed.
909      *
910      * @param array $data array of ("fieldname"=>value) of submitted data
911      * @param array $files array of uploaded files "element_name"=>tmp_file_path
912      * @return array of "element_name"=>"error_description" if there are errors,
913      *         or an empty array if everything is OK (true allowed for backwards compatibility too).
914      */
915     function validation($data, $files) {
916         return array();
917     }
919     /**
920      * Helper used by {@link repeat_elements()}.
921      *
922      * @param int $i the index of this element.
923      * @param HTML_QuickForm_element $elementclone
924      * @param array $namecloned array of names
925      */
926     function repeat_elements_fix_clone($i, $elementclone, &$namecloned) {
927         $name = $elementclone->getName();
928         $namecloned[] = $name;
930         if (!empty($name)) {
931             $elementclone->setName($name."[$i]");
932         }
934         if (is_a($elementclone, 'HTML_QuickForm_header')) {
935             $value = $elementclone->_text;
936             $elementclone->setValue(str_replace('{no}', ($i+1), $value));
938         } else {
939             $value=$elementclone->getLabel();
940             $elementclone->setLabel(str_replace('{no}', ($i+1), $value));
941         }
942     }
944     /**
945      * Method to add a repeating group of elements to a form.
946      *
947      * @param array $elementobjs Array of elements or groups of elements that are to be repeated
948      * @param int $repeats no of times to repeat elements initially
949      * @param array $options Array of options to apply to elements. Array keys are element names.
950      *     This is an array of arrays. The second sets of keys are the option types for the elements :
951      *         'default' - default value is value
952      *         'type' - PARAM_* constant is value
953      *         'helpbutton' - helpbutton params array is value
954      *         'disabledif' - last three moodleform::disabledIf()
955      *         params are value as an array
956      * @param string $repeathiddenname name for hidden element storing no of repeats in this form
957      * @param string $addfieldsname name for button to add more fields
958      * @param int $addfieldsno how many fields to add at a time
959      * @param string $addstring name of button, {no} is replaced by no of blanks that will be added.
960      * @param bool $addbuttoninside if true, don't call closeHeaderBefore($addfieldsname). Default false.
961      * @return int no of repeats of element in this page
962      */
963     function repeat_elements($elementobjs, $repeats, $options, $repeathiddenname,
964             $addfieldsname, $addfieldsno=5, $addstring=null, $addbuttoninside=false){
965         if ($addstring===null){
966             $addstring = get_string('addfields', 'form', $addfieldsno);
967         } else {
968             $addstring = str_ireplace('{no}', $addfieldsno, $addstring);
969         }
970         $repeats = optional_param($repeathiddenname, $repeats, PARAM_INT);
971         $addfields = optional_param($addfieldsname, '', PARAM_TEXT);
972         if (!empty($addfields)){
973             $repeats += $addfieldsno;
974         }
975         $mform =& $this->_form;
976         $mform->registerNoSubmitButton($addfieldsname);
977         $mform->addElement('hidden', $repeathiddenname, $repeats);
978         $mform->setType($repeathiddenname, PARAM_INT);
979         //value not to be overridden by submitted value
980         $mform->setConstants(array($repeathiddenname=>$repeats));
981         $namecloned = array();
982         for ($i = 0; $i < $repeats; $i++) {
983             foreach ($elementobjs as $elementobj){
984                 $elementclone = fullclone($elementobj);
985                 $this->repeat_elements_fix_clone($i, $elementclone, $namecloned);
987                 if ($elementclone instanceof HTML_QuickForm_group && !$elementclone->_appendName) {
988                     foreach ($elementclone->getElements() as $el) {
989                         $this->repeat_elements_fix_clone($i, $el, $namecloned);
990                     }
991                     $elementclone->setLabel(str_replace('{no}', $i + 1, $elementclone->getLabel()));
992                 }
994                 $mform->addElement($elementclone);
995             }
996         }
997         for ($i=0; $i<$repeats; $i++) {
998             foreach ($options as $elementname => $elementoptions){
999                 $pos=strpos($elementname, '[');
1000                 if ($pos!==FALSE){
1001                     $realelementname = substr($elementname, 0, $pos+1)."[$i]";
1002                     $realelementname .= substr($elementname, $pos+1);
1003                 }else {
1004                     $realelementname = $elementname."[$i]";
1005                 }
1006                 foreach ($elementoptions as  $option => $params){
1008                     switch ($option){
1009                         case 'default' :
1010                             $mform->setDefault($realelementname, $params);
1011                             break;
1012                         case 'helpbutton' :
1013                             $params = array_merge(array($realelementname), $params);
1014                             call_user_func_array(array(&$mform, 'addHelpButton'), $params);
1015                             break;
1016                         case 'disabledif' :
1017                             foreach ($namecloned as $num => $name){
1018                                 if ($params[0] == $name){
1019                                     $params[0] = $params[0]."[$i]";
1020                                     break;
1021                                 }
1022                             }
1023                             $params = array_merge(array($realelementname), $params);
1024                             call_user_func_array(array(&$mform, 'disabledIf'), $params);
1025                             break;
1026                         case 'rule' :
1027                             if (is_string($params)){
1028                                 $params = array(null, $params, null, 'client');
1029                             }
1030                             $params = array_merge(array($realelementname), $params);
1031                             call_user_func_array(array(&$mform, 'addRule'), $params);
1032                             break;
1033                         case 'type' :
1034                             //Type should be set only once
1035                             if (!isset($mform->_types[$elementname])) {
1036                                 $mform->setType($elementname, $params);
1037                             }
1038                             break;
1039                     }
1040                 }
1041             }
1042         }
1043         $mform->addElement('submit', $addfieldsname, $addstring);
1045         if (!$addbuttoninside) {
1046             $mform->closeHeaderBefore($addfieldsname);
1047         }
1049         return $repeats;
1050     }
1052     /**
1053      * Adds a link/button that controls the checked state of a group of checkboxes.
1054      *
1055      * @param int $groupid The id of the group of advcheckboxes this element controls
1056      * @param string $text The text of the link. Defaults to selectallornone ("select all/none")
1057      * @param array $attributes associative array of HTML attributes
1058      * @param int $originalValue The original general state of the checkboxes before the user first clicks this element
1059      */
1060     function add_checkbox_controller($groupid, $text = null, $attributes = null, $originalValue = 0) {
1061         global $CFG, $PAGE;
1063         // Name of the controller button
1064         $checkboxcontrollername = 'nosubmit_checkbox_controller' . $groupid;
1065         $checkboxcontrollerparam = 'checkbox_controller'. $groupid;
1066         $checkboxgroupclass = 'checkboxgroup'.$groupid;
1068         // Set the default text if none was specified
1069         if (empty($text)) {
1070             $text = get_string('selectallornone', 'form');
1071         }
1073         $mform = $this->_form;
1074         $selectvalue = optional_param($checkboxcontrollerparam, null, PARAM_INT);
1075         $contollerbutton = optional_param($checkboxcontrollername, null, PARAM_ALPHAEXT);
1077         $newselectvalue = $selectvalue;
1078         if (is_null($selectvalue)) {
1079             $newselectvalue = $originalValue;
1080         } else if (!is_null($contollerbutton)) {
1081             $newselectvalue = (int) !$selectvalue;
1082         }
1083         // set checkbox state depending on orignal/submitted value by controoler button
1084         if (!is_null($contollerbutton) || is_null($selectvalue)) {
1085             foreach ($mform->_elements as $element) {
1086                 if (($element instanceof MoodleQuickForm_advcheckbox) &&
1087                     $element->getAttribute('class') == $checkboxgroupclass) {
1088                     $mform->setConstants(array($element->getName() => $newselectvalue));
1089                 }
1090             }
1091         }
1093         $mform->addElement('hidden', $checkboxcontrollerparam, $newselectvalue, array('id' => "id_".$checkboxcontrollerparam));
1094         $mform->setType($checkboxcontrollerparam, PARAM_INT);
1095         $mform->setConstants(array($checkboxcontrollerparam => $newselectvalue));
1097         $PAGE->requires->yui_module('moodle-form-checkboxcontroller', 'M.form.checkboxcontroller',
1098                 array(
1099                     array('groupid' => $groupid,
1100                         'checkboxclass' => $checkboxgroupclass,
1101                         'checkboxcontroller' => $checkboxcontrollerparam,
1102                         'controllerbutton' => $checkboxcontrollername)
1103                     )
1104                 );
1106         require_once("$CFG->libdir/form/submit.php");
1107         $submitlink = new MoodleQuickForm_submit($checkboxcontrollername, $attributes);
1108         $mform->addElement($submitlink);
1109         $mform->registerNoSubmitButton($checkboxcontrollername);
1110         $mform->setDefault($checkboxcontrollername, $text);
1111     }
1113     /**
1114      * Use this method to a cancel and submit button to the end of your form. Pass a param of false
1115      * if you don't want a cancel button in your form. If you have a cancel button make sure you
1116      * check for it being pressed using is_cancelled() and redirecting if it is true before trying to
1117      * get data with get_data().
1118      *
1119      * @param bool $cancel whether to show cancel button, default true
1120      * @param string $submitlabel label for submit button, defaults to get_string('savechanges')
1121      */
1122     function add_action_buttons($cancel = true, $submitlabel=null){
1123         if (is_null($submitlabel)){
1124             $submitlabel = get_string('savechanges');
1125         }
1126         $mform =& $this->_form;
1127         if ($cancel){
1128             //when two elements we need a group
1129             $buttonarray=array();
1130             $buttonarray[] = &$mform->createElement('submit', 'submitbutton', $submitlabel);
1131             $buttonarray[] = &$mform->createElement('cancel');
1132             $mform->addGroup($buttonarray, 'buttonar', '', array(' '), false);
1133             $mform->closeHeaderBefore('buttonar');
1134         } else {
1135             //no group needed
1136             $mform->addElement('submit', 'submitbutton', $submitlabel);
1137             $mform->closeHeaderBefore('submitbutton');
1138         }
1139     }
1141     /**
1142      * Adds an initialisation call for a standard JavaScript enhancement.
1143      *
1144      * This function is designed to add an initialisation call for a JavaScript
1145      * enhancement that should exist within javascript-static M.form.init_{enhancementname}.
1146      *
1147      * Current options:
1148      *  - Selectboxes
1149      *      - smartselect:  Turns a nbsp indented select box into a custom drop down
1150      *                      control that supports multilevel and category selection.
1151      *                      $enhancement = 'smartselect';
1152      *                      $options = array('selectablecategories' => true|false)
1153      *
1154      * @since Moodle 2.0
1155      * @param string|element $element form element for which Javascript needs to be initalized
1156      * @param string $enhancement which init function should be called
1157      * @param array $options options passed to javascript
1158      * @param array $strings strings for javascript
1159      */
1160     function init_javascript_enhancement($element, $enhancement, array $options=array(), array $strings=null) {
1161         global $PAGE;
1162         if (is_string($element)) {
1163             $element = $this->_form->getElement($element);
1164         }
1165         if (is_object($element)) {
1166             $element->_generateId();
1167             $elementid = $element->getAttribute('id');
1168             $PAGE->requires->js_init_call('M.form.init_'.$enhancement, array($elementid, $options));
1169             if (is_array($strings)) {
1170                 foreach ($strings as $string) {
1171                     if (is_array($string)) {
1172                         call_user_method_array('string_for_js', $PAGE->requires, $string);
1173                     } else {
1174                         $PAGE->requires->string_for_js($string, 'moodle');
1175                     }
1176                 }
1177             }
1178         }
1179     }
1181     /**
1182      * Returns a JS module definition for the mforms JS
1183      *
1184      * @return array
1185      */
1186     public static function get_js_module() {
1187         global $CFG;
1188         return array(
1189             'name' => 'mform',
1190             'fullpath' => '/lib/form/form.js',
1191             'requires' => array('base', 'node'),
1192             'strings' => array(
1193                 array('showadvanced', 'form'),
1194                 array('hideadvanced', 'form')
1195             )
1196         );
1197     }
1200 /**
1201  * MoodleQuickForm implementation
1202  *
1203  * You never extend this class directly. The class methods of this class are available from
1204  * the private $this->_form property on moodleform and its children. You generally only
1205  * call methods on this class from within abstract methods that you override on moodleform such
1206  * as definition and definition_after_data
1207  *
1208  * @package   core_form
1209  * @category  form
1210  * @copyright 2006 Jamie Pratt <me@jamiep.org>
1211  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1212  */
1213 class MoodleQuickForm extends HTML_QuickForm_DHTMLRulesTableless {
1214     /** @var array type (PARAM_INT, PARAM_TEXT etc) of element value */
1215     var $_types = array();
1217     /** @var array dependent state for the element/'s */
1218     var $_dependencies = array();
1220     /** @var array Array of buttons that if pressed do not result in the processing of the form. */
1221     var $_noSubmitButtons=array();
1223     /** @var array Array of buttons that if pressed do not result in the processing of the form. */
1224     var $_cancelButtons=array();
1226     /** @var array Array whose keys are element names. If the key exists this is a advanced element */
1227     var $_advancedElements = array();
1229     /** @var bool Whether to display advanced elements (on page load) */
1230     var $_showAdvanced = null;
1232     /**
1233      * The form name is derived from the class name of the wrapper minus the trailing form
1234      * It is a name with words joined by underscores whereas the id attribute is words joined by underscores.
1235      * @var string
1236      */
1237     var $_formName = '';
1239     /**
1240      * String with the html for hidden params passed in as part of a moodle_url
1241      * object for the action. Output in the form.
1242      * @var string
1243      */
1244     var $_pageparams = '';
1246     /**
1247      * Class constructor - same parameters as HTML_QuickForm_DHTMLRulesTableless
1248      *
1249      * @staticvar int $formcounter counts number of forms
1250      * @param string $formName Form's name.
1251      * @param string $method Form's method defaults to 'POST'
1252      * @param string|moodle_url $action Form's action
1253      * @param string $target (optional)Form's target defaults to none
1254      * @param mixed $attributes (optional)Extra attributes for <form> tag
1255      */
1256     function MoodleQuickForm($formName, $method, $action, $target='', $attributes=null){
1257         global $CFG, $OUTPUT;
1259         static $formcounter = 1;
1261         HTML_Common::HTML_Common($attributes);
1262         $target = empty($target) ? array() : array('target' => $target);
1263         $this->_formName = $formName;
1264         if (is_a($action, 'moodle_url')){
1265             $this->_pageparams = html_writer::input_hidden_params($action);
1266             $action = $action->out_omit_querystring();
1267         } else {
1268             $this->_pageparams = '';
1269         }
1270         //no 'name' atttribute for form in xhtml strict :
1271         $attributes = array('action'=>$action, 'method'=>$method,
1272                 'accept-charset'=>'utf-8', 'id'=>'mform'.$formcounter) + $target;
1273         $formcounter++;
1274         $this->updateAttributes($attributes);
1276         //this is custom stuff for Moodle :
1277         $oldclass=   $this->getAttribute('class');
1278         if (!empty($oldclass)){
1279             $this->updateAttributes(array('class'=>$oldclass.' mform'));
1280         }else {
1281             $this->updateAttributes(array('class'=>'mform'));
1282         }
1283         $this->_reqHTML = '<img class="req" title="'.get_string('requiredelement', 'form').'" alt="'.get_string('requiredelement', 'form').'" src="'.$OUTPUT->pix_url('req') .'" />';
1284         $this->_advancedHTML = '<img class="adv" title="'.get_string('advancedelement', 'form').'" alt="'.get_string('advancedelement', 'form').'" src="'.$OUTPUT->pix_url('adv') .'" />';
1285         $this->setRequiredNote(get_string('somefieldsrequired', 'form', '<img alt="'.get_string('requiredelement', 'form').'" src="'.$OUTPUT->pix_url('req') .'" />'));
1286     }
1288     /**
1289      * Use this method to indicate an element in a form is an advanced field. If items in a form
1290      * are marked as advanced then 'Hide/Show Advanced' buttons will automatically be displayed in the
1291      * form so the user can decide whether to display advanced form controls.
1292      *
1293      * If you set a header element to advanced then all elements it contains will also be set as advanced.
1294      *
1295      * @param string $elementName group or element name (not the element name of something inside a group).
1296      * @param bool $advanced default true sets the element to advanced. False removes advanced mark.
1297      */
1298     function setAdvanced($elementName, $advanced=true){
1299         if ($advanced){
1300             $this->_advancedElements[$elementName]='';
1301         } elseif (isset($this->_advancedElements[$elementName])) {
1302             unset($this->_advancedElements[$elementName]);
1303         }
1304         if ($advanced && $this->getElementType('mform_showadvanced_last')===false){
1305             $this->setShowAdvanced();
1306             $this->registerNoSubmitButton('mform_showadvanced');
1308             $this->addElement('hidden', 'mform_showadvanced_last');
1309             $this->setType('mform_showadvanced_last', PARAM_INT);
1310         }
1311     }
1312     /**
1313      * Set whether to show advanced elements in the form on first displaying form. Default is not to
1314      * display advanced elements in the form until 'Show Advanced' is pressed.
1315      *
1316      * You can get the last state of the form and possibly save it for this user by using
1317      * value 'mform_showadvanced_last' in submitted data.
1318      *
1319      * @param bool $showadvancedNow if true will show adavance elements.
1320      */
1321     function setShowAdvanced($showadvancedNow = null){
1322         if ($showadvancedNow === null){
1323             if ($this->_showAdvanced !== null){
1324                 return;
1325             } else { //if setShowAdvanced is called without any preference
1326                      //make the default to not show advanced elements.
1327                 $showadvancedNow = get_user_preferences(
1328                                 textlib::strtolower($this->_formName.'_showadvanced', 0));
1329             }
1330         }
1331         //value of hidden element
1332         $hiddenLast = optional_param('mform_showadvanced_last', -1, PARAM_INT);
1333         //value of button
1334         $buttonPressed = optional_param('mform_showadvanced', 0, PARAM_RAW);
1335         //toggle if button pressed or else stay the same
1336         if ($hiddenLast == -1) {
1337             $next = $showadvancedNow;
1338         } elseif ($buttonPressed) { //toggle on button press
1339             $next = !$hiddenLast;
1340         } else {
1341             $next = $hiddenLast;
1342         }
1343         $this->_showAdvanced = $next;
1344         if ($showadvancedNow != $next){
1345             set_user_preference($this->_formName.'_showadvanced', $next);
1346         }
1347         $this->setConstants(array('mform_showadvanced_last'=>$next));
1348     }
1350     /**
1351      * Gets show advance value, if advance elements are visible it will return true else false
1352      *
1353      * @return bool
1354      */
1355     function getShowAdvanced(){
1356         return $this->_showAdvanced;
1357     }
1360    /**
1361     * Accepts a renderer
1362     *
1363     * @param HTML_QuickForm_Renderer $renderer An HTML_QuickForm_Renderer object
1364     */
1365     function accept(&$renderer) {
1366         if (method_exists($renderer, 'setAdvancedElements')){
1367             //check for visible fieldsets where all elements are advanced
1368             //and mark these headers as advanced as well.
1369             //And mark all elements in a advanced header as advanced
1370             $stopFields = $renderer->getStopFieldSetElements();
1371             $lastHeader = null;
1372             $lastHeaderAdvanced = false;
1373             $anyAdvanced = false;
1374             foreach (array_keys($this->_elements) as $elementIndex){
1375                 $element =& $this->_elements[$elementIndex];
1377                 // if closing header and any contained element was advanced then mark it as advanced
1378                 if ($element->getType()=='header' || in_array($element->getName(), $stopFields)){
1379                     if ($anyAdvanced && !is_null($lastHeader)){
1380                         $this->setAdvanced($lastHeader->getName());
1381                     }
1382                     $lastHeaderAdvanced = false;
1383                     unset($lastHeader);
1384                     $lastHeader = null;
1385                 } elseif ($lastHeaderAdvanced) {
1386                     $this->setAdvanced($element->getName());
1387                 }
1389                 if ($element->getType()=='header'){
1390                     $lastHeader =& $element;
1391                     $anyAdvanced = false;
1392                     $lastHeaderAdvanced = isset($this->_advancedElements[$element->getName()]);
1393                 } elseif (isset($this->_advancedElements[$element->getName()])){
1394                     $anyAdvanced = true;
1395                 }
1396             }
1397             // the last header may not be closed yet...
1398             if ($anyAdvanced && !is_null($lastHeader)){
1399                 $this->setAdvanced($lastHeader->getName());
1400             }
1401             $renderer->setAdvancedElements($this->_advancedElements);
1403         }
1404         parent::accept($renderer);
1405     }
1407     /**
1408      * Adds one or more element names that indicate the end of a fieldset
1409      *
1410      * @param string $elementName name of the element
1411      */
1412     function closeHeaderBefore($elementName){
1413         $renderer =& $this->defaultRenderer();
1414         $renderer->addStopFieldsetElements($elementName);
1415     }
1417     /**
1418      * Should be used for all elements of a form except for select, radio and checkboxes which
1419      * clean their own data.
1420      *
1421      * @param string $elementname
1422      * @param int $paramtype defines type of data contained in element. Use the constants PARAM_*.
1423      *        {@link lib/moodlelib.php} for defined parameter types
1424      */
1425     function setType($elementname, $paramtype) {
1426         $this->_types[$elementname] = $paramtype;
1427     }
1429     /**
1430      * This can be used to set several types at once.
1431      *
1432      * @param array $paramtypes types of parameters.
1433      * @see MoodleQuickForm::setType
1434      */
1435     function setTypes($paramtypes) {
1436         $this->_types = $paramtypes + $this->_types;
1437     }
1439     /**
1440      * Updates submitted values
1441      *
1442      * @param array $submission submitted values
1443      * @param array $files list of files
1444      */
1445     function updateSubmission($submission, $files) {
1446         $this->_flagSubmitted = false;
1448         if (empty($submission)) {
1449             $this->_submitValues = array();
1450         } else {
1451             foreach ($submission as $key=>$s) {
1452                 if (array_key_exists($key, $this->_types)) {
1453                     $type = $this->_types[$key];
1454                 } else {
1455                     $type = PARAM_RAW;
1456                 }
1457                 if (is_array($s)) {
1458                     $submission[$key] = clean_param_array($s, $type, true);
1459                 } else {
1460                     $submission[$key] = clean_param($s, $type);
1461                 }
1462             }
1463             $this->_submitValues = $submission;
1464             $this->_flagSubmitted = true;
1465         }
1467         if (empty($files)) {
1468             $this->_submitFiles = array();
1469         } else {
1470             $this->_submitFiles = $files;
1471             $this->_flagSubmitted = true;
1472         }
1474         // need to tell all elements that they need to update their value attribute.
1475          foreach (array_keys($this->_elements) as $key) {
1476              $this->_elements[$key]->onQuickFormEvent('updateValue', null, $this);
1477          }
1478     }
1480     /**
1481      * Returns HTML for required elements
1482      *
1483      * @return string
1484      */
1485     function getReqHTML(){
1486         return $this->_reqHTML;
1487     }
1489     /**
1490      * Returns HTML for advanced elements
1491      *
1492      * @return string
1493      */
1494     function getAdvancedHTML(){
1495         return $this->_advancedHTML;
1496     }
1498     /**
1499      * Initializes a default form value. Used to specify the default for a new entry where
1500      * no data is loaded in using moodleform::set_data()
1501      *
1502      * note: $slashed param removed
1503      *
1504      * @param string $elementName element name
1505      * @param mixed $defaultValue values for that element name
1506      */
1507     function setDefault($elementName, $defaultValue){
1508         $this->setDefaults(array($elementName=>$defaultValue));
1509     }
1511     /**
1512      * Add an array of buttons to the form
1513      *
1514      * @param array $buttons An associative array representing help button to attach to
1515      *        to the form. keys of array correspond to names of elements in form.
1516      * @param bool $suppresscheck if true then string check will be suppressed
1517      * @param string $function callback function to dispaly help button.
1518      * @deprecated since Moodle 2.0 use addHelpButton() call on each element manually
1519      * @todo MDL-31047 this api will be removed.
1520      * @see MoodleQuickForm::addHelpButton()
1521      */
1522     function setHelpButtons($buttons, $suppresscheck=false, $function='helpbutton'){
1524         debugging('function moodle_form::setHelpButtons() is deprecated');
1525         //foreach ($buttons as $elementname => $button){
1526         //    $this->setHelpButton($elementname, $button, $suppresscheck, $function);
1527         //}
1528     }
1530     /**
1531      * Add a help button to element
1532      *
1533      * @param string $elementname name of the element to add the item to
1534      * @param array $buttonargs arguments to pass to function $function
1535      * @param bool $suppresscheck whether to throw an error if the element
1536      *        doesn't exist.
1537      * @param string $function - function to generate html from the arguments in $button
1538      * @deprecated since Moodle 2.0 - use addHelpButton() call on each element manually
1539      * @todo MDL-31047 this api will be removed.
1540      * @see MoodleQuickForm::addHelpButton()
1541      */
1542     function setHelpButton($elementname, $buttonargs, $suppresscheck=false, $function='helpbutton'){
1543         global $OUTPUT;
1545         debugging('function moodle_form::setHelpButton() is deprecated');
1546         if ($function !== 'helpbutton') {
1547             //debugging('parameter $function in moodle_form::setHelpButton() is not supported any more');
1548         }
1550         $buttonargs = (array)$buttonargs;
1552         if (array_key_exists($elementname, $this->_elementIndex)) {
1553             //_elements has a numeric index, this code accesses the elements by name
1554             $element = $this->_elements[$this->_elementIndex[$elementname]];
1556             $page     = isset($buttonargs[0]) ? $buttonargs[0] : null;
1557             $text     = isset($buttonargs[1]) ? $buttonargs[1] : null;
1558             $module   = isset($buttonargs[2]) ? $buttonargs[2] : 'moodle';
1559             $linktext = isset($buttonargs[3]) ? $buttonargs[3] : false;
1561             $element->_helpbutton = $OUTPUT->old_help_icon($page, $text, $module, $linktext);
1563         } else if (!$suppresscheck) {
1564             print_error('nonexistentformelements', 'form', '', $elementname);
1565         }
1566     }
1568     /**
1569      * Add a help button to element, only one button per element is allowed.
1570      *
1571      * This is new, simplified and preferable method of setting a help icon on form elements.
1572      * It uses the new $OUTPUT->help_icon().
1573      *
1574      * Typically, you will provide the same identifier and the component as you have used for the
1575      * label of the element. The string identifier with the _help suffix added is then used
1576      * as the help string.
1577      *
1578      * There has to be two strings defined:
1579      *   1/ get_string($identifier, $component) - the title of the help page
1580      *   2/ get_string($identifier.'_help', $component) - the actual help page text
1581      *
1582      * @since Moodle 2.0
1583      * @param string $elementname name of the element to add the item to
1584      * @param string $identifier help string identifier without _help suffix
1585      * @param string $component component name to look the help string in
1586      * @param string $linktext optional text to display next to the icon
1587      * @param bool $suppresscheck set to true if the element may not exist
1588      */
1589     function addHelpButton($elementname, $identifier, $component = 'moodle', $linktext = '', $suppresscheck = false) {
1590         global $OUTPUT;
1591         if (array_key_exists($elementname, $this->_elementIndex)) {
1592             $element = $this->_elements[$this->_elementIndex[$elementname]];
1593             $element->_helpbutton = $OUTPUT->help_icon($identifier, $component, $linktext);
1594         } else if (!$suppresscheck) {
1595             debugging(get_string('nonexistentformelements', 'form', $elementname));
1596         }
1597     }
1599     /**
1600      * Set constant value not overridden by _POST or _GET
1601      * note: this does not work for complex names with [] :-(
1602      *
1603      * @param string $elname name of element
1604      * @param mixed $value
1605      */
1606     function setConstant($elname, $value) {
1607         $this->_constantValues = HTML_QuickForm::arrayMerge($this->_constantValues, array($elname=>$value));
1608         $element =& $this->getElement($elname);
1609         $element->onQuickFormEvent('updateValue', null, $this);
1610     }
1612     /**
1613      * export submitted values
1614      *
1615      * @param string $elementList list of elements in form
1616      * @return array
1617      */
1618     function exportValues($elementList = null){
1619         $unfiltered = array();
1620         if (null === $elementList) {
1621             // iterate over all elements, calling their exportValue() methods
1622             $emptyarray = array();
1623             foreach (array_keys($this->_elements) as $key) {
1624                 if ($this->_elements[$key]->isFrozen() && !$this->_elements[$key]->_persistantFreeze){
1625                     $value = $this->_elements[$key]->exportValue($emptyarray, true);
1626                 } else {
1627                     $value = $this->_elements[$key]->exportValue($this->_submitValues, true);
1628                 }
1630                 if (is_array($value)) {
1631                     // This shit throws a bogus warning in PHP 4.3.x
1632                     $unfiltered = HTML_QuickForm::arrayMerge($unfiltered, $value);
1633                 }
1634             }
1635         } else {
1636             if (!is_array($elementList)) {
1637                 $elementList = array_map('trim', explode(',', $elementList));
1638             }
1639             foreach ($elementList as $elementName) {
1640                 $value = $this->exportValue($elementName);
1641                 if (PEAR::isError($value)) {
1642                     return $value;
1643                 }
1644                 //oh, stock QuickFOrm was returning array of arrays!
1645                 $unfiltered = HTML_QuickForm::arrayMerge($unfiltered, $value);
1646             }
1647         }
1649         if (is_array($this->_constantValues)) {
1650             $unfiltered = HTML_QuickForm::arrayMerge($unfiltered, $this->_constantValues);
1651         }
1653         return $unfiltered;
1654     }
1656     /**
1657      * Adds a validation rule for the given field
1658      *
1659      * If the element is in fact a group, it will be considered as a whole.
1660      * To validate grouped elements as separated entities,
1661      * use addGroupRule instead of addRule.
1662      *
1663      * @param string $element Form element name
1664      * @param string $message Message to display for invalid data
1665      * @param string $type Rule type, use getRegisteredRules() to get types
1666      * @param string $format (optional)Required for extra rule data
1667      * @param string $validation (optional)Where to perform validation: "server", "client"
1668      * @param bool $reset Client-side validation: reset the form element to its original value if there is an error?
1669      * @param bool $force Force the rule to be applied, even if the target form element does not exist
1670      */
1671     function addRule($element, $message, $type, $format=null, $validation='server', $reset = false, $force = false)
1672     {
1673         parent::addRule($element, $message, $type, $format, $validation, $reset, $force);
1674         if ($validation == 'client') {
1675             $this->updateAttributes(array('onsubmit' => 'try { var myValidator = validate_' . $this->_formName . '; } catch(e) { return true; } return myValidator(this);'));
1676         }
1678     }
1680     /**
1681      * Adds a validation rule for the given group of elements
1682      *
1683      * Only groups with a name can be assigned a validation rule
1684      * Use addGroupRule when you need to validate elements inside the group.
1685      * Use addRule if you need to validate the group as a whole. In this case,
1686      * the same rule will be applied to all elements in the group.
1687      * Use addRule if you need to validate the group against a function.
1688      *
1689      * @param string $group Form group name
1690      * @param array|string $arg1 Array for multiple elements or error message string for one element
1691      * @param string $type (optional)Rule type use getRegisteredRules() to get types
1692      * @param string $format (optional)Required for extra rule data
1693      * @param int $howmany (optional)How many valid elements should be in the group
1694      * @param string $validation (optional)Where to perform validation: "server", "client"
1695      * @param bool $reset Client-side: whether to reset the element's value to its original state if validation failed.
1696      */
1697     function addGroupRule($group, $arg1, $type='', $format=null, $howmany=0, $validation = 'server', $reset = false)
1698     {
1699         parent::addGroupRule($group, $arg1, $type, $format, $howmany, $validation, $reset);
1700         if (is_array($arg1)) {
1701              foreach ($arg1 as $rules) {
1702                 foreach ($rules as $rule) {
1703                     $validation = (isset($rule[3]) && 'client' == $rule[3])? 'client': 'server';
1705                     if ('client' == $validation) {
1706                         $this->updateAttributes(array('onsubmit' => 'try { var myValidator = validate_' . $this->_formName . '; } catch(e) { return true; } return myValidator(this);'));
1707                     }
1708                 }
1709             }
1710         } elseif (is_string($arg1)) {
1712             if ($validation == 'client') {
1713                 $this->updateAttributes(array('onsubmit' => 'try { var myValidator = validate_' . $this->_formName . '; } catch(e) { return true; } return myValidator(this);'));
1714             }
1715         }
1716     }
1718     /**
1719      * Returns the client side validation script
1720      *
1721      * The code here was copied from HTML_QuickForm_DHTMLRulesTableless who copied it from  HTML_QuickForm
1722      * and slightly modified to run rules per-element
1723      * Needed to override this because of an error with client side validation of grouped elements.
1724      *
1725      * @return string Javascript to perform validation, empty string if no 'client' rules were added
1726      */
1727     function getValidationScript()
1728     {
1729         if (empty($this->_rules) || empty($this->_attributes['onsubmit'])) {
1730             return '';
1731         }
1733         include_once('HTML/QuickForm/RuleRegistry.php');
1734         $registry =& HTML_QuickForm_RuleRegistry::singleton();
1735         $test = array();
1736         $js_escape = array(
1737             "\r"    => '\r',
1738             "\n"    => '\n',
1739             "\t"    => '\t',
1740             "'"     => "\\'",
1741             '"'     => '\"',
1742             '\\'    => '\\\\'
1743         );
1745         foreach ($this->_rules as $elementName => $rules) {
1746             foreach ($rules as $rule) {
1747                 if ('client' == $rule['validation']) {
1748                     unset($element); //TODO: find out how to properly initialize it
1750                     $dependent  = isset($rule['dependent']) && is_array($rule['dependent']);
1751                     $rule['message'] = strtr($rule['message'], $js_escape);
1753                     if (isset($rule['group'])) {
1754                         $group    =& $this->getElement($rule['group']);
1755                         // No JavaScript validation for frozen elements
1756                         if ($group->isFrozen()) {
1757                             continue 2;
1758                         }
1759                         $elements =& $group->getElements();
1760                         foreach (array_keys($elements) as $key) {
1761                             if ($elementName == $group->getElementName($key)) {
1762                                 $element =& $elements[$key];
1763                                 break;
1764                             }
1765                         }
1766                     } elseif ($dependent) {
1767                         $element   =  array();
1768                         $element[] =& $this->getElement($elementName);
1769                         foreach ($rule['dependent'] as $elName) {
1770                             $element[] =& $this->getElement($elName);
1771                         }
1772                     } else {
1773                         $element =& $this->getElement($elementName);
1774                     }
1775                     // No JavaScript validation for frozen elements
1776                     if (is_object($element) && $element->isFrozen()) {
1777                         continue 2;
1778                     } elseif (is_array($element)) {
1779                         foreach (array_keys($element) as $key) {
1780                             if ($element[$key]->isFrozen()) {
1781                                 continue 3;
1782                             }
1783                         }
1784                     }
1785                     //for editor element, [text] is appended to the name.
1786                     if ($element->getType() == 'editor') {
1787                         $elementName .= '[text]';
1788                         //Add format to rule as moodleform check which format is supported by browser
1789                         //it is not set anywhere... So small hack to make sure we pass it down to quickform
1790                         if (is_null($rule['format'])) {
1791                             $rule['format'] = $element->getFormat();
1792                         }
1793                     }
1794                     // Fix for bug displaying errors for elements in a group
1795                     $test[$elementName][0][] = $registry->getValidationScript($element, $elementName, $rule);
1796                     $test[$elementName][1]=$element;
1797                     //end of fix
1798                 }
1799             }
1800         }
1802         // Fix for MDL-9524. If you don't do this, then $element may be left as a reference to one of the fields in
1803         // the form, and then that form field gets corrupted by the code that follows.
1804         unset($element);
1806         $js = '
1807 <script type="text/javascript">
1808 //<![CDATA[
1810 var skipClientValidation = false;
1812 function qf_errorHandler(element, _qfMsg) {
1813   div = element.parentNode;
1815   if ((div == undefined) || (element.name == undefined)) {
1816     //no checking can be done for undefined elements so let server handle it.
1817     return true;
1818   }
1820   if (_qfMsg != \'\') {
1821     var errorSpan = document.getElementById(\'id_error_\'+element.name);
1822     if (!errorSpan) {
1823       errorSpan = document.createElement("span");
1824       errorSpan.id = \'id_error_\'+element.name;
1825       errorSpan.className = "error";
1826       element.parentNode.insertBefore(errorSpan, element.parentNode.firstChild);
1827     }
1829     while (errorSpan.firstChild) {
1830       errorSpan.removeChild(errorSpan.firstChild);
1831     }
1833     errorSpan.appendChild(document.createTextNode(_qfMsg.substring(3)));
1834     errorSpan.appendChild(document.createElement("br"));
1836     if (div.className.substr(div.className.length - 6, 6) != " error"
1837         && div.className != "error") {
1838       div.className += " error";
1839     }
1841     return false;
1842   } else {
1843     var errorSpan = document.getElementById(\'id_error_\'+element.name);
1844     if (errorSpan) {
1845       errorSpan.parentNode.removeChild(errorSpan);
1846     }
1848     if (div.className.substr(div.className.length - 6, 6) == " error") {
1849       div.className = div.className.substr(0, div.className.length - 6);
1850     } else if (div.className == "error") {
1851       div.className = "";
1852     }
1854     return true;
1855   }
1856 }';
1857         $validateJS = '';
1858         foreach ($test as $elementName => $jsandelement) {
1859             // Fix for bug displaying errors for elements in a group
1860             //unset($element);
1861             list($jsArr,$element)=$jsandelement;
1862             //end of fix
1863             $escapedElementName = preg_replace_callback(
1864                 '/[_\[\]]/',
1865                 create_function('$matches', 'return sprintf("_%2x",ord($matches[0]));'),
1866                 $elementName);
1867             $js .= '
1868 function validate_' . $this->_formName . '_' . $escapedElementName . '(element) {
1869   if (undefined == element) {
1870      //required element was not found, then let form be submitted without client side validation
1871      return true;
1872   }
1873   var value = \'\';
1874   var errFlag = new Array();
1875   var _qfGroups = {};
1876   var _qfMsg = \'\';
1877   var frm = element.parentNode;
1878   if ((undefined != element.name) && (frm != undefined)) {
1879       while (frm && frm.nodeName.toUpperCase() != "FORM") {
1880         frm = frm.parentNode;
1881       }
1882     ' . join("\n", $jsArr) . '
1883       return qf_errorHandler(element, _qfMsg);
1884   } else {
1885     //element name should be defined else error msg will not be displayed.
1886     return true;
1887   }
1889 ';
1890             $validateJS .= '
1891   ret = validate_' . $this->_formName . '_' . $escapedElementName.'(frm.elements[\''.$elementName.'\']) && ret;
1892   if (!ret && !first_focus) {
1893     first_focus = true;
1894     frm.elements[\''.$elementName.'\'].focus();
1895   }
1896 ';
1898             // Fix for bug displaying errors for elements in a group
1899             //unset($element);
1900             //$element =& $this->getElement($elementName);
1901             //end of fix
1902             $valFunc = 'validate_' . $this->_formName . '_' . $escapedElementName . '(this)';
1903             $onBlur = $element->getAttribute('onBlur');
1904             $onChange = $element->getAttribute('onChange');
1905             $element->updateAttributes(array('onBlur' => $onBlur . $valFunc,
1906                                              'onChange' => $onChange . $valFunc));
1907         }
1908 //  do not rely on frm function parameter, because htmlarea breaks it when overloading the onsubmit method
1909         $js .= '
1910 function validate_' . $this->_formName . '(frm) {
1911   if (skipClientValidation) {
1912      return true;
1913   }
1914   var ret = true;
1916   var frm = document.getElementById(\''. $this->_attributes['id'] .'\')
1917   var first_focus = false;
1918 ' . $validateJS . ';
1919   return ret;
1921 //]]>
1922 </script>';
1923         return $js;
1924     } // end func getValidationScript
1926     /**
1927      * Sets default error message
1928      */
1929     function _setDefaultRuleMessages(){
1930         foreach ($this->_rules as $field => $rulesarr){
1931             foreach ($rulesarr as $key => $rule){
1932                 if ($rule['message']===null){
1933                     $a=new stdClass();
1934                     $a->format=$rule['format'];
1935                     $str=get_string('err_'.$rule['type'], 'form', $a);
1936                     if (strpos($str, '[[')!==0){
1937                         $this->_rules[$field][$key]['message']=$str;
1938                     }
1939                 }
1940             }
1941         }
1942     }
1944     /**
1945      * Get list of attributes which have dependencies
1946      *
1947      * @return array
1948      */
1949     function getLockOptionObject(){
1950         $result = array();
1951         foreach ($this->_dependencies as $dependentOn => $conditions){
1952             $result[$dependentOn] = array();
1953             foreach ($conditions as $condition=>$values) {
1954                 $result[$dependentOn][$condition] = array();
1955                 foreach ($values as $value=>$dependents) {
1956                     $result[$dependentOn][$condition][$value] = array();
1957                     $i = 0;
1958                     foreach ($dependents as $dependent) {
1959                         $elements = $this->_getElNamesRecursive($dependent);
1960                         if (empty($elements)) {
1961                             // probably element inside of some group
1962                             $elements = array($dependent);
1963                         }
1964                         foreach($elements as $element) {
1965                             if ($element == $dependentOn) {
1966                                 continue;
1967                             }
1968                             $result[$dependentOn][$condition][$value][] = $element;
1969                         }
1970                     }
1971                 }
1972             }
1973         }
1974         return array($this->getAttribute('id'), $result);
1975     }
1977     /**
1978      * Get names of element or elements in a group.
1979      *
1980      * @param HTML_QuickForm_group|element $element element group or element object
1981      * @return array
1982      */
1983     function _getElNamesRecursive($element) {
1984         if (is_string($element)) {
1985             if (!$this->elementExists($element)) {
1986                 return array();
1987             }
1988             $element = $this->getElement($element);
1989         }
1991         if (is_a($element, 'HTML_QuickForm_group')) {
1992             $elsInGroup = $element->getElements();
1993             $elNames = array();
1994             foreach ($elsInGroup as $elInGroup){
1995                 if (is_a($elInGroup, 'HTML_QuickForm_group')) {
1996                     // not sure if this would work - groups nested in groups
1997                     $elNames = array_merge($elNames, $this->_getElNamesRecursive($elInGroup));
1998                 } else {
1999                     $elNames[] = $element->getElementName($elInGroup->getName());
2000                 }
2001             }
2003         } else if (is_a($element, 'HTML_QuickForm_header')) {
2004             return array();
2006         } else if (is_a($element, 'HTML_QuickForm_hidden')) {
2007             return array();
2009         } else if (method_exists($element, 'getPrivateName') &&
2010                 !($element instanceof HTML_QuickForm_advcheckbox)) {
2011             // The advcheckbox element implements a method called getPrivateName,
2012             // but in a way that is not compatible with the generic API, so we
2013             // have to explicitly exclude it.
2014             return array($element->getPrivateName());
2016         } else {
2017             $elNames = array($element->getName());
2018         }
2020         return $elNames;
2021     }
2023     /**
2024      * Adds a dependency for $elementName which will be disabled if $condition is met.
2025      * If $condition = 'notchecked' (default) then the condition is that the $dependentOn element
2026      * is not checked. If $condition = 'checked' then the condition is that the $dependentOn element
2027      * is checked. If $condition is something else (like "eq" for equals) then it is checked to see if the value
2028      * of the $dependentOn element is $condition (such as equal) to $value.
2029      *
2030      * @param string $elementName the name of the element which will be disabled
2031      * @param string $dependentOn the name of the element whose state will be checked for condition
2032      * @param string $condition the condition to check
2033      * @param mixed $value used in conjunction with condition.
2034      */
2035     function disabledIf($elementName, $dependentOn, $condition = 'notchecked', $value='1'){
2036         if (!array_key_exists($dependentOn, $this->_dependencies)) {
2037             $this->_dependencies[$dependentOn] = array();
2038         }
2039         if (!array_key_exists($condition, $this->_dependencies[$dependentOn])) {
2040             $this->_dependencies[$dependentOn][$condition] = array();
2041         }
2042         if (!array_key_exists($value, $this->_dependencies[$dependentOn][$condition])) {
2043             $this->_dependencies[$dependentOn][$condition][$value] = array();
2044         }
2045         $this->_dependencies[$dependentOn][$condition][$value][] = $elementName;
2046     }
2048     /**
2049      * Registers button as no submit button
2050      *
2051      * @param string $buttonname name of the button
2052      */
2053     function registerNoSubmitButton($buttonname){
2054         $this->_noSubmitButtons[]=$buttonname;
2055     }
2057     /**
2058      * Checks if button is a no submit button, i.e it doesn't submit form
2059      *
2060      * @param string $buttonname name of the button to check
2061      * @return bool
2062      */
2063     function isNoSubmitButton($buttonname){
2064         return (array_search($buttonname, $this->_noSubmitButtons)!==FALSE);
2065     }
2067     /**
2068      * Registers a button as cancel button
2069      *
2070      * @param string $addfieldsname name of the button
2071      */
2072     function _registerCancelButton($addfieldsname){
2073         $this->_cancelButtons[]=$addfieldsname;
2074     }
2076     /**
2077      * Displays elements without HTML input tags.
2078      * This method is different to freeze() in that it makes sure no hidden
2079      * elements are included in the form.
2080      * Note: If you want to make sure the submitted value is ignored, please use setDefaults().
2081      *
2082      * This function also removes all previously defined rules.
2083      *
2084      * @param string|array $elementList array or string of element(s) to be frozen
2085      * @return object|bool if element list is not empty then return error object, else true
2086      */
2087     function hardFreeze($elementList=null)
2088     {
2089         if (!isset($elementList)) {
2090             $this->_freezeAll = true;
2091             $elementList = array();
2092         } else {
2093             if (!is_array($elementList)) {
2094                 $elementList = preg_split('/[ ]*,[ ]*/', $elementList);
2095             }
2096             $elementList = array_flip($elementList);
2097         }
2099         foreach (array_keys($this->_elements) as $key) {
2100             $name = $this->_elements[$key]->getName();
2101             if ($this->_freezeAll || isset($elementList[$name])) {
2102                 $this->_elements[$key]->freeze();
2103                 $this->_elements[$key]->setPersistantFreeze(false);
2104                 unset($elementList[$name]);
2106                 // remove all rules
2107                 $this->_rules[$name] = array();
2108                 // if field is required, remove the rule
2109                 $unset = array_search($name, $this->_required);
2110                 if ($unset !== false) {
2111                     unset($this->_required[$unset]);
2112                 }
2113             }
2114         }
2116         if (!empty($elementList)) {
2117             return PEAR::raiseError(null, QUICKFORM_NONEXIST_ELEMENT, null, E_USER_WARNING, "Nonexistant element(s): '" . implode("', '", array_keys($elementList)) . "' in HTML_QuickForm::freeze()", 'HTML_QuickForm_Error', true);
2118         }
2119         return true;
2120     }
2122     /**
2123      * Hard freeze all elements in a form except those whose names are in $elementList or hidden elements in a form.
2124      *
2125      * This function also removes all previously defined rules of elements it freezes.
2126      *
2127      * @throws HTML_QuickForm_Error
2128      * @param array $elementList array or string of element(s) not to be frozen
2129      * @return bool returns true
2130      */
2131     function hardFreezeAllVisibleExcept($elementList)
2132     {
2133         $elementList = array_flip($elementList);
2134         foreach (array_keys($this->_elements) as $key) {
2135             $name = $this->_elements[$key]->getName();
2136             $type = $this->_elements[$key]->getType();
2138             if ($type == 'hidden'){
2139                 // leave hidden types as they are
2140             } elseif (!isset($elementList[$name])) {
2141                 $this->_elements[$key]->freeze();
2142                 $this->_elements[$key]->setPersistantFreeze(false);
2144                 // remove all rules
2145                 $this->_rules[$name] = array();
2146                 // if field is required, remove the rule
2147                 $unset = array_search($name, $this->_required);
2148                 if ($unset !== false) {
2149                     unset($this->_required[$unset]);
2150                 }
2151             }
2152         }
2153         return true;
2154     }
2156    /**
2157     * Tells whether the form was already submitted
2158     *
2159     * This is useful since the _submitFiles and _submitValues arrays
2160     * may be completely empty after the trackSubmit value is removed.
2161     *
2162     * @return bool
2163     */
2164     function isSubmitted()
2165     {
2166         return parent::isSubmitted() && (!$this->isFrozen());
2167     }
2170 /**
2171  * MoodleQuickForm renderer
2172  *
2173  * A renderer for MoodleQuickForm that only uses XHTML and CSS and no
2174  * table tags, extends PEAR class HTML_QuickForm_Renderer_Tableless
2175  *
2176  * Stylesheet is part of standard theme and should be automatically included.
2177  *
2178  * @package   core_form
2179  * @copyright 2007 Jamie Pratt <me@jamiep.org>
2180  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2181  */
2182 class MoodleQuickForm_Renderer extends HTML_QuickForm_Renderer_Tableless{
2184     /** @var array Element template array */
2185     var $_elementTemplates;
2187     /**
2188      * Template used when opening a hidden fieldset
2189      * (i.e. a fieldset that is opened when there is no header element)
2190      * @var string
2191      */
2192     var $_openHiddenFieldsetTemplate = "\n\t<fieldset class=\"hidden\"><div>";
2194     /** @var string Header Template string */
2195     var $_headerTemplate =
2196        "\n\t\t<legend class=\"ftoggler\">{header}</legend>\n\t\t<div class=\"advancedbutton\">{advancedimg}{button}</div><div class=\"fcontainer clearfix\">\n\t\t";
2198     /** @var string Template used when opening a fieldset */
2199     var $_openFieldsetTemplate = "\n\t<fieldset class=\"clearfix\" {id}>";
2201     /** @var string Template used when closing a fieldset */
2202     var $_closeFieldsetTemplate = "\n\t\t</div></fieldset>";
2204     /** @var string Required Note template string */
2205     var $_requiredNoteTemplate =
2206         "\n\t\t<div class=\"fdescription required\">{requiredNote}</div>";
2208     /** @var array list of elements which are marked as advance and will be grouped together */
2209     var $_advancedElements = array();
2211     /** @var int Whether to display advanced elements (on page load) 1 => show, 0 => hide */
2212     var $_showAdvanced;
2214     /**
2215      * Constructor
2216      */
2217     function MoodleQuickForm_Renderer(){
2218         // switch next two lines for ol li containers for form items.
2219         //        $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>');
2220         $this->_elementTemplates = array(
2221         '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>',
2223         '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>',
2225         '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>',
2227 'warning'=>"\n\t\t".'<div class="fitem {advanced}">{element}</div>',
2229         'nodisplay'=>'');
2231         parent::HTML_QuickForm_Renderer_Tableless();
2232     }
2234     /**
2235      * Set element's as adavance element
2236      *
2237      * @param array $elements form elements which needs to be grouped as advance elements.
2238      */
2239     function setAdvancedElements($elements){
2240         $this->_advancedElements = $elements;
2241     }
2243     /**
2244      * What to do when starting the form
2245      *
2246      * @param MoodleQuickForm $form reference of the form
2247      */
2248     function startForm(&$form){
2249         global $PAGE;
2250         $this->_reqHTML = $form->getReqHTML();
2251         $this->_elementTemplates = str_replace('{req}', $this->_reqHTML, $this->_elementTemplates);
2252         $this->_advancedHTML = $form->getAdvancedHTML();
2253         $this->_showAdvanced = $form->getShowAdvanced();
2254         parent::startForm($form);
2255         if ($form->isFrozen()){
2256             $this->_formTemplate = "\n<div class=\"mform frozen\">\n{content}\n</div>";
2257         } else {
2258             $this->_formTemplate = "\n<form{attributes}>\n\t<div style=\"display: none;\">{hidden}</div>\n{content}\n</form>";
2259             $this->_hiddenHtml .= $form->_pageparams;
2260         }
2262         $PAGE->requires->yui_module('moodle-core-formchangechecker',
2263                 'M.core_formchangechecker.init',
2264                 array(array(
2265                     'formid' => $form->getAttribute('id')
2266                 ))
2267         );
2268         $PAGE->requires->string_for_js('changesmadereallygoaway', 'moodle');
2269     }
2271     /**
2272      * Create advance group of elements
2273      *
2274      * @param object $group Passed by reference
2275      * @param bool $required if input is required field
2276      * @param string $error error message to display
2277      */
2278     function startGroup(&$group, $required, $error){
2279         // Make sure the element has an id.
2280         $group->_generateId();
2282         if (method_exists($group, 'getElementTemplateType')){
2283             $html = $this->_elementTemplates[$group->getElementTemplateType()];
2284         }else{
2285             $html = $this->_elementTemplates['default'];
2287         }
2288         if ($this->_showAdvanced){
2289             $advclass = ' advanced';
2290         } else {
2291             $advclass = ' advanced hide';
2292         }
2293         if (isset($this->_advancedElements[$group->getName()])){
2294             $html =str_replace(' {advanced}', $advclass, $html);
2295             $html =str_replace('{advancedimg}', $this->_advancedHTML, $html);
2296         } else {
2297             $html =str_replace(' {advanced}', '', $html);
2298             $html =str_replace('{advancedimg}', '', $html);
2299         }
2300         if (method_exists($group, 'getHelpButton')){
2301             $html =str_replace('{help}', $group->getHelpButton(), $html);
2302         }else{
2303             $html =str_replace('{help}', '', $html);
2304         }
2305         $html =str_replace('{id}', 'fgroup_' . $group->getAttribute('id'), $html);
2306         $html =str_replace('{name}', $group->getName(), $html);
2307         $html =str_replace('{type}', 'fgroup', $html);
2309         $this->_templates[$group->getName()]=$html;
2310         // Fix for bug in tableless quickforms that didn't allow you to stop a
2311         // fieldset before a group of elements.
2312         // if the element name indicates the end of a fieldset, close the fieldset
2313         if (   in_array($group->getName(), $this->_stopFieldsetElements)
2314             && $this->_fieldsetsOpen > 0
2315            ) {
2316             $this->_html .= $this->_closeFieldsetTemplate;
2317             $this->_fieldsetsOpen--;
2318         }
2319         parent::startGroup($group, $required, $error);
2320     }
2321     /**
2322      * Renders element
2323      *
2324      * @param HTML_QuickForm_element $element element
2325      * @param bool $required if input is required field
2326      * @param string $error error message to display
2327      */
2328     function renderElement(&$element, $required, $error){
2329         // Make sure the element has an id.
2330         $element->_generateId();
2332         //adding stuff to place holders in template
2333         //check if this is a group element first
2334         if (($this->_inGroup) and !empty($this->_groupElementTemplate)) {
2335             // so it gets substitutions for *each* element
2336             $html = $this->_groupElementTemplate;
2337         }
2338         elseif (method_exists($element, 'getElementTemplateType')){
2339             $html = $this->_elementTemplates[$element->getElementTemplateType()];
2340         }else{
2341             $html = $this->_elementTemplates['default'];
2342         }
2343         if ($this->_showAdvanced){
2344             $advclass = ' advanced';
2345         } else {
2346             $advclass = ' advanced hide';
2347         }
2348         if (isset($this->_advancedElements[$element->getName()])){
2349             $html =str_replace(' {advanced}', $advclass, $html);
2350         } else {
2351             $html =str_replace(' {advanced}', '', $html);
2352         }
2353         if (isset($this->_advancedElements[$element->getName()])||$element->getName() == 'mform_showadvanced'){
2354             $html =str_replace('{advancedimg}', $this->_advancedHTML, $html);
2355         } else {
2356             $html =str_replace('{advancedimg}', '', $html);
2357         }
2358         $html =str_replace('{id}', 'fitem_' . $element->getAttribute('id'), $html);
2359         $html =str_replace('{type}', 'f'.$element->getType(), $html);
2360         $html =str_replace('{name}', $element->getName(), $html);
2361         if (method_exists($element, 'getHelpButton')){
2362             $html = str_replace('{help}', $element->getHelpButton(), $html);
2363         }else{
2364             $html = str_replace('{help}', '', $html);
2366         }
2367         if (($this->_inGroup) and !empty($this->_groupElementTemplate)) {
2368             $this->_groupElementTemplate = $html;
2369         }
2370         elseif (!isset($this->_templates[$element->getName()])) {
2371             $this->_templates[$element->getName()] = $html;
2372         }
2374         parent::renderElement($element, $required, $error);
2375     }
2377     /**
2378      * Called when visiting a form, after processing all form elements
2379      * Adds required note, form attributes, validation javascript and form content.
2380      *
2381      * @global moodle_page $PAGE
2382      * @param moodleform $form Passed by reference
2383      */
2384     function finishForm(&$form){
2385         global $PAGE;
2386         if ($form->isFrozen()){
2387             $this->_hiddenHtml = '';
2388         }
2389         parent::finishForm($form);
2390         if (!$form->isFrozen()) {
2391             $args = $form->getLockOptionObject();
2392             if (count($args[1]) > 0) {
2393                 $PAGE->requires->js_init_call('M.form.initFormDependencies', $args, true, moodleform::get_js_module());
2394             }
2395         }
2396     }
2397    /**
2398     * Called when visiting a header element
2399     *
2400     * @param HTML_QuickForm_header $header An HTML_QuickForm_header element being visited
2401     * @global moodle_page $PAGE
2402     */
2403     function renderHeader(&$header) {
2404         global $PAGE;
2406         $name = $header->getName();
2408         $id = empty($name) ? '' : ' id="' . $name . '"';
2409         $id = preg_replace(array('/\]/', '/\[/'), array('', '_'), $id);
2410         if (is_null($header->_text)) {
2411             $header_html = '';
2412         } elseif (!empty($name) && isset($this->_templates[$name])) {
2413             $header_html = str_replace('{header}', $header->toHtml(), $this->_templates[$name]);
2414         } else {
2415             $header_html = str_replace('{header}', $header->toHtml(), $this->_headerTemplate);
2416         }
2418         if (isset($this->_advancedElements[$name])){
2419             $header_html =str_replace('{advancedimg}', $this->_advancedHTML, $header_html);
2420             $elementName='mform_showadvanced';
2421             if ($this->_showAdvanced==0){
2422                 $buttonlabel = get_string('showadvanced', 'form');
2423             } else {
2424                 $buttonlabel = get_string('hideadvanced', 'form');
2425             }
2426             $button = '<input name="'.$elementName.'" class="showadvancedbtn" value="'.$buttonlabel.'" type="submit" />';
2427             $PAGE->requires->js_init_call('M.form.initShowAdvanced', array(), false, moodleform::get_js_module());
2428             $header_html = str_replace('{button}', $button, $header_html);
2429         } else {
2430             $header_html =str_replace('{advancedimg}', '', $header_html);
2431             $header_html = str_replace('{button}', '', $header_html);
2432         }
2434         if ($this->_fieldsetsOpen > 0) {
2435             $this->_html .= $this->_closeFieldsetTemplate;
2436             $this->_fieldsetsOpen--;
2437         }
2439         $openFieldsetTemplate = str_replace('{id}', $id, $this->_openFieldsetTemplate);
2440         if ($this->_showAdvanced){
2441             $advclass = ' class="advanced"';
2442         } else {
2443             $advclass = ' class="advanced hide"';
2444         }
2445         if (isset($this->_advancedElements[$name])){
2446             $openFieldsetTemplate = str_replace('{advancedclass}', $advclass, $openFieldsetTemplate);
2447         } else {
2448             $openFieldsetTemplate = str_replace('{advancedclass}', '', $openFieldsetTemplate);
2449         }
2450         $this->_html .= $openFieldsetTemplate . $header_html;
2451         $this->_fieldsetsOpen++;
2452     }
2454     /**
2455      * Return Array of element names that indicate the end of a fieldset
2456      *
2457      * @return array
2458      */
2459     function getStopFieldsetElements(){
2460         return $this->_stopFieldsetElements;
2461     }
2464 /**
2465  * Required elements validation
2466  *
2467  * This class overrides QuickForm validation since it allowed space or empty tag as a value
2468  *
2469  * @package   core_form
2470  * @category  form
2471  * @copyright 2006 Jamie Pratt <me@jamiep.org>
2472  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2473  */
2474 class MoodleQuickForm_Rule_Required extends HTML_QuickForm_Rule {
2475     /**
2476      * Checks if an element is not empty.
2477      * This is a server-side validation, it works for both text fields and editor fields
2478      *
2479      * @param string $value Value to check
2480      * @param int|string|array $options Not used yet
2481      * @return bool true if value is not empty
2482      */
2483     function validate($value, $options = null) {
2484         global $CFG;
2485         if (is_array($value) && array_key_exists('text', $value)) {
2486             $value = $value['text'];
2487         }
2488         if (is_array($value)) {
2489             // nasty guess - there has to be something in the array, hopefully nobody invents arrays in arrays
2490             $value = implode('', $value);
2491         }
2492         $stripvalues = array(
2493             '#</?(?!img|canvas|hr).*?>#im', // all tags except img, canvas and hr
2494             '#(\xc2|\xa0|\s|&nbsp;)#', //any whitespaces actually
2495         );
2496         if (!empty($CFG->strictformsrequired)) {
2497             $value = preg_replace($stripvalues, '', (string)$value);
2498         }
2499         if ((string)$value == '') {
2500             return false;
2501         }
2502         return true;
2503     }
2505     /**
2506      * This function returns Javascript code used to build client-side validation.
2507      * It checks if an element is not empty.
2508      *
2509      * @param int $format format of data which needs to be validated.
2510      * @return array
2511      */
2512     function getValidationScript($format = null) {
2513         global $CFG;
2514         if (!empty($CFG->strictformsrequired)) {
2515             if (!empty($format) && $format == FORMAT_HTML) {
2516                 return array('', "{jsVar}.replace(/(<[^img|hr|canvas]+>)|&nbsp;|\s+/ig, '') == ''");
2517             } else {
2518                 return array('', "{jsVar}.replace(/^\s+$/g, '') == ''");
2519             }
2520         } else {
2521             return array('', "{jsVar} == ''");
2522         }
2523     }
2526 /**
2527  * @global object $GLOBALS['_HTML_QuickForm_default_renderer']
2528  * @name $_HTML_QuickForm_default_renderer
2529  */
2530 $GLOBALS['_HTML_QuickForm_default_renderer'] = new MoodleQuickForm_Renderer();
2532 /** Please keep this list in alphabetical order. */
2533 MoodleQuickForm::registerElementType('advcheckbox', "$CFG->libdir/form/advcheckbox.php", 'MoodleQuickForm_advcheckbox');
2534 MoodleQuickForm::registerElementType('button', "$CFG->libdir/form/button.php", 'MoodleQuickForm_button');
2535 MoodleQuickForm::registerElementType('cancel', "$CFG->libdir/form/cancel.php", 'MoodleQuickForm_cancel');
2536 MoodleQuickForm::registerElementType('searchableselector', "$CFG->libdir/form/searchableselector.php", 'MoodleQuickForm_searchableselector');
2537 MoodleQuickForm::registerElementType('checkbox', "$CFG->libdir/form/checkbox.php", 'MoodleQuickForm_checkbox');
2538 MoodleQuickForm::registerElementType('date_selector', "$CFG->libdir/form/dateselector.php", 'MoodleQuickForm_date_selector');
2539 MoodleQuickForm::registerElementType('date_time_selector', "$CFG->libdir/form/datetimeselector.php", 'MoodleQuickForm_date_time_selector');
2540 MoodleQuickForm::registerElementType('duration', "$CFG->libdir/form/duration.php", 'MoodleQuickForm_duration');
2541 MoodleQuickForm::registerElementType('editor', "$CFG->libdir/form/editor.php", 'MoodleQuickForm_editor');
2542 MoodleQuickForm::registerElementType('file', "$CFG->libdir/form/file.php", 'MoodleQuickForm_file');
2543 MoodleQuickForm::registerElementType('filemanager', "$CFG->libdir/form/filemanager.php", 'MoodleQuickForm_filemanager');
2544 MoodleQuickForm::registerElementType('filepicker', "$CFG->libdir/form/filepicker.php", 'MoodleQuickForm_filepicker');
2545 MoodleQuickForm::registerElementType('format', "$CFG->libdir/form/format.php", 'MoodleQuickForm_format');
2546 MoodleQuickForm::registerElementType('grading', "$CFG->libdir/form/grading.php", 'MoodleQuickForm_grading');
2547 MoodleQuickForm::registerElementType('group', "$CFG->libdir/form/group.php", 'MoodleQuickForm_group');
2548 MoodleQuickForm::registerElementType('header', "$CFG->libdir/form/header.php", 'MoodleQuickForm_header');
2549 MoodleQuickForm::registerElementType('hidden', "$CFG->libdir/form/hidden.php", 'MoodleQuickForm_hidden');
2550 MoodleQuickForm::registerElementType('htmleditor', "$CFG->libdir/form/htmleditor.php", 'MoodleQuickForm_htmleditor');
2551 MoodleQuickForm::registerElementType('modgrade', "$CFG->libdir/form/modgrade.php", 'MoodleQuickForm_modgrade');
2552 MoodleQuickForm::registerElementType('modvisible', "$CFG->libdir/form/modvisible.php", 'MoodleQuickForm_modvisible');
2553 MoodleQuickForm::registerElementType('password', "$CFG->libdir/form/password.php", 'MoodleQuickForm_password');
2554 MoodleQuickForm::registerElementType('passwordunmask', "$CFG->libdir/form/passwordunmask.php", 'MoodleQuickForm_passwordunmask');
2555 MoodleQuickForm::registerElementType('questioncategory', "$CFG->libdir/form/questioncategory.php", 'MoodleQuickForm_questioncategory');
2556 MoodleQuickForm::registerElementType('radio', "$CFG->libdir/form/radio.php", 'MoodleQuickForm_radio');
2557 MoodleQuickForm::registerElementType('recaptcha', "$CFG->libdir/form/recaptcha.php", 'MoodleQuickForm_recaptcha');
2558 MoodleQuickForm::registerElementType('select', "$CFG->libdir/form/select.php", 'MoodleQuickForm_select');
2559 MoodleQuickForm::registerElementType('selectgroups', "$CFG->libdir/form/selectgroups.php", 'MoodleQuickForm_selectgroups');
2560 MoodleQuickForm::registerElementType('selectwithlink', "$CFG->libdir/form/selectwithlink.php", 'MoodleQuickForm_selectwithlink');
2561 MoodleQuickForm::registerElementType('selectyesno', "$CFG->libdir/form/selectyesno.php", 'MoodleQuickForm_selectyesno');
2562 MoodleQuickForm::registerElementType('static', "$CFG->libdir/form/static.php", 'MoodleQuickForm_static');
2563 MoodleQuickForm::registerElementType('submit', "$CFG->libdir/form/submit.php", 'MoodleQuickForm_submit');
2564 MoodleQuickForm::registerElementType('submitlink', "$CFG->libdir/form/submitlink.php", 'MoodleQuickForm_submitlink');
2565 MoodleQuickForm::registerElementType('tags', "$CFG->libdir/form/tags.php", 'MoodleQuickForm_tags');
2566 MoodleQuickForm::registerElementType('text', "$CFG->libdir/form/text.php", 'MoodleQuickForm_text');
2567 MoodleQuickForm::registerElementType('textarea', "$CFG->libdir/form/textarea.php", 'MoodleQuickForm_textarea');
2568 MoodleQuickForm::registerElementType('url', "$CFG->libdir/form/url.php", 'MoodleQuickForm_url');
2569 MoodleQuickForm::registerElementType('warning', "$CFG->libdir/form/warning.php", 'MoodleQuickForm_warning');
2571 MoodleQuickForm::registerRule('required', null, 'MoodleQuickForm_Rule_Required', "$CFG->libdir/formslib.php");