Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.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_imscp data generator.
  19   *
  20   * @package    mod_imscp
  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_imscp data generator class.
  30   *
  31   * @package    mod_imscp
  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_imscp_generator extends testing_module_generator {
  37  
  38      public function create_instance($record = null, array $options = null) {
  39          global $CFG, $USER;
  40  
  41          // Add default values for imscp.
  42          $record = (array)$record + array(
  43              'package' => '',
  44              'packagepath' => $CFG->dirroot.'/mod/imscp/tests/packages/singlescobasic.zip',
  45              'keepold' => -1
  46          );
  47  
  48          // The 'package' value corresponds to the draft file area ID. If not specified, create from packagepath.
  49          if (empty($record['package'])) {
  50              if (!isloggedin() || isguestuser()) {
  51                  throw new coding_exception('IMSCP generator requires a current user');
  52              }
  53              if (!file_exists($record['packagepath'])) {
  54                  throw new coding_exception("File {$record['packagepath']} does not exist");
  55              }
  56              $usercontext = context_user::instance($USER->id);
  57  
  58              // Pick a random context id for specified user.
  59              $record['package'] = file_get_unused_draft_itemid();
  60  
  61              // Add actual file there.
  62              $filerecord = array('component' => 'user', 'filearea' => 'draft',
  63                      'contextid' => $usercontext->id, 'itemid' => $record['package'],
  64                      'filename' => basename($record['packagepath']), 'filepath' => '/');
  65              $fs = get_file_storage();
  66              $fs->create_file_from_pathname($filerecord, $record['packagepath']);
  67          }
  68  
  69          return parent::create_instance($record, (array)$options);
  70      }
  71  }