You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
375 lines
12 KiB
375 lines
12 KiB
<?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/>.
|
|
|
|
/**
|
|
* mod_forum data generator
|
|
*
|
|
* @package mod_forum
|
|
* @category test
|
|
* @copyright 2012 Petr Skoda {@link http://skodak.org}
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
|
|
/**
|
|
* Forum module data generator class
|
|
*
|
|
* @package mod_forum
|
|
* @category test
|
|
* @copyright 2012 Petr Skoda {@link http://skodak.org}
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class mod_forum_generator extends testing_module_generator {
|
|
|
|
/**
|
|
* @var int keep track of how many forum discussions have been created.
|
|
*/
|
|
protected $forumdiscussioncount = 0;
|
|
|
|
/**
|
|
* @var int keep track of how many forum posts have been created.
|
|
*/
|
|
protected $forumpostcount = 0;
|
|
|
|
/**
|
|
* @var int keep track of how many forum subscriptions have been created.
|
|
*/
|
|
protected $forumsubscriptionscount = 0;
|
|
|
|
/**
|
|
* To be called from data reset code only,
|
|
* do not use in tests.
|
|
* @return void
|
|
*/
|
|
public function reset() {
|
|
$this->forumdiscussioncount = 0;
|
|
$this->forumpostcount = 0;
|
|
$this->forumsubscriptionscount = 0;
|
|
|
|
parent::reset();
|
|
}
|
|
|
|
public function create_instance($record = null, array $options = null) {
|
|
global $CFG;
|
|
require_once($CFG->dirroot.'/mod/forum/lib.php');
|
|
$record = (object)(array)$record;
|
|
|
|
if (!isset($record->type)) {
|
|
$record->type = 'general';
|
|
}
|
|
if (!isset($record->assessed)) {
|
|
$record->assessed = 0;
|
|
}
|
|
if (!isset($record->scale)) {
|
|
$record->scale = 0;
|
|
}
|
|
if (!isset($record->forcesubscribe)) {
|
|
$record->forcesubscribe = FORUM_CHOOSESUBSCRIBE;
|
|
}
|
|
|
|
return parent::create_instance($record, (array)$options);
|
|
}
|
|
|
|
/**
|
|
* Function to create a dummy subscription.
|
|
*
|
|
* @param array|stdClass $record
|
|
* @return stdClass the subscription object
|
|
*/
|
|
public function create_subscription($record = null) {
|
|
global $DB;
|
|
|
|
// Increment the forum subscription count.
|
|
$this->forumsubscriptionscount++;
|
|
|
|
$record = (array)$record;
|
|
|
|
if (!isset($record['course'])) {
|
|
throw new coding_exception('course must be present in phpunit_util::create_subscription() $record');
|
|
}
|
|
|
|
if (!isset($record['forum'])) {
|
|
throw new coding_exception('forum must be present in phpunit_util::create_subscription() $record');
|
|
}
|
|
|
|
if (!isset($record['userid'])) {
|
|
throw new coding_exception('userid must be present in phpunit_util::create_subscription() $record');
|
|
}
|
|
|
|
$record = (object)$record;
|
|
|
|
// Add the subscription.
|
|
$record->id = $DB->insert_record('forum_subscriptions', $record);
|
|
|
|
return $record;
|
|
}
|
|
|
|
/**
|
|
* Function to create a dummy discussion.
|
|
*
|
|
* @param array|stdClass $record
|
|
* @return stdClass the discussion object
|
|
*/
|
|
public function create_discussion($record = null) {
|
|
global $DB;
|
|
|
|
// Increment the forum discussion count.
|
|
$this->forumdiscussioncount++;
|
|
|
|
$record = (array) $record;
|
|
|
|
if (!isset($record['course'])) {
|
|
throw new coding_exception('course must be present in phpunit_util::create_discussion() $record');
|
|
}
|
|
|
|
if (!isset($record['forum'])) {
|
|
throw new coding_exception('forum must be present in phpunit_util::create_discussion() $record');
|
|
}
|
|
|
|
if (!isset($record['userid'])) {
|
|
throw new coding_exception('userid must be present in phpunit_util::create_discussion() $record');
|
|
}
|
|
|
|
if (!isset($record['name'])) {
|
|
$record['name'] = "Discussion " . $this->forumdiscussioncount;
|
|
}
|
|
|
|
if (!isset($record['subject'])) {
|
|
$record['subject'] = "Subject for discussion " . $this->forumdiscussioncount;
|
|
}
|
|
|
|
if (!isset($record['message'])) {
|
|
$record['message'] = html_writer::tag('p', 'Message for discussion ' . $this->forumdiscussioncount);
|
|
}
|
|
|
|
if (!isset($record['messageformat'])) {
|
|
$record['messageformat'] = editors_get_preferred_format();
|
|
}
|
|
|
|
if (!isset($record['messagetrust'])) {
|
|
$record['messagetrust'] = "";
|
|
}
|
|
|
|
if (!isset($record['assessed'])) {
|
|
$record['assessed'] = '1';
|
|
}
|
|
|
|
if (!isset($record['groupid'])) {
|
|
$record['groupid'] = "-1";
|
|
}
|
|
|
|
if (!isset($record['timestart'])) {
|
|
$record['timestart'] = "0";
|
|
}
|
|
|
|
if (!isset($record['timeend'])) {
|
|
$record['timeend'] = "0";
|
|
}
|
|
|
|
if (!isset($record['mailnow'])) {
|
|
$record['mailnow'] = "0";
|
|
}
|
|
|
|
if (isset($record['timemodified'])) {
|
|
$timemodified = $record['timemodified'];
|
|
}
|
|
|
|
if (!isset($record['pinned'])) {
|
|
$record['pinned'] = FORUM_DISCUSSION_UNPINNED;
|
|
}
|
|
|
|
if (!isset($record['timelocked'])) {
|
|
$record['timelocked'] = 0;
|
|
}
|
|
|
|
if (isset($record['mailed'])) {
|
|
$mailed = $record['mailed'];
|
|
}
|
|
|
|
$record = (object) $record;
|
|
|
|
// Add the discussion.
|
|
$record->id = forum_add_discussion($record, null, null, $record->userid);
|
|
|
|
$post = $DB->get_record('forum_posts', array('discussion' => $record->id));
|
|
|
|
if (isset($timemodified) || isset($mailed)) {
|
|
if (isset($mailed)) {
|
|
$post->mailed = $mailed;
|
|
}
|
|
|
|
if (isset($timemodified)) {
|
|
// Enforce the time modified.
|
|
$record->timemodified = $timemodified;
|
|
$post->modified = $post->created = $timemodified;
|
|
|
|
$DB->update_record('forum_discussions', $record);
|
|
}
|
|
|
|
$DB->update_record('forum_posts', $post);
|
|
}
|
|
|
|
if (property_exists($record, 'tags')) {
|
|
$cm = get_coursemodule_from_instance('forum', $record->forum);
|
|
$tags = is_array($record->tags) ? $record->tags : preg_split('/,/', $record->tags);
|
|
|
|
core_tag_tag::set_item_tags('mod_forum', 'forum_posts', $post->id,
|
|
context_module::instance($cm->id), $tags);
|
|
}
|
|
|
|
return $record;
|
|
}
|
|
|
|
/**
|
|
* Function to create a dummy post.
|
|
*
|
|
* @param array|stdClass $record
|
|
* @return stdClass the post object
|
|
*/
|
|
public function create_post($record = null) {
|
|
global $DB;
|
|
|
|
// Increment the forum post count.
|
|
$this->forumpostcount++;
|
|
|
|
// Variable to store time.
|
|
$time = time() + $this->forumpostcount;
|
|
|
|
$record = (array) $record;
|
|
|
|
if (!isset($record['discussion'])) {
|
|
throw new coding_exception('discussion must be present in phpunit_util::create_post() $record');
|
|
}
|
|
|
|
if (!isset($record['userid'])) {
|
|
throw new coding_exception('userid must be present in phpunit_util::create_post() $record');
|
|
}
|
|
|
|
if (!isset($record['parent'])) {
|
|
$record['parent'] = 0;
|
|
}
|
|
|
|
if (!isset($record['subject'])) {
|
|
$record['subject'] = 'Forum post subject ' . $this->forumpostcount;
|
|
}
|
|
|
|
if (!isset($record['message'])) {
|
|
$record['message'] = html_writer::tag('p', 'Forum message post ' . $this->forumpostcount);
|
|
}
|
|
|
|
if (!isset($record['created'])) {
|
|
$record['created'] = $time;
|
|
}
|
|
|
|
if (!isset($record['modified'])) {
|
|
$record['modified'] = $time;
|
|
}
|
|
|
|
if (!isset($record['mailed'])) {
|
|
$record['mailed'] = 0;
|
|
}
|
|
|
|
if (!isset($record['messageformat'])) {
|
|
$record['messageformat'] = 0;
|
|
}
|
|
|
|
if (!isset($record['messagetrust'])) {
|
|
$record['messagetrust'] = 0;
|
|
}
|
|
|
|
if (!isset($record['attachment'])) {
|
|
$record['attachment'] = "";
|
|
}
|
|
|
|
if (!isset($record['totalscore'])) {
|
|
$record['totalscore'] = 0;
|
|
}
|
|
|
|
if (!isset($record['mailnow'])) {
|
|
$record['mailnow'] = 0;
|
|
}
|
|
|
|
if (!isset($record['deleted'])) {
|
|
$record['deleted'] = 0;
|
|
}
|
|
|
|
if (!isset($record['privatereplyto'])) {
|
|
$record['privatereplyto'] = 0;
|
|
}
|
|
|
|
$record = (object) $record;
|
|
|
|
// Add the post.
|
|
$record->id = $DB->insert_record('forum_posts', $record);
|
|
|
|
if (property_exists($record, 'tags')) {
|
|
$discussion = $DB->get_record('forum_discussions', ['id' => $record->discussion]);
|
|
$cm = get_coursemodule_from_instance('forum', $discussion->forum);
|
|
$tags = is_array($record->tags) ? $record->tags : preg_split('/,/', $record->tags);
|
|
|
|
core_tag_tag::set_item_tags('mod_forum', 'forum_posts', $record->id,
|
|
context_module::instance($cm->id), $tags);
|
|
}
|
|
|
|
// Update the last post.
|
|
forum_discussion_update_last_post($record->discussion);
|
|
|
|
return $record;
|
|
}
|
|
|
|
public function create_content($instance, $record = array()) {
|
|
global $USER, $DB;
|
|
$record = (array)$record + array(
|
|
'forum' => $instance->id,
|
|
'userid' => $USER->id,
|
|
'course' => $instance->course
|
|
);
|
|
if (empty($record['discussion']) && empty($record['parent'])) {
|
|
// Create discussion.
|
|
$discussion = $this->create_discussion($record);
|
|
$post = $DB->get_record('forum_posts', array('id' => $discussion->firstpost));
|
|
} else {
|
|
// Create post.
|
|
if (empty($record['parent'])) {
|
|
$record['parent'] = $DB->get_field('forum_discussions', 'firstpost', array('id' => $record['discussion']), MUST_EXIST);
|
|
} else if (empty($record['discussion'])) {
|
|
$record['discussion'] = $DB->get_field('forum_posts', 'discussion', array('id' => $record['parent']), MUST_EXIST);
|
|
}
|
|
$post = $this->create_post($record);
|
|
}
|
|
return $post;
|
|
}
|
|
|
|
/**
|
|
* Extracted from exporter/post.php
|
|
*
|
|
* Get the HTML to display as a subheading in a post.
|
|
*
|
|
* @param stdClass $exportedauthor The exported author object
|
|
* @param int $timecreated The post time created timestamp if it's to be displayed
|
|
* @return string
|
|
*/
|
|
public function get_author_subheading_html(stdClass $exportedauthor, int $timecreated) : string {
|
|
$fullname = $exportedauthor->fullname;
|
|
$profileurl = $exportedauthor->urls['profile'] ?? null;
|
|
$formatteddate = userdate($timecreated, get_string('strftimedaydatetime', 'core_langconfig'));
|
|
$name = $profileurl ? "<a href=\"{$profileurl}\">{$fullname}</a>" : $fullname;
|
|
$date = "<time>{$formatteddate}</time>";
|
|
return get_string('bynameondate', 'mod_forum', ['name' => $name, 'date' => $date]);
|
|
}
|
|
}
|
|
|