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