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