[Summary view]

Differences Between: [Versions 310 and 403] [Versions 311 and 403] [Versions 39 and 403] [Versions 400 and 403] [Versions 401 and 403] [Versions 402 and 403]

   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/>.
  16  
  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   */
  37  
  38  defined('MOODLE_INTERNAL') || die();
  39  
  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';
  45  
  46  require_once $CFG->libdir.'/filelib.php';
  47  
  48  /**
  49   * EDITOR_UNLIMITED_FILES - hard-coded value for the 'maxfiles' option
  50   */
  51  define('EDITOR_UNLIMITED_FILES', -1);
  52  
  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  }
  63  
  64  if ($CFG->debugdeveloper) {
  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  }
  69  
  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          $done = true;
  81          $calendar = \core_calendar\type_factory::get_calendar_instance();
  82          if ($calendar->get_name() !== 'gregorian') {
  83              // The YUI2 calendar only supports the gregorian calendar type.
  84              return;
  85          }
  86          $module   = 'moodle-form-dateselector';
  87          $function = 'M.form.dateselector.init_date_selectors';
  88          $defaulttimezone = date_default_timezone_get();
  89  
  90          $config = array(array(
  91              'firstdayofweek'    => $calendar->get_starting_weekday(),
  92              'mon'               => date_format_string(strtotime("Monday"), '%a', $defaulttimezone),
  93              'tue'               => date_format_string(strtotime("Tuesday"), '%a', $defaulttimezone),
  94              'wed'               => date_format_string(strtotime("Wednesday"), '%a', $defaulttimezone),
  95              'thu'               => date_format_string(strtotime("Thursday"), '%a', $defaulttimezone),
  96              'fri'               => date_format_string(strtotime("Friday"), '%a', $defaulttimezone),
  97              'sat'               => date_format_string(strtotime("Saturday"), '%a', $defaulttimezone),
  98              'sun'               => date_format_string(strtotime("Sunday"), '%a', $defaulttimezone),
  99              'january'           => date_format_string(strtotime("January 1"), '%B', $defaulttimezone),
 100              'february'          => date_format_string(strtotime("February 1"), '%B', $defaulttimezone),
 101              'march'             => date_format_string(strtotime("March 1"), '%B', $defaulttimezone),
 102              'april'             => date_format_string(strtotime("April 1"), '%B', $defaulttimezone),
 103              'may'               => date_format_string(strtotime("May 1"), '%B', $defaulttimezone),
 104              'june'              => date_format_string(strtotime("June 1"), '%B', $defaulttimezone),
 105              'july'              => date_format_string(strtotime("July 1"), '%B', $defaulttimezone),
 106              'august'            => date_format_string(strtotime("August 1"), '%B', $defaulttimezone),
 107              'september'         => date_format_string(strtotime("September 1"), '%B', $defaulttimezone),
 108              'october'           => date_format_string(strtotime("October 1"), '%B', $defaulttimezone),
 109              'november'          => date_format_string(strtotime("November 1"), '%B', $defaulttimezone),
 110              'december'          => date_format_string(strtotime("December 1"), '%B', $defaulttimezone)
 111          ));
 112          $PAGE->requires->yui_module($module, $function, $config);
 113      }
 114  }
 115  
 116  /**
 117   * Wrapper that separates quickforms syntax from moodle code
 118   *
 119   * Moodle specific wrapper that separates quickforms syntax from moodle code. You won't directly
 120   * use this class you should write a class definition which extends this class or a more specific
 121   * subclass such a moodleform_mod for each form you want to display and/or process with formslib.
 122   *
 123   * You will write your own definition() method which performs the form set up.
 124   *
 125   * @package   core_form
 126   * @copyright 2006 Jamie Pratt <me@jamiep.org>
 127   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 128   * @todo      MDL-19380 rethink the file scanning
 129   */
 130  abstract class moodleform {
 131      /** @var string name of the form */
 132      protected $_formname;       // form name
 133  
 134      /** @var MoodleQuickForm quickform object definition */
 135      protected $_form;
 136  
 137      /** @var mixed globals workaround */
 138      protected $_customdata;
 139  
 140      /** @var array submitted form data when using mforms with ajax */
 141      protected $_ajaxformdata;
 142  
 143      /** @var object definition_after_data executed flag */
 144      protected $_definition_finalized = false;
 145  
 146      /** @var bool|null stores the validation result of this form or null if not yet validated */
 147      protected $_validated = null;
 148  
 149      /** @var int Unique identifier to be used for action buttons. */
 150      static protected $uniqueid = 0;
 151  
 152      /**
 153       * The constructor function calls the abstract function definition() and it will then
 154       * process and clean and attempt to validate incoming data.
 155       *
 156       * It will call your custom validate method to validate data and will also check any rules
 157       * you have specified in definition using addRule
 158       *
 159       * The name of the form (id attribute of the form) is automatically generated depending on
 160       * the name you gave the class extending moodleform. You should call your class something
 161       * like
 162       *
 163       * @param mixed $action the action attribute for the form. If empty defaults to auto detect the
 164       *              current url. If a moodle_url object then outputs params as hidden variables.
 165       * @param mixed $customdata if your form defintion method needs access to data such as $course
 166       *              $cm, etc. to construct the form definition then pass it in this array. You can
 167       *              use globals for somethings.
 168       * @param string $method if you set this to anything other than 'post' then _GET and _POST will
 169       *               be merged and used as incoming data to the form.
 170       * @param string $target target frame for form submission. You will rarely use this. Don't use
 171       *               it if you don't need to as the target attribute is deprecated in xhtml strict.
 172       * @param mixed $attributes you can pass a string of html attributes here or an array.
 173       *               Special attribute 'data-random-ids' will randomise generated elements ids. This
 174       *               is necessary when there are several forms on the same page.
 175       *               Special attribute 'data-double-submit-protection' set to 'off' will turn off
 176       *               double-submit protection JavaScript - this may be necessary if your form sends
 177       *               downloadable files in response to a submit button, and can't call
 178       *               \core_form\util::form_download_complete();
 179       * @param bool $editable
 180       * @param array $ajaxformdata Forms submitted via ajax, must pass their data here, instead of relying on _GET and _POST.
 181       */
 182      public function __construct($action=null, $customdata=null, $method='post', $target='', $attributes=null, $editable=true,
 183                                  $ajaxformdata=null) {
 184          global $CFG, $FULLME;
 185          // no standard mform in moodle should allow autocomplete with the exception of user signup
 186          if (empty($attributes)) {
 187              $attributes = array('autocomplete'=>'off');
 188          } else if (is_array($attributes)) {
 189              $attributes['autocomplete'] = 'off';
 190          } else {
 191              if (strpos($attributes, 'autocomplete') === false) {
 192                  $attributes .= ' autocomplete="off" ';
 193              }
 194          }
 195  
 196  
 197          if (empty($action)){
 198              // do not rely on PAGE->url here because dev often do not setup $actualurl properly in admin_externalpage_setup()
 199              $action = strip_querystring($FULLME);
 200              if (!empty($CFG->sslproxy)) {
 201                  // return only https links when using SSL proxy
 202                  $action = preg_replace('/^http:/', 'https:', $action, 1);
 203              }
 204              //TODO: use following instead of FULLME - see MDL-33015
 205              //$action = strip_querystring(qualified_me());
 206          }
 207          // Assign custom data first, so that get_form_identifier can use it.
 208          $this->_customdata = $customdata;
 209          $this->_formname = $this->get_form_identifier();
 210          $this->_ajaxformdata = $ajaxformdata;
 211  
 212          $this->_form = new MoodleQuickForm($this->_formname, $method, $action, $target, $attributes, $ajaxformdata);
 213          if (!$editable){
 214              $this->_form->hardFreeze();
 215          }
 216  
 217          $this->definition();
 218  
 219          $this->_form->addElement('hidden', 'sesskey', null); // automatic sesskey protection
 220          $this->_form->setType('sesskey', PARAM_RAW);
 221          $this->_form->setDefault('sesskey', sesskey());
 222          $this->_form->addElement('hidden', '_qf__'.$this->_formname, null);   // form submission marker
 223          $this->_form->setType('_qf__'.$this->_formname, PARAM_RAW);
 224          $this->_form->setDefault('_qf__'.$this->_formname, 1);
 225          $this->_form->_setDefaultRuleMessages();
 226  
 227          // Hook to inject logic after the definition was provided.
 228          $this->after_definition();
 229  
 230          // we have to know all input types before processing submission ;-)
 231          $this->_process_submission($method);
 232      }
 233  
 234      /**
 235       * Old syntax of class constructor. Deprecated in PHP7.
 236       *
 237       * @deprecated since Moodle 3.1
 238       */
 239      public function moodleform($action=null, $customdata=null, $method='post', $target='', $attributes=null, $editable=true) {
 240          debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);
 241          self::__construct($action, $customdata, $method, $target, $attributes, $editable);
 242      }
 243  
 244      /**
 245       * It should returns unique identifier for the form.
 246       * Currently it will return class name, but in case two same forms have to be
 247       * rendered on same page then override function to get unique form identifier.
 248       * e.g This is used on multiple self enrollments page.
 249       *
 250       * @return string form identifier.
 251       */
 252      protected function get_form_identifier() {
 253          $class = get_class($this);
 254  
 255          return preg_replace('/[^a-z0-9_]/i', '_', $class);
 256      }
 257  
 258      /**
 259       * To autofocus on first form element or first element with error.
 260       *
 261       * @param string $name if this is set then the focus is forced to a field with this name
 262       * @return string javascript to select form element with first error or
 263       *                first element if no errors. Use this as a parameter
 264       *                when calling print_header
 265       */
 266      function focus($name=NULL) {
 267          $form =& $this->_form;
 268          $elkeys = array_keys($form->_elementIndex);
 269          $error = false;
 270          if (isset($form->_errors) &&  0 != count($form->_errors)){
 271              $errorkeys = array_keys($form->_errors);
 272              $elkeys = array_intersect($elkeys, $errorkeys);
 273              $error = true;
 274          }
 275  
 276          if ($error or empty($name)) {
 277              $names = array();
 278              while (empty($names) and !empty($elkeys)) {
 279                  $el = array_shift($elkeys);
 280                  $names = $form->_getElNamesRecursive($el);
 281              }
 282              if (!empty($names)) {
 283                  $name = array_shift($names);
 284              }
 285          }
 286  
 287          $focus = '';
 288          if (!empty($name)) {
 289              $focus = 'forms[\''.$form->getAttribute('id').'\'].elements[\''.$name.'\']';
 290          }
 291  
 292          return $focus;
 293       }
 294  
 295      /**
 296       * Internal method. Alters submitted data to be suitable for quickforms processing.
 297       * Must be called when the form is fully set up.
 298       *
 299       * @param string $method name of the method which alters submitted data
 300       */
 301      function _process_submission($method) {
 302          $submission = array();
 303          if (!empty($this->_ajaxformdata)) {
 304              $submission = $this->_ajaxformdata;
 305          } else if ($method == 'post') {
 306              if (!empty($_POST)) {
 307                  $submission = $_POST;
 308              }
 309          } else {
 310              $submission = $_GET;
 311              merge_query_params($submission, $_POST); // Emulate handling of parameters in xxxx_param().
 312          }
 313  
 314          // following trick is needed to enable proper sesskey checks when using GET forms
 315          // the _qf__.$this->_formname serves as a marker that form was actually submitted
 316          if (array_key_exists('_qf__'.$this->_formname, $submission) and $submission['_qf__'.$this->_formname] == 1) {
 317              if (!confirm_sesskey()) {
 318                  throw new \moodle_exception('invalidsesskey');
 319              }
 320              $files = $_FILES;
 321          } else {
 322              $submission = array();
 323              $files = array();
 324          }
 325          $this->detectMissingSetType();
 326  
 327          $this->_form->updateSubmission($submission, $files);
 328      }
 329  
 330      /**
 331       * Internal method - should not be used anywhere.
 332       * @deprecated since 2.6
 333       * @return array $_POST.
 334       */
 335      protected function _get_post_params() {
 336          return $_POST;
 337      }
 338  
 339      /**
 340       * Internal method. Validates all old-style deprecated uploaded files.
 341       * The new way is to upload files via repository api.
 342       *
 343       * @param array $files list of files to be validated
 344       * @return bool|array Success or an array of errors
 345       */
 346      function _validate_files(&$files) {
 347          global $CFG, $COURSE;
 348  
 349          $files = array();
 350  
 351          if (empty($_FILES)) {
 352              // we do not need to do any checks because no files were submitted
 353              // note: server side rules do not work for files - use custom verification in validate() instead
 354              return true;
 355          }
 356  
 357          $errors = array();
 358          $filenames = array();
 359  
 360          // now check that we really want each file
 361          foreach ($_FILES as $elname=>$file) {
 362              $required = $this->_form->isElementRequired($elname);
 363  
 364              if ($file['error'] == 4 and $file['size'] == 0) {
 365                  if ($required) {
 366                      $errors[$elname] = get_string('required');
 367                  }
 368                  unset($_FILES[$elname]);
 369                  continue;
 370              }
 371  
 372              if (!empty($file['error'])) {
 373                  $errors[$elname] = file_get_upload_error($file['error']);
 374                  unset($_FILES[$elname]);
 375                  continue;
 376              }
 377  
 378              if (!is_uploaded_file($file['tmp_name'])) {
 379                  // TODO: improve error message
 380                  $errors[$elname] = get_string('error');
 381                  unset($_FILES[$elname]);
 382                  continue;
 383              }
 384  
 385              if (!$this->_form->elementExists($elname) or !$this->_form->getElementType($elname)=='file') {
 386                  // hmm, this file was not requested
 387                  unset($_FILES[$elname]);
 388                  continue;
 389              }
 390  
 391              // NOTE: the viruses are scanned in file picker, no need to deal with them here.
 392  
 393              $filename = clean_param($_FILES[$elname]['name'], PARAM_FILE);
 394              if ($filename === '') {
 395                  // TODO: improve error message - wrong chars
 396                  $errors[$elname] = get_string('error');
 397                  unset($_FILES[$elname]);
 398                  continue;
 399              }
 400              if (in_array($filename, $filenames)) {
 401                  // TODO: improve error message - duplicate name
 402                  $errors[$elname] = get_string('error');
 403                  unset($_FILES[$elname]);
 404                  continue;
 405              }
 406              $filenames[] = $filename;
 407              $_FILES[$elname]['name'] = $filename;
 408  
 409              $files[$elname] = $_FILES[$elname]['tmp_name'];
 410          }
 411  
 412          // return errors if found
 413          if (count($errors) == 0){
 414              return true;
 415  
 416          } else {
 417              $files = array();
 418              return $errors;
 419          }
 420      }
 421  
 422      /**
 423       * Internal method. Validates filepicker and filemanager files if they are
 424       * set as required fields. Also, sets the error message if encountered one.
 425       *
 426       * @return bool|array with errors
 427       */
 428      protected function validate_draft_files() {
 429          global $USER;
 430          $mform =& $this->_form;
 431  
 432          $errors = array();
 433          //Go through all the required elements and make sure you hit filepicker or
 434          //filemanager element.
 435          foreach ($mform->_rules as $elementname => $rules) {
 436              $elementtype = $mform->getElementType($elementname);
 437              //If element is of type filepicker then do validation
 438              if (($elementtype == 'filepicker') || ($elementtype == 'filemanager')){
 439                  //Check if rule defined is required rule
 440                  foreach ($rules as $rule) {
 441                      if ($rule['type'] == 'required') {
 442                          $draftid = (int)$mform->getSubmitValue($elementname);
 443                          $fs = get_file_storage();
 444                          $context = context_user::instance($USER->id);
 445                          if (!$files = $fs->get_area_files($context->id, 'user', 'draft', $draftid, 'id DESC', false)) {
 446                              $errors[$elementname] = $rule['message'];
 447                          }
 448                      }
 449                  }
 450              }
 451          }
 452          // Check all the filemanager elements to make sure they do not have too many
 453          // files in them.
 454          foreach ($mform->_elements as $element) {
 455              if ($element->_type == 'filemanager') {
 456                  $maxfiles = $element->getMaxfiles();
 457                  if ($maxfiles > 0) {
 458                      $draftid = (int)$element->getValue();
 459                      $fs = get_file_storage();
 460                      $context = context_user::instance($USER->id);
 461                      $files = $fs->get_area_files($context->id, 'user', 'draft', $draftid, '', false);
 462                      if (count($files) > $maxfiles) {
 463                          $errors[$element->getName()] = get_string('err_maxfiles', 'form', $maxfiles);
 464                      }
 465                  }
 466              }
 467          }
 468          if (empty($errors)) {
 469              return true;
 470          } else {
 471              return $errors;
 472          }
 473      }
 474  
 475      /**
 476       * Load in existing data as form defaults. Usually new entry defaults are stored directly in
 477       * form definition (new entry form); this function is used to load in data where values
 478       * already exist and data is being edited (edit entry form).
 479       *
 480       * note: $slashed param removed
 481       *
 482       * @param stdClass|array $default_values object or array of default values
 483       */
 484      function set_data($default_values) {
 485          if (is_object($default_values)) {
 486              $default_values = (array)$default_values;
 487          }
 488          $this->_form->setDefaults($default_values);
 489      }
 490  
 491      /**
 492       * Use this method to indicate that the fieldsets should be shown as expanded
 493       * and all other fieldsets should be hidden.
 494       * The method is applicable to header elements only.
 495       *
 496       * @param array $shownonly array of header element names
 497       * @return void
 498       */
 499      public function filter_shown_headers(array $shownonly): void {
 500          $toshow = [];
 501          foreach ($shownonly as $show) {
 502              if ($this->_form->elementExists($show) && $this->_form->getElementType($show) == 'header') {
 503                  $toshow[] = $show;
 504              }
 505          }
 506          $this->_form->filter_shown_headers($toshow);
 507      }
 508  
 509      /**
 510       * Check that form was submitted. Does not check validity of submitted data.
 511       *
 512       * @return bool true if form properly submitted
 513       */
 514      function is_submitted() {
 515          return $this->_form->isSubmitted();
 516      }
 517  
 518      /**
 519       * Checks if button pressed is not for submitting the form
 520       *
 521       * @staticvar bool $nosubmit keeps track of no submit button
 522       * @return bool
 523       */
 524      function no_submit_button_pressed(){
 525          static $nosubmit = null; // one check is enough
 526          if (!is_null($nosubmit)){
 527              return $nosubmit;
 528          }
 529          $mform =& $this->_form;
 530          $nosubmit = false;
 531          if (!$this->is_submitted()){
 532              return false;
 533          }
 534          foreach ($mform->_noSubmitButtons as $nosubmitbutton){
 535              if ($this->optional_param($nosubmitbutton, 0, PARAM_RAW)) {
 536                  $nosubmit = true;
 537                  break;
 538              }
 539          }
 540          return $nosubmit;
 541      }
 542  
 543      /**
 544       * Returns an element of multi-dimensional array given the list of keys
 545       *
 546       * Example:
 547       * $array['a']['b']['c'] = 13;
 548       * $v = $this->get_array_value_by_keys($array, ['a', 'b', 'c']);
 549       *
 550       * Will result it $v==13
 551       *
 552       * @param array $array
 553       * @param array $keys
 554       * @return mixed returns null if keys not present
 555       */
 556      protected function get_array_value_by_keys(array $array, array $keys) {
 557          $value = $array;
 558          foreach ($keys as $key) {
 559              if (array_key_exists($key, $value)) {
 560                  $value = $value[$key];
 561              } else {
 562                  return null;
 563              }
 564          }
 565          return $value;
 566      }
 567  
 568      /**
 569       * Checks if a parameter was passed in the previous form submission
 570       *
 571       * @param string $name the name of the page parameter we want, for example 'id' or 'element[sub][13]'
 572       * @param mixed  $default the default value to return if nothing is found
 573       * @param string $type expected type of parameter
 574       * @return mixed
 575       */
 576      public function optional_param($name, $default, $type) {
 577          $nameparsed = [];
 578          // Convert element name into a sequence of keys, for example 'element[sub][13]' -> ['element', 'sub', '13'].
 579          parse_str($name . '=1', $nameparsed);
 580          $keys = [];
 581          while (is_array($nameparsed)) {
 582              $key = key($nameparsed);
 583              $keys[] = $key;
 584              $nameparsed = $nameparsed[$key];
 585          }
 586  
 587          // Search for the element first in $this->_ajaxformdata, then in $_POST and then in $_GET.
 588          if (($value = $this->get_array_value_by_keys($this->_ajaxformdata ?? [], $keys)) !== null ||
 589              ($value = $this->get_array_value_by_keys($_POST, $keys)) !== null ||
 590              ($value = $this->get_array_value_by_keys($_GET, $keys)) !== null) {
 591              return $type == PARAM_RAW ? $value : clean_param($value, $type);
 592          }
 593  
 594          return $default;
 595      }
 596  
 597      /**
 598       * Check that form data is valid.
 599       * You should almost always use this, rather than {@link validate_defined_fields}
 600       *
 601       * @return bool true if form data valid
 602       */
 603      function is_validated() {
 604          //finalize the form definition before any processing
 605          if (!$this->_definition_finalized) {
 606              $this->_definition_finalized = true;
 607              $this->definition_after_data();
 608          }
 609  
 610          return $this->validate_defined_fields();
 611      }
 612  
 613      /**
 614       * Validate the form.
 615       *
 616       * You almost always want to call {@link is_validated} instead of this
 617       * because it calls {@link definition_after_data} first, before validating the form,
 618       * which is what you want in 99% of cases.
 619       *
 620       * This is provided as a separate function for those special cases where
 621       * you want the form validated before definition_after_data is called
 622       * for example, to selectively add new elements depending on a no_submit_button press,
 623       * but only when the form is valid when the no_submit_button is pressed,
 624       *
 625       * @param bool $validateonnosubmit optional, defaults to false.  The default behaviour
 626       *             is NOT to validate the form when a no submit button has been pressed.
 627       *             pass true here to override this behaviour
 628       *
 629       * @return bool true if form data valid
 630       */
 631      function validate_defined_fields($validateonnosubmit=false) {
 632          $mform =& $this->_form;
 633          if ($this->no_submit_button_pressed() && empty($validateonnosubmit)){
 634              return false;
 635          } elseif ($this->_validated === null) {
 636              $internal_val = $mform->validate();
 637  
 638              $files = array();
 639              $file_val = $this->_validate_files($files);
 640              //check draft files for validation and flag them if required files
 641              //are not in draft area.
 642              $draftfilevalue = $this->validate_draft_files();
 643  
 644              if ($file_val !== true && $draftfilevalue !== true) {
 645                  $file_val = array_merge($file_val, $draftfilevalue);
 646              } else if ($draftfilevalue !== true) {
 647                  $file_val = $draftfilevalue;
 648              } //default is file_val, so no need to assign.
 649  
 650              if ($file_val !== true) {
 651                  if (!empty($file_val)) {
 652                      foreach ($file_val as $element=>$msg) {
 653                          $mform->setElementError($element, $msg);
 654                      }
 655                  }
 656                  $file_val = false;
 657              }
 658  
 659              // Give the elements a chance to perform an implicit validation.
 660              $element_val = true;
 661              foreach ($mform->_elements as $element) {
 662                  if (method_exists($element, 'validateSubmitValue')) {
 663                      $value = $mform->getSubmitValue($element->getName());
 664                      $result = $element->validateSubmitValue($value);
 665                      if (!empty($result) && is_string($result)) {
 666                          $element_val = false;
 667                          $mform->setElementError($element->getName(), $result);
 668                      }
 669                  }
 670              }
 671  
 672              // Let the form instance validate the submitted values.
 673              $data = $mform->exportValues();
 674              $moodle_val = $this->validation($data, $files);
 675              if ((is_array($moodle_val) && count($moodle_val)!==0)) {
 676                  // non-empty array means errors
 677                  foreach ($moodle_val as $element=>$msg) {
 678                      $mform->setElementError($element, $msg);
 679                  }
 680                  $moodle_val = false;
 681  
 682              } else {
 683                  // anything else means validation ok
 684                  $moodle_val = true;
 685              }
 686  
 687              $this->_validated = ($internal_val and $element_val and $moodle_val and $file_val);
 688          }
 689          return $this->_validated;
 690      }
 691  
 692      /**
 693       * Return true if a cancel button has been pressed resulting in the form being submitted.
 694       *
 695       * @return bool true if a cancel button has been pressed
 696       */
 697      function is_cancelled(){
 698          $mform =& $this->_form;
 699          if ($mform->isSubmitted()){
 700              foreach ($mform->_cancelButtons as $cancelbutton){
 701                  if ($this->optional_param($cancelbutton, 0, PARAM_RAW)) {
 702                      return true;
 703                  }
 704              }
 705          }
 706          return false;
 707      }
 708  
 709      /**
 710       * Return submitted data if properly submitted or returns NULL if validation fails or
 711       * if there is no submitted data.
 712       *
 713       * note: $slashed param removed
 714       *
 715       * @return stdClass|null submitted data; NULL if not valid or not submitted or cancelled
 716       */
 717      function get_data() {
 718          $mform =& $this->_form;
 719  
 720          if (!$this->is_cancelled() and $this->is_submitted() and $this->is_validated()) {
 721              $data = $mform->exportValues();
 722              unset($data['sesskey']); // we do not need to return sesskey
 723              unset($data['_qf__'.$this->_formname]);   // we do not need the submission marker too
 724              if (empty($data)) {
 725                  return NULL;
 726              } else {
 727                  return (object)$data;
 728              }
 729          } else {
 730              return NULL;
 731          }
 732      }
 733  
 734      /**
 735       * Return submitted data without validation or NULL if there is no submitted data.
 736       * note: $slashed param removed
 737       *
 738       * @return stdClass|null submitted data; NULL if not submitted
 739       */
 740      function get_submitted_data() {
 741          $mform =& $this->_form;
 742  
 743          if ($this->is_submitted()) {
 744              $data = $mform->exportValues();
 745              unset($data['sesskey']); // we do not need to return sesskey
 746              unset($data['_qf__'.$this->_formname]);   // we do not need the submission marker too
 747              if (empty($data)) {
 748                  return NULL;
 749              } else {
 750                  return (object)$data;
 751              }
 752          } else {
 753              return NULL;
 754          }
 755      }
 756  
 757      /**
 758       * Save verified uploaded files into directory. Upload process can be customised from definition()
 759       *
 760       * @deprecated since Moodle 2.0
 761       * @todo MDL-31294 remove this api
 762       * @see moodleform::save_stored_file()
 763       * @see moodleform::save_file()
 764       * @param string $destination path where file should be stored
 765       * @return bool Always false
 766       */
 767      function save_files($destination) {
 768          debugging('Not used anymore, please fix code! Use save_stored_file() or save_file() instead');
 769          return false;
 770      }
 771  
 772      /**
 773       * Returns name of uploaded file.
 774       *
 775       * @param string $elname first element if null
 776       * @return string|bool false in case of failure, string if ok
 777       */
 778      function get_new_filename($elname=null) {
 779          global $USER;
 780  
 781          if (!$this->is_submitted() or !$this->is_validated()) {
 782              return false;
 783          }
 784  
 785          if (is_null($elname)) {
 786              if (empty($_FILES)) {
 787                  return false;
 788              }
 789              reset($_FILES);
 790              $elname = key($_FILES);
 791          }
 792  
 793          if (empty($elname)) {
 794              return false;
 795          }
 796  
 797          $element = $this->_form->getElement($elname);
 798  
 799          if ($element instanceof MoodleQuickForm_filepicker || $element instanceof MoodleQuickForm_filemanager) {
 800              $values = $this->_form->exportValues($elname);
 801              if (empty($values[$elname])) {
 802                  return false;
 803              }
 804              $draftid = $values[$elname];
 805              $fs = get_file_storage();
 806              $context = context_user::instance($USER->id);
 807              if (!$files = $fs->get_area_files($context->id, 'user', 'draft', $draftid, 'id DESC', false)) {
 808                  return false;
 809              }
 810              $file = reset($files);
 811              return $file->get_filename();
 812          }
 813  
 814          if (!isset($_FILES[$elname])) {
 815              return false;
 816          }
 817  
 818          return $_FILES[$elname]['name'];
 819      }
 820  
 821      /**
 822       * Save file to standard filesystem
 823       *
 824       * @param string $elname name of element
 825       * @param string $pathname full path name of file
 826       * @param bool $override override file if exists
 827       * @return bool success
 828       */
 829      function save_file($elname, $pathname, $override=false) {
 830          global $USER;
 831  
 832          if (!$this->is_submitted() or !$this->is_validated()) {
 833              return false;
 834          }
 835          if (file_exists($pathname)) {
 836              if ($override) {
 837                  if (!@unlink($pathname)) {
 838                      return false;
 839                  }
 840              } else {
 841                  return false;
 842              }
 843          }
 844  
 845          $element = $this->_form->getElement($elname);
 846  
 847          if ($element instanceof MoodleQuickForm_filepicker || $element instanceof MoodleQuickForm_filemanager) {
 848              $values = $this->_form->exportValues($elname);
 849              if (empty($values[$elname])) {
 850                  return false;
 851              }
 852              $draftid = $values[$elname];
 853              $fs = get_file_storage();
 854              $context = context_user::instance($USER->id);
 855              if (!$files = $fs->get_area_files($context->id, 'user', 'draft', $draftid, 'id DESC', false)) {
 856                  return false;
 857              }
 858              $file = reset($files);
 859  
 860              return $file->copy_content_to($pathname);
 861  
 862          } else if (isset($_FILES[$elname])) {
 863              return copy($_FILES[$elname]['tmp_name'], $pathname);
 864          }
 865  
 866          return false;
 867      }
 868  
 869      /**
 870       * Returns a temporary file, do not forget to delete after not needed any more.
 871       *
 872       * @param string $elname name of the elmenet
 873       * @return string|bool either string or false
 874       */
 875      function save_temp_file($elname) {
 876          if (!$this->get_new_filename($elname)) {
 877              return false;
 878          }
 879          if (!$dir = make_temp_directory('forms')) {
 880              return false;
 881          }
 882          if (!$tempfile = tempnam($dir, 'tempup_')) {
 883              return false;
 884          }
 885          if (!$this->save_file($elname, $tempfile, true)) {
 886              // something went wrong
 887              @unlink($tempfile);
 888              return false;
 889          }
 890  
 891          return $tempfile;
 892      }
 893  
 894      /**
 895       * Get draft files of a form element
 896       * This is a protected method which will be used only inside moodleforms
 897       *
 898       * @param string $elname name of element
 899       * @return array|bool|null
 900       */
 901      protected function get_draft_files($elname) {
 902          global $USER;
 903  
 904          if (!$this->is_submitted()) {
 905              return false;
 906          }
 907  
 908          $element = $this->_form->getElement($elname);
 909  
 910          if ($element instanceof MoodleQuickForm_filepicker || $element instanceof MoodleQuickForm_filemanager) {
 911              $values = $this->_form->exportValues($elname);
 912              if (empty($values[$elname])) {
 913                  return false;
 914              }
 915              $draftid = $values[$elname];
 916              $fs = get_file_storage();
 917              $context = context_user::instance($USER->id);
 918              if (!$files = $fs->get_area_files($context->id, 'user', 'draft', $draftid, 'id DESC', false)) {
 919                  return null;
 920              }
 921              return $files;
 922          }
 923          return null;
 924      }
 925  
 926      /**
 927       * Save file to local filesystem pool
 928       *
 929       * @param string $elname name of element
 930       * @param int $newcontextid id of context
 931       * @param string $newcomponent name of the component
 932       * @param string $newfilearea name of file area
 933       * @param int $newitemid item id
 934       * @param string $newfilepath path of file where it get stored
 935       * @param string $newfilename use specified filename, if not specified name of uploaded file used
 936       * @param bool $overwrite overwrite file if exists
 937       * @param int $newuserid new userid if required
 938       * @return mixed stored_file object or false if error; may throw exception if duplicate found
 939       */
 940      function save_stored_file($elname, $newcontextid, $newcomponent, $newfilearea, $newitemid, $newfilepath='/',
 941                                $newfilename=null, $overwrite=false, $newuserid=null) {
 942          global $USER;
 943  
 944          if (!$this->is_submitted() or !$this->is_validated()) {
 945              return false;
 946          }
 947  
 948          if (empty($newuserid)) {
 949              $newuserid = $USER->id;
 950          }
 951  
 952          $element = $this->_form->getElement($elname);
 953          $fs = get_file_storage();
 954  
 955          if ($element instanceof MoodleQuickForm_filepicker) {
 956              $values = $this->_form->exportValues($elname);
 957              if (empty($values[$elname])) {
 958                  return false;
 959              }
 960              $draftid = $values[$elname];
 961              $context = context_user::instance($USER->id);
 962              if (!$files = $fs->get_area_files($context->id, 'user' ,'draft', $draftid, 'id DESC', false)) {
 963                  return false;
 964              }
 965              $file = reset($files);
 966              if (is_null($newfilename)) {
 967                  $newfilename = $file->get_filename();
 968              }
 969  
 970              if ($overwrite) {
 971                  if ($oldfile = $fs->get_file($newcontextid, $newcomponent, $newfilearea, $newitemid, $newfilepath, $newfilename)) {
 972                      if (!$oldfile->delete()) {
 973                          return false;
 974                      }
 975                  }
 976              }
 977  
 978              $file_record = array('contextid'=>$newcontextid, 'component'=>$newcomponent, 'filearea'=>$newfilearea, 'itemid'=>$newitemid,
 979                                   'filepath'=>$newfilepath, 'filename'=>$newfilename, 'userid'=>$newuserid);
 980              return $fs->create_file_from_storedfile($file_record, $file);
 981  
 982          } else if (isset($_FILES[$elname])) {
 983              $filename = is_null($newfilename) ? $_FILES[$elname]['name'] : $newfilename;
 984  
 985              if ($overwrite) {
 986                  if ($oldfile = $fs->get_file($newcontextid, $newcomponent, $newfilearea, $newitemid, $newfilepath, $newfilename)) {
 987                      if (!$oldfile->delete()) {
 988                          return false;
 989                      }
 990                  }
 991              }
 992  
 993              $file_record = array('contextid'=>$newcontextid, 'component'=>$newcomponent, 'filearea'=>$newfilearea, 'itemid'=>$newitemid,
 994                                   'filepath'=>$newfilepath, 'filename'=>$newfilename, 'userid'=>$newuserid);
 995              return $fs->create_file_from_pathname($file_record, $_FILES[$elname]['tmp_name']);
 996          }
 997  
 998          return false;
 999      }
1000  
1001      /**
1002       * Get content of uploaded file.
1003       *
1004       * @param string $elname name of file upload element
1005       * @return string|bool false in case of failure, string if ok
1006       */
1007      function get_file_content($elname) {
1008          global $USER;
1009  
1010          if (!$this->is_submitted() or !$this->is_validated()) {
1011              return false;
1012          }
1013  
1014          $element = $this->_form->getElement($elname);
1015  
1016          if ($element instanceof MoodleQuickForm_filepicker || $element instanceof MoodleQuickForm_filemanager) {
1017              $values = $this->_form->exportValues($elname);
1018              if (empty($values[$elname])) {
1019                  return false;
1020              }
1021              $draftid = $values[$elname];
1022              $fs = get_file_storage();
1023              $context = context_user::instance($USER->id);
1024              if (!$files = $fs->get_area_files($context->id, 'user', 'draft', $draftid, 'id DESC', false)) {
1025                  return false;
1026              }
1027              $file = reset($files);
1028  
1029              return $file->get_content();
1030  
1031          } else if (isset($_FILES[$elname])) {
1032              return file_get_contents($_FILES[$elname]['tmp_name']);
1033          }
1034  
1035          return false;
1036      }
1037  
1038      /**
1039       * Print html form.
1040       */
1041      function display() {
1042          //finalize the form definition if not yet done
1043          if (!$this->_definition_finalized) {
1044              $this->_definition_finalized = true;
1045              $this->definition_after_data();
1046          }
1047  
1048          $this->_form->display();
1049      }
1050  
1051      /**
1052       * Renders the html form (same as display, but returns the result).
1053       *
1054       * Note that you can only output this rendered result once per page, as
1055       * it contains IDs which must be unique.
1056       *
1057       * @return string HTML code for the form
1058       */
1059      public function render() {
1060          ob_start();
1061          $this->display();
1062          $out = ob_get_contents();
1063          ob_end_clean();
1064          return $out;
1065      }
1066  
1067      /**
1068       * Form definition. Abstract method - always override!
1069       */
1070      protected abstract function definition();
1071  
1072      /**
1073       * After definition hook.
1074       *
1075       * This is useful for intermediate classes to inject logic after the definition was
1076       * provided without requiring developers to call the parent {{@link self::definition()}}
1077       * as it's not obvious by design. The 'intermediate' class is 'MyClass extends
1078       * IntermediateClass extends moodleform'.
1079       *
1080       * Classes overriding this method should always call the parent. We may not add
1081       * anything specifically in this instance of the method, but intermediate classes
1082       * are likely to do so, and so it is a good practice to always call the parent.
1083       *
1084       * @return void
1085       */
1086      protected function after_definition() {
1087      }
1088  
1089      /**
1090       * Dummy stub method - override if you need to setup the form depending on current
1091       * values. This method is called after definition(), data submission and set_data().
1092       * All form setup that is dependent on form values should go in here.
1093       */
1094      function definition_after_data(){
1095      }
1096  
1097      /**
1098       * Dummy stub method - override if you needed to perform some extra validation.
1099       * If there are errors return array of errors ("fieldname"=>"error message"),
1100       * otherwise true if ok.
1101       *
1102       * Server side rules do not work for uploaded files, implement serverside rules here if needed.
1103       *
1104       * @param array $data array of ("fieldname"=>value) of submitted data
1105       * @param array $files array of uploaded files "element_name"=>tmp_file_path
1106       * @return array of "element_name"=>"error_description" if there are errors,
1107       *         or an empty array if everything is OK (true allowed for backwards compatibility too).
1108       */
1109      function validation($data, $files) {
1110          return array();
1111      }
1112  
1113      /**
1114       * Helper used by {@link repeat_elements()}.
1115       *
1116       * @param int $i the index of this element.
1117       * @param HTML_QuickForm_element $elementclone
1118       * @param array $namecloned array of names
1119       */
1120      function repeat_elements_fix_clone($i, $elementclone, &$namecloned) {
1121          $name = $elementclone->getName();
1122          $namecloned[] = $name;
1123  
1124          if (!empty($name)) {
1125              $elementclone->setName($name."[$i]");
1126          }
1127  
1128          if (is_a($elementclone, 'HTML_QuickForm_header')) {
1129              $value = $elementclone->_text;
1130              $elementclone->setValue(str_replace('{no}', ($i+1), $value));
1131  
1132          } else if (is_a($elementclone, 'HTML_QuickForm_submit') || is_a($elementclone, 'HTML_QuickForm_button')) {
1133              $elementclone->setValue(str_replace('{no}', ($i+1), $elementclone->getValue()));
1134  
1135          } else {
1136              $value=$elementclone->getLabel();
1137              $elementclone->setLabel(str_replace('{no}', ($i+1), $value));
1138          }
1139      }
1140  
1141      /**
1142       * Method to add a repeating group of elements to a form.
1143       *
1144       * @param array $elementobjs Array of elements or groups of elements that are to be repeated
1145       * @param int $repeats no of times to repeat elements initially
1146       * @param array $options a nested array. The first array key is the element name.
1147       *    the second array key is the type of option to set, and depend on that option,
1148       *    the value takes different forms.
1149       *         'default'    - default value to set. Can include '{no}' which is replaced by the repeat number.
1150       *         'type'       - PARAM_* type.
1151       *         'helpbutton' - array containing the helpbutton params.
1152       *         'disabledif' - array containing the disabledIf() arguments after the element name.
1153       *         'rule'       - array containing the addRule arguments after the element name.
1154       *         'expanded'   - whether this section of the form should be expanded by default. (Name be a header element.)
1155       *         'advanced'   - whether this element is hidden by 'Show more ...'.
1156       * @param string $repeathiddenname name for hidden element storing no of repeats in this form
1157       * @param string $addfieldsname name for button to add more fields
1158       * @param int $addfieldsno how many fields to add at a time
1159       * @param string $addstring name of button, {no} is replaced by no of blanks that will be added.
1160       * @param bool $addbuttoninside if true, don't call closeHeaderBefore($addfieldsname). Default false.
1161       * @param string $deletebuttonname if specified, treats the no-submit button with this name as a "delete element" button
1162       *         in each of the elements
1163       * @return int no of repeats of element in this page
1164       */
1165      public function repeat_elements($elementobjs, $repeats, $options, $repeathiddenname,
1166                                      $addfieldsname, $addfieldsno = 5, $addstring = null, $addbuttoninside = false,
1167                                      $deletebuttonname = '') {
1168          if ($addstring === null) {
1169              $addstring = get_string('addfields', 'form', $addfieldsno);
1170          } else {
1171              $addstring = str_ireplace('{no}', $addfieldsno, $addstring);
1172          }
1173          $repeats = $this->optional_param($repeathiddenname, $repeats, PARAM_INT);
1174          $addfields = $this->optional_param($addfieldsname, '', PARAM_TEXT);
1175          $oldrepeats = $repeats;
1176          if (!empty($addfields)){
1177              $repeats += $addfieldsno;
1178          }
1179          $mform =& $this->_form;
1180          $mform->registerNoSubmitButton($addfieldsname);
1181          $mform->addElement('hidden', $repeathiddenname, $repeats);
1182          $mform->setType($repeathiddenname, PARAM_INT);
1183          //value not to be overridden by submitted value
1184          $mform->setConstants(array($repeathiddenname=>$repeats));
1185          $namecloned = array();
1186          $no = 1;
1187          for ($i = 0; $i < $repeats; $i++) {
1188              if ($deletebuttonname) {
1189                  $mform->registerNoSubmitButton($deletebuttonname . "[$i]");
1190                  $isdeleted = $this->optional_param($deletebuttonname . "[$i]", false, PARAM_RAW) ||
1191                      $this->optional_param($deletebuttonname . "-hidden[$i]", false, PARAM_RAW);
1192                  if ($isdeleted) {
1193                      $mform->addElement('hidden', $deletebuttonname . "-hidden[$i]", 1);
1194                      $mform->setType($deletebuttonname . "-hidden[$i]", PARAM_INT);
1195                      continue;
1196                  }
1197              }
1198              foreach ($elementobjs as $elementobj){
1199                  $elementclone = fullclone($elementobj);
1200                  $this->repeat_elements_fix_clone($i, $elementclone, $namecloned);
1201  
1202                  if ($elementclone instanceof HTML_QuickForm_group && !$elementclone->_appendName) {
1203                      foreach ($elementclone->getElements() as $el) {
1204                          $this->repeat_elements_fix_clone($i, $el, $namecloned);
1205                      }
1206                      $elementclone->setLabel(str_replace('{no}', $no, $elementclone->getLabel()));
1207                  } else if ($elementobj instanceof \HTML_QuickForm_submit && $elementobj->getName() == $deletebuttonname) {
1208                      // Mark the "Delete" button as no-submit.
1209                      $onclick = $elementclone->getAttribute('onclick');
1210                      $skip = 'skipClientValidation = true;';
1211                      $onclick = ($onclick !== null) ? $skip . ' ' . $onclick : $skip;
1212                      $elementclone->updateAttributes(['data-skip-validation' => 1, 'data-no-submit' => 1, 'onclick' => $onclick]);
1213                  }
1214  
1215                  // Mark newly created elements, so they know not to look for any submitted data.
1216                  if ($i >= $oldrepeats) {
1217                      $mform->note_new_repeat($elementclone->getName());
1218                  }
1219  
1220                  $mform->addElement($elementclone);
1221                  $no++;
1222              }
1223          }
1224          for ($i=0; $i<$repeats; $i++) {
1225              foreach ($options as $elementname => $elementoptions){
1226                  $pos=strpos($elementname, '[');
1227                  if ($pos!==FALSE){
1228                      $realelementname = substr($elementname, 0, $pos)."[$i]";
1229                      $realelementname .= substr($elementname, $pos);
1230                  }else {
1231                      $realelementname = $elementname."[$i]";
1232                  }
1233                  foreach ($elementoptions as  $option => $params){
1234  
1235                      switch ($option){
1236                          case 'default' :
1237                              $mform->setDefault($realelementname, str_replace('{no}', $i + 1, $params));
1238                              break;
1239                          case 'helpbutton' :
1240                              $params = array_merge(array($realelementname), $params);
1241                              call_user_func_array(array(&$mform, 'addHelpButton'), $params);
1242                              break;
1243                          case 'disabledif' :
1244                          case 'hideif' :
1245                              $pos = strpos($params[0], '[');
1246                              $ending = '';
1247                              if ($pos !== false) {
1248                                  $ending = substr($params[0], $pos);
1249                                  $params[0] = substr($params[0], 0, $pos);
1250                              }
1251                              foreach ($namecloned as $num => $name){
1252                                  if ($params[0] == $name){
1253                                      $params[0] = $params[0] . "[$i]" . $ending;
1254                                      break;
1255                                  }
1256                              }
1257                              $params = array_merge(array($realelementname), $params);
1258                              $function = ($option === 'disabledif') ? 'disabledIf' : 'hideIf';
1259                              call_user_func_array(array(&$mform, $function), $params);
1260                              break;
1261                          case 'rule' :
1262                              if (is_string($params)){
1263                                  $params = array(null, $params, null, 'client');
1264                              }
1265                              $params = array_merge(array($realelementname), $params);
1266                              call_user_func_array(array(&$mform, 'addRule'), $params);
1267                              break;
1268  
1269                          case 'type':
1270                              $mform->setType($realelementname, $params);
1271                              break;
1272  
1273                          case 'expanded':
1274                              $mform->setExpanded($realelementname, $params);
1275                              break;
1276  
1277                          case 'advanced' :
1278                              $mform->setAdvanced($realelementname, $params);
1279                              break;
1280                      }
1281                  }
1282              }
1283          }
1284          $mform->addElement('submit', $addfieldsname, $addstring, [], false);
1285  
1286          if (!$addbuttoninside) {
1287              $mform->closeHeaderBefore($addfieldsname);
1288          }
1289  
1290          return $repeats;
1291      }
1292  
1293      /**
1294       * Adds a link/button that controls the checked state of a group of checkboxes.
1295       *
1296       * @param int $groupid The id of the group of advcheckboxes this element controls
1297       * @param string $text The text of the link. Defaults to selectallornone ("select all/none")
1298       * @param array $attributes associative array of HTML attributes
1299       * @param int $originalValue The original general state of the checkboxes before the user first clicks this element
1300       */
1301      function add_checkbox_controller($groupid, $text = null, $attributes = null, $originalValue = 0) {
1302          global $CFG, $PAGE;
1303  
1304          // Name of the controller button
1305          $checkboxcontrollername = 'nosubmit_checkbox_controller' . $groupid;
1306          $checkboxcontrollerparam = 'checkbox_controller'. $groupid;
1307          $checkboxgroupclass = 'checkboxgroup'.$groupid;
1308  
1309          // Set the default text if none was specified
1310          if (empty($text)) {
1311              $text = get_string('selectallornone', 'form');
1312          }
1313  
1314          $mform = $this->_form;
1315          $selectvalue = $this->optional_param($checkboxcontrollerparam, null, PARAM_INT);
1316          $contollerbutton = $this->optional_param($checkboxcontrollername, null, PARAM_ALPHAEXT);
1317  
1318          $newselectvalue = $selectvalue;
1319          if (is_null($selectvalue)) {
1320              $newselectvalue = $originalValue;
1321          } else if (!is_null($contollerbutton)) {
1322              $newselectvalue = (int) !$selectvalue;
1323          }
1324          // set checkbox state depending on orignal/submitted value by controoler button
1325          if (!is_null($contollerbutton) || is_null($selectvalue)) {
1326              foreach ($mform->_elements as $element) {
1327                  if (($element instanceof MoodleQuickForm_advcheckbox) &&
1328                          $element->getAttribute('class') == $checkboxgroupclass &&
1329                          !$element->isFrozen()) {
1330                      $mform->setConstants(array($element->getName() => $newselectvalue));
1331                  }
1332              }
1333          }
1334  
1335          $mform->addElement('hidden', $checkboxcontrollerparam, $newselectvalue, array('id' => "id_".$checkboxcontrollerparam));
1336          $mform->setType($checkboxcontrollerparam, PARAM_INT);
1337          $mform->setConstants(array($checkboxcontrollerparam => $newselectvalue));
1338  
1339          $PAGE->requires->yui_module('moodle-form-checkboxcontroller', 'M.form.checkboxcontroller',
1340                  array(
1341                      array('groupid' => $groupid,
1342                          'checkboxclass' => $checkboxgroupclass,
1343                          'checkboxcontroller' => $checkboxcontrollerparam,
1344                          'controllerbutton' => $checkboxcontrollername)
1345                      )
1346                  );
1347  
1348          require_once("$CFG->libdir/form/submit.php");
1349          $submitlink = new MoodleQuickForm_submit($checkboxcontrollername, $attributes);
1350          $mform->addElement($submitlink);
1351          $mform->registerNoSubmitButton($checkboxcontrollername);
1352          $mform->setDefault($checkboxcontrollername, $text);
1353      }
1354  
1355      /**
1356       * Use this method to a cancel and submit button to the end of your form. Pass a param of false
1357       * if you don't want a cancel button in your form. If you have a cancel button make sure you
1358       * check for it being pressed using is_cancelled() and redirecting if it is true before trying to
1359       * get data with get_data().
1360       *
1361       * @param bool $cancel whether to show cancel button, default true
1362       * @param string $submitlabel label for submit button, defaults to get_string('savechanges')
1363       */
1364      public function add_action_buttons($cancel = true, $submitlabel = null) {
1365          if (is_null($submitlabel)) {
1366              $submitlabel = get_string('savechanges');
1367          }
1368          $mform = $this->_form;
1369          // Only use uniqueid if the form defines it needs to be used.
1370          $forceuniqueid = false;
1371          if (is_array($this->_customdata)) {
1372              $forceuniqueid = $this->_customdata['forceuniqueid'] ?? false;
1373          }
1374          // Keep the first action button as submitbutton (without uniqueid) because single forms pages expect this to happen.
1375          $submitbuttonname = $forceuniqueid && $this::$uniqueid > 0 ? 'submitbutton_' . $this::$uniqueid : 'submitbutton';
1376          if ($cancel) {
1377              // When two elements we need a group.
1378              $buttonarray = [
1379                  $mform->createElement('submit', $submitbuttonname, $submitlabel),
1380                  $mform->createElement('cancel'),
1381              ];
1382              $buttonarname = $forceuniqueid && $this::$uniqueid > 0 ? 'buttonar_' . $this::$uniqueid : 'buttonar';
1383              $mform->addGroup($buttonarray, $buttonarname, '', [' '], false);
1384              $mform->closeHeaderBefore('buttonar');
1385          } else {
1386              // No group needed.
1387              $mform->addElement('submit', $submitbuttonname, $submitlabel);
1388              $mform->closeHeaderBefore('submitbutton');
1389          }
1390  
1391          // Increase the uniqueid so that we can have multiple forms with different ids for the action buttons on the same page.
1392          if ($forceuniqueid) {
1393              $this::$uniqueid++;
1394          }
1395      }
1396  
1397      /**
1398       * Use this method to make a sticky submit/cancel button at the end of your form.
1399       *
1400       * @param bool $cancel whether to show cancel button, default true
1401       * @param string|null $submitlabel label for submit button, defaults to get_string('savechanges')
1402       */
1403      public function add_sticky_action_buttons(bool $cancel = true, ?string $submitlabel = null): void {
1404          $this->add_action_buttons($cancel, $submitlabel);
1405          if ($cancel) {
1406              $this->_form->set_sticky_footer('buttonar');
1407          } else {
1408              $this->_form->set_sticky_footer('submitbutton');
1409          }
1410      }
1411  
1412      /**
1413       * Adds an initialisation call for a standard JavaScript enhancement.
1414       *
1415       * This function is designed to add an initialisation call for a JavaScript
1416       * enhancement that should exist within javascript-static M.form.init_{enhancementname}.
1417       *
1418       * Current options:
1419       *  - Selectboxes
1420       *      - smartselect:  Turns a nbsp indented select box into a custom drop down
1421       *                      control that supports multilevel and category selection.
1422       *                      $enhancement = 'smartselect';
1423       *                      $options = array('selectablecategories' => true|false)
1424       *
1425       * @param string|element $element form element for which Javascript needs to be initalized
1426       * @param string $enhancement which init function should be called
1427       * @param array $options options passed to javascript
1428       * @param array $strings strings for javascript
1429       * @deprecated since Moodle 3.3 MDL-57471
1430       */
1431      function init_javascript_enhancement($element, $enhancement, array $options=array(), array $strings=null) {
1432          debugging('$mform->init_javascript_enhancement() is deprecated and no longer does anything. '.
1433              'smartselect uses should be converted to the searchableselector form element.', DEBUG_DEVELOPER);
1434      }
1435  
1436      /**
1437       * Returns a JS module definition for the mforms JS
1438       *
1439       * @return array
1440       */
1441      public static function get_js_module() {
1442          global $CFG;
1443          return array(
1444              'name' => 'mform',
1445              'fullpath' => '/lib/form/form.js',
1446              'requires' => array('base', 'node')
1447          );
1448      }
1449  
1450      /**
1451       * Detects elements with missing setType() declerations.
1452       *
1453       * Finds elements in the form which should a PARAM_ type set and throws a
1454       * developer debug warning for any elements without it. This is to reduce the
1455       * risk of potential security issues by developers mistakenly forgetting to set
1456       * the type.
1457       *
1458       * @return void
1459       */
1460      private function detectMissingSetType() {
1461          global $CFG;
1462  
1463          if (!$CFG->debugdeveloper) {
1464              // Only for devs.
1465              return;
1466          }
1467  
1468          $mform = $this->_form;
1469          foreach ($mform->_elements as $element) {
1470              $group = false;
1471              $elements = array($element);
1472  
1473              if ($element->getType() == 'group') {
1474                  $group = $element;
1475                  $elements = $element->getElements();
1476              }
1477  
1478              foreach ($elements as $index => $element) {
1479                  switch ($element->getType()) {
1480                      case 'hidden':
1481                      case 'text':
1482                      case 'url':
1483                          if ($group) {
1484                              $name = $group->getElementName($index);
1485                          } else {
1486                              $name = $element->getName();
1487                          }
1488                          $key = $name;
1489                          $found = array_key_exists($key, $mform->_types);
1490                          // For repeated elements we need to look for
1491                          // the "main" type, not for the one present
1492                          // on each repetition. All the stuff in formslib
1493                          // (repeat_elements(), updateSubmission()... seems
1494                          // to work that way.
1495                          while (!$found && strrpos($key, '[') !== false) {
1496                              $pos = strrpos($key, '[');
1497                              $key = substr($key, 0, $pos);
1498                              $found = array_key_exists($key, $mform->_types);
1499                          }
1500                          if (!$found) {
1501                              debugging("Did you remember to call setType() for '$name'? ".
1502                                  'Defaulting to PARAM_RAW cleaning.', DEBUG_DEVELOPER);
1503                          }
1504                          break;
1505                  }
1506              }
1507          }
1508      }
1509  
1510      /**
1511       * Used by tests to simulate submitted form data submission from the user.
1512       *
1513       * For form fields where no data is submitted the default for that field as set by set_data or setDefault will be passed to
1514       * get_data.
1515       *
1516       * This method sets $_POST or $_GET and $_FILES with the data supplied. Our unit test code empties all these
1517       * global arrays after each test.
1518       *
1519       * @param array  $simulatedsubmitteddata       An associative array of form values (same format as $_POST).
1520       * @param array  $simulatedsubmittedfiles      An associative array of files uploaded (same format as $_FILES). Can be omitted.
1521       * @param string $method                       'post' or 'get', defaults to 'post'.
1522       * @param null   $formidentifier               the default is to use the class name for this class but you may need to provide
1523       *                                              a different value here for some forms that are used more than once on the
1524       *                                              same page.
1525       */
1526      public static function mock_submit($simulatedsubmitteddata, $simulatedsubmittedfiles = array(), $method = 'post',
1527                                         $formidentifier = null) {
1528          $_FILES = $simulatedsubmittedfiles;
1529          if ($formidentifier === null) {
1530              $formidentifier = get_called_class();
1531              $formidentifier = str_replace('\\', '_', $formidentifier); // See MDL-56233 for more information.
1532          }
1533          $simulatedsubmitteddata['_qf__'.$formidentifier] = 1;
1534          $simulatedsubmitteddata['sesskey'] = sesskey();
1535          if (strtolower($method) === 'get') {
1536              $_GET = $simulatedsubmitteddata;
1537          } else {
1538              $_POST = $simulatedsubmitteddata;
1539          }
1540      }
1541  
1542      /**
1543       * Used by tests to simulate submitted form data submission via AJAX.
1544       *
1545       * For form fields where no data is submitted the default for that field as set by set_data or setDefault will be passed to
1546       * get_data.
1547       *
1548       * This method sets $_POST or $_GET and $_FILES with the data supplied. Our unit test code empties all these
1549       * global arrays after each test.
1550       *
1551       * @param array  $simulatedsubmitteddata       An associative array of form values (same format as $_POST).
1552       * @param array  $simulatedsubmittedfiles      An associative array of files uploaded (same format as $_FILES). Can be omitted.
1553       * @param string $method                       'post' or 'get', defaults to 'post'.
1554       * @param null   $formidentifier               the default is to use the class name for this class but you may need to provide
1555       *                                              a different value here for some forms that are used more than once on the
1556       *                                              same page.
1557       * @return array array to pass to form constructor as $ajaxdata
1558       */
1559      public static function mock_ajax_submit($simulatedsubmitteddata, $simulatedsubmittedfiles = array(), $method = 'post',
1560                                              $formidentifier = null) {
1561          $_FILES = $simulatedsubmittedfiles;
1562          if ($formidentifier === null) {
1563              $formidentifier = get_called_class();
1564              $formidentifier = str_replace('\\', '_', $formidentifier); // See MDL-56233 for more information.
1565          }
1566          $simulatedsubmitteddata['_qf__'.$formidentifier] = 1;
1567          $simulatedsubmitteddata['sesskey'] = sesskey();
1568          if (strtolower($method) === 'get') {
1569              $_GET = ['sesskey' => sesskey()];
1570          } else {
1571              $_POST = ['sesskey' => sesskey()];
1572          }
1573          return $simulatedsubmitteddata;
1574      }
1575  
1576      /**
1577       * Used by tests to generate valid submit keys for moodle forms that are
1578       * submitted with ajax data.
1579       *
1580       * @throws \moodle_exception If called outside unit test environment
1581       * @param array  $data Existing form data you wish to add the keys to.
1582       * @return array
1583       */
1584      public static function mock_generate_submit_keys($data = []) {
1585          if (!defined('PHPUNIT_TEST') || !PHPUNIT_TEST) {
1586              throw new \moodle_exception("This function can only be used for unit testing.");
1587          }
1588  
1589          $formidentifier = get_called_class();
1590          $formidentifier = str_replace('\\', '_', $formidentifier); // See MDL-56233 for more information.
1591          $data['sesskey'] = sesskey();
1592          $data['_qf__' . $formidentifier] = 1;
1593  
1594          return $data;
1595      }
1596  
1597      /**
1598       * Set display mode for the form when labels take full width of the form and above the elements even on big screens
1599       *
1600       * Useful for forms displayed inside modals or in narrow containers
1601       */
1602      public function set_display_vertical() {
1603          $oldclass = $this->_form->getAttribute('class');
1604          $this->_form->updateAttributes(array('class' => $oldclass . ' full-width-labels'));
1605      }
1606  
1607      /**
1608       * Set the initial 'dirty' state of the form.
1609       *
1610       * @param bool $state
1611       * @since Moodle 3.7.1
1612       */
1613      public function set_initial_dirty_state($state = false) {
1614          $this->_form->set_initial_dirty_state($state);
1615      }
1616  }
1617  
1618  /**
1619   * MoodleQuickForm implementation
1620   *
1621   * You never extend this class directly. The class methods of this class are available from
1622   * the private $this->_form property on moodleform and its children. You generally only
1623   * call methods on this class from within abstract methods that you override on moodleform such
1624   * as definition and definition_after_data
1625   *
1626   * @package   core_form
1627   * @category  form
1628   * @copyright 2006 Jamie Pratt <me@jamiep.org>
1629   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1630   */
1631  class MoodleQuickForm extends HTML_QuickForm_DHTMLRulesTableless {
1632      /** @var array type (PARAM_INT, PARAM_TEXT etc) of element value */
1633      var $_types = array();
1634  
1635      /** @var array dependent state for the element/'s */
1636      var $_dependencies = array();
1637  
1638      /**
1639       * @var array elements that will become hidden based on another element
1640       */
1641      protected $_hideifs = array();
1642  
1643      /** @var array Array of buttons that if pressed do not result in the processing of the form. */
1644      var $_noSubmitButtons=array();
1645  
1646      /** @var array Array of buttons that if pressed do not result in the processing of the form. */
1647      var $_cancelButtons=array();
1648  
1649      /** @var array Array whose keys are element names. If the key exists this is a advanced element */
1650      var $_advancedElements = array();
1651  
1652      /**
1653       * The form element to render in the sticky footer, if any.
1654       * @var string|null $_stickyfooterelement
1655       */
1656      protected $_stickyfooterelement = null;
1657  
1658      /**
1659       * Array whose keys are element names and values are the desired collapsible state.
1660       * True for collapsed, False for expanded. If not present, set to default in
1661       * {@link self::accept()}.
1662       *
1663       * @var array
1664       */
1665      var $_collapsibleElements = array();
1666  
1667      /**
1668       * Whether to enable shortforms for this form
1669       *
1670       * @var boolean
1671       */
1672      var $_disableShortforms = false;
1673  
1674      /**
1675       * Array whose keys are the only elements to be shown.
1676       * Rest of the elements that are not in this array will be hidden.
1677       *
1678       * @var array
1679       */
1680      protected $_shownonlyelements = [];
1681  
1682      /** @var bool whether to automatically initialise the form change detector this form. */
1683      protected $_use_form_change_checker = true;
1684  
1685      /**
1686       * The initial state of the dirty state.
1687       *
1688       * @var bool
1689       */
1690      protected $_initial_form_dirty_state = false;
1691  
1692      /**
1693       * The form name is derived from the class name of the wrapper minus the trailing form
1694       * It is a name with words joined by underscores whereas the id attribute is words joined by underscores.
1695       * @var string
1696       */
1697      var $_formName = '';
1698  
1699      /**
1700       * String with the html for hidden params passed in as part of a moodle_url
1701       * object for the action. Output in the form.
1702       * @var string
1703       */
1704      var $_pageparams = '';
1705  
1706      /** @var array names of new repeating elements that should not expect to find submitted data */
1707      protected $_newrepeats = array();
1708  
1709      /** @var array $_ajaxformdata submitted form data when using mforms with ajax */
1710      protected $_ajaxformdata;
1711  
1712      /**
1713       * Whether the form contains any client-side validation or not.
1714       * @var bool
1715       */
1716      protected $clientvalidation = false;
1717  
1718      /**
1719       * Is this a 'disableIf' dependency ?
1720       */
1721      const DEP_DISABLE = 0;
1722  
1723      /**
1724       * Is this a 'hideIf' dependency?
1725       */
1726      const DEP_HIDE = 1;
1727  
1728      /** @var string request class HTML. */
1729      protected $_reqHTML;
1730  
1731      /** @var string advanced class HTML. */
1732      protected $_advancedHTML;
1733  
1734      /**
1735       * Class constructor - same parameters as HTML_QuickForm_DHTMLRulesTableless
1736       *
1737       * @staticvar int $formcounter counts number of forms
1738       * @param string $formName Form's name.
1739       * @param string $method Form's method defaults to 'POST'
1740       * @param string|moodle_url $action Form's action
1741       * @param string $target (optional)Form's target defaults to none
1742       * @param mixed $attributes (optional)Extra attributes for <form> tag
1743       * @param array $ajaxformdata Forms submitted via ajax, must pass their data here, instead of relying on _GET and _POST.
1744       */
1745      public function __construct($formName, $method, $action, $target = '', $attributes = null, $ajaxformdata = null) {
1746          global $CFG, $OUTPUT;
1747  
1748          static $formcounter = 1;
1749  
1750          // TODO MDL-52313 Replace with the call to parent::__construct().
1751          HTML_Common::__construct($attributes);
1752          $target = empty($target) ? array() : array('target' => $target);
1753          $this->_formName = $formName;
1754          if (is_a($action, 'moodle_url')){
1755              $this->_pageparams = html_writer::input_hidden_params($action);
1756              $action = $action->out_omit_querystring();
1757          } else {
1758              $this->_pageparams = '';
1759          }
1760          // No 'name' atttribute for form in xhtml strict :
1761          $attributes = array('action' => $action, 'method' => $method, 'accept-charset' => 'utf-8') + $target;
1762          if (is_null($this->getAttribute('id'))) {
1763              // Append a random id, forms can be loaded in different requests using Fragments API.
1764              $attributes['id'] = 'mform' . $formcounter . '_' . random_string();
1765          }
1766          $formcounter++;
1767          $this->updateAttributes($attributes);
1768  
1769          // This is custom stuff for Moodle :
1770          $this->_ajaxformdata = $ajaxformdata;
1771          $oldclass=   $this->getAttribute('class');
1772          if (!empty($oldclass)){
1773              $this->updateAttributes(array('class'=>$oldclass.' mform'));
1774          }else {
1775              $this->updateAttributes(array('class'=>'mform'));
1776          }
1777          $this->_reqHTML = '<span class="req">' . $OUTPUT->pix_icon('req', get_string('requiredelement', 'form')) . '</span>';
1778          $this->_advancedHTML = '<span class="adv">' . $OUTPUT->pix_icon('adv', get_string('advancedelement', 'form')) . '</span>';
1779          $this->setRequiredNote(get_string('somefieldsrequired', 'form', $OUTPUT->pix_icon('req', get_string('requiredelement', 'form'))));
1780      }
1781  
1782      /**
1783       * Old syntax of class constructor. Deprecated in PHP7.
1784       *
1785       * @deprecated since Moodle 3.1
1786       */
1787      public function MoodleQuickForm($formName, $method, $action, $target='', $attributes=null) {
1788          debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);
1789          self::__construct($formName, $method, $action, $target, $attributes);
1790      }
1791  
1792      /**
1793       * Use this method to indicate an element in a form is an advanced field. If items in a form
1794       * are marked as advanced then 'Hide/Show Advanced' buttons will automatically be displayed in the
1795       * form so the user can decide whether to display advanced form controls.
1796       *
1797       * If you set a header element to advanced then all elements it contains will also be set as advanced.
1798       *
1799       * @param string $elementName group or element name (not the element name of something inside a group).
1800       * @param bool $advanced default true sets the element to advanced. False removes advanced mark.
1801       */
1802      function setAdvanced($elementName, $advanced = true) {
1803          if ($advanced){
1804              $this->_advancedElements[$elementName]='';
1805          } elseif (isset($this->_advancedElements[$elementName])) {
1806              unset($this->_advancedElements[$elementName]);
1807          }
1808      }
1809  
1810      /**
1811       * Use this method to indicate an element to display as a sticky footer.
1812       *
1813       * Only one page element can be displayed in the sticky footer. To render
1814       * more than one element use addGroup to create a named group.
1815       *
1816       * @param string|null $elementname group or element name (not the element name of something inside a group).
1817       */
1818      public function set_sticky_footer(?string $elementname): void {
1819          $this->_stickyfooterelement = $elementname;
1820      }
1821  
1822      /**
1823       * Checks if a parameter was passed in the previous form submission
1824       *
1825       * @param string $name the name of the page parameter we want
1826       * @param mixed  $default the default value to return if nothing is found
1827       * @param string $type expected type of parameter
1828       * @return mixed
1829       */
1830      public function optional_param($name, $default, $type) {
1831          if (isset($this->_ajaxformdata[$name])) {
1832              return clean_param($this->_ajaxformdata[$name], $type);
1833          } else {
1834              return optional_param($name, $default, $type);
1835          }
1836      }
1837  
1838      /**
1839       * Use this method to indicate that the fieldset should be shown as expanded.
1840       * The method is applicable to header elements only.
1841       *
1842       * @param string $headername header element name
1843       * @param boolean $expanded default true sets the element to expanded. False makes the element collapsed.
1844       * @param boolean $ignoreuserstate override the state regardless of the state it was on when
1845       *                                 the form was submitted.
1846       * @return void
1847       */
1848      function setExpanded($headername, $expanded = true, $ignoreuserstate = false) {
1849          if (empty($headername)) {
1850              return;
1851          }
1852          $element = $this->getElement($headername);
1853          if ($element->getType() != 'header') {
1854              debugging('Cannot use setExpanded on non-header elements', DEBUG_DEVELOPER);
1855              return;
1856          }
1857          if (!$headerid = $element->getAttribute('id')) {
1858              $element->_generateId();
1859              $headerid = $element->getAttribute('id');
1860          }
1861          if ($this->getElementType('mform_isexpanded_' . $headerid) === false) {
1862              // See if the form has been submitted already.
1863              $formexpanded = $this->optional_param('mform_isexpanded_' . $headerid, -1, PARAM_INT);
1864              if (!$ignoreuserstate && $formexpanded != -1) {
1865                  // Override expanded state with the form variable.
1866                  $expanded = $formexpanded;
1867              }
1868              // Create the form element for storing expanded state.
1869              $this->addElement('hidden', 'mform_isexpanded_' . $headerid);
1870              $this->setType('mform_isexpanded_' . $headerid, PARAM_INT);
1871              $this->setConstant('mform_isexpanded_' . $headerid, (int) $expanded);
1872          }
1873          $this->_collapsibleElements[$headername] = !$expanded;
1874      }
1875  
1876      /**
1877       * Use this method to indicate that the fieldsets should be shown and expanded
1878       * and all other fieldsets should be hidden.
1879       * The method is applicable to header elements only.
1880       *
1881       * @param array $shownonly array of header element names
1882       * @return void
1883       */
1884      public function filter_shown_headers(array $shownonly): void {
1885          $this->_shownonlyelements = [];
1886          if (empty($shownonly)) {
1887              return;
1888          }
1889          foreach ($shownonly as $headername) {
1890              $element = $this->getElement($headername);
1891              if ($element->getType() == 'header') {
1892                  $this->_shownonlyelements[] = $headername;
1893                  $this->setExpanded($headername);
1894              }
1895          }
1896      }
1897  
1898      /**
1899       * Use this method to check if the fieldsets could be shown.
1900       * The method is applicable to header elements only.
1901       *
1902       * @param string $headername header element name to check in the shown only elements array.
1903       * @return void
1904       */
1905      public function is_shown(string $headername): bool {
1906          if (empty($headername)) {
1907              return true;
1908          }
1909          if (empty($this->_shownonlyelements)) {
1910              return true;
1911          }
1912          return in_array($headername, $this->_shownonlyelements);
1913      }
1914  
1915      /**
1916       * Use this method to add show more/less status element required for passing
1917       * over the advanced elements visibility status on the form submission.
1918       *
1919       * @param string $headerName header element name.
1920       * @param boolean $showmore default false sets the advanced elements to be hidden.
1921       */
1922      function addAdvancedStatusElement($headerid, $showmore=false){
1923          // Add extra hidden element to store advanced items state for each section.
1924          if ($this->getElementType('mform_showmore_' . $headerid) === false) {
1925              // See if we the form has been submitted already.
1926              $formshowmore = $this->optional_param('mform_showmore_' . $headerid, -1, PARAM_INT);
1927              if (!$showmore && $formshowmore != -1) {
1928                  // Override showmore state with the form variable.
1929                  $showmore = $formshowmore;
1930              }
1931              // Create the form element for storing advanced items state.
1932              $this->addElement('hidden', 'mform_showmore_' . $headerid);
1933              $this->setType('mform_showmore_' . $headerid, PARAM_INT);
1934              $this->setConstant('mform_showmore_' . $headerid, (int)$showmore);
1935          }
1936      }
1937  
1938      /**
1939       * This function has been deprecated. Show advanced has been replaced by
1940       * "Show more.../Show less..." in the shortforms javascript module.
1941       *
1942       * @deprecated since Moodle 2.5
1943       * @param bool $showadvancedNow if true will show advanced elements.
1944        */
1945      function setShowAdvanced($showadvancedNow = null){
1946          debugging('Call to deprecated function setShowAdvanced. See "Show more.../Show less..." in shortforms yui module.');
1947      }
1948  
1949      /**
1950       * This function has been deprecated. Show advanced has been replaced by
1951       * "Show more.../Show less..." in the shortforms javascript module.
1952       *
1953       * @deprecated since Moodle 2.5
1954       * @return bool (Always false)
1955        */
1956      function getShowAdvanced(){
1957          debugging('Call to deprecated function setShowAdvanced. See "Show more.../Show less..." in shortforms yui module.');
1958          return false;
1959      }
1960  
1961      /**
1962       * Use this method to indicate that the form will not be using shortforms.
1963       *
1964       * @param boolean $disable default true, controls if the shortforms are disabled.
1965       */
1966      function setDisableShortforms ($disable = true) {
1967          $this->_disableShortforms = $disable;
1968      }
1969  
1970      /**
1971       * Set the initial 'dirty' state of the form.
1972       *
1973       * @param bool $state
1974       * @since Moodle 3.7.1
1975       */
1976      public function set_initial_dirty_state($state = false) {
1977          $this->_initial_form_dirty_state = $state;
1978      }
1979  
1980      /**
1981       * Is the form currently set to dirty?
1982       *
1983       * @return boolean Initial dirty state.
1984       * @since Moodle 3.7.1
1985       */
1986      public function is_dirty() {
1987          return $this->_initial_form_dirty_state;
1988      }
1989  
1990      /**
1991       * Call this method if you don't want the formchangechecker JavaScript to be
1992       * automatically initialised for this form.
1993       */
1994      public function disable_form_change_checker() {
1995          $this->_use_form_change_checker = false;
1996      }
1997  
1998      /**
1999       * If you have called {@link disable_form_change_checker()} then you can use
2000       * this method to re-enable it. It is enabled by default, so normally you don't
2001       * need to call this.
2002       */
2003      public function enable_form_change_checker() {
2004          $this->_use_form_change_checker = true;
2005      }
2006  
2007      /**
2008       * @return bool whether this form should automatically initialise
2009       *      formchangechecker for itself.
2010       */
2011      public function is_form_change_checker_enabled() {
2012          return $this->_use_form_change_checker;
2013      }
2014  
2015      /**
2016      * Accepts a renderer
2017      *
2018      * @param HTML_QuickForm_Renderer $renderer An HTML_QuickForm_Renderer object
2019      */
2020      function accept(&$renderer) {
2021          if (method_exists($renderer, 'setAdvancedElements')){
2022              //Check for visible fieldsets where all elements are advanced
2023              //and mark these headers as advanced as well.
2024              //Also mark all elements in a advanced header as advanced.
2025              $stopFields = $renderer->getStopFieldSetElements();
2026              $lastHeader = null;
2027              $lastHeaderAdvanced = false;
2028              $anyAdvanced = false;
2029              $anyError = false;
2030              foreach (array_keys($this->_elements) as $elementIndex){
2031                  $element =& $this->_elements[$elementIndex];
2032  
2033                  // if closing header and any contained element was advanced then mark it as advanced
2034                  if ($element->getType()=='header' || in_array($element->getName(), $stopFields)){
2035                      if ($anyAdvanced && !is_null($lastHeader)) {
2036                          $lastHeader->_generateId();
2037                          $this->setAdvanced($lastHeader->getName());
2038                          $this->addAdvancedStatusElement($lastHeader->getAttribute('id'), $anyError);
2039                      }
2040                      $lastHeaderAdvanced = false;
2041                      unset($lastHeader);
2042                      $lastHeader = null;
2043                  } elseif ($lastHeaderAdvanced) {
2044                      $this->setAdvanced($element->getName());
2045                  }
2046  
2047                  if ($element->getType()=='header'){
2048                      $lastHeader =& $element;
2049                      $anyAdvanced = false;
2050                      $anyError = false;
2051                      $lastHeaderAdvanced = isset($this->_advancedElements[$element->getName()]);
2052                  } elseif (isset($this->_advancedElements[$element->getName()])){
2053                      $anyAdvanced = true;
2054                      if (isset($this->_errors[$element->getName()])) {
2055                          $anyError = true;
2056                      }
2057                  }
2058              }
2059              // the last header may not be closed yet...
2060              if ($anyAdvanced && !is_null($lastHeader)){
2061                  $this->setAdvanced($lastHeader->getName());
2062                  $lastHeader->_generateId();
2063                  $this->addAdvancedStatusElement($lastHeader->getAttribute('id'), $anyError);
2064              }
2065              $renderer->setAdvancedElements($this->_advancedElements);
2066          }
2067          if (method_exists($renderer, 'setCollapsibleElements') && !$this->_disableShortforms) {
2068  
2069              // Count the number of sections.
2070              $headerscount = 0;
2071              foreach (array_keys($this->_elements) as $elementIndex){
2072                  $element =& $this->_elements[$elementIndex];
2073                  if ($element->getType() == 'header') {
2074                      $headerscount++;
2075                  }
2076              }
2077  
2078              $anyrequiredorerror = false;
2079              $headercounter = 0;
2080              $headername = null;
2081              foreach (array_keys($this->_elements) as $elementIndex){
2082                  $element =& $this->_elements[$elementIndex];
2083  
2084                  if ($element->getType() == 'header') {
2085                      $headercounter++;
2086                      $element->_generateId();
2087                      $headername = $element->getName();
2088                      $anyrequiredorerror = false;
2089                  } else if (in_array($element->getName(), $this->_required) || isset($this->_errors[$element->getName()])) {
2090                      $anyrequiredorerror = true;
2091                  } else {
2092                      // Do not reset $anyrequiredorerror to false because we do not want any other element
2093                      // in this header (fieldset) to possibly revert the state given.
2094                  }
2095  
2096                  if ($element->getType() == 'header') {
2097                      if (!$this->is_shown($headername)) {
2098                          $this->setExpanded($headername, false);
2099                          continue;
2100                      }
2101                      if ($headercounter === 1 && !isset($this->_collapsibleElements[$headername])) {
2102                          // By default the first section is always expanded, except if a state has already been set.
2103                          $this->setExpanded($headername, true);
2104                      } else if (
2105                          ($headercounter === 2 && $headerscount === 2)
2106                          && !isset($this->_collapsibleElements[$headername])
2107                      ) {
2108                          // The second section is always expanded if the form only contains 2 sections),
2109                          // except if a state has already been set.
2110                          $this->setExpanded($headername, true);
2111                      }
2112                  } else if ($anyrequiredorerror && (empty($headername) || $this->is_shown($headername))) {
2113                      // If any error or required field are present within the header, we need to expand it.
2114                      $this->setExpanded($headername, true, true);
2115                  } else if (!isset($this->_collapsibleElements[$headername])) {
2116                      // Define element as collapsed by default.
2117                      $this->setExpanded($headername, false);
2118                  }
2119              }
2120  
2121              // Pass the array to renderer object.
2122              $renderer->setCollapsibleElements($this->_collapsibleElements);
2123          }
2124  
2125          $this->accept_set_nonvisible_elements($renderer);
2126  
2127          if (method_exists($renderer, 'set_sticky_footer') && !empty($this->_stickyfooterelement)) {
2128              $renderer->set_sticky_footer($this->_stickyfooterelement);
2129          }
2130          parent::accept($renderer);
2131      }
2132  
2133      /**
2134       * Checking non-visible elements to set when accepting a renderer.
2135       * @param HTML_QuickForm_Renderer $renderer
2136       */
2137      private function accept_set_nonvisible_elements($renderer) {
2138          if (!method_exists($renderer, 'set_nonvisible_elements') || $this->_disableShortforms) {
2139              return;
2140          }
2141          $nonvisibles = [];
2142          foreach (array_keys($this->_elements) as $index) {
2143              $element =& $this->_elements[$index];
2144              if ($element->getType() != 'header') {
2145                  continue;
2146              }
2147              $headername = $element->getName();
2148              if (!$this->is_shown($headername)) {
2149                  $nonvisibles[] = $headername;
2150              }
2151          }
2152          // Pass the array to renderer object.
2153          $renderer->set_nonvisible_elements($nonvisibles);
2154      }
2155  
2156      /**
2157       * Adds one or more element names that indicate the end of a fieldset
2158       *
2159       * @param string $elementName name of the element
2160       */
2161      function closeHeaderBefore($elementName){
2162          $renderer =& $this->defaultRenderer();
2163          $renderer->addStopFieldsetElements($elementName);
2164      }
2165  
2166      /**
2167       * Set an element to be forced to flow LTR.
2168       *
2169       * The element must exist and support this functionality. Also note that
2170       * when setting the type of a field (@link self::setType} we try to guess the
2171       * whether the field should be force to LTR or not. Make sure you're always
2172       * calling this method last.
2173       *
2174       * @param string $elementname The element name.
2175       * @param bool $value When false, disables force LTR, else enables it.
2176       */
2177      public function setForceLtr($elementname, $value = true) {
2178          $this->getElement($elementname)->set_force_ltr($value);
2179      }
2180  
2181      /**
2182       * Should be used for all elements of a form except for select, radio and checkboxes which
2183       * clean their own data.
2184       *
2185       * @param string $elementname
2186       * @param string $paramtype defines type of data contained in element. Use the constants PARAM_*.
2187       *        {@link lib/moodlelib.php} for defined parameter types
2188       */
2189      function setType($elementname, $paramtype) {
2190          $this->_types[$elementname] = $paramtype;
2191  
2192          // This will not always get it right, but it should be accurate in most cases.
2193          // When inaccurate use setForceLtr().
2194          if (!is_rtl_compatible($paramtype)
2195                  && $this->elementExists($elementname)
2196                  && ($element =& $this->getElement($elementname))
2197                  && method_exists($element, 'set_force_ltr')) {
2198  
2199              $element->set_force_ltr(true);
2200          }
2201      }
2202  
2203      /**
2204       * This can be used to set several types at once.
2205       *
2206       * @param array $paramtypes types of parameters.
2207       * @see MoodleQuickForm::setType
2208       */
2209      function setTypes($paramtypes) {
2210          foreach ($paramtypes as $elementname => $paramtype) {
2211              $this->setType($elementname, $paramtype);
2212          }
2213      }
2214  
2215      /**
2216       * Return the type(s) to use to clean an element.
2217       *
2218       * In the case where the element has an array as a value, we will try to obtain a
2219       * type defined for that specific key, and recursively until done.
2220       *
2221       * This method does not work reverse, you cannot pass a nested element and hoping to
2222       * fallback on the clean type of a parent. This method intends to be used with the
2223       * main element, which will generate child types if needed, not the other way around.
2224       *
2225       * Example scenario:
2226       *
2227       * You have defined a new repeated element containing a text field called 'foo'.
2228       * By default there will always be 2 occurence of 'foo' in the form. Even though
2229       * you've set the type on 'foo' to be PARAM_INT, for some obscure reason, you want
2230       * the first value of 'foo', to be PARAM_FLOAT, which you set using setType:
2231       * $mform->setType('foo[0]', PARAM_FLOAT).
2232       *
2233       * Now if you call this method passing 'foo', along with the submitted values of 'foo':
2234       * array(0 => '1.23', 1 => '10'), you will get an array telling you that the key 0 is a
2235       * FLOAT and 1 is an INT. If you had passed 'foo[1]', along with its value '10', you would
2236       * get the default clean type returned (param $default).
2237       *
2238       * @param string $elementname name of the element.
2239       * @param mixed $value value that should be cleaned.
2240       * @param int $default default constant value to be returned (PARAM_...)
2241       * @return string|array constant value or array of constant values (PARAM_...)
2242       */
2243      public function getCleanType($elementname, $value, $default = PARAM_RAW) {
2244          $type = $default;
2245          if (array_key_exists($elementname, $this->_types)) {
2246              $type = $this->_types[$elementname];
2247          }
2248          if (is_array($value)) {
2249              $default = $type;
2250              $type = array();
2251              foreach ($value as $subkey => $subvalue) {
2252                  $typekey = "$elementname" . "[$subkey]";
2253                  if (array_key_exists($typekey, $this->_types)) {
2254                      $subtype = $this->_types[$typekey];
2255                  } else {
2256                      $subtype = $default;
2257                  }
2258                  if (is_array($subvalue)) {
2259                      $type[$subkey] = $this->getCleanType($typekey, $subvalue, $subtype);
2260                  } else {
2261                      $type[$subkey] = $subtype;
2262                  }
2263              }
2264          }
2265          return $type;
2266      }
2267  
2268      /**
2269       * Return the cleaned value using the passed type(s).
2270       *
2271       * @param mixed $value value that has to be cleaned.
2272       * @param int|array $type constant value to use to clean (PARAM_...), typically returned by {@link self::getCleanType()}.
2273       * @return mixed cleaned up value.
2274       */
2275      public function getCleanedValue($value, $type) {
2276          if (is_array($type) && is_array($value)) {
2277              foreach ($type as $key => $param) {
2278                  $value[$key] = $this->getCleanedValue($value[$key], $param);
2279              }
2280          } else if (!is_array($type) && !is_array($value)) {
2281              $value = clean_param($value, $type);
2282          } else if (!is_array($type) && is_array($value)) {
2283              $value = clean_param_array($value, $type, true);
2284          } else {
2285              throw new coding_exception('Unexpected type or value received in MoodleQuickForm::getCleanedValue()');
2286          }
2287          return $value;
2288      }
2289  
2290      /**
2291       * Updates submitted values
2292       *
2293       * @param array $submission submitted values
2294       * @param array $files list of files
2295       */
2296      function updateSubmission($submission, $files) {
2297          $this->_flagSubmitted = false;
2298  
2299          if (empty($submission)) {
2300              $this->_submitValues = array();
2301          } else {
2302              foreach ($submission as $key => $s) {
2303                  $type = $this->getCleanType($key, $s);
2304                  $submission[$key] = $this->getCleanedValue($s, $type);
2305              }
2306              $this->_submitValues = $submission;
2307              $this->_flagSubmitted = true;
2308          }
2309  
2310          if (empty($files)) {
2311              $this->_submitFiles = array();
2312          } else {
2313              $this->_submitFiles = $files;
2314              $this->_flagSubmitted = true;
2315          }
2316  
2317          // need to tell all elements that they need to update their value attribute.
2318           foreach (array_keys($this->_elements) as $key) {
2319               $this->_elements[$key]->onQuickFormEvent('updateValue', null, $this);
2320           }
2321      }
2322  
2323      /**
2324       * Returns HTML for required elements
2325       *
2326       * @return string
2327       */
2328      function getReqHTML(){
2329          return $this->_reqHTML;
2330      }
2331  
2332      /**
2333       * Returns HTML for advanced elements
2334       *
2335       * @return string
2336       */
2337      function getAdvancedHTML(){
2338          return $this->_advancedHTML;
2339      }
2340  
2341      /**
2342       * Initializes a default form value. Used to specify the default for a new entry where
2343       * no data is loaded in using moodleform::set_data()
2344       *
2345       * note: $slashed param removed
2346       *
2347       * @param string $elementName element name
2348       * @param mixed $defaultValue values for that element name
2349       */
2350      function setDefault($elementName, $defaultValue){
2351          $this->setDefaults(array($elementName=>$defaultValue));
2352      }
2353  
2354      /**
2355       * Add a help button to element, only one button per element is allowed.
2356       *
2357       * This is new, simplified and preferable method of setting a help icon on form elements.
2358       * It uses the new $OUTPUT->help_icon().
2359       *
2360       * Typically, you will provide the same identifier and the component as you have used for the
2361       * label of the element. The string identifier with the _help suffix added is then used
2362       * as the help string.
2363       *
2364       * There has to be two strings defined:
2365       *   1/ get_string($identifier, $component) - the title of the help page
2366       *   2/ get_string($identifier.'_help', $component) - the actual help page text
2367       *
2368       * @since Moodle 2.0
2369       * @param string $elementname name of the element to add the item to
2370       * @param string $identifier help string identifier without _help suffix
2371       * @param string $component component name to look the help string in
2372       * @param string $linktext optional text to display next to the icon
2373       * @param bool $suppresscheck set to true if the element may not exist
2374       * @param string|object|array|int $a An object, string or number that can be used
2375       *      within translation strings
2376       */
2377      public function addHelpButton(
2378          $elementname,
2379          $identifier,
2380          $component = 'moodle',
2381          $linktext = '',
2382          $suppresscheck = false,
2383          $a = null
2384      ) {
2385          global $OUTPUT;
2386          if (array_key_exists($elementname, $this->_elementIndex)) {
2387              $element = $this->_elements[$this->_elementIndex[$elementname]];
2388              $element->_helpbutton = $OUTPUT->help_icon($identifier, $component, $linktext, $a);
2389          } else if (!$suppresscheck) {
2390              debugging(get_string('nonexistentformelements', 'form', $elementname));
2391          }
2392      }
2393  
2394      /**
2395       * Set constant value not overridden by _POST or _GET
2396       * note: this does not work for complex names with [] :-(
2397       *
2398       * @param string $elname name of element
2399       * @param mixed $value
2400       */
2401      function setConstant($elname, $value) {
2402          $this->_constantValues = HTML_QuickForm::arrayMerge($this->_constantValues, array($elname=>$value));
2403          $element =& $this->getElement($elname);
2404          $element->onQuickFormEvent('updateValue', null, $this);
2405      }
2406  
2407      /**
2408       * export submitted values
2409       *
2410       * @param string $elementList list of elements in form
2411       * @return array
2412       */
2413      function exportValues($elementList = null){
2414          $unfiltered = array();
2415          if (null === $elementList) {
2416              // iterate over all elements, calling their exportValue() methods
2417              foreach (array_keys($this->_elements) as $key) {
2418                  if ($this->_elements[$key]->isFrozen() && !$this->_elements[$key]->_persistantFreeze) {
2419                      $value = '';
2420                      if (isset($this->_elements[$key]->_attributes['name'])) {
2421                          $varname = $this->_elements[$key]->_attributes['name'];
2422                          // If we have a default value then export it.
2423                          if (isset($this->_defaultValues[$varname])) {
2424                              $value = $this->prepare_fixed_value($varname, $this->_defaultValues[$varname]);
2425                          }
2426                      }
2427                  } else {
2428                      $value = $this->_elements[$key]->exportValue($this->_submitValues, true);
2429                  }
2430  
2431                  if (is_array($value)) {
2432                      // This shit throws a bogus warning in PHP 4.3.x
2433                      $unfiltered = HTML_QuickForm::arrayMerge($unfiltered, $value);
2434                  }
2435              }
2436          } else {
2437              if (!is_array($elementList)) {
2438                  $elementList = array_map('trim', explode(',', $elementList));
2439              }
2440              foreach ($elementList as $elementName) {
2441                  $value = $this->exportValue($elementName);
2442                  if ((new PEAR())->isError($value)) {
2443                      return $value;
2444                  }
2445                  //oh, stock QuickFOrm was returning array of arrays!
2446                  $unfiltered = HTML_QuickForm::arrayMerge($unfiltered, $value);
2447              }
2448          }
2449  
2450          if (is_array($this->_constantValues)) {
2451              $unfiltered = HTML_QuickForm::arrayMerge($unfiltered, $this->_constantValues);
2452          }
2453          return $unfiltered;
2454      }
2455  
2456      /**
2457       * This is a bit of a hack, and it duplicates the code in
2458       * HTML_QuickForm_element::_prepareValue, but I could not think of a way or
2459       * reliably calling that code. (Think about date selectors, for example.)
2460       * @param string $name the element name.
2461       * @param mixed $value the fixed value to set.
2462       * @return mixed the appropriate array to add to the $unfiltered array.
2463       */
2464      protected function prepare_fixed_value($name, $value) {
2465          if (null === $value) {
2466              return null;
2467          } else {
2468              if (!strpos($name, '[')) {
2469                  return array($name => $value);
2470              } else {
2471                  $valueAry = array();
2472                  $myIndex  = "['" . str_replace(array(']', '['), array('', "']['"), $name) . "']";
2473                  eval("\$valueAry$myIndex = \$value;");
2474                  return $valueAry;
2475              }
2476          }
2477      }
2478  
2479      /**
2480       * Adds a validation rule for the given field
2481       *
2482       * If the element is in fact a group, it will be considered as a whole.
2483       * To validate grouped elements as separated entities,
2484       * use addGroupRule instead of addRule.
2485       *
2486       * @param string $element Form element name
2487       * @param string|null $message Message to display for invalid data
2488       * @param string $type Rule type, use getRegisteredRules() to get types
2489       * @param mixed $format (optional)Required for extra rule data
2490       * @param string $validation (optional)Where to perform validation: "server", "client"
2491       * @param bool $reset Client-side validation: reset the form element to its original value if there is an error?
2492       * @param bool $force Force the rule to be applied, even if the target form element does not exist
2493       */
2494      function addRule($element, $message, $type, $format=null, $validation='server', $reset = false, $force = false)
2495      {
2496          parent::addRule($element, $message, $type, $format, $validation, $reset, $force);
2497          if ($validation == 'client') {
2498              $this->clientvalidation = true;
2499          }
2500  
2501      }
2502  
2503      /**
2504       * Adds a validation rule for the given group of elements
2505       *
2506       * Only groups with a name can be assigned a validation rule
2507       * Use addGroupRule when you need to validate elements inside the group.
2508       * Use addRule if you need to validate the group as a whole. In this case,
2509       * the same rule will be applied to all elements in the group.
2510       * Use addRule if you need to validate the group against a function.
2511       *
2512       * @param string $group Form group name
2513       * @param array|string $arg1 Array for multiple elements or error message string for one element
2514       * @param string $type (optional)Rule type use getRegisteredRules() to get types
2515       * @param string $format (optional)Required for extra rule data
2516       * @param int $howmany (optional)How many valid elements should be in the group
2517       * @param string $validation (optional)Where to perform validation: "server", "client"
2518       * @param bool $reset Client-side: whether to reset the element's value to its original state if validation failed.
2519       */
2520      function addGroupRule($group, $arg1, $type='', $format=null, $howmany=0, $validation = 'server', $reset = false)
2521      {
2522          parent::addGroupRule($group, $arg1, $type, $format, $howmany, $validation, $reset);
2523          if (is_array($arg1)) {
2524               foreach ($arg1 as $rules) {
2525                  foreach ($rules as $rule) {
2526                      $validation = (isset($rule[3]) && 'client' == $rule[3])? 'client': 'server';
2527                      if ($validation == 'client') {
2528                          $this->clientvalidation = true;
2529                      }
2530                  }
2531              }
2532          } elseif (is_string($arg1)) {
2533              if ($validation == 'client') {
2534                  $this->clientvalidation = true;
2535              }
2536          }
2537      }
2538  
2539      /**
2540       * Returns the client side validation script
2541       *
2542       * The code here was copied from HTML_QuickForm_DHTMLRulesTableless who copied it from  HTML_QuickForm
2543       * and slightly modified to run rules per-element
2544       * Needed to override this because of an error with client side validation of grouped elements.
2545       *
2546       * @return string Javascript to perform validation, empty string if no 'client' rules were added
2547       */
2548      function getValidationScript()
2549      {
2550          global $PAGE;
2551  
2552          if (empty($this->_rules) || $this->clientvalidation === false) {
2553              return '';
2554          }
2555  
2556          include_once('HTML/QuickForm/RuleRegistry.php');
2557          $registry =& HTML_QuickForm_RuleRegistry::singleton();
2558          $test = array();
2559          $js_escape = array(
2560              "\r"    => '\r',
2561              "\n"    => '\n',
2562              "\t"    => '\t',
2563              "'"     => "\\'",
2564              '"'     => '\"',
2565              '\\'    => '\\\\'
2566          );
2567  
2568          foreach ($this->_rules as $elementName => $rules) {
2569              foreach ($rules as $rule) {
2570                  if ('client' == $rule['validation']) {
2571                      unset($element); //TODO: find out how to properly initialize it
2572  
2573                      $dependent  = isset($rule['dependent']) && is_array($rule['dependent']);
2574                      $rule['message'] = strtr($rule['message'], $js_escape);
2575  
2576                      if (isset($rule['group'])) {
2577                          $group    =& $this->getElement($rule['group']);
2578                          // No JavaScript validation for frozen elements
2579                          if ($group->isFrozen()) {
2580                              continue 2;
2581                          }
2582                          $elements =& $group->getElements();
2583                          foreach (array_keys($elements) as $key) {
2584                              if ($elementName == $group->getElementName($key)) {
2585                                  $element =& $elements[$key];
2586                                  break;
2587                              }
2588                          }
2589                      } elseif ($dependent) {
2590                          $element   =  array();
2591                          $element[] =& $this->getElement($elementName);
2592                          foreach ($rule['dependent'] as $elName) {
2593                              $element[] =& $this->getElement($elName);
2594                          }
2595                      } else {
2596                          $element =& $this->getElement($elementName);
2597                      }
2598                      // No JavaScript validation for frozen elements
2599                      if (is_object($element) && $element->isFrozen()) {
2600                          continue 2;
2601                      } elseif (is_array($element)) {
2602                          foreach (array_keys($element) as $key) {
2603                              if ($element[$key]->isFrozen()) {
2604                                  continue 3;
2605                              }
2606                          }
2607                      }
2608                      //for editor element, [text] is appended to the name.
2609                      $fullelementname = $elementName;
2610                      if (is_object($element) && $element->getType() == 'editor') {
2611                          if ($element->getType() == 'editor') {
2612                              $fullelementname .= '[text]';
2613                              // Add format to rule as moodleform check which format is supported by browser
2614                              // it is not set anywhere... So small hack to make sure we pass it down to quickform.
2615                              if (is_null($rule['format'])) {
2616                                  $rule['format'] = $element->getFormat();
2617                              }
2618                          }
2619                      }
2620                      // Fix for bug displaying errors for elements in a group
2621                      $test[$fullelementname][0][] = $registry->getValidationScript($element, $fullelementname, $rule);
2622                      $test[$fullelementname][1]=$element;
2623                      //end of fix
2624                  }
2625              }
2626          }
2627  
2628          // Fix for MDL-9524. If you don't do this, then $element may be left as a reference to one of the fields in
2629          // the form, and then that form field gets corrupted by the code that follows.
2630          unset($element);
2631  
2632          $js = '
2633  
2634  require([
2635      "core_form/events",
2636      "jquery",
2637  ], function(
2638      FormEvents,
2639      $
2640  ) {
2641  
2642      function qf_errorHandler(element, _qfMsg, escapedName) {
2643          const event = FormEvents.notifyFieldValidationFailure(element, _qfMsg);
2644          if (event.defaultPrevented) {
2645              return _qfMsg == \'\';
2646          } else {
2647              // Legacy mforms.
2648              var div = element.parentNode;
2649  
2650              if ((div == undefined) || (element.name == undefined)) {
2651                  // No checking can be done for undefined elements so let server handle it.
2652                  return true;
2653              }
2654  
2655              if (_qfMsg != \'\') {
2656                  var errorSpan = document.getElementById(\'id_error_\' + escapedName);
2657                  if (!errorSpan) {
2658                      errorSpan = document.createElement("span");
2659                      errorSpan.id = \'id_error_\' + escapedName;
2660                      errorSpan.className = "error";
2661                      element.parentNode.insertBefore(errorSpan, element.parentNode.firstChild);
2662                      document.getElementById(errorSpan.id).setAttribute(\'TabIndex\', \'0\');
2663                      document.getElementById(errorSpan.id).focus();
2664                  }
2665  
2666                  while (errorSpan.firstChild) {
2667                      errorSpan.removeChild(errorSpan.firstChild);
2668                  }
2669  
2670                  errorSpan.appendChild(document.createTextNode(_qfMsg.substring(3)));
2671  
2672                  if (div.className.substr(div.className.length - 6, 6) != " error"
2673                          && div.className != "error") {
2674                      div.className += " error";
2675                      linebreak = document.createElement("br");
2676                      linebreak.className = "error";
2677                      linebreak.id = \'id_error_break_\' + escapedName;
2678                      errorSpan.parentNode.insertBefore(linebreak, errorSpan.nextSibling);
2679                  }
2680  
2681                  return false;
2682              } else {
2683                  var errorSpan = document.getElementById(\'id_error_\' + escapedName);
2684                  if (errorSpan) {
2685                      errorSpan.parentNode.removeChild(errorSpan);
2686                  }
2687                  var linebreak = document.getElementById(\'id_error_break_\' + escapedName);
2688                  if (linebreak) {
2689                      linebreak.parentNode.removeChild(linebreak);
2690                  }
2691  
2692                  if (div.className.substr(div.className.length - 6, 6) == " error") {
2693                      div.className = div.className.substr(0, div.className.length - 6);
2694                  } else if (div.className == "error") {
2695                      div.className = "";
2696                  }
2697  
2698                  return true;
2699              } // End if.
2700          } // End if.
2701      } // End function.
2702      ';
2703          $validateJS = '';
2704          foreach ($test as $elementName => $jsandelement) {
2705              // Fix for bug displaying errors for elements in a group
2706              //unset($element);
2707              list($jsArr,$element)=$jsandelement;
2708              //end of fix
2709              $escapedElementName = preg_replace_callback(
2710                  '/[_\[\]-]/',
2711                  function($matches) {
2712                      return sprintf("_%2x", ord($matches[0]));
2713                  },
2714                  $elementName);
2715              $valFunc = 'validate_' . $this->_formName . '_' . $escapedElementName . '(ev.target, \''.$escapedElementName.'\')';
2716  
2717              if (!is_array($element)) {
2718                  $element = [$element];
2719              }
2720              foreach ($element as $elem) {
2721                  if (key_exists('id', $elem->_attributes)) {
2722                      $js .= '
2723      function validate_' . $this->_formName . '_' . $escapedElementName . '(element, escapedName) {
2724        if (undefined == element) {
2725           //required element was not found, then let form be submitted without client side validation
2726           return true;
2727        }
2728        var value = \'\';
2729        var errFlag = new Array();
2730        var _qfGroups = {};
2731        var _qfMsg = \'\';
2732        var frm = element.parentNode;
2733        if ((undefined != element.name) && (frm != undefined)) {
2734            while (frm && frm.nodeName.toUpperCase() != "FORM") {
2735              frm = frm.parentNode;
2736            }
2737          ' . join("\n", $jsArr) . '
2738            return qf_errorHandler(element, _qfMsg, escapedName);
2739        } else {
2740          //element name should be defined else error msg will not be displayed.
2741          return true;
2742        }
2743      }
2744  
2745      document.getElementById(\'' . $elem->_attributes['id'] . '\').addEventListener(\'blur\', function(ev) {
2746          ' . $valFunc . '
2747      });
2748      document.getElementById(\'' . $elem->_attributes['id'] . '\').addEventListener(\'change\', function(ev) {
2749          ' . $valFunc . '
2750      });
2751  ';
2752                  }
2753              }
2754              // This handles both randomised (MDL-65217) and non-randomised IDs.
2755              $errorid = preg_replace('/^id_/', 'id_error_', $elem->_attributes['id']);
2756              $validateJS .= '
2757        ret = validate_' . $this->_formName . '_' . $escapedElementName.'(frm.elements[\''.$elementName.'\'], \''.$escapedElementName.'\') && ret;
2758        if (!ret && !first_focus) {
2759          first_focus = true;
2760          const element = document.getElementById("' . $errorid . '");
2761          if (element) {
2762            FormEvents.notifyFormError(element);
2763            element.focus();
2764          }
2765        }
2766  ';
2767  
2768              // Fix for bug displaying errors for elements in a group
2769              //unset($element);
2770              //$element =& $this->getElement($elementName);
2771              //end of fix
2772              //$onBlur = $element->getAttribute('onBlur');
2773              //$onChange = $element->getAttribute('onChange');
2774              //$element->updateAttributes(array('onBlur' => $onBlur . $valFunc,
2775                                               //'onChange' => $onChange . $valFunc));
2776          }
2777  //  do not rely on frm function parameter, because htmlarea breaks it when overloading the onsubmit method
2778          $js .= '
2779  
2780      function validate_' . $this->_formName . '() {
2781        if (skipClientValidation) {
2782           return true;
2783        }
2784        var ret = true;
2785  
2786        var frm = document.getElementById(\''. $this->_attributes['id'] .'\')
2787        var first_focus = false;
2788      ' . $validateJS . ';
2789        return ret;
2790      }
2791  
2792      var form = document.getElementById(\'' . $this->_attributes['id'] . '\').closest(\'form\');
2793      form.addEventListener(FormEvents.eventTypes.formSubmittedByJavascript, () => {
2794          try {
2795              var myValidator = validate_' . $this->_formName . ';
2796          } catch(e) {
2797              return;
2798          }
2799          if (myValidator) {
2800              myValidator();
2801          }
2802      });
2803  
2804      document.getElementById(\'' . $this->_attributes['id'] . '\').addEventListener(\'submit\', function(ev) {
2805          try {
2806              var myValidator = validate_' . $this->_formName . ';
2807          } catch(e) {
2808              return true;
2809          }
2810          if (typeof window.tinyMCE !== \'undefined\') {
2811              window.tinyMCE.triggerSave();
2812          }
2813          if (!myValidator()) {
2814              ev.preventDefault();
2815          }
2816      });
2817  
2818  });
2819  ';
2820  
2821          $PAGE->requires->js_amd_inline($js);
2822  
2823          // Global variable used to skip the client validation.
2824          return html_writer::tag('script', 'var skipClientValidation = false;');
2825      } // end func getValidationScript
2826  
2827      /**
2828       * Sets default error message
2829       */
2830      function _setDefaultRuleMessages(){
2831          foreach ($this->_rules as $field => $rulesarr){
2832              foreach ($rulesarr as $key => $rule){
2833                  if ($rule['message']===null){
2834                      $a=new stdClass();
2835                      $a->format=$rule['format'];
2836                      $str=get_string('err_'.$rule['type'], 'form', $a);
2837                      if (strpos($str, '[[')!==0){
2838                          $this->_rules[$field][$key]['message']=$str;
2839                      }
2840                  }
2841              }
2842          }
2843      }
2844  
2845      /**
2846       * Get list of attributes which have dependencies
2847       *
2848       * @return array
2849       */
2850      function getLockOptionObject(){
2851          $result = array();
2852          foreach ($this->_dependencies as $dependentOn => $conditions){
2853              $result[$dependentOn] = array();
2854              foreach ($conditions as $condition=>$values) {
2855                  $result[$dependentOn][$condition] = array();
2856                  foreach ($values as $value=>$dependents) {
2857                      $result[$dependentOn][$condition][$value][self::DEP_DISABLE] = array();
2858                      foreach ($dependents as $dependent) {
2859                          $elements = $this->_getElNamesRecursive($dependent);
2860                          if (empty($elements)) {
2861                              // probably element inside of some group
2862                              $elements = array($dependent);
2863                          }
2864                          foreach($elements as $element) {
2865                              if ($element == $dependentOn) {
2866                                  continue;
2867                              }
2868                              $result[$dependentOn][$condition][$value][self::DEP_DISABLE][] = $element;
2869                          }
2870                      }
2871                  }
2872              }
2873          }
2874          foreach ($this->_hideifs as $dependenton => $conditions) {
2875              if (!isset($result[$dependenton])) {
2876                  $result[$dependenton] = array();
2877              }
2878              foreach ($conditions as $condition => $values) {
2879                  if (!isset($result[$dependenton][$condition])) {
2880                      $result[$dependenton][$condition] = array();
2881                  }
2882                  foreach ($values as $value => $dependents) {
2883                      $result[$dependenton][$condition][$value][self::DEP_HIDE] = array();
2884                      foreach ($dependents as $dependent) {
2885                          $elements = $this->_getElNamesRecursive($dependent);
2886                          if (!in_array($dependent, $elements)) {
2887                              // Always want to hide the main element, even if it contains sub-elements as well.
2888                              $elements[] = $dependent;
2889                          }
2890                          foreach ($elements as $element) {
2891                              if ($element == $dependenton) {
2892                                  continue;
2893                              }
2894                              $result[$dependenton][$condition][$value][self::DEP_HIDE][] = $element;
2895                          }
2896                      }
2897                  }
2898              }
2899          }
2900          return array($this->getAttribute('id'), $result);
2901      }
2902  
2903      /**
2904       * Get names of element or elements in a group.
2905       *
2906       * @param HTML_QuickForm_group|element $element element group or element object
2907       * @return array
2908       */
2909      function _getElNamesRecursive($element) {
2910          if (is_string($element)) {
2911              if (!$this->elementExists($element)) {
2912                  return array();
2913              }
2914              $element = $this->getElement($element);
2915          }
2916  
2917          if (is_a($element, 'HTML_QuickForm_group')) {
2918              $elsInGroup = $element->getElements();
2919              $elNames = array();
2920              foreach ($elsInGroup as $elInGroup){
2921                  if (is_a($elInGroup, 'HTML_QuickForm_group')) {
2922                      // Groups nested in groups: append the group name to the element and then change it back.
2923                      // We will be appending group name again in MoodleQuickForm_group::export_for_template().
2924                      $oldname = $elInGroup->getName();
2925                      if ($element->_appendName) {
2926                          $elInGroup->setName($element->getName() . '[' . $oldname . ']');
2927                      }
2928                      $elNames = array_merge($elNames, $this->_getElNamesRecursive($elInGroup));
2929                      $elInGroup->setName($oldname);
2930                  } else {
2931                      $elNames[] = $element->getElementName($elInGroup->getName());
2932                  }
2933              }
2934  
2935          } else if (is_a($element, 'HTML_QuickForm_header')) {
2936              return array();
2937  
2938          } else if (is_a($element, 'HTML_QuickForm_hidden')) {
2939              return array();
2940  
2941          } else if (method_exists($element, 'getPrivateName') &&
2942                  !($element instanceof HTML_QuickForm_advcheckbox)) {
2943              // The advcheckbox element implements a method called getPrivateName,
2944              // but in a way that is not compatible with the generic API, so we
2945              // have to explicitly exclude it.
2946              return array($element->getPrivateName());
2947  
2948          } else {
2949              $elNames = array($element->getName());
2950          }
2951  
2952          return $elNames;
2953      }
2954  
2955      /**
2956       * Adds a dependency for $elementName which will be disabled if $condition is met.
2957       * If $condition = 'notchecked' (default) then the condition is that the $dependentOn element
2958       * is not checked. If $condition = 'checked' then the condition is that the $dependentOn element
2959       * is checked. If $condition is something else (like "eq" for equals) then it is checked to see if the value
2960       * of the $dependentOn element is $condition (such as equal) to $value.
2961       *
2962       * When working with multiple selects, the dependentOn has to be the real name of the select, meaning that
2963       * it will most likely end up with '[]'. Also, the value should be an array of required values, or a string
2964       * containing the values separated by pipes: array('red', 'blue') or 'red|blue'.
2965       *
2966       * @param string $elementName the name of the element which will be disabled
2967       * @param string $dependentOn the name of the element whose state will be checked for condition
2968       * @param string $condition the condition to check
2969       * @param mixed $value used in conjunction with condition.
2970       */
2971      function disabledIf($elementName, $dependentOn, $condition = 'notchecked', $value='1') {
2972          // Multiple selects allow for a multiple selection, we transform the array to string here as
2973          // an array cannot be used as a key in an associative array.
2974          if (is_array($value)) {
2975              $value = implode('|', $value);
2976          }
2977          if (!array_key_exists($dependentOn, $this->_dependencies)) {
2978              $this->_dependencies[$dependentOn] = array();
2979          }
2980          if (!array_key_exists($condition, $this->_dependencies[$dependentOn])) {
2981              $this->_dependencies[$dependentOn][$condition] = array();
2982          }
2983          if (!array_key_exists($value, $this->_dependencies[$dependentOn][$condition])) {
2984              $this->_dependencies[$dependentOn][$condition][$value] = array();
2985          }
2986          $this->_dependencies[$dependentOn][$condition][$value][] = $elementName;
2987      }
2988  
2989      /**
2990       * Adds a dependency for $elementName which will be hidden if $condition is met.
2991       * If $condition = 'notchecked' (default) then the condition is that the $dependentOn element
2992       * is not checked. If $condition = 'checked' then the condition is that the $dependentOn element
2993       * is checked. If $condition is something else (like "eq" for equals) then it is checked to see if the value
2994       * of the $dependentOn element is $condition (such as equal) to $value.
2995       *
2996       * When working with multiple selects, the dependentOn has to be the real name of the select, meaning that
2997       * it will most likely end up with '[]'. Also, the value should be an array of required values, or a string
2998       * containing the values separated by pipes: array('red', 'blue') or 'red|blue'.
2999       *
3000       * @param string $elementname the name of the element which will be hidden
3001       * @param string $dependenton the name of the element whose state will be checked for condition
3002       * @param string $condition the condition to check
3003       * @param mixed $value used in conjunction with condition.
3004       */
3005      public function hideIf($elementname, $dependenton, $condition = 'notchecked', $value = '1') {
3006          // Multiple selects allow for a multiple selection, we transform the array to string here as
3007          // an array cannot be used as a key in an associative array.
3008          if (is_array($value)) {
3009              $value = implode('|', $value);
3010          }
3011          if (!array_key_exists($dependenton, $this->_hideifs)) {
3012              $this->_hideifs[$dependenton] = array();
3013          }
3014          if (!array_key_exists($condition, $this->_hideifs[$dependenton])) {
3015              $this->_hideifs[$dependenton][$condition] = array();
3016          }
3017          if (!array_key_exists($value, $this->_hideifs[$dependenton][$condition])) {
3018              $this->_hideifs[$dependenton][$condition][$value] = array();
3019          }
3020          $this->_hideifs[$dependenton][$condition][$value][] = $elementname;
3021      }
3022  
3023      /**
3024       * Registers button as no submit button
3025       *
3026       * @param string $buttonname name of the button
3027       */
3028      function registerNoSubmitButton($buttonname){
3029          $this->_noSubmitButtons[]=$buttonname;
3030      }
3031  
3032      /**
3033       * Checks if button is a no submit button, i.e it doesn't submit form
3034       *
3035       * @param string $buttonname name of the button to check
3036       * @return bool
3037       */
3038      function isNoSubmitButton($buttonname){
3039          return (array_search($buttonname, $this->_noSubmitButtons)!==FALSE);
3040      }
3041  
3042      /**
3043       * Registers a button as cancel button
3044       *
3045       * @param string $addfieldsname name of the button
3046       */
3047      function _registerCancelButton($addfieldsname){
3048          $this->_cancelButtons[]=$addfieldsname;
3049      }
3050  
3051      /**
3052       * Displays elements without HTML input tags.
3053       * This method is different to freeze() in that it makes sure no hidden
3054       * elements are included in the form.
3055       * Note: If you want to make sure the submitted value is ignored, please use setDefaults().
3056       *
3057       * This function also removes all previously defined rules.
3058       *
3059       * @param string|array $elementList array or string of element(s) to be frozen
3060       * @return object|bool if element list is not empty then return error object, else true
3061       */
3062      function hardFreeze($elementList=null)
3063      {
3064          if (!isset($elementList)) {
3065              $this->_freezeAll = true;
3066              $elementList = array();
3067          } else {
3068              if (!is_array($elementList)) {
3069                  $elementList = preg_split('/[ ]*,[ ]*/', $elementList);
3070              }
3071              $elementList = array_flip($elementList);
3072          }
3073  
3074          foreach (array_keys($this->_elements) as $key) {
3075              $name = $this->_elements[$key]->getName();
3076              if ($this->_freezeAll || isset($elementList[$name])) {
3077                  $this->_elements[$key]->freeze();
3078                  $this->_elements[$key]->setPersistantFreeze(false);
3079                  unset($elementList[$name]);
3080  
3081                  // remove all rules
3082                  $this->_rules[$name] = array();
3083                  // if field is required, remove the rule
3084                  $unset = array_search($name, $this->_required);
3085                  if ($unset !== false) {
3086                      unset($this->_required[$unset]);
3087                  }
3088              }
3089          }
3090  
3091          if (!empty($elementList)) {
3092              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);
3093          }
3094          return true;
3095      }
3096  
3097      /**
3098       * Hard freeze all elements in a form except those whose names are in $elementList or hidden elements in a form.
3099       *
3100       * This function also removes all previously defined rules of elements it freezes.
3101       *
3102       * @throws HTML_QuickForm_Error
3103       * @param array $elementList array or string of element(s) not to be frozen
3104       * @return bool returns true
3105       */
3106      function hardFreezeAllVisibleExcept($elementList)
3107      {
3108          $elementList = array_flip($elementList);
3109          foreach (array_keys($this->_elements) as $key) {
3110              $name = $this->_elements[$key]->getName();
3111              $type = $this->_elements[$key]->getType();
3112  
3113              if ($type == 'hidden'){
3114                  // leave hidden types as they are
3115              } elseif (!isset($elementList[$name])) {
3116                  $this->_elements[$key]->freeze();
3117                  $this->_elements[$key]->setPersistantFreeze(false);
3118  
3119                  // remove all rules
3120                  $this->_rules[$name] = array();
3121                  // if field is required, remove the rule
3122                  $unset = array_search($name, $this->_required);
3123                  if ($unset !== false) {
3124                      unset($this->_required[$unset]);
3125                  }
3126              }
3127          }
3128          return true;
3129      }
3130  
3131     /**
3132      * Tells whether the form was already submitted
3133      *
3134      * This is useful since the _submitFiles and _submitValues arrays
3135      * may be completely empty after the trackSubmit value is removed.
3136      *
3137      * @return bool
3138      */
3139      function isSubmitted()
3140      {
3141          return parent::isSubmitted() && (!$this->isFrozen());
3142      }
3143  
3144      /**
3145       * Add the element name to the list of newly-created repeat elements
3146       * (So that elements that interpret 'no data submitted' as a valid state
3147       * can tell when they should get the default value instead).
3148       *
3149       * @param string $name the name of the new element
3150       */
3151      public function note_new_repeat($name) {
3152          $this->_newrepeats[] = $name;
3153      }
3154  
3155      /**
3156       * Check if the element with the given name has just been added by clicking
3157       * on the 'Add repeating elements' button.
3158       *
3159       * @param string $name the name of the element being checked
3160       * @return bool true if the element is newly added
3161       */
3162      public function is_new_repeat($name) {
3163          return in_array($name, $this->_newrepeats);
3164      }
3165  }
3166  
3167  /**
3168   * MoodleQuickForm renderer
3169   *
3170   * A renderer for MoodleQuickForm that only uses XHTML and CSS and no
3171   * table tags, extends PEAR class HTML_QuickForm_Renderer_Tableless
3172   *
3173   * Stylesheet is part of standard theme and should be automatically included.
3174   *
3175   * @package   core_form
3176   * @copyright 2007 Jamie Pratt <me@jamiep.org>
3177   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3178   */
3179  class MoodleQuickForm_Renderer extends HTML_QuickForm_Renderer_Tableless{
3180  
3181      /** @var array Element template array */
3182      var $_elementTemplates;
3183  
3184      /**
3185       * Template used when opening a hidden fieldset
3186       * (i.e. a fieldset that is opened when there is no header element)
3187       * @var string
3188       */
3189      var $_openHiddenFieldsetTemplate = "\n\t<fieldset class=\"hidden\"><div>";
3190  
3191      /** @var string Template used when opening a fieldset */
3192      var $_openFieldsetTemplate = "\n\t<fieldset class=\"{classes}\" {id}>";
3193  
3194      /** @var string Template used when closing a fieldset */
3195      var $_closeFieldsetTemplate = "\n\t\t</div></fieldset>";
3196  
3197      /** @var string Required Note template string */
3198      var $_requiredNoteTemplate =
3199          "\n\t\t<div class=\"fdescription required\">{requiredNote}</div>";
3200  
3201      /**
3202       * Collapsible buttons string template.
3203       *
3204       * Note that the <span> will be converted as a link. This is done so that the link is not yet clickable
3205       * until the Javascript has been fully loaded.
3206       *
3207       * @var string
3208       */
3209      var $_collapseButtonsTemplate =
3210          "\n\t<div class=\"collapsible-actions\"><span class=\"collapseexpand\">{strexpandall}</span></div>";
3211  
3212      /**
3213       * Array whose keys are element names. If the key exists this is a advanced element
3214       *
3215       * @var array
3216       */
3217      var $_advancedElements = array();
3218  
3219      /**
3220       * The form element to render in the sticky footer, if any.
3221       * @var string|null $_stickyfooterelement
3222       */
3223      protected $_stickyfooterelement = null;
3224  
3225      /**
3226       * Array whose keys are element names and the the boolean values reflect the current state. If the key exists this is a collapsible element.
3227       *
3228       * @var array
3229       */
3230      var $_collapsibleElements = array();
3231  
3232      /**
3233       * @var string Contains the collapsible buttons to add to the form.
3234       */
3235      var $_collapseButtons = '';
3236  
3237      /** @var string request class HTML. */
3238      protected $_reqHTML;
3239  
3240      /** @var string advanced class HTML. */
3241      protected $_advancedHTML;
3242  
3243      /**
3244       * Array whose keys are element names should be hidden.
3245       * If the key exists this is an invisible element.
3246       *
3247       * @var array
3248       */
3249      protected $_nonvisibleelements = [];
3250  
3251      /**
3252       * Constructor
3253       */
3254      public function __construct() {
3255          // switch next two lines for ol li containers for form items.
3256          //        $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 --> {typeclass}"><!-- BEGIN error --><span class="error">{error}</span><br /><!-- END error -->{element}</div></li>');
3257          $this->_elementTemplates = array(
3258          'default' => "\n\t\t".'<div id="{id}" class="fitem {advanced}<!-- BEGIN required --> required<!-- END required --> fitem_{typeclass} {emptylabel} {class}" {aria-live} {groupname}><div class="fitemtitle"><label>{label}<!-- BEGIN required -->{req}<!-- END required -->{advancedimg} </label>{help}</div><div class="felement {typeclass}<!-- BEGIN error --> error<!-- END error -->" data-fieldtype="{type}"><!-- BEGIN error --><span class="error" tabindex="0">{error}</span><br /><!-- END error -->{element}</div></div>',
3259  
3260          'actionbuttons' => "\n\t\t".'<div id="{id}" class="fitem fitem_actionbuttons fitem_{typeclass} {class}" {groupname}><div class="felement {typeclass}" data-fieldtype="{type}">{element}</div></div>',
3261  
3262          'fieldset' => "\n\t\t".'<div id="{id}" class="fitem {advanced} {class}<!-- BEGIN required --> required<!-- END required --> fitem_{typeclass} {emptylabel}" {groupname}><div class="fitemtitle"><div class="fgrouplabel"><label>{label}<!-- BEGIN required -->{req}<!-- END required -->{advancedimg} </label>{help}</div></div><fieldset class="felement {typeclass}<!-- BEGIN error --> error<!-- END error -->" data-fieldtype="{type}"><!-- BEGIN error --><span class="error" tabindex="0">{error}</span><br /><!-- END error -->{element}</fieldset></div>',
3263  
3264          'static' => "\n\t\t".'<div id="{id}" class="fitem {advanced} {emptylabel} {class}" {groupname}><div class="fitemtitle"><div class="fstaticlabel">{label}<!-- BEGIN required -->{req}<!-- END required -->{advancedimg} {help}</div></div><div class="felement fstatic <!-- BEGIN error --> error<!-- END error -->" data-fieldtype="static"><!-- BEGIN error --><span class="error" tabindex="0">{error}</span><br /><!-- END error -->{element}</div></div>',
3265  
3266          'warning' => "\n\t\t".'<div id="{id}" class="fitem {advanced} {emptylabel} {class}">{element}</div>',
3267  
3268          'nodisplay' => '');
3269  
3270          parent::__construct();
3271      }
3272  
3273      /**
3274       * Old syntax of class constructor. Deprecated in PHP7.
3275       *
3276       * @deprecated since Moodle 3.1
3277       */
3278      public function MoodleQuickForm_Renderer() {
3279          debugging('Use of class name as constructor is deprecated', DEBUG_DEVELOPER);
3280          self::__construct();
3281      }
3282  
3283      /**
3284       * Set element's as adavance element
3285       *
3286       * @param array $elements form elements which needs to be grouped as advance elements.
3287       */
3288      function setAdvancedElements($elements){
3289          $this->_advancedElements = $elements;
3290      }
3291  
3292      /**
3293       * Set the sticky footer element if any.
3294       *
3295       * @param string|null $elementname the form element name.
3296       */
3297      public function set_sticky_footer(?string $elementname): void {
3298          $this->_stickyfooterelement = $elementname;
3299      }
3300  
3301      /**
3302       * Setting collapsible elements
3303       *
3304       * @param array $elements
3305       */
3306      function setCollapsibleElements($elements) {
3307          $this->_collapsibleElements = $elements;
3308      }
3309  
3310      /**
3311       * Setting non visible elements
3312       *
3313       * @param array $elements
3314       */
3315      public function set_nonvisible_elements($elements) {
3316          $this->_nonvisibleelements = $elements;
3317      }
3318  
3319      /**
3320       * What to do when starting the form
3321       *
3322       * @param MoodleQuickForm $form reference of the form
3323       */
3324      function startForm(&$form){
3325          global $PAGE, $OUTPUT;
3326          $this->_reqHTML = $form->getReqHTML();
3327          $this->_elementTemplates = str_replace('{req}', $this->_reqHTML, $this->_elementTemplates);
3328          $this->_advancedHTML = $form->getAdvancedHTML();
3329          $this->_collapseButtons = '';
3330          $formid = $form->getAttribute('id');
3331          parent::startForm($form);
3332          if ($form->isFrozen()){
3333              $this->_formTemplate = "\n<div id=\"$formid\" class=\"mform frozen\">\n{collapsebtns}\n{content}\n</div>";
3334          } else {
3335              $this->_formTemplate = "\n<form{attributes}>\n\t<div style=\"display: none;\">{hidden}</div>\n{collapsebtns}\n{content}\n</form>";
3336              $this->_hiddenHtml .= $form->_pageparams;
3337          }
3338  
3339          if ($form->is_form_change_checker_enabled()) {
3340              $PAGE->requires->js_call_amd('core_form/changechecker', 'watchFormById', [$formid]);
3341              if ($form->is_dirty()) {
3342                  $PAGE->requires->js_call_amd('core_form/changechecker', 'markFormAsDirtyById', [$formid]);
3343              }
3344          }
3345          if (!empty($this->_collapsibleElements)) {
3346              if (count($this->_collapsibleElements) > 1) {
3347                  $this->_collapseButtons = $OUTPUT->render_from_template('core_form/collapsesections', (object)[]);
3348              }
3349              $PAGE->requires->yui_module('moodle-form-shortforms', 'M.form.shortforms', array(array('formid' => $formid)));
3350          }
3351          if (!empty($this->_advancedElements)){
3352              $PAGE->requires->js_call_amd('core_form/showadvanced', 'init', [$formid]);
3353          }
3354      }
3355  
3356      /**
3357       * Create advance group of elements
3358       *
3359       * @param MoodleQuickForm_group $group Passed by reference
3360       * @param bool $required if input is required field
3361       * @param string $error error message to display
3362       */
3363      function startGroup(&$group, $required, $error){
3364          global $OUTPUT;
3365  
3366          // Make sure the element has an id.
3367          $group->_generateId();
3368  
3369          // Prepend 'fgroup_' to the ID we generated.
3370          $groupid = 'fgroup_' . $group->getAttribute('id');
3371  
3372          // Update the ID.
3373          $attributes = $group->getAttributes();
3374          $attributes['id'] = $groupid;
3375          $group->updateAttributes($attributes);
3376          $advanced = isset($this->_advancedElements[$group->getName()]);
3377  
3378          $html = $OUTPUT->mform_element($group, $required, $advanced, $error, false);
3379          $fromtemplate = !empty($html);
3380          if (!$fromtemplate) {
3381              if (method_exists($group, 'getElementTemplateType')) {
3382                  $html = $this->_elementTemplates[$group->getElementTemplateType()];
3383              } else {
3384                  $html = $this->_elementTemplates['default'];
3385              }
3386  
3387              if (isset($this->_advancedElements[$group->getName()])) {
3388                  $html = str_replace(' {advanced}', ' advanced', $html);
3389                  $html = str_replace('{advancedimg}', $this->_advancedHTML, $html);
3390              } else {
3391                  $html = str_replace(' {advanced}', '', $html);
3392                  $html = str_replace('{advancedimg}', '', $html);
3393              }
3394              if (method_exists($group, 'getHelpButton')) {
3395                  $html = str_replace('{help}', $group->getHelpButton(), $html);
3396              } else {
3397                  $html = str_replace('{help}', '', $html);
3398              }
3399              $html = str_replace('{id}', $group->getAttribute('id'), $html);
3400              $html = str_replace('{name}', $group->getName(), $html);
3401              $html = str_replace('{groupname}', 'data-groupname="'.$group->getName().'"', $html);
3402              $html = str_replace('{typeclass}', 'fgroup', $html);
3403              $html = str_replace('{type}', 'group', $html);
3404              $html = str_replace('{class}', $group->getAttribute('class') ?? '', $html);
3405              $emptylabel = '';
3406              if ($group->getLabel() == '') {
3407                  $emptylabel = 'femptylabel';
3408              }
3409              $html = str_replace('{emptylabel}', $emptylabel, $html);
3410          }
3411          $this->_templates[$group->getName()] = $html;
3412          // Check if the element should be displayed in the sticky footer.
3413          if ($group->getName() && ($this->_stickyfooterelement == $group->getName())) {
3414              $stickyfooter = new core\output\sticky_footer($html);
3415              $html = $OUTPUT->render($stickyfooter);
3416          }
3417  
3418          // Fix for bug in tableless quickforms that didn't allow you to stop a
3419          // fieldset before a group of elements.
3420          // if the element name indicates the end of a fieldset, close the fieldset
3421          if (in_array($group->getName(), $this->_stopFieldsetElements) && $this->_fieldsetsOpen > 0) {
3422              $this->_html .= $this->_closeFieldsetTemplate;
3423              $this->_fieldsetsOpen--;
3424          }
3425          if (!$fromtemplate) {
3426              parent::startGroup($group, $required, $error);
3427          } else {
3428              $this->_html .= $html;
3429          }
3430      }
3431  
3432      /**
3433       * Renders element
3434       *
3435       * @param HTML_QuickForm_element $element element
3436       * @param bool $required if input is required field
3437       * @param string $error error message to display
3438       */
3439      function renderElement(&$element, $required, $error){
3440          global $OUTPUT;
3441  
3442          // Make sure the element has an id.
3443          $element->_generateId();
3444          $advanced = isset($this->_advancedElements[$element->getName()]);
3445  
3446          $html = $OUTPUT->mform_element($element, $required, $advanced, $error, false);
3447          $fromtemplate = !empty($html);
3448          if (!$fromtemplate) {
3449              // Adding stuff to place holders in template
3450              // check if this is a group element first.
3451              if (($this->_inGroup) and !empty($this->_groupElementTemplate)) {
3452                  // So it gets substitutions for *each* element.
3453                  $html = $this->_groupElementTemplate;
3454              } else if (method_exists($element, 'getElementTemplateType')) {
3455                  $html = $this->_elementTemplates[$element->getElementTemplateType()];
3456              } else {
3457                  $html = $this->_elementTemplates['default'];
3458              }
3459              if (isset($this->_advancedElements[$element->getName()])) {
3460                  $html = str_replace(' {advanced}', ' advanced', $html);
3461                  $html = str_replace(' {aria-live}', ' aria-live="polite"', $html);
3462              } else {
3463                  $html = str_replace(' {advanced}', '', $html);
3464                  $html = str_replace(' {aria-live}', '', $html);
3465              }
3466              if (isset($this->_advancedElements[$element->getName()]) || $element->getName() == 'mform_showadvanced') {
3467                  $html = str_replace('{advancedimg}', $this->_advancedHTML, $html);
3468              } else {
3469                  $html = str_replace('{advancedimg}', '', $html);
3470              }
3471              $html = str_replace('{id}', 'fitem_' . $element->getAttribute('id'), $html);
3472              $html = str_replace('{typeclass}', 'f' . $element->getType(), $html);
3473              $html = str_replace('{type}', $element->getType(), $html);
3474              $html = str_replace('{name}', $element->getName(), $html);
3475              $html = str_replace('{groupname}', '', $html);
3476              $html = str_replace('{class}', $element->getAttribute('class') ?? '', $html);
3477              $emptylabel = '';
3478              if ($element->getLabel() == '') {
3479                  $emptylabel = 'femptylabel';
3480              }
3481              $html = str_replace('{emptylabel}', $emptylabel, $html);
3482              if (method_exists($element, 'getHelpButton')) {
3483                  $html = str_replace('{help}', $element->getHelpButton(), $html);
3484              } else {
3485                  $html = str_replace('{help}', '', $html);
3486              }
3487          } else {
3488              if ($this->_inGroup) {
3489                  $this->_groupElementTemplate = $html;
3490              }
3491          }
3492          if (($this->_inGroup) and !empty($this->_groupElementTemplate)) {
3493              $this->_groupElementTemplate = $html;
3494          } else if (!isset($this->_templates[$element->getName()])) {
3495              $this->_templates[$element->getName()] = $html;
3496          }
3497  
3498          // Check if the element should be displayed in the sticky footer.
3499          if ($element->getName() && ($this->_stickyfooterelement == $element->getName())) {
3500              $stickyfooter = new core\output\sticky_footer($html);
3501              $html = $OUTPUT->render($stickyfooter);
3502          }
3503  
3504          if (!$fromtemplate) {
3505              parent::renderElement($element, $required, $error);
3506          } else {
3507              if (in_array($element->getName(), $this->_stopFieldsetElements) && $this->_fieldsetsOpen > 0) {
3508                  $this->_html .= $this->_closeFieldsetTemplate;
3509                  $this->_fieldsetsOpen--;
3510              }
3511              $this->_html .= $html;
3512          }
3513      }
3514  
3515      /**
3516       * Called when visiting a form, after processing all form elements
3517       * Adds required note, form attributes, validation javascript and form content.
3518       *
3519       * @global moodle_page $PAGE
3520       * @param MoodleQuickForm $form Passed by reference
3521       */
3522      function finishForm(&$form){
3523          global $PAGE;
3524          if ($form->isFrozen()){
3525              $this->_hiddenHtml = '';
3526          }
3527          parent::finishForm($form);
3528          $this->_html = str_replace('{collapsebtns}', $this->_collapseButtons, $this->_html);
3529          if (!$form->isFrozen()) {
3530              $args = $form->getLockOptionObject();
3531              if (count($args[1]) > 0) {
3532                  $PAGE->requires->js_init_call('M.form.initFormDependencies', $args, true, moodleform::get_js_module());
3533              }
3534          }
3535      }
3536     /**
3537      * Called when visiting a header element
3538      *
3539      * @param HTML_QuickForm_header $header An HTML_QuickForm_header element being visited
3540      * @global moodle_page $PAGE
3541      */
3542      function renderHeader(&$header) {
3543          global $PAGE, $OUTPUT;
3544  
3545          $header->_generateId();
3546          $name = $header->getName();
3547  
3548          $collapsed = $collapseable = '';
3549          if (isset($this->_collapsibleElements[$header->getName()])) {
3550              $collapseable = true;
3551              $collapsed = $this->_collapsibleElements[$header->getName()];
3552          }
3553  
3554          $id = empty($name) ? '' : ' id="' . $header->getAttribute('id') . '"';
3555          if (!empty($name) && isset($this->_templates[$name])) {
3556              $headerhtml = str_replace('{header}', $header->toHtml(), $this->_templates[$name]);
3557          } else {
3558              $headerhtml = $OUTPUT->render_from_template('core_form/element-header',
3559                  (object)[
3560                      'header' => $header->toHtml(),
3561                      'id' => $header->getAttribute('id'),
3562                      'collapseable' => $collapseable,
3563                      'collapsed' => $collapsed,
3564                      'helpbutton' => $header->getHelpButton(),
3565                  ]);
3566          }
3567  
3568          if ($this->_fieldsetsOpen > 0) {
3569              $this->_html .= $this->_closeFieldsetTemplate;
3570              $this->_fieldsetsOpen--;
3571          }
3572  
3573          // Define collapsible classes for fieldsets.
3574          $arialive = '';
3575          $fieldsetclasses = array('clearfix');
3576          if (isset($this->_collapsibleElements[$header->getName()])) {
3577              $fieldsetclasses[] = 'collapsible';
3578              if ($this->_collapsibleElements[$header->getName()]) {
3579                  $fieldsetclasses[] = 'collapsed';
3580              }
3581          }
3582  
3583          // Hide fieldsets not included in the shown only elements.
3584          if (in_array($header->getName(), $this->_nonvisibleelements)) {
3585              $fieldsetclasses[] = 'd-none';
3586          }
3587  
3588          if (isset($this->_advancedElements[$name])){
3589              $fieldsetclasses[] = 'containsadvancedelements';
3590          }
3591  
3592          $openFieldsetTemplate = str_replace('{id}', $id, $this->_openFieldsetTemplate);
3593          $openFieldsetTemplate = str_replace('{classes}', join(' ', $fieldsetclasses), $openFieldsetTemplate);
3594  
3595          $this->_html .= $openFieldsetTemplate . $headerhtml;
3596          $this->_fieldsetsOpen++;
3597      }
3598  
3599      /**
3600       * Return Array of element names that indicate the end of a fieldset
3601       *
3602       * @return array
3603       */
3604      function getStopFieldsetElements(){
3605          return $this->_stopFieldsetElements;
3606      }
3607  }
3608  
3609  /**
3610   * Required elements validation
3611   *
3612   * This class overrides QuickForm validation since it allowed space or empty tag as a value
3613   *
3614   * @package   core_form
3615   * @category  form
3616   * @copyright 2006 Jamie Pratt <me@jamiep.org>
3617   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
3618   */
3619  class MoodleQuickForm_Rule_Required extends HTML_QuickForm_Rule {
3620      /**
3621       * Checks if an element is not empty.
3622       * This is a server-side validation, it works for both text fields and editor fields
3623       *
3624       * @param string $value Value to check
3625       * @param int|string|array $options Not used yet
3626       * @return bool true if value is not empty
3627       */
3628      function validate($value, $options = null) {
3629          global $CFG;
3630          if (is_array($value) && array_key_exists('text', $value)) {
3631              $value = $value['text'];
3632          }
3633          if (is_array($value)) {
3634              // nasty guess - there has to be something in the array, hopefully nobody invents arrays in arrays
3635              $value = implode('', $value);
3636          }
3637          $stripvalues = array(
3638              '#</?(?!img|canvas|hr).*?>#im', // all tags except img, canvas and hr
3639              '#(\xc2\xa0|\s|&nbsp;)#', // Any whitespaces actually.
3640          );
3641          if (!empty($CFG->strictformsrequired)) {
3642              $value = preg_replace($stripvalues, '', (string)$value);
3643          }
3644          if ((string)$value == '') {
3645              return false;
3646          }
3647          return true;
3648      }
3649  
3650      /**
3651       * This function returns Javascript code used to build client-side validation.
3652       * It checks if an element is not empty.
3653       *
3654       * @param int $format format of data which needs to be validated.
3655       * @return array
3656       */
3657      function getValidationScript($format = null) {
3658          global $CFG;
3659          if (!empty($CFG->strictformsrequired)) {
3660              if (!empty($format) && $format == FORMAT_HTML) {
3661                  return array('', "{jsVar}.replace(/(<(?!img|hr|canvas)[^>]*>)|&nbsp;|\s+/ig, '') == ''");
3662              } else {
3663                  return array('', "{jsVar}.replace(/^\s+$/g, '') == ''");
3664              }
3665          } else {
3666              return array('', "{jsVar} == ''");
3667          }
3668      }
3669  }
3670  
3671  /**
3672   * @global object $GLOBALS['_HTML_QuickForm_default_renderer']
3673   * @name $_HTML_QuickForm_default_renderer
3674   */
3675  $GLOBALS['_HTML_QuickForm_default_renderer'] = new MoodleQuickForm_Renderer();
3676  
3677  /** Please keep this list in alphabetical order. */
3678  MoodleQuickForm::registerElementType('advcheckbox', "$CFG->libdir/form/advcheckbox.php", 'MoodleQuickForm_advcheckbox');
3679  MoodleQuickForm::registerElementType('autocomplete', "$CFG->libdir/form/autocomplete.php", 'MoodleQuickForm_autocomplete');
3680  MoodleQuickForm::registerElementType('button', "$CFG->libdir/form/button.php", 'MoodleQuickForm_button');
3681  MoodleQuickForm::registerElementType('cancel', "$CFG->libdir/form/cancel.php", 'MoodleQuickForm_cancel');
3682  MoodleQuickForm::registerElementType('course', "$CFG->libdir/form/course.php", 'MoodleQuickForm_course');
3683  MoodleQuickForm::registerElementType('cohort', "$CFG->libdir/form/cohort.php", 'MoodleQuickForm_cohort');
3684  MoodleQuickForm::registerElementType('searchableselector', "$CFG->libdir/form/searchableselector.php", 'MoodleQuickForm_searchableselector');
3685  MoodleQuickForm::registerElementType('checkbox', "$CFG->libdir/form/checkbox.php", 'MoodleQuickForm_checkbox');
3686  MoodleQuickForm::registerElementType('date_selector', "$CFG->libdir/form/dateselector.php", 'MoodleQuickForm_date_selector');
3687  MoodleQuickForm::registerElementType('date_time_selector', "$CFG->libdir/form/datetimeselector.php", 'MoodleQuickForm_date_time_selector');
3688  MoodleQuickForm::registerElementType('duration', "$CFG->libdir/form/duration.php", 'MoodleQuickForm_duration');
3689  MoodleQuickForm::registerElementType('editor', "$CFG->libdir/form/editor.php", 'MoodleQuickForm_editor');
3690  MoodleQuickForm::registerElementType('filemanager', "$CFG->libdir/form/filemanager.php", 'MoodleQuickForm_filemanager');
3691  MoodleQuickForm::registerElementType('filepicker', "$CFG->libdir/form/filepicker.php", 'MoodleQuickForm_filepicker');
3692  MoodleQuickForm::registerElementType('filetypes', "$CFG->libdir/form/filetypes.php", 'MoodleQuickForm_filetypes');
3693  MoodleQuickForm::registerElementType('float', "$CFG->libdir/form/float.php", 'MoodleQuickForm_float');
3694  MoodleQuickForm::registerElementType('grading', "$CFG->libdir/form/grading.php", 'MoodleQuickForm_grading');
3695  MoodleQuickForm::registerElementType('group', "$CFG->libdir/form/group.php", 'MoodleQuickForm_group');
3696  MoodleQuickForm::registerElementType('header', "$CFG->libdir/form/header.php", 'MoodleQuickForm_header');
3697  MoodleQuickForm::registerElementType('hidden', "$CFG->libdir/form/hidden.php", 'MoodleQuickForm_hidden');
3698  MoodleQuickForm::registerElementType('listing', "$CFG->libdir/form/listing.php", 'MoodleQuickForm_listing');
3699  MoodleQuickForm::registerElementType('defaultcustom', "$CFG->libdir/form/defaultcustom.php", 'MoodleQuickForm_defaultcustom');
3700  MoodleQuickForm::registerElementType('modgrade', "$CFG->libdir/form/modgrade.php", 'MoodleQuickForm_modgrade');
3701  MoodleQuickForm::registerElementType('modvisible', "$CFG->libdir/form/modvisible.php", 'MoodleQuickForm_modvisible');
3702  MoodleQuickForm::registerElementType('password', "$CFG->libdir/form/password.php", 'MoodleQuickForm_password');
3703  MoodleQuickForm::registerElementType('passwordunmask', "$CFG->libdir/form/passwordunmask.php", 'MoodleQuickForm_passwordunmask');
3704  MoodleQuickForm::registerElementType('questioncategory', "$CFG->libdir/form/questioncategory.php", 'MoodleQuickForm_questioncategory');
3705  MoodleQuickForm::registerElementType('radio', "$CFG->libdir/form/radio.php", 'MoodleQuickForm_radio');
3706  MoodleQuickForm::registerElementType('recaptcha', "$CFG->libdir/form/recaptcha.php", 'MoodleQuickForm_recaptcha');
3707  MoodleQuickForm::registerElementType('select', "$CFG->libdir/form/select.php", 'MoodleQuickForm_select');
3708  MoodleQuickForm::registerElementType('selectgroups', "$CFG->libdir/form/selectgroups.php", 'MoodleQuickForm_selectgroups');
3709  MoodleQuickForm::registerElementType('selectwithlink', "$CFG->libdir/form/selectwithlink.php", 'MoodleQuickForm_selectwithlink');
3710  MoodleQuickForm::registerElementType('selectyesno', "$CFG->libdir/form/selectyesno.php", 'MoodleQuickForm_selectyesno');
3711  MoodleQuickForm::registerElementType('static', "$CFG->libdir/form/static.php", 'MoodleQuickForm_static');
3712  MoodleQuickForm::registerElementType('submit', "$CFG->libdir/form/submit.php", 'MoodleQuickForm_submit');
3713  MoodleQuickForm::registerElementType('tags', "$CFG->libdir/form/tags.php", 'MoodleQuickForm_tags');
3714  MoodleQuickForm::registerElementType('text', "$CFG->libdir/form/text.php", 'MoodleQuickForm_text');
3715  MoodleQuickForm::registerElementType('textarea', "$CFG->libdir/form/textarea.php", 'MoodleQuickForm_textarea');
3716  MoodleQuickForm::registerElementType('url', "$CFG->libdir/form/url.php", 'MoodleQuickForm_url');
3717  MoodleQuickForm::registerElementType('warning', "$CFG->libdir/form/warning.php", 'MoodleQuickForm_warning');
3718  
3719  MoodleQuickForm::registerRule('required', null, 'MoodleQuickForm_Rule_Required', "$CFG->libdir/formslib.php");