Andrew Nicols
90 lines
2.6 KiB
PHP
90 lines
2.6 KiB
PHP
<?php
|
|
// This file is part of Moodle - http://moodle.org/
|
|
//
|
|
// Moodle is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// Moodle is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
/**
|
|
* Component generator base class.
|
|
*
|
|
* @package core
|
|
* @category test
|
|
* @copyright 2013 The Open University
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
/**
|
|
* Component generator base class.
|
|
*
|
|
* Extend in path/to/component/tests/generator/lib.php as
|
|
* class type_plugin_generator extends component_generator_base
|
|
* Note that there are more specific classes to extend for mods and blocks.
|
|
*
|
|
* @copyright 2013 The Open University
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
abstract class component_generator_base {
|
|
|
|
/**
|
|
* @var testing_data_generator
|
|
*/
|
|
protected $datagenerator;
|
|
|
|
/**
|
|
* Constructor.
|
|
* @param testing_data_generator $datagenerator
|
|
*/
|
|
public function __construct(testing_data_generator $datagenerator) {
|
|
$this->datagenerator = $datagenerator;
|
|
}
|
|
|
|
/**
|
|
* To be called from data reset code only,
|
|
* do not use in tests.
|
|
* @return void
|
|
*/
|
|
public function reset() {
|
|
}
|
|
|
|
/**
|
|
* Set the current user during data generation.
|
|
*
|
|
* This should be avoided wherever possible, but in some situations underlying code will insert data as the current
|
|
* user.
|
|
*
|
|
* @param stdClass $user
|
|
*/
|
|
protected function set_user(?stdClass $user = null): void {
|
|
global $CFG, $DB;
|
|
|
|
if ($user === null) {
|
|
$user = (object) [
|
|
'id' => 0,
|
|
'mnethostid' => $CFG->mnet_localhost_id,
|
|
];
|
|
} else {
|
|
$user = clone($user);
|
|
unset($user->description);
|
|
unset($user->access);
|
|
unset($user->preference);
|
|
}
|
|
|
|
// Ensure session is empty, as it may contain caches and user-specific info.
|
|
\core\session\manager::init_empty_session();
|
|
|
|
\core\session\manager::set_user($user);
|
|
}
|
|
}
|