Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.3.x will end 7 October 2024 (12 months).
  • Bug fixes for security issues in 4.3.x will end 21 April 2025 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.2.x is supported too.
   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   * mod_survey data generator.
  19   *
  20   * @package    mod_survey
  21   * @category   test
  22   * @copyright  2013 Marina Glancy
  23   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   */
  25  
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  /**
  29   * mod_survey data generator class.
  30   *
  31   * @package    mod_survey
  32   * @category   test
  33   * @copyright  2013 Marina Glancy
  34   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35   */
  36  class mod_survey_generator extends testing_module_generator {
  37  
  38      /**
  39       * Cached list of available templates.
  40       * @var array
  41       */
  42      private $templates = null;
  43  
  44      public function reset() {
  45          $this->templates = null;
  46          parent::reset();
  47      }
  48  
  49      public function create_instance($record = null, array $options = null) {
  50          global $DB;
  51  
  52          if ($this->templates === null) {
  53              $this->templates = $DB->get_records_menu('survey', array('template' => 0), 'name', 'id, name');
  54          }
  55          if (empty($this->templates)) {
  56              throw new moodle_exception('cannotfindsurveytmpt', 'survey');
  57          }
  58          $record = (array)$record;
  59          if (isset($record['template']) && !is_number($record['template'])) {
  60              // Substitute template name with template id.
  61              $record['template'] = array_search($record['template'], $this->templates);
  62          }
  63          if (isset($record['template']) && !array_key_exists($record['template'], $this->templates)) {
  64              throw new moodle_exception('cannotfindsurveytmpt', 'survey');
  65          }
  66  
  67          // Add default values for survey.
  68          if (!isset($record['template'])) {
  69              reset($this->templates);
  70              $record['template'] = key($this->templates);
  71          }
  72  
  73          return parent::create_instance($record, (array)$options);
  74      }
  75  }