mirror of
https://github.com/moodle/moodle.git
synced 2025-08-05 00:46:50 +02:00
110 lines
4.4 KiB
PHP
110 lines
4.4 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/>.
|
|
|
|
/**
|
|
* Generator for the core_contentbank subsystem.
|
|
*
|
|
* @package core_contentbank
|
|
* @category test
|
|
* @copyright 2020 Sara Arjona <sara@moodle.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
use core_contentbank\content;
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
global $CFG;
|
|
require_once($CFG->dirroot . '/contentbank/tests/fixtures/testable_contenttype.php');
|
|
|
|
/**
|
|
* Generator for the core_contentbank subsystem.
|
|
*
|
|
* @package core_contentbank
|
|
* @copyright 2020 Sara Arjona <sara@moodle.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class core_contentbank_generator extends \component_generator_base {
|
|
|
|
/**
|
|
* Populate contentbank database tables with relevant data to simulate the process of adding items to the content bank.
|
|
*
|
|
* @param string $contenttype Content bank plugin type to add. If none is defined, contenttype_testable is used.
|
|
* @param int $itemstocreate Number of items to add to the content bank.
|
|
* @param int $userid The user identifier creating the content.
|
|
* @param context $context The context where the content will be created.
|
|
* @param bool $convert2class Whether the class should return stdClass or plugin instance.
|
|
* @param string $filepath The filepath of the file associated to the content to create.
|
|
* @param string $contentname The name of the content that will be created.
|
|
* @param int $visibility The visibility of the content that will be created.
|
|
* @return array An array with all the records added to the content bank.
|
|
*/
|
|
public function generate_contentbank_data(?string $contenttype, int $itemstocreate = 1, int $userid = 0,
|
|
?\context $context = null, bool $convert2class = true, string $filepath = 'contentfile.h5p',
|
|
string $contentname = 'Test content ', int $visibility = content::VISIBILITY_PUBLIC): array {
|
|
global $DB, $USER;
|
|
|
|
$records = [];
|
|
|
|
$contenttype = $contenttype ?? 'contenttype_testable';
|
|
$contenttypeclass = "\\$contenttype\\contenttype";
|
|
if (!class_exists($contenttypeclass)) {
|
|
// Early return with empty array because the contenttype doesn't exist.
|
|
return $records;
|
|
}
|
|
if (empty($context)) {
|
|
$context = \context_system::instance();
|
|
}
|
|
$type = new $contenttypeclass($context);
|
|
$fs = get_file_storage();
|
|
for ($i = 0; $i < $itemstocreate; $i++) {
|
|
// Create content.
|
|
$record = new stdClass();
|
|
// If only 1 item is being created, do not add a number suffix to the content name.
|
|
$record->name = ($itemstocreate === 1) ? $contentname : $contentname . $i;
|
|
$record->configdata = '';
|
|
$record->usercreated = $userid ?? $USER->id;
|
|
$record->visibility = $visibility;
|
|
|
|
$content = $type->create_content($record);
|
|
$record = $content->get_content();
|
|
|
|
// Create a dummy file.
|
|
$filerecord = array(
|
|
'contextid' => $context->id,
|
|
'component' => 'contentbank',
|
|
'filearea' => 'public',
|
|
'itemid' => $record->id,
|
|
'filepath' => '/',
|
|
'filename' => basename($filepath)
|
|
);
|
|
if (file_exists($filepath)) {
|
|
$fs->create_file_from_pathname($filerecord, $filepath);
|
|
} else {
|
|
$fs->create_file_from_string($filerecord, 'Dummy content ' . $i);
|
|
}
|
|
|
|
// Prepare the return value.
|
|
if ($convert2class) {
|
|
$records[$record->id] = $content;
|
|
} else {
|
|
$records[$record->id] = $record;
|
|
}
|
|
}
|
|
|
|
return $records;
|
|
}
|
|
}
|