907cb7c1ed303769d42c1974082f9b67e222bc3f
[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 defintion 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  *
34  * @copyright Jamie Pratt <me@jamiep.org>
35  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36  * @package   moodlecore
37  */
39 /** setup.php icludes our hacked pear libs first */
40 require_once 'HTML/QuickForm.php';
41 require_once 'HTML/QuickForm/DHTMLRulesTableless.php';
42 require_once 'HTML/QuickForm/Renderer/Tableless.php';
44 require_once $CFG->libdir.'/filelib.php';
45 require_once $CFG->libdir.'/uploadlib.php'; // TODO: remove
47 define('EDITOR_UNLIMITED_FILES', -1);
49 /**
50  * Callback called when PEAR throws an error
51  *
52  * @param PEAR_Error $error
53  */
54 function pear_handle_error($error){
55     echo '<strong>'.$error->GetMessage().'</strong> '.$error->getUserInfo();
56     echo '<br /> <strong>Backtrace </strong>:';
57     print_object($error->backtrace);
58 }
60 if (!empty($CFG->debug) and $CFG->debug >= DEBUG_ALL){
61     PEAR::setErrorHandling(PEAR_ERROR_CALLBACK, 'pear_handle_error');
62 }
64 /**
65  * 
66  * @staticvar bool $done
67  */
68 function form_init_date_js() {
69     global $PAGE;
70     static $done = false;
71     if (!$done) {
72         $PAGE->requires->yui_lib('calendar');
73         $PAGE->requires->yui_lib('container');
74         $PAGE->requires->js_function_call('init_date_selectors',
75                 array(get_string('firstdayofweek')));
76         $done = true;
77     }
78 }
80 /**
81  * Moodle specific wrapper that separates quickforms syntax from moodle code. You won't directly
82  * use this class you should write a class definition which extends this class or a more specific
83  * subclass such a moodleform_mod for each form you want to display and/or process with formslib.
84  *
85  * You will write your own definition() method which performs the form set up.
86  *
87  * @package   moodlecore
88  * @copyright Jamie Pratt <me@jamiep.org>
89  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
90  */
91 abstract class moodleform {
92     /** @var string */
93     protected $_formname;       // form name
94     /**
95      * quickform object definition
96      *
97      * @var object MoodleQuickForm
98      */
99     protected $_form;
100     /**
101      * globals workaround
102      *
103      * @var array
104      */
105     protected $_customdata;
106     /**
107      * definition_after_data executed flag
108      * @var object definition_finalized
109      */
110     protected $_definition_finalized = false;
112     /**
113      * The constructor function calls the abstract function definition() and it will then
114      * process and clean and attempt to validate incoming data.
115      *
116      * It will call your custom validate method to validate data and will also check any rules
117      * you have specified in definition using addRule
118      *
119      * The name of the form (id attribute of the form) is automatically generated depending on
120      * the name you gave the class extending moodleform. You should call your class something
121      * like
122      *
123      * @param mixed $action the action attribute for the form. If empty defaults to auto detect the
124      *                  current url. If a moodle_url object then outputs params as hidden variables.
125      * @param array $customdata if your form defintion method needs access to data such as $course
126      *               $cm, etc. to construct the form definition then pass it in this array. You can
127      *               use globals for somethings.
128      * @param string $method if you set this to anything other than 'post' then _GET and _POST will
129      *               be merged and used as incoming data to the form.
130      * @param string $target target frame for form submission. You will rarely use this. Don't use
131      *                  it if you don't need to as the target attribute is deprecated in xhtml
132      *                  strict.
133      * @param mixed $attributes you can pass a string of html attributes here or an array.
134      * @param bool $editable
135      * @return object moodleform
136      */
137     function moodleform($action=null, $customdata=null, $method='post', $target='', $attributes=null, $editable=true) {
138         if (empty($action)){
139             $action = strip_querystring(qualified_me());
140         }
142         $this->_formname = get_class($this); // '_form' suffix kept in order to prevent collisions of form id and other element
143         $this->_customdata = $customdata;
144         $this->_form = new MoodleQuickForm($this->_formname, $method, $action, $target, $attributes);
145         if (!$editable){
146             $this->_form->hardFreeze();
147         }
149         $this->definition();
151         $this->_form->addElement('hidden', 'sesskey', null); // automatic sesskey protection
152         $this->_form->setDefault('sesskey', sesskey());
153         $this->_form->addElement('hidden', '_qf__'.$this->_formname, null);   // form submission marker
154         $this->_form->setDefault('_qf__'.$this->_formname, 1);
155         $this->_form->_setDefaultRuleMessages();
157         // we have to know all input types before processing submission ;-)
158         $this->_process_submission($method);
159     }
161     /**
162      * To autofocus on first form element or first element with error.
163      *
164      * @param string $name if this is set then the focus is forced to a field with this name
165      *
166      * @return string  javascript to select form element with first error or
167      *                  first element if no errors. Use this as a parameter
168      *                  when calling print_header
169      */
170     function focus($name=NULL) {
171         $form =& $this->_form;
172         $elkeys = array_keys($form->_elementIndex);
173         $error = false;
174         if (isset($form->_errors) &&  0 != count($form->_errors)){
175             $errorkeys = array_keys($form->_errors);
176             $elkeys = array_intersect($elkeys, $errorkeys);
177             $error = true;
178         }
180         if ($error or empty($name)) {
181             $names = array();
182             while (empty($names) and !empty($elkeys)) {
183                 $el = array_shift($elkeys);
184                 $names = $form->_getElNamesRecursive($el);
185             }
186             if (!empty($names)) {
187                 $name = array_shift($names);
188             }
189         }
191         $focus = '';
192         if (!empty($name)) {
193             $focus = 'forms[\''.$form->getAttribute('id').'\'].elements[\''.$name.'\']';
194         }
196         return $focus;
197      }
199     /**
200      * Internal method. Alters submitted data to be suitable for quickforms processing.
201      * Must be called when the form is fully set up.
202      *
203      * @param string $method
204      */
205     function _process_submission($method) {
206         $submission = array();
207         if ($method == 'post') {
208             if (!empty($_POST)) {
209                 $submission = $_POST;
210             }
211         } else {
212             $submission = array_merge_recursive($_GET, $_POST); // emulate handling of parameters in xxxx_param()
213         }
215         // following trick is needed to enable proper sesskey checks when using GET forms
216         // the _qf__.$this->_formname serves as a marker that form was actually submitted
217         if (array_key_exists('_qf__'.$this->_formname, $submission) and $submission['_qf__'.$this->_formname] == 1) {
218             if (!confirm_sesskey()) {
219                 print_error('invalidsesskey');
220             }
221             $files = $_FILES;
222         } else {
223             $submission = array();
224             $files = array();
225         }
227         $this->_form->updateSubmission($submission, $files);
228     }
230     /**
231      * Internal method. Validates all old-style uploaded files.
232      * 
233      * @global object
234      * @global object
235      * @param array $files
236      * @return bool|array Success or an array of errors
237      */
238     function _validate_files(&$files) {
239         global $CFG, $COURSE;
241         $files = array();
243         if (empty($_FILES)) {
244             // we do not need to do any checks because no files were submitted
245             // note: server side rules do not work for files - use custom verification in validate() instead
246             return true;
247         }
249         $errors = array();
250         $filenames = array();
252         // now check that we really want each file
253         foreach ($_FILES as $elname=>$file) {
254             $required = $this->_form->isElementRequired($elname);
256             if ($file['error'] == 4 and $file['size'] == 0) {
257                 if ($required) {
258                     $errors[$elname] = get_string('required');
259                 }
260                 unset($_FILES[$elname]);
261                 continue;
262             }
264             if (!empty($file['error'])) {
265                 $errors[$elname] = file_get_upload_error($file['error']);
266                 unset($_FILES[$elname]);
267                 continue;
268             }
270             if (!is_uploaded_file($file['tmp_name'])) {
271                 // TODO: improve error message
272                 $errors[$elname] = get_string('error');
273                 unset($_FILES[$elname]);
274                 continue;
275             }
277             if (!$this->_form->elementExists($elname) or !$this->_form->getElementType($elname)=='file') {
278                 // hmm, this file was not requested
279                 unset($_FILES[$elname]);
280                 continue;
281             }
283 /*
284   // TODO: rethink the file scanning
285             if ($CFG->runclamonupload) {
286                 if (!clam_scan_moodle_file($_FILES[$elname], $COURSE)) {
287                     $errors[$elname] = $_FILES[$elname]['uploadlog'];
288                     unset($_FILES[$elname]);
289                     continue;
290                 }
291             }
292 */
293             $filename = clean_param($_FILES[$elname]['name'], PARAM_FILE);
294             if ($filename === '') {
295                 // TODO: improve error message - wrong chars
296                 $errors[$elname] = get_string('error');
297                 unset($_FILES[$elname]);
298                 continue;
299             }
300             if (in_array($filename, $filenames)) {
301                 // TODO: improve error message - duplicate name
302                 $errors[$elname] = get_string('error');
303                 unset($_FILES[$elname]);
304                 continue;
305             }
306             $filenames[] = $filename;
307             $_FILES[$elname]['name'] = $filename;
309             $files[$elname] = $_FILES[$elname]['tmp_name'];
310         }
312         // return errors if found
313         if (count($errors) == 0){
314             return true;
316         } else {
317             $files = array();
318             return $errors;
319         }
320     }
322     /**
323      * Load in existing data as form defaults. Usually new entry defaults are stored directly in
324      * form definition (new entry form); this function is used to load in data where values
325      * already exist and data is being edited (edit entry form).
326      *
327      * note: $slashed param removed
328      *
329      * @param mixed $default_values object or array of default values
330      * @param bool $slased true if magic quotes applied to data values
331      */
332     function set_data($default_values) {
333         if (is_object($default_values)) {
334             $default_values = (array)$default_values;
335         }
336         $this->_form->setDefaults($default_values);
337     }
339     /**
340      * @param bool $um
341      */
342     function set_upload_manager($um=false) {
343         debugging('Not used anymore, please fix code!');
344     }
346     /**
347      * Check that form was submitted. Does not check validity of submitted data.
348      *
349      * @return bool true if form properly submitted
350      */
351     function is_submitted() {
352         return $this->_form->isSubmitted();
353     }
355     /**
356      * @staticvar bool $nosubmit
357      */
358     function no_submit_button_pressed(){
359         static $nosubmit = null; // one check is enough
360         if (!is_null($nosubmit)){
361             return $nosubmit;
362         }
363         $mform =& $this->_form;
364         $nosubmit = false;
365         if (!$this->is_submitted()){
366             return false;
367         }
368         foreach ($mform->_noSubmitButtons as $nosubmitbutton){
369             if (optional_param($nosubmitbutton, 0, PARAM_RAW)){
370                 $nosubmit = true;
371                 break;
372             }
373         }
374         return $nosubmit;
375     }
378     /**
379      * Check that form data is valid.
380      * You should almost always use this, rather than {@see validate_defined_fields}
381      *
382      * @staticvar bool $validated
383      * @return bool true if form data valid
384      */
385     function is_validated() {
386         //finalize the form definition before any processing
387         if (!$this->_definition_finalized) {
388             $this->_definition_finalized = true;
389             $this->definition_after_data();
390         }
392         return $this->validate_defined_fields();
393     }
395     /**
396      * Validate the form.
397      *
398      * You almost always want to call {@see is_validated} instead of this
399      * because it calls {@see definition_after_data} first, before validating the form,
400      * which is what you want in 99% of cases.
401      *
402      * This is provided as a separate function for those special cases where
403      * you want the form validated before definition_after_data is called
404      * for example, to selectively add new elements depending on a no_submit_button press,
405      * but only when the form is valid when the no_submit_button is pressed,
406      *
407      * @param boolean $validateonnosubmit optional, defaults to false.  The default behaviour
408      *                is NOT to validate the form when a no submit button has been pressed.
409      *                pass true here to override this behaviour
410      *
411      * @return bool true if form data valid
412      */
413     function validate_defined_fields($validateonnosubmit=false) {
414         static $validated = null; // one validation is enough
415         $mform =& $this->_form;
416         if ($this->no_submit_button_pressed() && empty($validateonnosubmit)){
417             return false;
418         } elseif ($validated === null) {
419             $internal_val = $mform->validate();
421             $files = array();
422             $file_val = $this->_validate_files($files);
423             if ($file_val !== true) {
424                 if (!empty($file_val)) {
425                     foreach ($file_val as $element=>$msg) {
426                         $mform->setElementError($element, $msg);
427                     }
428                 }
429                 $file_val = false;
430             }
432             $data = $mform->exportValues();
433             $moodle_val = $this->validation($data, $files);
434             if ((is_array($moodle_val) && count($moodle_val)!==0)) {
435                 // non-empty array means errors
436                 foreach ($moodle_val as $element=>$msg) {
437                     $mform->setElementError($element, $msg);
438                 }
439                 $moodle_val = false;
441             } else {
442                 // anything else means validation ok
443                 $moodle_val = true;
444             }
446             $validated = ($internal_val and $moodle_val and $file_val);
447         }
448         return $validated;
449     }
451     /**
452      * Return true if a cancel button has been pressed resulting in the form being submitted.
453      *
454      * @return boolean true if a cancel button has been pressed
455      */
456     function is_cancelled(){
457         $mform =& $this->_form;
458         if ($mform->isSubmitted()){
459             foreach ($mform->_cancelButtons as $cancelbutton){
460                 if (optional_param($cancelbutton, 0, PARAM_RAW)){
461                     return true;
462                 }
463             }
464         }
465         return false;
466     }
468     /**
469      * Return submitted data if properly submitted or returns NULL if validation fails or
470      * if there is no submitted data.
471      *
472      * note: $slashed param removed
473      *
474      * @return object submitted data; NULL if not valid or not submitted
475      */
476     function get_data() {
477         $mform =& $this->_form;
479         if ($this->is_submitted() and $this->is_validated()) {
480             $data = $mform->exportValues();
481             unset($data['sesskey']); // we do not need to return sesskey
482             unset($data['_qf__'.$this->_formname]);   // we do not need the submission marker too
483             if (empty($data)) {
484                 return NULL;
485             } else {
486                 return (object)$data;
487             }
488         } else {
489             return NULL;
490         }
491     }
493     /**
494      * Return submitted data without validation or NULL if there is no submitted data.
495      * note: $slashed param removed
496      *
497      * @return object submitted data; NULL if not submitted
498      */
499     function get_submitted_data() {
500         $mform =& $this->_form;
502         if ($this->is_submitted()) {
503             $data = $mform->exportValues();
504             unset($data['sesskey']); // we do not need to return sesskey
505             unset($data['_qf__'.$this->_formname]);   // we do not need the submission marker too
506             if (empty($data)) {
507                 return NULL;
508             } else {
509                 return (object)$data;
510             }
511         } else {
512             return NULL;
513         }
514     }
516     /**
517      * Save verified uploaded files into directory. Upload process can be customised from definition()
518      * NOTE: please use save_stored_file() or save_file()
519      *
520      * @return bool Always false
521      */
522     function save_files($destination) {
523         debugging('Not used anymore, please fix code! Use save_stored_file() or save_file() instead');
524         return false;
525     }
527     /**
528      * Returns name of uploaded file.
529      *
530      * @global object
531      * @param string $elname, first element if null
532      * @return mixed false in case of failure, string if ok
533      */
534     function get_new_filename($elname=null) {
535         global $USER;
537         if (!$this->is_submitted() or !$this->is_validated()) {
538             return false;
539         }
541         if (is_null($elname)) {
542             if (empty($_FILES)) {
543                 return false;
544             }
545             reset($_FILES);
546             $elname = key($_FILES);
547         }
549         if (empty($elname)) {
550             return false;
551         }
553         $element = $this->_form->getElement($elname);
555         if ($element instanceof MoodleQuickForm_filepicker) {
556             $values = $this->_form->exportValues($elname);
557             if (empty($values[$elname])) {
558                 return false;
559             }
560             $draftid = $values[$elname];
561             $fs = get_file_storage();
562             $context = get_context_instance(CONTEXT_USER, $USER->id);
563             if (!$files = $fs->get_area_files($context->id, 'user_draft', $draftid, 'id DESC', false)) {
564                 return false;
565             }
566             $file = reset($files);
567             return $file->get_filename();
568         }
570         if (!isset($_FILES[$elname])) {
571             return false;
572         }
574         return $_FILES[$elname]['name'];
575     }
577     /**
578      * Save file to standard filesystem
579      *
580      * @global object
581      * @param string $elname name of element
582      * @param string $pathname full path name of file
583      * @param bool $override override file if exists
584      * @return bool success
585      */
586     function save_file($elname, $pathname, $override=false) {
587         global $USER;
589         if (!$this->is_submitted() or !$this->is_validated()) {
590             return false;
591         }
593         if (file_exists($pathname)) {
594             if ($override) {
595                 if (!@unlink($pathname)) {
596                     return false;
597                 }
598             } else {
599                 return false;
600             }
601         }
603         $element = $this->_form->getElement($elname);
605         if ($element instanceof MoodleQuickForm_filepicker) {
606             $values = $this->_form->exportValues($elname);
607             if (empty($values[$elname])) {
608                 return false;
609             }
610             $draftid = $values[$elname];
611             $fs = get_file_storage();
612             $context = get_context_instance(CONTEXT_USER, $USER->id);
613             if (!$files = $fs->get_area_files($context->id, 'user_draft', $draftid, 'id DESC', false)) {
614                 return false;
615             }
616             $file = reset($files);
618             return $file->copy_content_to($pathname);
620         } else if (isset($_FILES[$elname])) {
621             return copy($_FILES[$elname]['tmp_name'], $pathname);
622         }
624         return false;
625     }
627     /**
628      * Save file to local filesystem pool
629      *
630      * @global object
631      * @param string $elname name of element
632      * @param int $newcontextid
633      * @param string $newfilearea
634      * @param string $newfilepath
635      * @param string $newfilename - use specified filename, if not specified name of uploaded file used
636      * @param bool $overwrite  - overwrite file if exists
637      * @param int $newuserid - new userid if required
638      * @return mixed stored_file object or false if error; may throw exception if duplicate found
639      */
640     function save_stored_file($elname, $newcontextid, $newfilearea, $newitemid, $newfilepath='/',
641                               $newfilename=null, $overwrite=false, $newuserid=null) {
642         global $USER;
644         if (!$this->is_submitted() or !$this->is_validated()) {
645             return false;
646         }
648         if (empty($newuserid)) {
649             $newuserid = $USER->id;
650         }
652         $element = $this->_form->getElement($elname);
653         $fs = get_file_storage();
655         if ($element instanceof MoodleQuickForm_filepicker) {
656             $values = $this->_form->exportValues($elname);
657             if (empty($values[$elname])) {
658                 return false;
659             }
660             $draftid = $values[$elname];
661             $context = get_context_instance(CONTEXT_USER, $USER->id);
662             if (!$files = $fs->get_area_files($context->id, 'user_draft', $draftid, 'id DESC', false)) {
663                 return false;
664             }
665             $file = reset($files);
666             if (is_null($newfilename)) {
667                 $newfilename = $file->get_filename();
668             }
670             if ($overwrite) {
671                 if ($oldfile = $fs->get_file($newcontextid, $newfilearea, $newitemid, $newfilepath, $newfilename)) {
672                     if (!$oldfile->delete()) {
673                         return false;
674                     }
675                 }
676             }
678             $file_record = array('contextid'=>$newcontextid, 'filearea'=>$newfilearea, 'itemid'=>$newitemid,
679                                  'filepath'=>$newfilepath, 'filename'=>$newfilename, 'userid'=>$newuserid);
680             return $fs->create_file_from_storedfile($file_record, $file);
682         } else if (isset($_FILES[$elname])) {
683             $filename = is_null($newfilename) ? $_FILES[$elname]['name'] : $newfilename;
685             if ($overwrite) {
686                 if ($oldfile = $fs->get_file($newcontextid, $newfilearea, $newitemid, $newfilepath, $newfilename)) {
687                     if (!$oldfile->delete()) {
688                         return false;
689                     }
690                 }
691             }
693             $file_record = array('contextid'=>$newcontextid, 'filearea'=>$newfilearea, 'itemid'=>$newitemid,
694                                  'filepath'=>$newfilepath, 'filename'=>$newfilename, 'userid'=>$newuserid);
695             return $fs->create_file_from_pathname($file_record, $_FILES[$elname]['tmp_name']);
696         }
698         return false;
699     }
701     /**
702      * Get content of uploaded file.
703      *
704      * @global object
705      * @param $element name of file upload element
706      * @return mixed false in case of failure, string if ok
707      */
708     function get_file_content($elname) {
709         global $USER;
711         if (!$this->is_submitted() or !$this->is_validated()) {
712             return false;
713         }
715         $element = $this->_form->getElement($elname);
717         if ($element instanceof MoodleQuickForm_filepicker) {
718             $values = $this->_form->exportValues($elname);
719             if (empty($values[$elname])) {
720                 return false;
721             }
722             $draftid = $values[$elname];
723             $fs = get_file_storage();
724             $context = get_context_instance(CONTEXT_USER, $USER->id);
725             if (!$files = $fs->get_area_files($context->id, 'user_draft', $draftid, 'id DESC', false)) {
726                 return false;
727             }
728             $file = reset($files);
730             return $file->get_content();
732         } else if (isset($_FILES[$elname])) {
733             return file_get_contents($_FILES[$elname]['tmp_name']);
734         }
736         return false;
737     }
739     /**
740      * Print html form.
741      */
742     function display() {
743         //finalize the form definition if not yet done
744         if (!$this->_definition_finalized) {
745             $this->_definition_finalized = true;
746             $this->definition_after_data();
747         }
748         $this->_form->display();
749     }
751     /**
752      * Abstract method - always override!
753      *
754      * If you need special handling of uploaded files, create instance of $this->_upload_manager here.
755      */
756     protected abstract function definition();
758     /**
759      * Dummy stub method - override if you need to setup the form depending on current
760      * values. This method is called after definition(), data submission and set_data().
761      * All form setup that is dependent on form values should go in here.
762      */
763     function definition_after_data(){
764     }
766     /**
767      * Dummy stub method - override if you needed to perform some extra validation.
768      * If there are errors return array of errors ("fieldname"=>"error message"),
769      * otherwise true if ok.
770      *
771      * Server side rules do not work for uploaded files, implement serverside rules here if needed.
772      *
773      * @param array $data array of ("fieldname"=>value) of submitted data
774      * @param array $files array of uploaded files "element_name"=>tmp_file_path
775      * @return array of "element_name"=>"error_description" if there are errors,
776      *               or an empty array if everything is OK (true allowed for backwards compatibility too).
777      */
778     function validation($data, $files) {
779         return array();
780     }
782     /**
783      * Method to add a repeating group of elements to a form.
784      *
785      * @param array $elementobjs Array of elements or groups of elements that are to be repeated
786      * @param integer $repeats no of times to repeat elements initially
787      * @param array $options Array of options to apply to elements. Array keys are element names.
788      *                      This is an array of arrays. The second sets of keys are the option types
789      *                      for the elements :
790      *                          'default' - default value is value
791      *                          'type' - PARAM_* constant is value
792      *                          'helpbutton' - helpbutton params array is value
793      *                          'disabledif' - last three moodleform::disabledIf()
794      *                                           params are value as an array
795      * @param string $repeathiddenname name for hidden element storing no of repeats in this form
796      * @param string $addfieldsname name for button to add more fields
797      * @param int $addfieldsno how many fields to add at a time
798      * @param string $addstring name of button, {no} is replaced by no of blanks that will be added.
799      * @param boolean $addbuttoninside if true, don't call closeHeaderBefore($addfieldsname). Default false.
800      * @return int no of repeats of element in this page
801      */
802     function repeat_elements($elementobjs, $repeats, $options, $repeathiddenname,
803             $addfieldsname, $addfieldsno=5, $addstring=null, $addbuttoninside=false){
804         if ($addstring===null){
805             $addstring = get_string('addfields', 'form', $addfieldsno);
806         } else {
807             $addstring = str_ireplace('{no}', $addfieldsno, $addstring);
808         }
809         $repeats = optional_param($repeathiddenname, $repeats, PARAM_INT);
810         $addfields = optional_param($addfieldsname, '', PARAM_TEXT);
811         if (!empty($addfields)){
812             $repeats += $addfieldsno;
813         }
814         $mform =& $this->_form;
815         $mform->registerNoSubmitButton($addfieldsname);
816         $mform->addElement('hidden', $repeathiddenname, $repeats);
817         //value not to be overridden by submitted value
818         $mform->setConstants(array($repeathiddenname=>$repeats));
819         $namecloned = array();
820         for ($i = 0; $i < $repeats; $i++) {
821             foreach ($elementobjs as $elementobj){
822                 $elementclone = fullclone($elementobj);
823                 $name = $elementclone->getName();
824                 $namecloned[] = $name;
825                 if (!empty($name)) {
826                     $elementclone->setName($name."[$i]");
827                 }
828                 if (is_a($elementclone, 'HTML_QuickForm_header')) {
829                     $value = $elementclone->_text;
830                     $elementclone->setValue(str_replace('{no}', ($i+1), $value));
832                 } else {
833                     $value=$elementclone->getLabel();
834                     $elementclone->setLabel(str_replace('{no}', ($i+1), $value));
836                 }
838                 $mform->addElement($elementclone);
839             }
840         }
841         for ($i=0; $i<$repeats; $i++) {
842             foreach ($options as $elementname => $elementoptions){
843                 $pos=strpos($elementname, '[');
844                 if ($pos!==FALSE){
845                     $realelementname = substr($elementname, 0, $pos+1)."[$i]";
846                     $realelementname .= substr($elementname, $pos+1);
847                 }else {
848                     $realelementname = $elementname."[$i]";
849                 }
850                 foreach ($elementoptions as  $option => $params){
852                     switch ($option){
853                         case 'default' :
854                             $mform->setDefault($realelementname, $params);
855                             break;
856                         case 'helpbutton' :
857                             $mform->setHelpButton($realelementname, $params);
858                             break;
859                         case 'disabledif' :
860                             foreach ($namecloned as $num => $name){
861                                 if ($params[0] == $name){
862                                     $params[0] = $params[0]."[$i]";
863                                     break;
864                                 }
865                             }
866                             $params = array_merge(array($realelementname), $params);
867                             call_user_func_array(array(&$mform, 'disabledIf'), $params);
868                             break;
869                         case 'rule' :
870                             if (is_string($params)){
871                                 $params = array(null, $params, null, 'client');
872                             }
873                             $params = array_merge(array($realelementname), $params);
874                             call_user_func_array(array(&$mform, 'addRule'), $params);
875                             break;
877                     }
878                 }
879             }
880         }
881         $mform->addElement('submit', $addfieldsname, $addstring);
883         if (!$addbuttoninside) {
884             $mform->closeHeaderBefore($addfieldsname);
885         }
887         return $repeats;
888     }
890     /**
891      * Adds a link/button that controls the checked state of a group of checkboxes.
892      *
893      * @global object
894      * @param int    $groupid The id of the group of advcheckboxes this element controls
895      * @param string $buttontext The text of the link. Defaults to "select all/none"
896      * @param array  $attributes associative array of HTML attributes
897      * @param int    $originalValue The original general state of the checkboxes before the user first clicks this element
898      */
899     function add_checkbox_controller($groupid, $buttontext, $attributes, $originalValue = 0) {
900         global $CFG;
901         if (empty($text)) {
902             $text = get_string('selectallornone', 'form');
903         }
905         $mform = $this->_form;
906         $select_value = optional_param('checkbox_controller'. $groupid, null, PARAM_INT);
908         if ($select_value == 0 || is_null($select_value)) {
909             $new_select_value = 1;
910         } else {
911             $new_select_value = 0;
912         }
914         $mform->addElement('hidden', "checkbox_controller$groupid");
915         $mform->setConstants(array("checkbox_controller$groupid" => $new_select_value));
917         // Locate all checkboxes for this group and set their value, IF the optional param was given
918         if (!is_null($select_value)) {
919             foreach ($this->_form->_elements as $element) {
920                 if ($element->getAttribute('class') == "checkboxgroup$groupid") {
921                     $mform->setConstants(array($element->getAttribute('name') => $select_value));
922                 }
923             }
924         }
926         $checkbox_controller_name = 'nosubmit_checkbox_controller' . $groupid;
927         $mform->registerNoSubmitButton($checkbox_controller_name);
929         // Prepare Javascript for submit element
930         $js = "\n//<![CDATA[\n";
931         if (!defined('HTML_QUICKFORM_CHECKBOXCONTROLLER_EXISTS')) {
932             $js .= <<<EOS
933 function html_quickform_toggle_checkboxes(group) {
934     var checkboxes = getElementsByClassName(document, 'input', 'checkboxgroup' + group);
935     var newvalue = false;
936     var global = eval('html_quickform_checkboxgroup' + group + ';');
937     if (global == 1) {
938         eval('html_quickform_checkboxgroup' + group + ' = 0;');
939         newvalue = '';
940     } else {
941         eval('html_quickform_checkboxgroup' + group + ' = 1;');
942         newvalue = 'checked';
943     }
945     for (i = 0; i < checkboxes.length; i++) {
946         checkboxes[i].checked = newvalue;
947     }
949 EOS;
950             define('HTML_QUICKFORM_CHECKBOXCONTROLLER_EXISTS', true);
951         }
952         $js .= "\nvar html_quickform_checkboxgroup$groupid=$originalValue;\n";
954         $js .= "//]]>\n";
956         require_once("$CFG->libdir/form/submitlink.php");
957         $submitlink = new MoodleQuickForm_submitlink($checkbox_controller_name, $attributes);
958         $submitlink->_js = $js;
959         $submitlink->_onclick = "html_quickform_toggle_checkboxes($groupid); return false;";
960         $mform->addElement($submitlink);
961         $mform->setDefault($checkbox_controller_name, $text);
962     }
964     /**
965      * Use this method to a cancel and submit button to the end of your form. Pass a param of false
966      * if you don't want a cancel button in your form. If you have a cancel button make sure you
967      * check for it being pressed using is_cancelled() and redirecting if it is true before trying to
968      * get data with get_data().
969      *
970      * @param boolean $cancel whether to show cancel button, default true
971      * @param string $submitlabel label for submit button, defaults to get_string('savechanges')
972      */
973     function add_action_buttons($cancel = true, $submitlabel=null){
974         if (is_null($submitlabel)){
975             $submitlabel = get_string('savechanges');
976         }
977         $mform =& $this->_form;
978         if ($cancel){
979             //when two elements we need a group
980             $buttonarray=array();
981             $buttonarray[] = &$mform->createElement('submit', 'submitbutton', $submitlabel);
982             $buttonarray[] = &$mform->createElement('cancel');
983             $mform->addGroup($buttonarray, 'buttonar', '', array(' '), false);
984             $mform->closeHeaderBefore('buttonar');
985         } else {
986             //no group needed
987             $mform->addElement('submit', 'submitbutton', $submitlabel);
988             $mform->closeHeaderBefore('submitbutton');
989         }
990     }
993 /**
994  * You never extend this class directly. The class methods of this class are available from
995  * the private $this->_form property on moodleform and its children. You generally only
996  * call methods on this class from within abstract methods that you override on moodleform such
997  * as definition and definition_after_data
998  *
999  * @package   moodlecore
1000  * @copyright Jamie Pratt <me@jamiep.org>
1001  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1002  */
1003 class MoodleQuickForm extends HTML_QuickForm_DHTMLRulesTableless {
1004     /** @var array */
1005     var $_types = array();
1006     var $_dependencies = array();
1007     /**
1008      * Array of buttons that if pressed do not result in the processing of the form.
1009      *
1010      * @var array
1011      */
1012     var $_noSubmitButtons=array();
1013     /**
1014      * Array of buttons that if pressed do not result in the processing of the form.
1015      *
1016      * @var array
1017      */
1018     var $_cancelButtons=array();
1020     /**
1021      * Array whose keys are element names. If the key exists this is a advanced element
1022      *
1023      * @var array
1024      */
1025     var $_advancedElements = array();
1027     /**
1028      * Whether to display advanced elements (on page load)
1029      *
1030      * @var boolean
1031      */
1032     var $_showAdvanced = null;
1034     /**
1035      * The form name is derrived from the class name of the wrapper minus the trailing form
1036      * It is a name with words joined by underscores whereas the id attribute is words joined by
1037      * underscores.
1038      *
1039      * @var unknown_type
1040      */
1041     var $_formName = '';
1043     /**
1044      * String with the html for hidden params passed in as part of a moodle_url object for the action. Output in the form.
1045      *
1046      * @var string
1047      */
1048     var $_pageparams = '';
1050     /**
1051      * Class constructor - same parameters as HTML_QuickForm_DHTMLRulesTableless
1052      *
1053      * @global object
1054      * @staticvar int $formcounter
1055      * @param    string      $formName          Form's name.
1056      * @param    string      $method            (optional)Form's method defaults to 'POST'
1057      * @param    mixed      $action             (optional)Form's action - string or moodle_url
1058      * @param    string      $target            (optional)Form's target defaults to none
1059      * @param    mixed       $attributes        (optional)Extra attributes for <form> tag
1060      * @access   public
1061      */
1062     function MoodleQuickForm($formName, $method, $action, $target='', $attributes=null){
1063         global $CFG, $OUTPUT;
1065         static $formcounter = 1;
1067         HTML_Common::HTML_Common($attributes);
1068         $target = empty($target) ? array() : array('target' => $target);
1069         $this->_formName = $formName;
1070         if (is_a($action, 'moodle_url')){
1071             $this->_pageparams = $action->hidden_params_out();
1072             $action = $action->out(true);
1073         } else {
1074             $this->_pageparams = '';
1075         }
1076         //no 'name' atttribute for form in xhtml strict :
1077         $attributes = array('action'=>$action, 'method'=>$method,
1078                 'accept-charset'=>'utf-8', 'id'=>'mform'.$formcounter) + $target;
1079         $formcounter++;
1080         $this->updateAttributes($attributes);
1082         //this is custom stuff for Moodle :
1083         $oldclass=   $this->getAttribute('class');
1084         if (!empty($oldclass)){
1085             $this->updateAttributes(array('class'=>$oldclass.' mform'));
1086         }else {
1087             $this->updateAttributes(array('class'=>'mform'));
1088         }
1089         $this->_reqHTML = '<img class="req" title="'.get_string('requiredelement', 'form').'" alt="'.get_string('requiredelement', 'form').'" src="'.$OUTPUT->old_icon_url('req') .'" />';
1090         $this->_advancedHTML = '<img class="adv" title="'.get_string('advancedelement', 'form').'" alt="'.get_string('advancedelement', 'form').'" src="'.$OUTPUT->old_icon_url('adv') .'" />';
1091         $this->setRequiredNote(get_string('somefieldsrequired', 'form', '<img alt="'.get_string('requiredelement', 'form').'" src="'.$OUTPUT->old_icon_url('req') .'" />'));
1092         //(Help file doesn't add anything) helpbutton('requiredelement', get_string('requiredelement', 'form'), 'moodle', true, false, '', true));
1093     }
1095     /**
1096      * Use this method to indicate an element in a form is an advanced field. If items in a form
1097      * are marked as advanced then 'Hide/Show Advanced' buttons will automatically be displayed in the
1098      * form so the user can decide whether to display advanced form controls.
1099      *
1100      * If you set a header element to advanced then all elements it contains will also be set as advanced.
1101      *
1102      * @param string $elementName group or element name (not the element name of something inside a group).
1103      * @param boolean $advanced default true sets the element to advanced. False removes advanced mark.
1104      */
1105     function setAdvanced($elementName, $advanced=true){
1106         if ($advanced){
1107             $this->_advancedElements[$elementName]='';
1108         } elseif (isset($this->_advancedElements[$elementName])) {
1109             unset($this->_advancedElements[$elementName]);
1110         }
1111         if ($advanced && $this->getElementType('mform_showadvanced_last')===false){
1112             $this->setShowAdvanced();
1113             $this->registerNoSubmitButton('mform_showadvanced');
1115             $this->addElement('hidden', 'mform_showadvanced_last');
1116         }
1117     }
1118     /**
1119      * Set whether to show advanced elements in the form on first displaying form. Default is not to
1120      * display advanced elements in the form until 'Show Advanced' is pressed.
1121      *
1122      * You can get the last state of the form and possibly save it for this user by using
1123      * value 'mform_showadvanced_last' in submitted data.
1124      *
1125      * @param boolean $showadvancedNow
1126      */
1127     function setShowAdvanced($showadvancedNow = null){
1128         if ($showadvancedNow === null){
1129             if ($this->_showAdvanced !== null){
1130                 return;
1131             } else { //if setShowAdvanced is called without any preference
1132                      //make the default to not show advanced elements.
1133                 $showadvancedNow = get_user_preferences(
1134                                 moodle_strtolower($this->_formName.'_showadvanced', 0));
1135             }
1136         }
1137         //value of hidden element
1138         $hiddenLast = optional_param('mform_showadvanced_last', -1, PARAM_INT);
1139         //value of button
1140         $buttonPressed = optional_param('mform_showadvanced', 0, PARAM_RAW);
1141         //toggle if button pressed or else stay the same
1142         if ($hiddenLast == -1) {
1143             $next = $showadvancedNow;
1144         } elseif ($buttonPressed) { //toggle on button press
1145             $next = !$hiddenLast;
1146         } else {
1147             $next = $hiddenLast;
1148         }
1149         $this->_showAdvanced = $next;
1150         if ($showadvancedNow != $next){
1151             set_user_preference($this->_formName.'_showadvanced', $next);
1152         }
1153         $this->setConstants(array('mform_showadvanced_last'=>$next));
1154     }
1155     function getShowAdvanced(){
1156         return $this->_showAdvanced;
1157     }
1160    /**
1161     * Accepts a renderer
1162     *
1163     * @param object $renderer HTML_QuickForm_Renderer  An HTML_QuickForm_Renderer object
1164     * @access public
1165     * @return void
1166     */
1167     function accept(&$renderer) {
1168         if (method_exists($renderer, 'setAdvancedElements')){
1169             //check for visible fieldsets where all elements are advanced
1170             //and mark these headers as advanced as well.
1171             //And mark all elements in a advanced header as advanced
1172             $stopFields = $renderer->getStopFieldSetElements();
1173             $lastHeader = null;
1174             $lastHeaderAdvanced = false;
1175             $anyAdvanced = false;
1176             foreach (array_keys($this->_elements) as $elementIndex){
1177                 $element =& $this->_elements[$elementIndex];
1179                 // if closing header and any contained element was advanced then mark it as advanced
1180                 if ($element->getType()=='header' || in_array($element->getName(), $stopFields)){
1181                     if ($anyAdvanced && !is_null($lastHeader)){
1182                         $this->setAdvanced($lastHeader->getName());
1183                     }
1184                     $lastHeaderAdvanced = false;
1185                     unset($lastHeader);
1186                     $lastHeader = null;
1187                 } elseif ($lastHeaderAdvanced) {
1188                     $this->setAdvanced($element->getName());
1189                 }
1191                 if ($element->getType()=='header'){
1192                     $lastHeader =& $element;
1193                     $anyAdvanced = false;
1194                     $lastHeaderAdvanced = isset($this->_advancedElements[$element->getName()]);
1195                 } elseif (isset($this->_advancedElements[$element->getName()])){
1196                     $anyAdvanced = true;
1197                 }
1198             }
1199             // the last header may not be closed yet...
1200             if ($anyAdvanced && !is_null($lastHeader)){
1201                 $this->setAdvanced($lastHeader->getName());
1202             }
1203             $renderer->setAdvancedElements($this->_advancedElements);
1205         }
1206         parent::accept($renderer);
1207     }
1209     /**
1210      * @param string $elementName
1211      */
1212     function closeHeaderBefore($elementName){
1213         $renderer =& $this->defaultRenderer();
1214         $renderer->addStopFieldsetElements($elementName);
1215     }
1217     /**
1218      * Should be used for all elements of a form except for select, radio and checkboxes which
1219      * clean their own data.
1220      *
1221      * @param string $elementname
1222      * @param integer $paramtype use the constants PARAM_*.
1223      *     *  PARAM_CLEAN is deprecated and you should try to use a more specific type.
1224      *     *  PARAM_TEXT should be used for cleaning data that is expected to be plain text.
1225      *          It will strip all html tags. But will still let tags for multilang support
1226      *          through.
1227      *     *  PARAM_RAW means no cleaning whatsoever, it is used mostly for data from the
1228      *          html editor. Data from the editor is later cleaned before display using
1229      *          format_text() function. PARAM_RAW can also be used for data that is validated
1230      *          by some other way or printed by p() or s().
1231      *     *  PARAM_INT should be used for integers.
1232      *     *  PARAM_ACTION is an alias of PARAM_ALPHA and is used for hidden fields specifying
1233      *          form actions.
1234      */
1235     function setType($elementname, $paramtype) {
1236         $this->_types[$elementname] = $paramtype;
1237     }
1239     /**
1240      * See description of setType above. This can be used to set several types at once.
1241      *
1242      * @param array $paramtypes
1243      */
1244     function setTypes($paramtypes) {
1245         $this->_types = $paramtypes + $this->_types;
1246     }
1248     /**
1249      * @param array $submission
1250      * @param array $files
1251      */
1252     function updateSubmission($submission, $files) {
1253         $this->_flagSubmitted = false;
1255         if (empty($submission)) {
1256             $this->_submitValues = array();
1257         } else {
1258             foreach ($submission as $key=>$s) {
1259                 if (array_key_exists($key, $this->_types)) {
1260                     $submission[$key] = clean_param($s, $this->_types[$key]);
1261                 }
1262             }
1263             $this->_submitValues = $submission;
1264             $this->_flagSubmitted = true;
1265         }
1267         if (empty($files)) {
1268             $this->_submitFiles = array();
1269         } else {
1270             $this->_submitFiles = $files;
1271             $this->_flagSubmitted = true;
1272         }
1274         // need to tell all elements that they need to update their value attribute.
1275          foreach (array_keys($this->_elements) as $key) {
1276              $this->_elements[$key]->onQuickFormEvent('updateValue', null, $this);
1277          }
1278     }
1280     /**
1281      * @return string
1282      */
1283     function getReqHTML(){
1284         return $this->_reqHTML;
1285     }
1286     
1287     /**
1288      * @return string
1289      */
1290     function getAdvancedHTML(){
1291         return $this->_advancedHTML;
1292     }
1294     /**
1295      * Initializes a default form value. Used to specify the default for a new entry where
1296      * no data is loaded in using moodleform::set_data()
1297      *
1298      * note: $slashed param removed
1299      *
1300      * @param     string   $elementname        element name
1301      * @param     mixed    $values             values for that element name
1302      * @access    public
1303      * @return    void
1304      */
1305     function setDefault($elementName, $defaultValue){
1306         $this->setDefaults(array($elementName=>$defaultValue));
1307     } // end func setDefault
1308     /**
1309      * Add an array of buttons to the form
1310      * @param    array       $buttons          An associative array representing help button to attach to
1311      *                                          to the form. keys of array correspond to names of elements in form.
1312      * @param bool $suppresscheck
1313      * @param string $function
1314      * @access   public
1315     */
1316     function setHelpButtons($buttons, $suppresscheck=false, $function='helpbutton'){
1318         foreach ($buttons as $elementname => $button){
1319             $this->setHelpButton($elementname, $button, $suppresscheck, $function);
1320         }
1321     }
1322     /**
1323      * Add a single button.
1324      *
1325      * @param string $elementname name of the element to add the item to
1326      * @param array $button arguments to pass to function $function
1327      * @param boolean $suppresscheck whether to throw an error if the element
1328      *                                  doesn't exist.
1329      * @param string $function - function to generate html from the arguments in $button
1330      * @param string $function
1331      */
1332     function setHelpButton($elementname, $button, $suppresscheck=false, $function='helpbutton'){
1333         global $OUTPUT;
1334         if (array_key_exists($elementname, $this->_elementIndex)){
1335             //_elements has a numeric index, this code accesses the elements by name
1336             $element=&$this->_elements[$this->_elementIndex[$elementname]];
1337             $buttonparams = array('page', 'text', 'module', 'image', 'linktext', 'text', 'return', 'imagetext');
1338             $helpiconoptions = array('page' => null, 'text' => null, 'module' => 'moodle', 'image' => null, 'linktext' => false);
1340             foreach ($button as $key => $val) {
1341                 if (isset($button[$key])) {
1342                     $helpiconoptions[$buttonparams[$key]] = $val;
1343                 }
1344             }
1345             $helpicon = moodle_help_icon::make($helpiconoptions['page'], $helpiconoptions['text'], $helpiconoptions['module'], $helpiconoptions['linktext']);
1346             if (!$helpiconoptions['image']) {
1347                 $helpicon->image = false;
1348             }
1350             $element->_helpbutton = $OUTPUT->help_icon($helpicon);
1351         }elseif (!$suppresscheck){
1352             print_error('nonexistentformelements', 'form', '', $elementname);
1353         }
1354     }
1356     /**
1357      * Set constant value not overriden by _POST or _GET
1358      * note: this does not work for complex names with [] :-(
1359      *
1360      * @param string $elname name of element
1361      * @param mixed $value
1362      * @return void
1363      */
1364     function setConstant($elname, $value) {
1365         $this->_constantValues = HTML_QuickForm::arrayMerge($this->_constantValues, array($elname=>$value));
1366         $element =& $this->getElement($elname);
1367         $element->onQuickFormEvent('updateValue', null, $this);
1368     }
1370     /**
1371      * @param string $elementList
1372      */
1373     function exportValues($elementList = null){
1374         $unfiltered = array();
1375         if (null === $elementList) {
1376             // iterate over all elements, calling their exportValue() methods
1377             $emptyarray = array();
1378             foreach (array_keys($this->_elements) as $key) {
1379                 if ($this->_elements[$key]->isFrozen() && !$this->_elements[$key]->_persistantFreeze){
1380                     $value = $this->_elements[$key]->exportValue($emptyarray, true);
1381                 } else {
1382                     $value = $this->_elements[$key]->exportValue($this->_submitValues, true);
1383                 }
1385                 if (is_array($value)) {
1386                     // This shit throws a bogus warning in PHP 4.3.x
1387                     $unfiltered = HTML_QuickForm::arrayMerge($unfiltered, $value);
1388                 }
1389             }
1390         } else {
1391             if (!is_array($elementList)) {
1392                 $elementList = array_map('trim', explode(',', $elementList));
1393             }
1394             foreach ($elementList as $elementName) {
1395                 $value = $this->exportValue($elementName);
1396                 if (PEAR::isError($value)) {
1397                     return $value;
1398                 }
1399                 //oh, stock QuickFOrm was returning array of arrays!
1400                 $unfiltered = HTML_QuickForm::arrayMerge($unfiltered, $value);
1401             }
1402         }
1404         return $unfiltered;
1405     }
1406     /**
1407      * Adds a validation rule for the given field
1408      *
1409      * If the element is in fact a group, it will be considered as a whole.
1410      * To validate grouped elements as separated entities,
1411      * use addGroupRule instead of addRule.
1412      *
1413      * @param    string     $element       Form element name
1414      * @param    string     $message       Message to display for invalid data
1415      * @param    string     $type          Rule type, use getRegisteredRules() to get types
1416      * @param    string     $format        (optional)Required for extra rule data
1417      * @param    string     $validation    (optional)Where to perform validation: "server", "client"
1418      * @param    boolean    $reset         Client-side validation: reset the form element to its original value if there is an error?
1419      * @param    boolean    $force         Force the rule to be applied, even if the target form element does not exist
1420      * @access   public
1421      */
1422     function addRule($element, $message, $type, $format=null, $validation='server', $reset = false, $force = false)
1423     {
1424         parent::addRule($element, $message, $type, $format, $validation, $reset, $force);
1425         if ($validation == 'client') {
1426             $this->updateAttributes(array('onsubmit' => 'try { var myValidator = validate_' . $this->_formName . '; } catch(e) { return true; } return myValidator(this);'));
1427         }
1429     } // end func addRule
1430     /**
1431      * Adds a validation rule for the given group of elements
1432      *
1433      * Only groups with a name can be assigned a validation rule
1434      * Use addGroupRule when you need to validate elements inside the group.
1435      * Use addRule if you need to validate the group as a whole. In this case,
1436      * the same rule will be applied to all elements in the group.
1437      * Use addRule if you need to validate the group against a function.
1438      *
1439      * @param    string     $group         Form group name
1440      * @param    mixed      $arg1          Array for multiple elements or error message string for one element
1441      * @param    string     $type          (optional)Rule type use getRegisteredRules() to get types
1442      * @param    string     $format        (optional)Required for extra rule data
1443      * @param    int        $howmany       (optional)How many valid elements should be in the group
1444      * @param    string     $validation    (optional)Where to perform validation: "server", "client"
1445      * @param    bool       $reset         Client-side: whether to reset the element's value to its original state if validation failed.
1446      * @access   public
1447      */
1448     function addGroupRule($group, $arg1, $type='', $format=null, $howmany=0, $validation = 'server', $reset = false)
1449     {
1450         parent::addGroupRule($group, $arg1, $type, $format, $howmany, $validation, $reset);
1451         if (is_array($arg1)) {
1452              foreach ($arg1 as $rules) {
1453                 foreach ($rules as $rule) {
1454                     $validation = (isset($rule[3]) && 'client' == $rule[3])? 'client': 'server';
1456                     if ('client' == $validation) {
1457                         $this->updateAttributes(array('onsubmit' => 'try { var myValidator = validate_' . $this->_formName . '; } catch(e) { return true; } return myValidator(this);'));
1458                     }
1459                 }
1460             }
1461         } elseif (is_string($arg1)) {
1463             if ($validation == 'client') {
1464                 $this->updateAttributes(array('onsubmit' => 'try { var myValidator = validate_' . $this->_formName . '; } catch(e) { return true; } return myValidator(this);'));
1465             }
1466         }
1467     } // end func addGroupRule
1469     // }}}
1470     /**
1471      * Returns the client side validation script
1472      *
1473      * The code here was copied from HTML_QuickForm_DHTMLRulesTableless who copied it from  HTML_QuickForm
1474      * and slightly modified to run rules per-element
1475      * Needed to override this because of an error with client side validation of grouped elements.
1476      *
1477      * @access    public
1478      * @return    string    Javascript to perform validation, empty string if no 'client' rules were added
1479      */
1480     function getValidationScript()
1481     {
1482         if (empty($this->_rules) || empty($this->_attributes['onsubmit'])) {
1483             return '';
1484         }
1486         include_once('HTML/QuickForm/RuleRegistry.php');
1487         $registry =& HTML_QuickForm_RuleRegistry::singleton();
1488         $test = array();
1489         $js_escape = array(
1490             "\r"    => '\r',
1491             "\n"    => '\n',
1492             "\t"    => '\t',
1493             "'"     => "\\'",
1494             '"'     => '\"',
1495             '\\'    => '\\\\'
1496         );
1498         foreach ($this->_rules as $elementName => $rules) {
1499             foreach ($rules as $rule) {
1500                 if ('client' == $rule['validation']) {
1501                     unset($element); //TODO: find out how to properly initialize it
1503                     $dependent  = isset($rule['dependent']) && is_array($rule['dependent']);
1504                     $rule['message'] = strtr($rule['message'], $js_escape);
1506                     if (isset($rule['group'])) {
1507                         $group    =& $this->getElement($rule['group']);
1508                         // No JavaScript validation for frozen elements
1509                         if ($group->isFrozen()) {
1510                             continue 2;
1511                         }
1512                         $elements =& $group->getElements();
1513                         foreach (array_keys($elements) as $key) {
1514                             if ($elementName == $group->getElementName($key)) {
1515                                 $element =& $elements[$key];
1516                                 break;
1517                             }
1518                         }
1519                     } elseif ($dependent) {
1520                         $element   =  array();
1521                         $element[] =& $this->getElement($elementName);
1522                         foreach ($rule['dependent'] as $elName) {
1523                             $element[] =& $this->getElement($elName);
1524                         }
1525                     } else {
1526                         $element =& $this->getElement($elementName);
1527                     }
1528                     // No JavaScript validation for frozen elements
1529                     if (is_object($element) && $element->isFrozen()) {
1530                         continue 2;
1531                     } elseif (is_array($element)) {
1532                         foreach (array_keys($element) as $key) {
1533                             if ($element[$key]->isFrozen()) {
1534                                 continue 3;
1535                             }
1536                         }
1537                     }
1538                     // Fix for bug displaying errors for elements in a group
1539                     //$test[$elementName][] = $registry->getValidationScript($element, $elementName, $rule);
1540                     $test[$elementName][0][] = $registry->getValidationScript($element, $elementName, $rule);
1541                     $test[$elementName][1]=$element;
1542                     //end of fix
1543                 }
1544             }
1545         }
1547         // Fix for MDL-9524. If you don't do this, then $element may be left as a reference to one of the fields in
1548         // the form, and then that form field gets corrupted by the code that follows.
1549         unset($element);
1551         $js = '
1552 <script type="text/javascript">
1553 //<![CDATA[
1555 var skipClientValidation = false;
1557 function qf_errorHandler(element, _qfMsg) {
1558   div = element.parentNode;
1559   if (_qfMsg != \'\') {
1560     var errorSpan = document.getElementById(\'id_error_\'+element.name);
1561     if (!errorSpan) {
1562       errorSpan = document.createElement("span");
1563       errorSpan.id = \'id_error_\'+element.name;
1564       errorSpan.className = "error";
1565       element.parentNode.insertBefore(errorSpan, element.parentNode.firstChild);
1566     }
1568     while (errorSpan.firstChild) {
1569       errorSpan.removeChild(errorSpan.firstChild);
1570     }
1572     errorSpan.appendChild(document.createTextNode(_qfMsg.substring(3)));
1573     errorSpan.appendChild(document.createElement("br"));
1575     if (div.className.substr(div.className.length - 6, 6) != " error"
1576         && div.className != "error") {
1577       div.className += " error";
1578     }
1580     return false;
1581   } else {
1582     var errorSpan = document.getElementById(\'id_error_\'+element.name);
1583     if (errorSpan) {
1584       errorSpan.parentNode.removeChild(errorSpan);
1585     }
1587     if (div.className.substr(div.className.length - 6, 6) == " error") {
1588       div.className = div.className.substr(0, div.className.length - 6);
1589     } else if (div.className == "error") {
1590       div.className = "";
1591     }
1593     return true;
1594   }
1595 }';
1596         $validateJS = '';
1597         foreach ($test as $elementName => $jsandelement) {
1598             // Fix for bug displaying errors for elements in a group
1599             //unset($element);
1600             list($jsArr,$element)=$jsandelement;
1601             //end of fix
1602             $js .= '
1603 function validate_' . $this->_formName . '_' . $elementName . '(element) {
1604   var value = \'\';
1605   var errFlag = new Array();
1606   var _qfGroups = {};
1607   var _qfMsg = \'\';
1608   var frm = element.parentNode;
1609   while (frm && frm.nodeName.toUpperCase() != "FORM") {
1610     frm = frm.parentNode;
1611   }
1612 ' . join("\n", $jsArr) . '
1613   return qf_errorHandler(element, _qfMsg);
1615 ';
1616             $validateJS .= '
1617   ret = validate_' . $this->_formName . '_' . $elementName.'(frm.elements[\''.$elementName.'\']) && ret;
1618   if (!ret && !first_focus) {
1619     first_focus = true;
1620     frm.elements[\''.$elementName.'\'].focus();
1621   }
1622 ';
1624             // Fix for bug displaying errors for elements in a group
1625             //unset($element);
1626             //$element =& $this->getElement($elementName);
1627             //end of fix
1628             $valFunc = 'validate_' . $this->_formName . '_' . $elementName . '(this)';
1629             $onBlur = $element->getAttribute('onBlur');
1630             $onChange = $element->getAttribute('onChange');
1631             $element->updateAttributes(array('onBlur' => $onBlur . $valFunc,
1632                                              'onChange' => $onChange . $valFunc));
1633         }
1634 //  do not rely on frm function parameter, because htmlarea breaks it when overloading the onsubmit method
1635         $js .= '
1636 function validate_' . $this->_formName . '(frm) {
1637   if (skipClientValidation) {
1638      return true;
1639   }
1640   var ret = true;
1642   var frm = document.getElementById(\''. $this->_attributes['id'] .'\')
1643   var first_focus = false;
1644 ' . $validateJS . ';
1645   return ret;
1647 //]]>
1648 </script>';
1649         return $js;
1650     } // end func getValidationScript
1651     function _setDefaultRuleMessages(){
1652         foreach ($this->_rules as $field => $rulesarr){
1653             foreach ($rulesarr as $key => $rule){
1654                 if ($rule['message']===null){
1655                     $a=new object();
1656                     $a->format=$rule['format'];
1657                     $str=get_string('err_'.$rule['type'], 'form', $a);
1658                     if (strpos($str, '[[')!==0){
1659                         $this->_rules[$field][$key]['message']=$str;
1660                     }
1661                 }
1662             }
1663         }
1664     }
1666     /**
1667      * @return string
1668      */
1669     function getLockOptionEndScript(){
1671         $iname = $this->getAttribute('id').'items';
1672         $js = '<script type="text/javascript">'."\n";
1673         $js .= '//<![CDATA['."\n";
1674         $js .= "var $iname = Array();\n";
1676         foreach ($this->_dependencies as $dependentOn => $conditions){
1677             $js .= "{$iname}['$dependentOn'] = Array();\n";
1678             foreach ($conditions as $condition=>$values) {
1679                 $js .= "{$iname}['$dependentOn']['$condition'] = Array();\n";
1680                 foreach ($values as $value=>$dependents) {
1681                     $js .= "{$iname}['$dependentOn']['$condition']['$value'] = Array();\n";
1682                     $i = 0;
1683                     foreach ($dependents as $dependent) {
1684                         $elements = $this->_getElNamesRecursive($dependent);
1685                         if (empty($elements)) {
1686                             // probably element inside of some group
1687                             $elements = array($dependent);
1688                         }
1689                         foreach($elements as $element) {
1690                             if ($element == $dependentOn) {
1691                                 continue;
1692                             }
1693                             $js .= "{$iname}['$dependentOn']['$condition']['$value'][$i]='$element';\n";
1694                             $i++;
1695                         }
1696                     }
1697                 }
1698             }
1699         }
1700         $js .="lockoptionsallsetup('".$this->getAttribute('id')."');\n";
1701         $js .='//]]>'."\n";
1702         $js .='</script>'."\n";
1703         return $js;
1704     }
1706     /**
1707      * @param mixed $element
1708      * @return array
1709      */
1710     function _getElNamesRecursive($element) {
1711         if (is_string($element)) {
1712             if (!$this->elementExists($element)) {
1713                 return array();
1714             }
1715             $element = $this->getElement($element);
1716         }
1718         if (is_a($element, 'HTML_QuickForm_group')) {
1719             $elsInGroup = $element->getElements();
1720             $elNames = array();
1721             foreach ($elsInGroup as $elInGroup){
1722                 if (is_a($elInGroup, 'HTML_QuickForm_group')) {
1723                     // not sure if this would work - groups nested in groups
1724                     $elNames = array_merge($elNames, $this->_getElNamesRecursive($elInGroup));
1725                 } else {
1726                     $elNames[] = $element->getElementName($elInGroup->getName());
1727                 }
1728             }
1730         } else if (is_a($element, 'HTML_QuickForm_header')) {
1731             return array();
1733         } else if (is_a($element, 'HTML_QuickForm_hidden')) {
1734             return array();
1736         } else if (method_exists($element, 'getPrivateName')) {
1737             return array($element->getPrivateName());
1739         } else {
1740             $elNames = array($element->getName());
1741         }
1743         return $elNames;
1744     }
1746     /**
1747      * Adds a dependency for $elementName which will be disabled if $condition is met.
1748      * If $condition = 'notchecked' (default) then the condition is that the $dependentOn element
1749      * is not checked. If $condition = 'checked' then the condition is that the $dependentOn element
1750      * is checked. If $condition is something else (like "eq" for equals) then it is checked to see if the value
1751      * of the $dependentOn element is $condition (such as equal) to $value.
1752      *
1753      * @param string $elementName the name of the element which will be disabled
1754      * @param string $dependentOn the name of the element whose state will be checked for
1755      *                            condition
1756      * @param string $condition the condition to check
1757      * @param mixed $value used in conjunction with condition.
1758      */
1759     function disabledIf($elementName, $dependentOn, $condition = 'notchecked', $value='1'){
1760         if (!array_key_exists($dependentOn, $this->_dependencies)) {
1761             $this->_dependencies[$dependentOn] = array();
1762         }
1763         if (!array_key_exists($condition, $this->_dependencies[$dependentOn])) {
1764             $this->_dependencies[$dependentOn][$condition] = array();
1765         }
1766         if (!array_key_exists($value, $this->_dependencies[$dependentOn][$condition])) {
1767             $this->_dependencies[$dependentOn][$condition][$value] = array();
1768         }
1769         $this->_dependencies[$dependentOn][$condition][$value][] = $elementName;
1770     }
1772     function registerNoSubmitButton($buttonname){
1773         $this->_noSubmitButtons[]=$buttonname;
1774     }
1776     /**
1777      * @param string $buttonname
1778      * @return mixed
1779      */
1780     function isNoSubmitButton($buttonname){
1781         return (array_search($buttonname, $this->_noSubmitButtons)!==FALSE);
1782     }
1784     /**
1785      * @param string $buttonname
1786      */
1787     function _registerCancelButton($addfieldsname){
1788         $this->_cancelButtons[]=$addfieldsname;
1789     }
1790     /**
1791      * Displays elements without HTML input tags.
1792      * This method is different to freeze() in that it makes sure no hidden
1793      * elements are included in the form.
1794      * Note: If you want to make sure the submitted value is ignored, please use setDefaults().
1795      *
1796      * This function also removes all previously defined rules.
1797      *
1798      * @param    mixed   $elementList       array or string of element(s) to be frozen
1799      * @access   public
1800      */
1801     function hardFreeze($elementList=null)
1802     {
1803         if (!isset($elementList)) {
1804             $this->_freezeAll = true;
1805             $elementList = array();
1806         } else {
1807             if (!is_array($elementList)) {
1808                 $elementList = preg_split('/[ ]*,[ ]*/', $elementList);
1809             }
1810             $elementList = array_flip($elementList);
1811         }
1813         foreach (array_keys($this->_elements) as $key) {
1814             $name = $this->_elements[$key]->getName();
1815             if ($this->_freezeAll || isset($elementList[$name])) {
1816                 $this->_elements[$key]->freeze();
1817                 $this->_elements[$key]->setPersistantFreeze(false);
1818                 unset($elementList[$name]);
1820                 // remove all rules
1821                 $this->_rules[$name] = array();
1822                 // if field is required, remove the rule
1823                 $unset = array_search($name, $this->_required);
1824                 if ($unset !== false) {
1825                     unset($this->_required[$unset]);
1826                 }
1827             }
1828         }
1830         if (!empty($elementList)) {
1831             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);
1832         }
1833         return true;
1834     }
1835     /**
1836      * Hard freeze all elements in a form except those whose names are in $elementList or hidden elements in a form.
1837      *
1838      * This function also removes all previously defined rules of elements it freezes.
1839      *
1840      * throws   HTML_QuickForm_Error
1841      *
1842      * @param    array   $elementList       array or string of element(s) not to be frozen
1843      * @access   public
1844      */
1845     function hardFreezeAllVisibleExcept($elementList)
1846     {
1847         $elementList = array_flip($elementList);
1848         foreach (array_keys($this->_elements) as $key) {
1849             $name = $this->_elements[$key]->getName();
1850             $type = $this->_elements[$key]->getType();
1852             if ($type == 'hidden'){
1853                 // leave hidden types as they are
1854             } elseif (!isset($elementList[$name])) {
1855                 $this->_elements[$key]->freeze();
1856                 $this->_elements[$key]->setPersistantFreeze(false);
1858                 // remove all rules
1859                 $this->_rules[$name] = array();
1860                 // if field is required, remove the rule
1861                 $unset = array_search($name, $this->_required);
1862                 if ($unset !== false) {
1863                     unset($this->_required[$unset]);
1864                 }
1865             }
1866         }
1867         return true;
1868     }
1869    /**
1870     * Tells whether the form was already submitted
1871     *
1872     * This is useful since the _submitFiles and _submitValues arrays
1873     * may be completely empty after the trackSubmit value is removed.
1874     *
1875     * @access public
1876     * @return bool
1877     */
1878     function isSubmitted()
1879     {
1880         return parent::isSubmitted() && (!$this->isFrozen());
1881     }
1885 /**
1886  * A renderer for MoodleQuickForm that only uses XHTML and CSS and no
1887  * table tags, extends PEAR class HTML_QuickForm_Renderer_Tableless
1888  *
1889  * Stylesheet is part of standard theme and should be automatically included.
1890  *
1891  * @package   moodlecore
1892  * @copyright Jamie Pratt <me@jamiep.org>
1893  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1894  */
1895 class MoodleQuickForm_Renderer extends HTML_QuickForm_Renderer_Tableless{
1897     /**
1898     * Element template array
1899     * @var      array
1900     * @access   private
1901     */
1902     var $_elementTemplates;
1903     /**
1904     * Template used when opening a hidden fieldset
1905     * (i.e. a fieldset that is opened when there is no header element)
1906     * @var      string
1907     * @access   private
1908     */
1909     var $_openHiddenFieldsetTemplate = "\n\t<fieldset class=\"hidden\"><div>";
1910    /**
1911     * Header Template string
1912     * @var      string
1913     * @access   private
1914     */
1915     var $_headerTemplate =
1916        "\n\t\t<legend class=\"ftoggler\">{header}</legend>\n\t\t<div class=\"advancedbutton\">{advancedimg}{button}</div><div class=\"fcontainer clearfix\">\n\t\t";
1918    /**
1919     * Template used when opening a fieldset
1920     * @var      string
1921     * @access   private
1922     */
1923     var $_openFieldsetTemplate = "\n\t<fieldset class=\"clearfix\" {id}>";
1925     /**
1926     * Template used when closing a fieldset
1927     * @var      string
1928     * @access   private
1929     */
1930     var $_closeFieldsetTemplate = "\n\t\t</div></fieldset>";
1932    /**
1933     * Required Note template string
1934     * @var      string
1935     * @access   private
1936     */
1937     var $_requiredNoteTemplate =
1938         "\n\t\t<div class=\"fdescription required\">{requiredNote}</div>";
1940     var $_advancedElements = array();
1942     /**
1943      * Whether to display advanced elements (on page load)
1944      *
1945      * @var integer 1 means show 0 means hide
1946      */
1947     var $_showAdvanced;
1949     function MoodleQuickForm_Renderer(){
1950         // switch next two lines for ol li containers for form items.
1951         //        $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>');
1952         $this->_elementTemplates = array(
1953         'default'=>"\n\t\t".'<div class="fitem {advanced}<!-- BEGIN required --> required<!-- END required -->"><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>',
1955         'fieldset'=>"\n\t\t".'<div class="fitem {advanced}<!-- BEGIN required --> required<!-- END required -->"><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>',
1957         '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>',
1959 'warning'=>"\n\t\t".'<div class="fitem {advanced}">{element}</div>',
1961         'nodisplay'=>'');
1963         parent::HTML_QuickForm_Renderer_Tableless();
1964     }
1966     /**
1967      * @param array $elements
1968      */
1969     function setAdvancedElements($elements){
1970         $this->_advancedElements = $elements;
1971     }
1973     /**
1974      * What to do when starting the form
1975      *
1976      * @param object $form MoodleQuickForm
1977      */
1978     function startForm(&$form){
1979         $this->_reqHTML = $form->getReqHTML();
1980         $this->_elementTemplates = str_replace('{req}', $this->_reqHTML, $this->_elementTemplates);
1981         $this->_advancedHTML = $form->getAdvancedHTML();
1982         $this->_showAdvanced = $form->getShowAdvanced();
1983         parent::startForm($form);
1984         if ($form->isFrozen()){
1985             $this->_formTemplate = "\n<div class=\"mform frozen\">\n{content}\n</div>";
1986         } else {
1987             $this->_hiddenHtml .= $form->_pageparams;
1988         }
1991     }
1992     
1993     /**
1994      * @param object $group Passed by reference
1995      * @param mixed $required
1996      * @param mixed $error
1997      */
1998     function startGroup(&$group, $required, $error){
1999         if (method_exists($group, 'getElementTemplateType')){
2000             $html = $this->_elementTemplates[$group->getElementTemplateType()];
2001         }else{
2002             $html = $this->_elementTemplates['default'];
2004         }
2005         if ($this->_showAdvanced){
2006             $advclass = ' advanced';
2007         } else {
2008             $advclass = ' advanced hide';
2009         }
2010         if (isset($this->_advancedElements[$group->getName()])){
2011             $html =str_replace(' {advanced}', $advclass, $html);
2012             $html =str_replace('{advancedimg}', $this->_advancedHTML, $html);
2013         } else {
2014             $html =str_replace(' {advanced}', '', $html);
2015             $html =str_replace('{advancedimg}', '', $html);
2016         }
2017         if (method_exists($group, 'getHelpButton')){
2018             $html =str_replace('{help}', $group->getHelpButton(), $html);
2019         }else{
2020             $html =str_replace('{help}', '', $html);
2021         }
2022         $html =str_replace('{name}', $group->getName(), $html);
2023         $html =str_replace('{type}', 'fgroup', $html);
2025         $this->_templates[$group->getName()]=$html;
2026         // Fix for bug in tableless quickforms that didn't allow you to stop a
2027         // fieldset before a group of elements.
2028         // if the element name indicates the end of a fieldset, close the fieldset
2029         if (   in_array($group->getName(), $this->_stopFieldsetElements)
2030             && $this->_fieldsetsOpen > 0
2031            ) {
2032             $this->_html .= $this->_closeFieldsetTemplate;
2033             $this->_fieldsetsOpen--;
2034         }
2035         parent::startGroup($group, $required, $error);
2036     }
2037     /**
2038      * @param object $element
2039      * @param mixed $required
2040      * @param mixed $error
2041      */
2042     function renderElement(&$element, $required, $error){
2043         //manipulate id of all elements before rendering
2044         if (!is_null($element->getAttribute('id'))) {
2045             $id = $element->getAttribute('id');
2046         } else {
2047             $id = $element->getName();
2048         }
2049         //strip qf_ prefix and replace '[' with '_' and strip ']'
2050         $id = preg_replace(array('/^qf_|\]/', '/\[/'), array('', '_'), $id);
2051         if (strpos($id, 'id_') !== 0){
2052             $element->updateAttributes(array('id'=>'id_'.$id));
2053         }
2055         //adding stuff to place holders in template
2056         //check if this is a group element first
2057         if (($this->_inGroup) and !empty($this->_groupElementTemplate)) {
2058             // so it gets substitutions for *each* element
2059             $html = $this->_groupTemplates[$element->getName()];
2060         }
2061         elseif (method_exists($element, 'getElementTemplateType')){
2062             $html = $this->_elementTemplates[$element->getElementTemplateType()];
2063         }else{
2064             $html = $this->_elementTemplates['default'];
2065         }
2066         if ($this->_showAdvanced){
2067             $advclass = ' advanced';
2068         } else {
2069             $advclass = ' advanced hide';
2070         }
2071         if (isset($this->_advancedElements[$element->getName()])){
2072             $html =str_replace(' {advanced}', $advclass, $html);
2073         } else {
2074             $html =str_replace(' {advanced}', '', $html);
2075         }
2076         if (isset($this->_advancedElements[$element->getName()])||$element->getName() == 'mform_showadvanced'){
2077             $html =str_replace('{advancedimg}', $this->_advancedHTML, $html);
2078         } else {
2079             $html =str_replace('{advancedimg}', '', $html);
2080         }
2081         $html =str_replace('{type}', 'f'.$element->getType(), $html);
2082         $html =str_replace('{name}', $element->getName(), $html);
2083         if (method_exists($element, 'getHelpButton')){
2084             $html = str_replace('{help}', $element->getHelpButton(), $html);
2085         }else{
2086             $html = str_replace('{help}', '', $html);
2088         }
2089         if (($this->_inGroup) and !empty($this->_groupElementTemplate)) {
2090             $this->_groupElementTemplate = $html;
2091         }
2092         elseif (!isset($this->_templates[$element->getName()])) {
2093             $this->_templates[$element->getName()] = $html;
2094         }
2096         parent::renderElement($element, $required, $error);
2097     }
2099     /**
2100      * @param object $form Passed by reference
2101      */
2102     function finishForm(&$form){
2103         if ($form->isFrozen()){
2104             $this->_hiddenHtml = '';
2105         }
2106         parent::finishForm($form);
2107         if ((!$form->isFrozen()) && ('' != ($script = $form->getLockOptionEndScript()))) {
2108             // add a lockoptions script
2109             $this->_html = $this->_html . "\n" . $script;
2110         }
2111     }
2112    /**
2113     * Called when visiting a header element
2114     *
2115     * @param    object  $header   An HTML_QuickForm_header element being visited
2116     * @access   public
2117     * @return   void
2118     */
2119     function renderHeader(&$header) {
2120         global $PAGE;
2121         static $advformcount;
2123         // This ensures that if 2(+) advanced buttons are used
2124         // that all show/hide buttons appear in the correct place
2125         // Because of now using $PAGE->requires->js_function_call
2126         if ($advformcount==null) {
2127             $advformcount = 1;
2128         }
2130         $name = $header->getName();
2132         $id = empty($name) ? '' : ' id="' . $name . '"';
2133         $id = preg_replace(array('/\]/', '/\[/'), array('', '_'), $id);
2134         if (is_null($header->_text)) {
2135             $header_html = '';
2136         } elseif (!empty($name) && isset($this->_templates[$name])) {
2137             $header_html = str_replace('{header}', $header->toHtml(), $this->_templates[$name]);
2138         } else {
2139             $header_html = str_replace('{header}', $header->toHtml(), $this->_headerTemplate);
2140         }
2142         if (isset($this->_advancedElements[$name])){
2143             $header_html =str_replace('{advancedimg}', $this->_advancedHTML, $header_html);
2144         } else {
2145             $header_html =str_replace('{advancedimg}', '', $header_html);
2146         }
2147         $elementName='mform_showadvanced';
2148         if ($this->_showAdvanced==0){
2149             $buttonlabel = get_string('showadvanced', 'form');
2150         } else {
2151             $buttonlabel = get_string('hideadvanced', 'form');
2152         }
2154         if (isset($this->_advancedElements[$name])){
2155             $PAGE->requires->yui_lib('event');
2156             // this is tricky - the first submit button on form is "clicked" if user presses enter
2157             // we do not want to "submit" using advanced button if javascript active
2158             $button_nojs = '<input name="'.$elementName.'" id="'.$elementName.(string)$advformcount.'" class="showadvancedbtn" value="'.$buttonlabel.'" type="submit" />';
2160             $buttonlabel = addslashes_js($buttonlabel);
2161             $PAGE->requires->string_for_js('showadvanced', 'form');
2162             $PAGE->requires->string_for_js('hideadvanced', 'form');
2163             $PAGE->requires->js_function_call('showAdvancedInit', Array($elementName.(string)$advformcount, $elementName, $buttonlabel));
2164             
2165             $advformcount++;
2166             $header_html = str_replace('{button}', $button_nojs, $header_html);
2167         } else {
2168             $header_html = str_replace('{button}', '', $header_html);
2169         }
2171         if ($this->_fieldsetsOpen > 0) {
2172             $this->_html .= $this->_closeFieldsetTemplate;
2173             $this->_fieldsetsOpen--;
2174         }
2176         $openFieldsetTemplate = str_replace('{id}', $id, $this->_openFieldsetTemplate);
2177         if ($this->_showAdvanced){
2178             $advclass = ' class="advanced"';
2179         } else {
2180             $advclass = ' class="advanced hide"';
2181         }
2182         if (isset($this->_advancedElements[$name])){
2183             $openFieldsetTemplate = str_replace('{advancedclass}', $advclass, $openFieldsetTemplate);
2184         } else {
2185             $openFieldsetTemplate = str_replace('{advancedclass}', '', $openFieldsetTemplate);
2186         }
2187         $this->_html .= $openFieldsetTemplate . $header_html;
2188         $this->_fieldsetsOpen++;
2189     } // end func renderHeader
2191     function getStopFieldsetElements(){
2192         return $this->_stopFieldsetElements;
2193     }
2196 /**
2197  * @global object $GLOBALS['_HTML_QuickForm_default_renderer']
2198  * @name $_HTML_QuickForm_default_renderer
2199  */
2200 $GLOBALS['_HTML_QuickForm_default_renderer'] = new MoodleQuickForm_Renderer();
2202 /** Please keep this list in alphabetical order. */
2203 MoodleQuickForm::registerElementType('advcheckbox', "$CFG->libdir/form/advcheckbox.php", 'MoodleQuickForm_advcheckbox');
2204 MoodleQuickForm::registerElementType('button', "$CFG->libdir/form/button.php", 'MoodleQuickForm_button');
2205 MoodleQuickForm::registerElementType('cancel', "$CFG->libdir/form/cancel.php", 'MoodleQuickForm_cancel');
2206 MoodleQuickForm::registerElementType('checkbox', "$CFG->libdir/form/checkbox.php", 'MoodleQuickForm_checkbox');
2207 MoodleQuickForm::registerElementType('choosecoursefile', "$CFG->libdir/form/choosecoursefile.php", 'MoodleQuickForm_choosecoursefile');
2208 MoodleQuickForm::registerElementType('choosecoursefileorimsrepo', "$CFG->libdir/form/choosecoursefileorimsrepo.php", 'MoodleQuickForm_choosecoursefileorimsrepo');
2209 MoodleQuickForm::registerElementType('date_selector', "$CFG->libdir/form/dateselector.php", 'MoodleQuickForm_date_selector');
2210 MoodleQuickForm::registerElementType('date_time_selector', "$CFG->libdir/form/datetimeselector.php", 'MoodleQuickForm_date_time_selector');
2211 MoodleQuickForm::registerElementType('duration', "$CFG->libdir/form/duration.php", 'MoodleQuickForm_duration');
2212 MoodleQuickForm::registerElementType('editor', "$CFG->libdir/form/editor.php", 'MoodleQuickForm_editor');
2213 MoodleQuickForm::registerElementType('file', "$CFG->libdir/form/file.php", 'MoodleQuickForm_file');
2214 MoodleQuickForm::registerElementType('filemanager', "$CFG->libdir/form/filemanager.php", 'MoodleQuickForm_filemanager');
2215 MoodleQuickForm::registerElementType('filepicker', "$CFG->libdir/form/filepicker.php", 'MoodleQuickForm_filepicker');
2216 MoodleQuickForm::registerElementType('format', "$CFG->libdir/form/format.php", 'MoodleQuickForm_format');
2217 MoodleQuickForm::registerElementType('group', "$CFG->libdir/form/group.php", 'MoodleQuickForm_group');
2218 MoodleQuickForm::registerElementType('header', "$CFG->libdir/form/header.php", 'MoodleQuickForm_header');
2219 MoodleQuickForm::registerElementType('hidden', "$CFG->libdir/form/hidden.php", 'MoodleQuickForm_hidden');
2220 MoodleQuickForm::registerElementType('htmleditor', "$CFG->libdir/form/htmleditor.php", 'MoodleQuickForm_htmleditor');
2221 MoodleQuickForm::registerElementType('modgrade', "$CFG->libdir/form/modgrade.php", 'MoodleQuickForm_modgrade');
2222 MoodleQuickForm::registerElementType('modvisible', "$CFG->libdir/form/modvisible.php", 'MoodleQuickForm_modvisible');
2223 MoodleQuickForm::registerElementType('password', "$CFG->libdir/form/password.php", 'MoodleQuickForm_password');
2224 MoodleQuickForm::registerElementType('passwordunmask', "$CFG->libdir/form/passwordunmask.php", 'MoodleQuickForm_passwordunmask');
2225 MoodleQuickForm::registerElementType('questioncategory', "$CFG->libdir/form/questioncategory.php", 'MoodleQuickForm_questioncategory');
2226 MoodleQuickForm::registerElementType('radio', "$CFG->libdir/form/radio.php", 'MoodleQuickForm_radio');
2227 MoodleQuickForm::registerElementType('recaptcha', "$CFG->libdir/form/recaptcha.php", 'MoodleQuickForm_recaptcha');
2228 MoodleQuickForm::registerElementType('select', "$CFG->libdir/form/select.php", 'MoodleQuickForm_select');
2229 MoodleQuickForm::registerElementType('selectgroups', "$CFG->libdir/form/selectgroups.php", 'MoodleQuickForm_selectgroups');
2230 MoodleQuickForm::registerElementType('selectwithlink', "$CFG->libdir/form/selectwithlink.php", 'MoodleQuickForm_selectwithlink');
2231 MoodleQuickForm::registerElementType('selectyesno', "$CFG->libdir/form/selectyesno.php", 'MoodleQuickForm_selectyesno');
2232 MoodleQuickForm::registerElementType('static', "$CFG->libdir/form/static.php", 'MoodleQuickForm_static');
2233 MoodleQuickForm::registerElementType('submit', "$CFG->libdir/form/submit.php", 'MoodleQuickForm_submit');
2234 MoodleQuickForm::registerElementType('submitlink', "$CFG->libdir/form/submitlink.php", 'MoodleQuickForm_submitlink');
2235 MoodleQuickForm::registerElementType('tags', "$CFG->libdir/form/tags.php", 'MoodleQuickForm_tags');
2236 MoodleQuickForm::registerElementType('text', "$CFG->libdir/form/text.php", 'MoodleQuickForm_text');
2237 MoodleQuickForm::registerElementType('textarea', "$CFG->libdir/form/textarea.php", 'MoodleQuickForm_textarea');
2238 MoodleQuickForm::registerElementType('warning', "$CFG->libdir/form/warning.php", 'MoodleQuickForm_warning');
2239 ?>