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