[Summary view]

Differences Between: [Versions 311 and 401] [Versions 311 and 402] [Versions 311 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   * Component generator base class.
  19   *
  20   * @package   core
  21   * @category  test
  22   * @copyright 2013 The Open University
  23   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   */
  25  
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  /**
  29   * Component generator base class.
  30   *
  31   * Extend in path/to/component/tests/generator/lib.php as
  32   * class type_plugin_generator extends component_generator_base
  33   * Note that there are more specific classes to extend for mods and blocks.
  34   *
  35   * @copyright 2013 The Open University
  36   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  37   */
  38  abstract class component_generator_base {
  39  
  40      /**
  41       * @var testing_data_generator
  42       */
  43      protected $datagenerator;
  44  
  45      /**
  46       * Constructor.
  47       * @param testing_data_generator $datagenerator
  48       */
  49      public function __construct(testing_data_generator $datagenerator) {
  50          $this->datagenerator = $datagenerator;
  51      }
  52  
  53      /**
  54       * To be called from data reset code only,
  55       * do not use in tests.
  56       * @return void
  57       */
  58      public function reset() {
  59      }
  60  
  61      /**
  62       * Set the current user during data generation.
  63       *
  64       * This should be avoided wherever possible, but in some situations underlying code will insert data as the current
  65       * user.
  66       *
  67       * @param stdClass $user
  68       */
  69      protected function set_user(?stdClass $user = null): void {
  70          global $CFG, $DB;
  71  
  72          if ($user === null) {
  73              $user = (object) [
  74                  'id' => 0,
  75                  'mnethostid' => $CFG->mnet_localhost_id,
  76              ];
  77          } else {
  78              $user = clone($user);
  79              unset($user->description);
  80              unset($user->access);
  81              unset($user->preference);
  82          }
  83  
  84          // Ensure session is empty, as it may contain caches and user-specific info.
  85          \core\session\manager::init_empty_session();
  86  
  87          \core\session\manager::set_user($user);
  88      }
  89  }