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