<?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/>.
/**
* @package mod_forum
* @copyright 2014 Andrew Robert Nicols <andrew@nicols.co.uk>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
// Deprecated a very long time ago.
/**
* @deprecated since Moodle 1.1 - please do not use this function any more.
*/
function forum_count_unrated_posts() {
throw new coding_exception(__FUNCTION__ . '() can not be used any more.');
}
// Since Moodle 1.5.
/**
* @deprecated since Moodle 1.5 - please do not use this function any more.
*/
function forum_tp_count_discussion_read_records() {
throw new coding_exception(__FUNCTION__ . '() can not be used any more.');
}
/**
* @deprecated since Moodle 1.5 - please do not use this function any more.
*/
function forum_get_user_discussions() {
throw new coding_exception(__FUNCTION__ . '() can not be used any more.');
}
// Since Moodle 1.6.
/**
* @deprecated since Moodle 1.6 - please do not use this function any more.
*/
function forum_tp_count_forum_posts() {
throw new coding_exception(__FUNCTION__ . '() can not be used any more.');
}
/**
* @deprecated since Moodle 1.6 - please do not use this function any more.
*/
function forum_tp_count_forum_read_records() {
throw new coding_exception(__FUNCTION__ . '() can not be used any more.');
}
// Since Moodle 1.7.
/**
* @deprecated since Moodle 1.7 - please do not use this function any more.
*/
function forum_get_open_modes() {
throw new coding_exception(__FUNCTION__ . '() can not be used any more.');
}
// Since Moodle 1.9.
/**
* @deprecated since Moodle 1.9 MDL-13303 - please do not use this function any more.
*/
function forum_get_child_posts() {
throw new coding_exception(__FUNCTION__ . '() can not be used any more.');
}
/**
* @deprecated since Moodle 1.9 MDL-13303 - please do not use this function any more.
*/
function forum_get_discussion_posts() {
throw new coding_exception(__FUNCTION__ . '() can not be used any more.');
}
// Since Moodle 2.0.
/**
* @deprecated since Moodle 2.0 MDL-21657 - please do not use this function any more.
*/
function forum_get_ratings() {
throw new coding_exception(__FUNCTION__ . '() can not be used any more.');
}
/**
* @deprecated since Moodle 2.0 MDL-14632 - please do not use this function any more.
*/
function forum_get_tracking_link() {
throw new coding_exception(__FUNCTION__ . '() can not be used any more.');
}
/**
* @deprecated since Moodle 2.0 MDL-14113 - please do not use this function any more.
*/
function forum_tp_count_discussion_unread_posts() {
throw new coding_exception(__FUNCTION__ . '() can not be used any more.');
}
/**
* @deprecated since Moodle 2.0 MDL-23479 - please do not use this function any more.
*/
function forum_convert_to_roles() {
throw new coding_exception(__FUNCTION__ . '() can not be used any more.');
}
/**
* @deprecated since Moodle 2.0 MDL-14113 - please do not use this function any more.
*/
function forum_tp_get_read_records() {
throw new coding_exception(__FUNCTION__ . '() can not be used any more.');
}
/**
* @deprecated since Moodle 2.0 MDL-14113 - please do not use this function any more.
*/
function forum_tp_get_discussion_read_records() {
throw new coding_exception(__FUNCTION__ . '() can not be used any more.');
}
// Deprecated in 2.3.
/**
* @deprecated since Moodle 2.3 MDL-33166 - please do not use this function any more.
*/
function forum_user_enrolled() {
throw new coding_exception(__FUNCTION__ . '() can not be used any more.');
}
// Deprecated in 2.4.
/**
* @deprecated since Moodle 2.4 use forum_user_can_see_post() instead
*/
function forum_user_can_view_post() {
throw new coding_exception(__FUNCTION__ . '() can not be used any more.');
}
// Deprecated in 2.6.
/**
* FORUM_TRACKING_ON - deprecated alias for FORUM_TRACKING_FORCED.
* @deprecated since 2.6
*/
define('FORUM_TRACKING_ON', 2);
/**
* @deprecated since Moodle 2.6
* @see shorten_text()
*/
function forum_shorten_post($message) {
throw new coding_exception(__FUNCTION__ . '() can not be used any more. '
. 'Please use shorten_text($message, $CFG->forum_shortpost) instead.');
}
// Deprecated in 2.8.
/**
* @deprecated since Moodle 2.8 use \mod_forum\subscriptions::is_subscribed() instead
*/
function forum_is_subscribed() {
throw new coding_exception(__FUNCTION__ . '() can not be used any more.');
}
/**
* @deprecated since Moodle 2.8 use \mod_forum\subscriptions::subscribe_user() instead
*/
function forum_subscribe() {
throw new coding_exception(__FUNCTION__ . '() can not be used any more. Please use '
. \mod_forum\subscriptions::class . '::subscribe_user() instead');
}
/**
* @deprecated since Moodle 2.8 use \mod_forum\subscriptions::unsubscribe_user() instead
*/
function forum_unsubscribe() {
throw new coding_exception(__FUNCTION__ . '() can not be used any more. Please use '
. \mod_forum\subscriptions::class . '::unsubscribe_user() instead');
}
/**
* @deprecated since Moodle 2.8 use \mod_forum\subscriptions::fetch_subscribed_users() instead
*/
function forum_subscribed_users() {
throw new coding_exception(__FUNCTION__ . '() can not be used any more. Please use '
. \mod_forum\subscriptions::class . '::fetch_subscribed_users() instead');
}
/**
* Determine whether the forum is force subscribed.
*
* @deprecated since Moodle 2.8 use \mod_forum\subscriptions::is_forcesubscribed() instead
*/
function forum_is_forcesubscribed($forum) {
throw new coding_exception(__FUNCTION__ . '() can not be used any more. Please use '
. \mod_forum\subscriptions::class . '::is_forcesubscribed() instead');
}
/**
* @deprecated since Moodle 2.8 use \mod_forum\subscriptions::set_subscription_mode() instead
*/
function forum_forcesubscribe($forumid, $value = 1) {
throw new coding_exception(__FUNCTION__ . '() can not be used any more. Please use '
. \mod_forum\subscriptions::class . '::set_subscription_mode() instead');
}
/**
* @deprecated since Moodle 2.8 use \mod_forum\subscriptions::get_subscription_mode() instead
*/
function forum_get_forcesubscribed($forum) {
throw new coding_exception(__FUNCTION__ . '() can not be used any more. Please use '
. \mod_forum\subscriptions::class . '::set_subscription_mode() instead');
}
/**
* @deprecated since Moodle 2.8 use \mod_forum\subscriptions::is_subscribed in combination wtih
* \mod_forum\subscriptions::fill_subscription_cache_for_course instead.
*/
function forum_get_subscribed_forums() {
throw new coding_exception(__FUNCTION__ . '() can not be used any more. Please use '
. \mod_forum\subscriptions::class . '::is_subscribed(), and '
. \mod_forum\subscriptions::class . '::fill_subscription_cache_for_course() instead');
}
/**
* @deprecated since Moodle 2.8 use \mod_forum\subscriptions::get_unsubscribable_forums() instead
*/
function forum_get_optional_subscribed_forums() {
throw new coding_exception(__FUNCTION__ . '() can not be used any more. Please use '
. \mod_forum\subscriptions::class . '::get_unsubscribable_forums() instead');
}
/**
* @deprecated since Moodle 2.8 use \mod_forum\subscriptions::get_potential_subscribers() instead
*/
function forum_get_potential_subscribers() {
throw new coding_exception(__FUNCTION__ . '() can not be used any more. Please use '
. \mod_forum\subscriptions::class . '::get_potential_subscribers() instead');
}
/**
< * Builds and returns the body of the email notification in plain text.
< *
< * @uses CONTEXT_MODULE
< * @param object $course
< * @param object $cm
< * @param object $forum
< * @param object $discussion
< * @param object $post
< * @param object $userfrom
< * @param object $userto
< * @param boolean $bare
< * @param string $replyaddress The inbound address that a user can reply to the generated e-mail with. [Since 2.8].
< * @return string The email body in plain text format.
* @deprecated since Moodle 3.0 use \mod_forum\output\forum_post_email instead
*/
< function forum_make_mail_text($course, $cm, $forum, $discussion, $post, $userfrom, $userto, $bare = false, $replyaddress = null) {
< global $PAGE;
< $renderable = new \mod_forum\output\forum_post_email(
< $course,
< $cm,
< $forum,
< $discussion,
< $post,
< $userfrom,
< $userto,
< forum_user_can_post($forum, $discussion, $userto, $cm, $course)
< );
<
< $modcontext = context_module::instance($cm->id);
< $renderable->viewfullnames = has_capability('moodle/site:viewfullnames', $modcontext, $userto->id);
<
< if ($bare) {
< $renderer = $PAGE->get_renderer('mod_forum', 'emaildigestfull', 'textemail');
< } else {
< $renderer = $PAGE->get_renderer('mod_forum', 'email', 'textemail');
< }
<
< debugging("forum_make_mail_text() has been deprecated, please use the \mod_forum\output\forum_post_email renderable instead.",
< DEBUG_DEVELOPER);
<
< return $renderer->render($renderable);
> function forum_make_mail_text() {
> throw new coding_exception(__FUNCTION__ . '() can not be used any more. Please use '
> . '\mod_forum\output\forum_post_email');
}
/**
< * Builds and returns the body of the email notification in html format.
< *
< * @param object $course
< * @param object $cm
< * @param object $forum
< * @param object $discussion
< * @param object $post
< * @param object $userfrom
< * @param object $userto
< * @param string $replyaddress The inbound address that a user can reply to the generated e-mail with. [Since 2.8].
< * @return string The email text in HTML format
* @deprecated since Moodle 3.0 use \mod_forum\output\forum_post_email instead
*/
< function forum_make_mail_html($course, $cm, $forum, $discussion, $post, $userfrom, $userto, $replyaddress = null) {
< return forum_make_mail_post($course,
< $cm,
< $forum,
< $discussion,
< $post,
< $userfrom,
< $userto,
< forum_user_can_post($forum, $discussion, $userto, $cm, $course)
< );
> function forum_make_mail_html() {
> throw new coding_exception(__FUNCTION__ . '() can not be used any more. Please use '
> . '\mod_forum\output\forum_post_email');
}
/**
< * Given the data about a posting, builds up the HTML to display it and
< * returns the HTML in a string. This is designed for sending via HTML email.
< *
< * @param object $course
< * @param object $cm
< * @param object $forum
< * @param object $discussion
< * @param object $post
< * @param object $userfrom
< * @param object $userto
< * @param bool $ownpost
< * @param bool $reply
< * @param bool $link
< * @param bool $rate
< * @param string $footer
< * @return string
* @deprecated since Moodle 3.0 use \mod_forum\output\forum_post_email instead
*/
< function forum_make_mail_post($course, $cm, $forum, $discussion, $post, $userfrom, $userto,
< $ownpost=false, $reply=false, $link=false, $rate=false, $footer="") {
< global $PAGE;
< $renderable = new \mod_forum\output\forum_post_email(
< $course,
< $cm,
< $forum,
< $discussion,
< $post,
< $userfrom,
< $userto,
< $reply);
<
< $modcontext = context_module::instance($cm->id);
< $renderable->viewfullnames = has_capability('moodle/site:viewfullnames', $modcontext, $userto->id);
<
< // Assume that this is being used as a standard forum email.
< $renderer = $PAGE->get_renderer('mod_forum', 'email', 'htmlemail');
<
< debugging("forum_make_mail_post() has been deprecated, please use the \mod_forum\output\forum_post_email renderable instead.",
< DEBUG_DEVELOPER);
<
< return $renderer->render($renderable);
> function forum_make_mail_post() {
> throw new coding_exception(__FUNCTION__ . '() can not be used any more. Please use '
> . '\mod_forum\output\forum_post_email');
}
/**
< * Removes properties from user record that are not necessary for sending post notifications.
< *
< * @param stdClass $user
< * @return void, $user parameter is modified
* @deprecated since Moodle 3.7
*/
< function forum_cron_minimise_user_record(stdClass $user) {
< debugging("forum_cron_minimise_user_record() has been deprecated and has not been replaced.",
< DEBUG_DEVELOPER);
<
< // We store large amount of users in one huge array,
< // make sure we do not store info there we do not actually need
< // in mail generation code or messaging.
<
< unset($user->institution);
< unset($user->department);
< unset($user->address);
< unset($user->city);
< unset($user->currentlogin);
< unset($user->description);
< unset($user->descriptionformat);
> function forum_cron_minimise_user_record() {
> throw new coding_exception(__FUNCTION__ . '() can not be used any more. It has not been replaced.');
}
/**
< * Function to be run periodically according to the scheduled task.
< *
< * Finds all posts that have yet to be mailed out, and mails them out to all subscribers as well as other maintance
< * tasks.
< *
* @deprecated since Moodle 3.7
*/
function forum_cron() {
< debugging("forum_cron() has been deprecated and replaced with new tasks. Please uses these instead.",
< DEBUG_DEVELOPER);
> throw new coding_exception(__FUNCTION__ . '() can not be used any more. Please use the forum tasks');
}
/**
< * Prints a forum discussion
< *
< * @uses CONTEXT_MODULE
< * @uses FORUM_MODE_FLATNEWEST
< * @uses FORUM_MODE_FLATOLDEST
< * @uses FORUM_MODE_THREADED
< * @uses FORUM_MODE_NESTED
< * @param stdClass $course
< * @param stdClass $cm
< * @param stdClass $forum
< * @param stdClass $discussion
< * @param stdClass $post
< * @param int $mode
< * @param mixed $canreply
< * @param bool $canrate
* @deprecated since Moodle 3.7
*/
< function forum_print_discussion($course, $cm, $forum, $discussion, $post, $mode, $canreply=NULL, $canrate=false) {
< debugging('forum_print_discussion() has been deprecated, ' .
< 'please use \mod_forum\local\renderers\discussion instead.', DEBUG_DEVELOPER);
<
< global $USER, $CFG;
<
< require_once($CFG->dirroot.'/rating/lib.php');
<
< $ownpost = (isloggedin() && $USER->id == $post->userid);
<
< $modcontext = context_module::instance($cm->id);
< if ($canreply === NULL) {
< $reply = forum_user_can_post($forum, $discussion, $USER, $cm, $course, $modcontext);
< } else {
< $reply = $canreply;
< }
<
< // $cm holds general cache for forum functions
< $cm->cache = new stdClass;
< $cm->cache->groups = groups_get_all_groups($course->id, 0, $cm->groupingid);
< $cm->cache->usersgroups = array();
<
< $posters = array();
<
< // preload all posts - TODO: improve...
< if ($mode == FORUM_MODE_FLATNEWEST) {
< $sort = "p.created DESC";
< } else {
< $sort = "p.created ASC";
< }
<
< $forumtracked = forum_tp_is_tracked($forum);
< $posts = forum_get_all_discussion_posts($discussion->id, $sort, $forumtracked);
< $post = $posts[$post->id];
<
< foreach ($posts as $pid=>$p) {
< $posters[$p->userid] = $p->userid;
< }
<
< // preload all groups of ppl that posted in this discussion
< if ($postersgroups = groups_get_all_groups($course->id, $posters, $cm->groupingid, 'gm.id, gm.groupid, gm.userid')) {
< foreach($postersgroups as $pg) {
< if (!isset($cm->cache->usersgroups[$pg->userid])) {
< $cm->cache->usersgroups[$pg->userid] = array();
< }
< $cm->cache->usersgroups[$pg->userid][$pg->groupid] = $pg->groupid;
< }
< unset($postersgroups);
< }
<
< //load ratings
< if ($forum->assessed != RATING_AGGREGATE_NONE) {
< $ratingoptions = new stdClass;
< $ratingoptions->context = $modcontext;
< $ratingoptions->component = 'mod_forum';
< $ratingoptions->ratingarea = 'post';
< $ratingoptions->items = $posts;
< $ratingoptions->aggregate = $forum->assessed;//the aggregation method
< $ratingoptions->scaleid = $forum->scale;
< $ratingoptions->userid = $USER->id;
< if ($forum->type == 'single' or !$discussion->id) {
< $ratingoptions->returnurl = "$CFG->wwwroot/mod/forum/view.php?id=$cm->id";
< } else {
< $ratingoptions->returnurl = "$CFG->wwwroot/mod/forum/discuss.php?d=$discussion->id";
< }
< $ratingoptions->assesstimestart = $forum->assesstimestart;
< $ratingoptions->assesstimefinish = $forum->assesstimefinish;
<
< $rm = new rating_manager();
< $posts = $rm->get_ratings($ratingoptions);
< }
<
<
< $post->forum = $forum->id; // Add the forum id to the post object, later used by forum_print_post
< $post->forumtype = $forum->type;
<
< $post->subject = format_string($post->subject);
<
< $postread = !empty($post->postread);
<
< forum_print_post_start($post);
< forum_print_post($post, $discussion, $forum, $cm, $course, $ownpost, $reply, false,
< '', '', $postread, true, $forumtracked);
<
< switch ($mode) {
< case FORUM_MODE_FLATOLDEST :
< case FORUM_MODE_FLATNEWEST :
< default:
< forum_print_posts_flat($course, $cm, $forum, $discussion, $post, $mode, $reply, $forumtracked, $posts);
< break;
<
< case FORUM_MODE_THREADED :
< forum_print_posts_threaded($course, $cm, $forum, $discussion, $post, 0, $reply, $forumtracked, $posts);
< break;
<
< case FORUM_MODE_NESTED :
< forum_print_posts_nested($course, $cm, $forum, $discussion, $post, $reply, $forumtracked, $posts);
< break;
< }
< forum_print_post_end($post);
> function forum_print_discussion() {
> throw new coding_exception(__FUNCTION__ . '() can not be used any more. ' .
> 'please use \mod_forum\local\renderers\discussion instead');
}
/**
< * Return a static array of posts that are open.
< *
< * @return array
* @deprecated since Moodle 3.7
*/
function forum_post_nesting_cache() {
< debugging('forum_post_nesting_cache() has been deprecated, ' .
< 'please use \mod_forum\local\renderers\posts instead.', DEBUG_DEVELOPER);
< static $nesting = array();
< return $nesting;
> throw new coding_exception(__FUNCTION__ . '() can not be used any more. ' .
> 'please use \mod_forum\local\renderers\posts instead');
}
/**
< * Return true for the first time this post was started
< *
< * @param int $id The id of the post to start
< * @return bool
* @deprecated since Moodle 3.7
*/
< function forum_should_start_post_nesting($id) {
< debugging('forum_should_start_post_nesting() has been deprecated, ' .
< 'please use \mod_forum\local\renderers\posts instead.', DEBUG_DEVELOPER);
< $cache = forum_post_nesting_cache();
< if (!array_key_exists($id, $cache)) {
< $cache[$id] = 1;
< return true;
< } else {
< $cache[$id]++;
< return false;
< }
> function forum_should_start_post_nesting() {
> throw new coding_exception(__FUNCTION__ . '() can not be used any more. ' .
> 'please use \mod_forum\local\renderers\posts instead');
}
/**
< * Return true when all the opens are nested with a close.
< *
< * @param int $id The id of the post to end
< * @return bool
* @deprecated since Moodle 3.7
*/
< function forum_should_end_post_nesting($id) {
< debugging('forum_should_end_post_nesting() has been deprecated, ' .
< 'please use \mod_forum\local\renderers\posts instead.', DEBUG_DEVELOPER);
< $cache = forum_post_nesting_cache();
< if (!array_key_exists($id, $cache)) {
< return true;
< } else {
< $cache[$id]--;
< if ($cache[$id] == 0) {
< unset($cache[$id]);
< return true;
< }
< }
< return false;
> function forum_should_end_post_nesting() {
> throw new coding_exception(__FUNCTION__ . '() can not be used any more. ' .
> 'please use \mod_forum\local\renderers\posts instead');
}
/**
< * Start a forum post container
< *
< * @param object $post The post to print.
< * @param bool $return Return the string or print it
< * @return string
* @deprecated since Moodle 3.7
*/
< function forum_print_post_start($post, $return = false) {
< debugging('forum_print_post_start() has been deprecated, ' .
< 'please use \mod_forum\local\renderers\posts instead.', DEBUG_DEVELOPER);
< $output = '';
<
< if (forum_should_start_post_nesting($post->id)) {
< $attributes = [
< 'id' => 'p'.$post->id,
< 'tabindex' => -1,
< 'class' => 'relativelink'
< ];
< $output .= html_writer::start_tag('article', $attributes);
< }
< if ($return) {
< return $output;
< }
< echo $output;
< return;
> function forum_print_post_start() {
> throw new coding_exception(__FUNCTION__ . '() can not be used any more. ' .
> 'please use \mod_forum\local\renderers\posts instead');
}
/**
< * End a forum post container
< *
< * @param object $post The post to print.
< * @param bool $return Return the string or print it
< * @return string
* @deprecated since Moodle 3.7
*/
< function forum_print_post_end($post, $return = false) {
< debugging('forum_print_post_end() has been deprecated, ' .
< 'please use \mod_forum\local\renderers\posts instead.', DEBUG_DEVELOPER);
< $output = '';
<
< if (forum_should_end_post_nesting($post->id)) {
< $output .= html_writer::end_tag('article');
< }
< if ($return) {
< return $output;
< }
< echo $output;
< return;
> function forum_print_post_end() {
> throw new coding_exception(__FUNCTION__ . '() can not be used any more. ' .
> 'please use \mod_forum\local\renderers\posts instead');
}
/**
< * Print a forum post
< * This function should always be surrounded with calls to forum_print_post_start
< * and forum_print_post_end to create the surrounding container for the post.
< * Replies can be nested before forum_print_post_end and should reflect the structure of
< * thread.
< *
< * @global object
< * @global object
< * @uses FORUM_MODE_THREADED
< * @uses PORTFOLIO_FORMAT_PLAINHTML
< * @uses PORTFOLIO_FORMAT_FILE
< * @uses PORTFOLIO_FORMAT_RICHHTML
< * @uses PORTFOLIO_ADD_TEXT_LINK
< * @uses CONTEXT_MODULE
< * @param object $post The post to print.
< * @param object $discussion
< * @param object $forum
< * @param object $cm
< * @param object $course
< * @param boolean $ownpost Whether this post belongs to the current user.
< * @param boolean $reply Whether to print a 'reply' link at the bottom of the message.
< * @param boolean $link Just print a shortened version of the post as a link to the full post.
< * @param string $footer Extra stuff to print after the message.
< * @param string $highlight Space-separated list of terms to highlight.
< * @param int $post_read true, false or -99. If we already know whether this user
< * has read this post, pass that in, otherwise, pass in -99, and this
< * function will work it out.
< * @param boolean $dummyifcantsee When forum_user_can_see_post says that
< * the current user can't see this post, if this argument is true
< * (the default) then print a dummy 'you can't see this post' post.
< * If false, don't output anything at all.
< * @param bool|null $istracked
< * @return void
* @deprecated since Moodle 3.7
*/
< function forum_print_post($post, $discussion, $forum, &$cm, $course, $ownpost=false, $reply=false, $link=false,
< $footer="", $highlight="", $postisread=null, $dummyifcantsee=true, $istracked=null, $return=false) {
< debugging('forum_print_post() has been deprecated, ' .
< 'please use \mod_forum\local\renderers\posts instead.', DEBUG_DEVELOPER);
< global $USER, $CFG, $OUTPUT;
<
< require_once($CFG->libdir . '/filelib.php');
<
< // String cache
< static $str;
< // This is an extremely hacky way to ensure we only print the 'unread' anchor
< // the first time we encounter an unread post on a page. Ideally this would
< // be moved into the caller somehow, and be better testable. But at the time
< // of dealing with this bug, this static workaround was the most surgical and
< // it fits together with only printing th unread anchor id once on a given page.
< static $firstunreadanchorprinted = false;
<
< $modcontext = context_module::instance($cm->id);
<
< $post->course = $course->id;
< $post->forum = $forum->id;
< $post->message = file_rewrite_pluginfile_urls($post->message, 'pluginfile.php', $modcontext->id, 'mod_forum', 'post', $post->id);
< if (!empty($CFG->enableplagiarism)) {
< require_once($CFG->libdir.'/plagiarismlib.php');
< $post->message .= plagiarism_get_links(array('userid' => $post->userid,
< 'content' => $post->message,
< 'cmid' => $cm->id,
< 'course' => $post->course,
< 'forum' => $post->forum));
< }
<
< // caching
< if (!isset($cm->cache)) {
< $cm->cache = new stdClass;
< }
<
< if (!isset($cm->cache->caps)) {
< $cm->cache->caps = array();
< $cm->cache->caps['mod/forum:viewdiscussion'] = has_capability('mod/forum:viewdiscussion', $modcontext);
< $cm->cache->caps['moodle/site:viewfullnames'] = has_capability('moodle/site:viewfullnames', $modcontext);
< $cm->cache->caps['mod/forum:editanypost'] = has_capability('mod/forum:editanypost', $modcontext);
< $cm->cache->caps['mod/forum:splitdiscussions'] = has_capability('mod/forum:splitdiscussions', $modcontext);
< $cm->cache->caps['mod/forum:deleteownpost'] = has_capability('mod/forum:deleteownpost', $modcontext);
< $cm->cache->caps['mod/forum:deleteanypost'] = has_capability('mod/forum:deleteanypost', $modcontext);
< $cm->cache->caps['mod/forum:viewanyrating'] = has_capability('mod/forum:viewanyrating', $modcontext);
< $cm->cache->caps['mod/forum:exportpost'] = has_capability('mod/forum:exportpost', $modcontext);
< $cm->cache->caps['mod/forum:exportownpost'] = has_capability('mod/forum:exportownpost', $modcontext);
< }
<
< if (!isset($cm->uservisible)) {
< $cm->uservisible = \core_availability\info_module::is_user_visible($cm, 0, false);
< }
<
< if ($istracked && is_null($postisread)) {
< $postisread = forum_tp_is_post_read($USER->id, $post);
< }
<
< if (!forum_user_can_see_post($forum, $discussion, $post, null, $cm, false)) {
< // Do _not_ check the deleted flag - we need to display a different UI.
< $output = '';
< if (!$dummyifcantsee) {
< if ($return) {
< return $output;
< }
< echo $output;
< return;
< }
<
< $output .= html_writer::start_tag('div', array('class' => 'forumpost clearfix',
< 'aria-label' => get_string('hiddenforumpost', 'forum')));
< $output .= html_writer::start_tag('header', array('class' => 'row header'));
< $output .= html_writer::tag('div', '', array('class' => 'left picture', 'role' => 'presentation')); // Picture.
< if ($post->parent) {
< $output .= html_writer::start_tag('div', array('class' => 'topic'));
< } else {
< $output .= html_writer::start_tag('div', array('class' => 'topic starter'));
< }
< $output .= html_writer::tag('div', get_string('forumsubjecthidden','forum'), array('class' => 'subject',
< 'role' => 'header',
< 'id' => ('headp' . $post->id))); // Subject.
< $authorclasses = array('class' => 'author');
< $output .= html_writer::tag('address', get_string('forumauthorhidden', 'forum'), $authorclasses); // Author.
< $output .= html_writer::end_tag('div');
< $output .= html_writer::end_tag('header'); // Header.
< $output .= html_writer::start_tag('div', array('class'=>'row'));
< $output .= html_writer::tag('div', ' ', array('class'=>'left side')); // Groups
< $output .= html_writer::tag('div', get_string('forumbodyhidden','forum'), array('class'=>'content')); // Content
< $output .= html_writer::end_tag('div'); // row
< $output .= html_writer::end_tag('div'); // forumpost
<
< if ($return) {
< return $output;
< }
< echo $output;
< return;
< }
<
< if (!empty($post->deleted)) {
< // Note: Posts marked as deleted are still returned by the above forum_user_can_post because it is required for
< // nesting of posts.
< $output = '';
< if (!$dummyifcantsee) {
< if ($return) {
< return $output;
< }
< echo $output;
< return;
< }
< $output .= html_writer::start_tag('div', [
< 'class' => 'forumpost clearfix',
< 'aria-label' => get_string('forumbodydeleted', 'forum'),
< ]);
<
< $output .= html_writer::start_tag('header', array('class' => 'row header'));
< $output .= html_writer::tag('div', '', array('class' => 'left picture', 'role' => 'presentation'));
<
< $classes = ['topic'];
< if (!empty($post->parent)) {
< $classes[] = 'starter';
< }
< $output .= html_writer::start_tag('div', ['class' => implode(' ', $classes)]);
<
< // Subject.
< $output .= html_writer::tag('div', get_string('forumsubjectdeleted', 'forum'), [
< 'class' => 'subject',
< 'role' => 'header',
< 'id' => ('headp' . $post->id)
< ]);
<
< // Author.
< $output .= html_writer::tag('address', '', ['class' => 'author']);
<
< $output .= html_writer::end_tag('div');
< $output .= html_writer::end_tag('header'); // End header.
< $output .= html_writer::start_tag('div', ['class' => 'row']);
< $output .= html_writer::tag('div', ' ', ['class' => 'left side']); // Groups.
< $output .= html_writer::tag('div', get_string('forumbodydeleted', 'forum'), ['class' => 'content']); // Content.
< $output .= html_writer::end_tag('div'); // End row.
< $output .= html_writer::end_tag('div'); // End forumpost.
<
< if ($return) {
< return $output;
< }
< echo $output;
< return;
< }
<
< if (empty($str)) {
< $str = new stdClass;
< $str->edit = get_string('edit', 'forum');
< $str->delete = get_string('delete', 'forum');
< $str->reply = get_string('reply', 'forum');
< $str->parent = get_string('parent', 'forum');
< $str->pruneheading = get_string('pruneheading', 'forum');
< $str->prune = get_string('prune', 'forum');
< $str->displaymode = get_user_preferences('forum_displaymode', $CFG->forum_displaymode);
< $str->markread = get_string('markread', 'forum');
< $str->markunread = get_string('markunread', 'forum');
< }
<
< $discussionlink = new moodle_url('/mod/forum/discuss.php', array('d'=>$post->discussion));
<
< // Build an object that represents the posting user
< $postuser = new stdClass;
< $postuserfields = explode(',', implode(',', \core_user\fields::get_picture_fields()));
< $postuser = username_load_fields_from_object($postuser, $post, null, $postuserfields);
< $postuser->id = $post->userid;
< $postuser->fullname = fullname($postuser, $cm->cache->caps['moodle/site:viewfullnames']);
< $postuser->profilelink = new moodle_url('/user/view.php', array('id'=>$post->userid, 'course'=>$course->id));
<
< // Prepare the groups the posting user belongs to
< if (isset($cm->cache->usersgroups)) {
< $groups = array();
< if (isset($cm->cache->usersgroups[$post->userid])) {
< foreach ($cm->cache->usersgroups[$post->userid] as $gid) {
< $groups[$gid] = $cm->cache->groups[$gid];
< }
< }
< } else {
< $groups = groups_get_all_groups($course->id, $post->userid, $cm->groupingid);
< }
<
< // Prepare the attachements for the post, files then images
< list($attachments, $attachedimages) = forum_print_attachments($post, $cm, 'separateimages');
<
< // Determine if we need to shorten this post
< $shortenpost = ($link && (strlen(strip_tags($post->message)) > $CFG->forum_longpost));
<
< // Prepare an array of commands
< $commands = array();
<
< // Add a permalink.
< $permalink = new moodle_url($discussionlink);
< $permalink->set_anchor('p' . $post->id);
< $commands[] = array('url' => $permalink, 'text' => get_string('permalink', 'forum'), 'attributes' => ['rel' => 'bookmark']);
<
< // SPECIAL CASE: The front page can display a news item post to non-logged in users.
< // Don't display the mark read / unread controls in this case.
< if ($istracked && $CFG->forum_usermarksread && isloggedin()) {
< $url = new moodle_url($discussionlink, array('postid'=>$post->id, 'mark'=>'unread'));
< $text = $str->markunread;
< if (!$postisread) {
< $url->param('mark', 'read');
< $text = $str->markread;
< }
< if ($str->displaymode == FORUM_MODE_THREADED) {
< $url->param('parent', $post->parent);
< } else {
< $url->set_anchor('p'.$post->id);
< }
< $commands[] = array('url'=>$url, 'text'=>$text, 'attributes' => ['rel' => 'bookmark']);
< }
<
< // Zoom in to the parent specifically
< if ($post->parent) {
< $url = new moodle_url($discussionlink);
< if ($str->displaymode == FORUM_MODE_THREADED) {
< $url->param('parent', $post->parent);
< } else {
< $url->set_anchor('p'.$post->parent);
< }
< $commands[] = array('url'=>$url, 'text'=>$str->parent, 'attributes' => ['rel' => 'bookmark']);
< }
<
< // Hack for allow to edit news posts those are not displayed yet until they are displayed
< $age = time() - $post->created;
< if (!$post->parent && $forum->type == 'news' && $discussion->timestart > time()) {
< $age = 0;
< }
<
< if ($forum->type == 'single' and $discussion->firstpost == $post->id) {
< if (has_capability('moodle/course:manageactivities', $modcontext)) {
< // The first post in single simple is the forum description.
< $commands[] = array('url'=>new moodle_url('/course/modedit.php', array('update'=>$cm->id, 'sesskey'=>sesskey(), 'return'=>1)), 'text'=>$str->edit);
< }
< } else if (($ownpost && $age < $CFG->maxeditingtime) || $cm->cache->caps['mod/forum:editanypost']) {
< $commands[] = array('url'=>new moodle_url('/mod/forum/post.php', array('edit'=>$post->id)), 'text'=>$str->edit);
< }
<
< if ($cm->cache->caps['mod/forum:splitdiscussions'] && $post->parent && $forum->type != 'single') {
< $commands[] = array('url'=>new moodle_url('/mod/forum/post.php', array('prune'=>$post->id)), 'text'=>$str->prune, 'title'=>$str->pruneheading);
< }
<
< if ($forum->type == 'single' and $discussion->firstpost == $post->id) {
< // Do not allow deleting of first post in single simple type.
< } else if (($ownpost && $age < $CFG->maxeditingtime && $cm->cache->caps['mod/forum:deleteownpost']) || $cm->cache->caps['mod/forum:deleteanypost']) {
< $commands[] = array('url'=>new moodle_url('/mod/forum/post.php', array('delete'=>$post->id)), 'text'=>$str->delete);
< }
<
< if ($reply) {
< $commands[] = array('url'=>new moodle_url('/mod/forum/post.php#mformforum', array('reply'=>$post->id)), 'text'=>$str->reply);
< }
<
< if ($CFG->enableportfolios && ($cm->cache->caps['mod/forum:exportpost'] || ($ownpost && $cm->cache->caps['mod/forum:exportownpost']))) {
< $p = array('postid' => $post->id);
< require_once($CFG->libdir.'/portfoliolib.php');
< $button = new portfolio_add_button();
< $button->set_callback_options('forum_portfolio_caller', array('postid' => $post->id), 'mod_forum');
< if (empty($attachments)) {
< $button->set_formats(PORTFOLIO_FORMAT_PLAINHTML);
< } else {
< $button->set_formats(PORTFOLIO_FORMAT_RICHHTML);
< }
<
< $porfoliohtml = $button->to_html(PORTFOLIO_ADD_TEXT_LINK);
< if (!empty($porfoliohtml)) {
< $commands[] = $porfoliohtml;
< }
< }
< // Finished building commands
<
<
< // Begin output
<
< $output = '';
<
< if ($istracked) {
< if ($postisread) {
< $forumpostclass = ' read';
< } else {
< $forumpostclass = ' unread';
< // If this is the first unread post printed then give it an anchor and id of unread.
< if (!$firstunreadanchorprinted) {
< $output .= html_writer::tag('a', '', array('id' => 'unread'));
< $firstunreadanchorprinted = true;
< }
< }
< } else {
< // ignore trackign status if not tracked or tracked param missing
< $forumpostclass = '';
< }
<
< $topicclass = '';
< if (empty($post->parent)) {
< $topicclass = ' firstpost starter';
< }
<
< if (!empty($post->lastpost)) {
< $forumpostclass .= ' lastpost';
< }
<
< // Flag to indicate whether we should hide the author or not.
< $authorhidden = forum_is_author_hidden($post, $forum);
< $postbyuser = new stdClass;
< $postbyuser->post = $post->subject;
< $postbyuser->user = $postuser->fullname;
< $discussionbyuser = get_string('postbyuser', 'forum', $postbyuser);
< // Begin forum post.
< $output .= html_writer::start_div('forumpost clearfix' . $forumpostclass . $topicclass,
< ['aria-label' => $discussionbyuser]);
< // Begin header row.
< $output .= html_writer::start_tag('header', ['class' => 'row header clearfix']);
<
< // User picture.
< if (!$authorhidden) {
< $picture = $OUTPUT->user_picture($postuser, ['courseid' => $course->id]);
< $output .= html_writer::div($picture, 'left picture', ['role' => 'presentation']);
< $topicclass = 'topic' . $topicclass;
< }
<
< // Begin topic column.
< $output .= html_writer::start_div($topicclass);
< $postsubject = $post->subject;
< if (empty($post->subjectnoformat)) {
< $postsubject = format_string($postsubject);
< }
< $output .= html_writer::div($postsubject, 'subject', ['role' => 'heading', 'aria-level' => '1', 'id' => ('headp' . $post->id)]);
<
< if ($authorhidden) {
< $bytext = userdate_htmltime($post->created);
< } else {
< $by = new stdClass();
< $by->date = userdate_htmltime($post->created);
< $by->name = html_writer::link($postuser->profilelink, $postuser->fullname);
< $bytext = get_string('bynameondate', 'forum', $by);
< }
< $bytextoptions = [
< 'class' => 'author'
< ];
< $output .= html_writer::tag('address', $bytext, $bytextoptions);
< // End topic column.
< $output .= html_writer::end_div();
<
< // End header row.
< $output .= html_writer::end_tag('header');
<
< // Row with the forum post content.
< $output .= html_writer::start_div('row maincontent clearfix');
< // Show if author is not hidden or we have groups.
< if (!$authorhidden || $groups) {
< $output .= html_writer::start_div('left');
< $groupoutput = '';
< if ($groups) {
< $groupoutput = print_group_picture($groups, $course->id, false, true, true);
< }
< if (empty($groupoutput)) {
< $groupoutput = ' ';
< }
< $output .= html_writer::div($groupoutput, 'grouppictures');
< $output .= html_writer::end_div(); // Left side.
< }
<
< $output .= html_writer::start_tag('div', array('class'=>'no-overflow'));
< $output .= html_writer::start_tag('div', array('class'=>'content'));
<
< $options = new stdClass;
< $options->para = false;
< $options->trusted = $post->messagetrust;
< $options->context = $modcontext;
< if ($shortenpost) {
< // Prepare shortened version by filtering the text then shortening it.
< $postclass = 'shortenedpost';
< $postcontent = format_text($post->message, $post->messageformat, $options);
< $postcontent = shorten_text($postcontent, $CFG->forum_shortpost);
< $postcontent .= html_writer::link($discussionlink, get_string('readtherest', 'forum'));
< $postcontent .= html_writer::tag('div', '('.get_string('numwords', 'moodle', count_words($post->message)).')',
< array('class'=>'post-word-count'));
< } else {
< // Prepare whole post
< $postclass = 'fullpost';
< $postcontent = format_text($post->message, $post->messageformat, $options, $course->id);
< if (!empty($highlight)) {
< $postcontent = highlight($highlight, $postcontent);
< }
< if (!empty($forum->displaywordcount)) {
< $postcontent .= html_writer::tag('div', get_string('numwords', 'moodle', count_words($postcontent)),
< array('class'=>'post-word-count'));
< }
< $postcontent .= html_writer::tag('div', $attachedimages, array('class'=>'attachedimages'));
< }
<
< if (\core_tag_tag::is_enabled('mod_forum', 'forum_posts')) {
< $postcontent .= $OUTPUT->tag_list(core_tag_tag::get_item_tags('mod_forum', 'forum_posts', $post->id), null, 'forum-tags');
< }
<
< // Output the post content
< $output .= html_writer::tag('div', $postcontent, array('class'=>'posting '.$postclass));
< $output .= html_writer::end_tag('div'); // Content
< $output .= html_writer::end_tag('div'); // Content mask
< $output .= html_writer::end_tag('div'); // Row
<
< $output .= html_writer::start_tag('nav', array('class' => 'row side'));
< $output .= html_writer::tag('div',' ', array('class'=>'left'));
< $output .= html_writer::start_tag('div', array('class'=>'options clearfix'));
<
< if (!empty($attachments)) {
< $output .= html_writer::tag('div', $attachments, array('class' => 'attachments'));
< }
<
< // Output ratings
< if (!empty($post->rating)) {
< $output .= html_writer::tag('div', $OUTPUT->render($post->rating), array('class'=>'forum-post-rating'));
< }
<
< // Output the commands
< $commandhtml = array();
< foreach ($commands as $command) {
< if (is_array($command)) {
< $attributes = ['class' => 'nav-item nav-link'];
< if (isset($command['attributes'])) {
< $attributes = array_merge($attributes, $command['attributes']);
< }
< $commandhtml[] = html_writer::link($command['url'], $command['text'], $attributes);
< } else {
< $commandhtml[] = $command;
< }
< }
< $output .= html_writer::tag('div', implode(' ', $commandhtml), array('class' => 'commands nav'));
<
< // Output link to post if required
< if ($link) {
< if (forum_user_can_post($forum, $discussion, $USER, $cm, $course, $modcontext)) {
< $langstring = 'discussthistopic';
< } else {
< $langstring = 'viewthediscussion';
< }
< if ($post->replies == 1) {
< $replystring = get_string('repliesone', 'forum', $post->replies);
< } else {
< $replystring = get_string('repliesmany', 'forum', $post->replies);
< }
< if (!empty($discussion->unread) && $discussion->unread !== '-') {
< $replystring .= ' <span class="sep">/</span> <span class="unread">';
< $unreadlink = new moodle_url($discussionlink, null, 'unread');
< if ($discussion->unread == 1) {
< $replystring .= html_writer::link($unreadlink, get_string('unreadpostsone', 'forum'));
< } else {
< $replystring .= html_writer::link($unreadlink, get_string('unreadpostsnumber', 'forum', $discussion->unread));
< }
< $replystring .= '</span>';
< }
<
< $output .= html_writer::start_tag('div', array('class'=>'link'));
< $output .= html_writer::link($discussionlink, get_string($langstring, 'forum'));
< $output .= ' ('.$replystring.')';
< $output .= html_writer::end_tag('div'); // link
< }
<
< // Output footer if required
< if ($footer) {
< $output .= html_writer::tag('div', $footer, array('class'=>'footer'));
< }
<
< // Close remaining open divs
< $output .= html_writer::end_tag('div'); // content
< $output .= html_writer::end_tag('nav'); // row
< $output .= html_writer::end_tag('div'); // forumpost
<
< // Mark the forum post as read if required
< if ($istracked && !$CFG->forum_usermarksread && !$postisread) {
< forum_tp_mark_post_read($USER->id, $post);
< }
<
< if ($return) {
< return $output;
< }
< echo $output;
< return;
> function forum_print_post() {
> throw new coding_exception(__FUNCTION__ . '() can not be used any more. ' .
> 'please use \mod_forum\local\renderers\posts instead');
}
/**
< * @global object
< * @global object
< * @uses FORUM_MODE_FLATNEWEST
< * @param object $course
< * @param object $cm
< * @param object $forum
< * @param object $discussion
< * @param object $post
< * @param object $mode
< * @param bool $reply
< * @param bool $forumtracked
< * @param array $posts
< * @return void
* @deprecated since Moodle 3.7
*/
< function forum_print_posts_flat($course, &$cm, $forum, $discussion, $post, $mode, $reply, $forumtracked, $posts) {
< debugging('forum_print_posts_flat() has been deprecated, ' .
< 'please use \mod_forum\local\renderers\posts instead.', DEBUG_DEVELOPER);
< global $USER, $CFG;
<
< $link = false;
<
< foreach ($posts as $post) {
< if (!$post->parent) {
< continue;
< }
< $post->subject = format_string($post->subject);
< $ownpost = ($USER->id == $post->userid);
<
< $postread = !empty($post->postread);
<
< forum_print_post_start($post);
< forum_print_post($post, $discussion, $forum, $cm, $course, $ownpost, $reply, $link,
< '', '', $postread, true, $forumtracked);
< forum_print_post_end($post);
< }
> function forum_print_posts_flat() {
> throw new coding_exception(__FUNCTION__ . '() can not be used any more. ' .
> 'please use \mod_forum\local\renderers\posts instead');
}
/**
< * @todo Document this function
< *
< * @global object
< * @global object
< * @uses CONTEXT_MODULE
< * @return void
* @deprecated since Moodle 3.7
*/
< function forum_print_posts_threaded($course, &$cm, $forum, $discussion, $parent, $depth, $reply, $forumtracked, $posts) {
< debugging('forum_print_posts_threaded() has been deprecated, ' .
< 'please use \mod_forum\local\renderers\posts instead.', DEBUG_DEVELOPER);
< global $USER, $CFG;
<
< $link = false;
<
< if (!empty($posts[$parent->id]->children)) {
< $posts = $posts[$parent->id]->children;
<
< $modcontext = context_module::instance($cm->id);
< $canviewfullnames = has_capability('moodle/site:viewfullnames', $modcontext);
<
< foreach ($posts as $post) {
<
< echo '<div class="indent">';
< if ($depth > 0) {
< $ownpost = ($USER->id == $post->userid);
< $post->subject = format_string($post->subject);
<
< $postread = !empty($post->postread);
<
< forum_print_post_start($post);
< forum_print_post($post, $discussion, $forum, $cm, $course, $ownpost, $reply, $link,
< '', '', $postread, true, $forumtracked);
< forum_print_post_end($post);
< } else {
< if (!forum_user_can_see_post($forum, $discussion, $post, null, $cm, true)) {
< if (forum_user_can_see_post($forum, $discussion, $post, null, $cm, false)) {
< // This post has been deleted but still exists and may have children.
< $subject = get_string('privacy:request:delete:post:subject', 'mod_forum');
< $byline = '';
< } else {
< // The user can't see this post at all.
< echo "</div>\n";
< continue;
< }
< } else {
< $by = new stdClass();
< $by->name = fullname($post, $canviewfullnames);
< $by->date = userdate_htmltime($post->modified);
< $byline = ' ' . get_string("bynameondate", "forum", $by);
< $subject = format_string($post->subject, true);
< }
<
< if ($forumtracked) {
< if (!empty($post->postread)) {
< $style = '<span class="forumthread read">';
< } else {
< $style = '<span class="forumthread unread">';
< }
< } else {
< $style = '<span class="forumthread">';
< }
<
< echo $style;
< echo "<a name='{$post->id}'></a>";
< echo html_writer::link(new moodle_url('/mod/forum/discuss.php', [
< 'd' => $post->discussion,
< 'parent' => $post->id,
< ]), $subject);
< echo $byline;
< echo "</span>";
< }
<
< forum_print_posts_threaded($course, $cm, $forum, $discussion, $post, $depth-1, $reply, $forumtracked, $posts);
< echo "</div>\n";
< }
< }
> function forum_print_posts_threaded() {
> throw new coding_exception(__FUNCTION__ . '() can not be used any more. ' .
> 'please use \mod_forum\local\renderers\posts instead');
}
/**
< * @todo Document this function
< * @global object
< * @global object
< * @return void
* @deprecated since Moodle 3.7
*/
< function forum_print_posts_nested($course, &$cm, $forum, $discussion, $parent, $reply, $forumtracked, $posts) {
< debugging('forum_print_posts_nested() has been deprecated, ' .
< 'please use \mod_forum\local\renderers\posts instead.', DEBUG_DEVELOPER);
< global $USER, $CFG;
<
< $link = false;
<
< if (!empty($posts[$parent->id]->children)) {
< $posts = $posts[$parent->id]->children;
<
< foreach ($posts as $post) {
<
< echo '<div class="indent">';
< if (!isloggedin()) {
< $ownpost = false;
< } else {
< $ownpost = ($USER->id == $post->userid);
< }
<
< $post->subject = format_string($post->subject);
< $postread = !empty($post->postread);
<
< forum_print_post_start($post);
< forum_print_post($post, $discussion, $forum, $cm, $course, $ownpost, $reply, $link,
< '', '', $postread, true, $forumtracked);
< forum_print_posts_nested($course, $cm, $forum, $discussion, $post, $reply, $forumtracked, $posts);
< forum_print_post_end($post);
< echo "</div>\n";
< }
< }
> function forum_print_posts_nested() {
> throw new coding_exception(__FUNCTION__ . '() can not be used any more. ' .
> 'please use \mod_forum\local\renderers\posts instead');
}
/**
< * Prints the discussion view screen for a forum.
< *
< * @param object $course The current course object.
< * @param object $forum Forum to be printed.
< * @param int $maxdiscussions
< * @param string $displayformat The display format to use (optional).
< * @param string $sort Sort arguments for database query (optional).
< * @param int $currentgroup
< * @param int $groupmode Group mode of the forum (optional).
< * @param int $page Page mode, page to display (optional).
< * @param int $perpage The maximum number of discussions per page(optional)
< * @param stdClass $cm
* @deprecated since Moodle 3.7
*/
< function forum_print_latest_discussions($course, $forum, $maxdiscussions = -1, $displayformat = 'plain', $sort = '',
< $currentgroup = -1, $groupmode = -1, $page = -1, $perpage = 100, $cm = null) {
< debugging('forum_print_latest_discussions has been deprecated.', DEBUG_DEVELOPER);
< global $CFG, $USER, $OUTPUT;
<
< require_once($CFG->dirroot . '/course/lib.php');
<
< if (!$cm) {
< if (!$cm = get_coursemodule_from_instance('forum', $forum->id, $forum->course)) {
< print_error('invalidcoursemodule');
< }
< }
< $context = context_module::instance($cm->id);
<
< if (empty($sort)) {
< $sort = forum_get_default_sort_order();
< }
<
< $olddiscussionlink = false;
<
< // Sort out some defaults.
< if ($perpage <= 0) {
< $perpage = 0;
< $page = -1;
< }
<
< if ($maxdiscussions == 0) {
< // All discussions - backwards compatibility.
< $page = -1;
< $perpage = 0;
< if ($displayformat == 'plain') {
< $displayformat = 'header'; // Abbreviate display by default.
< }
<
< } else if ($maxdiscussions > 0) {
< $page = -1;
< $perpage = $maxdiscussions;
< }
<
< $fullpost = false;
< if ($displayformat == 'plain') {
< $fullpost = true;
< }
<
< // Decide if current user is allowed to see ALL the current discussions or not.
< // First check the group stuff.
< if ($currentgroup == -1 or $groupmode == -1) {
< $groupmode = groups_get_activity_groupmode($cm, $course);
< $currentgroup = groups_get_activity_group($cm);
< }
<
< // Cache.
< $groups = array();
<
< // If the user can post discussions, then this is a good place to put the
< // button for it. We do not show the button if we are showing site news
< // and the current user is a guest.
<
< $canstart = forum_user_can_post_discussion($forum, $currentgroup, $groupmode, $cm, $context);
< if (!$canstart and $forum->type !== 'news') {
< if (isguestuser() or !isloggedin()) {
< $canstart = true;
< }
< if (!is_enrolled($context) and !is_viewing($context)) {
< // Allow guests and not-logged-in to see the button - they are prompted to log in after clicking the link
< // normal users with temporary guest access see this button too, they are asked to enrol instead
< // do not show the button to users with suspended enrolments here.
< $canstart = enrol_selfenrol_available($course->id);
< }
< }
<
< if ($canstart) {
< switch ($forum->type) {
< case 'news':
< case 'blog':
< $buttonadd = get_string('addanewtopic', 'forum');
< break;
< case 'qanda':
< $buttonadd = get_string('addanewquestion', 'forum');
< break;
< default:
< $buttonadd = get_string('addanewdiscussion', 'forum');
< break;
< }
< $button = new single_button(new moodle_url('/mod/forum/post.php', ['forum' => $forum->id]), $buttonadd, 'get');
< $button->class = 'singlebutton forumaddnew';
< $button->formid = 'newdiscussionform';
< echo $OUTPUT->render($button);
<
< } else if (isguestuser() or !isloggedin() or $forum->type == 'news' or
< $forum->type == 'qanda' and !has_capability('mod/forum:addquestion', $context) or
< $forum->type != 'qanda' and !has_capability('mod/forum:startdiscussion', $context)) {
< // No button and no info.
< $ignore = true;
< } else if ($groupmode and !has_capability('moodle/site:accessallgroups', $context)) {
< // Inform users why they can not post new discussion.
< if (!$currentgroup) {
< if (!has_capability('mod/forum:canposttomygroups', $context)) {
< echo $OUTPUT->notification(get_string('cannotadddiscussiongroup', 'forum'));
< } else {
< echo $OUTPUT->notification(get_string('cannotadddiscussionall', 'forum'));
< }
< } else if (!groups_is_member($currentgroup)) {
< echo $OUTPUT->notification(get_string('cannotadddiscussion', 'forum'));
< }
< }
<
< // Get all the recent discussions we're allowed to see.
<
< $getuserlastmodified = ($displayformat == 'header');
<
< $discussions = forum_get_discussions($cm, $sort, $fullpost, null, $maxdiscussions, $getuserlastmodified, $page, $perpage);
< if (!$discussions) {
< echo '<div class="forumnodiscuss">';
< if ($forum->type == 'news') {
< echo '('.get_string('nonews', 'forum').')';
< } else if ($forum->type == 'qanda') {
< echo '('.get_string('noquestions', 'forum').')';
< } else {
< echo '('.get_string('nodiscussions', 'forum').')';
< }
< echo "</div>\n";
< return;
< }
<
< $canseeprivatereplies = has_capability('mod/forum:readprivatereplies', $context);
< // If we want paging.
< if ($page != -1) {
< // Get the number of discussions found.
< $numdiscussions = forum_get_discussions_count($cm);
<
< // Show the paging bar.
< echo $OUTPUT->paging_bar($numdiscussions, $page, $perpage, "view.php?f=$forum->id");
< if ($numdiscussions > 1000) {
< // Saves some memory on sites with very large forums.
< $replies = forum_count_discussion_replies($forum->id, $sort, $maxdiscussions, $page, $perpage, $canseeprivatereplies);
< } else {
< $replies = forum_count_discussion_replies($forum->id, "", -1, -1, 0, $canseeprivatereplies);
< }
<
< } else {
< $replies = forum_count_discussion_replies($forum->id, "", -1, -1, 0, $canseeprivatereplies);
<
< if ($maxdiscussions > 0 and $maxdiscussions <= count($discussions)) {
< $olddiscussionlink = true;
< }
< }
<
< $canviewparticipants = course_can_view_participants($context);
< $canviewhiddentimedposts = has_capability('mod/forum:viewhiddentimedposts', $context);
<
< $strdatestring = get_string('strftimerecentfull');
<
< // Check if the forum is tracked.
< if ($cantrack = forum_tp_can_track_forums($forum)) {
< $forumtracked = forum_tp_is_tracked($forum);
< } else {
< $forumtracked = false;
< }
<
< if ($forumtracked) {
< $unreads = forum_get_discussions_unread($cm);
< } else {
< $unreads = array();
< }
<
< if ($displayformat == 'header') {
< echo '<table cellspacing="0" class="forumheaderlist">';
< echo '<thead class="text-left">';
< echo '<tr>';
< echo '<th class="header topic" scope="col">'.get_string('discussion', 'forum').'</th>';
< echo '<th class="header author" scope="col">'.get_string('startedby', 'forum').'</th>';
< if ($groupmode > 0) {
< echo '<th class="header group" scope="col">'.get_string('group').'</th>';
< }
< if (has_capability('mod/forum:viewdiscussion', $context)) {
< echo '<th class="header replies" scope="col">'.get_string('replies', 'forum').'</th>';
< // If the forum can be tracked, display the unread column.
< if ($cantrack) {
< echo '<th class="header replies" scope="col">'.get_string('unread', 'forum');
< if ($forumtracked) {
< echo '<a title="'.get_string('markallread', 'forum').
< '" href="'.$CFG->wwwroot.'/mod/forum/markposts.php?f='.
< $forum->id.'&mark=read&return=/mod/forum/view.php&sesskey=' . sesskey() . '">'.
< $OUTPUT->pix_icon('t/markasread', get_string('markallread', 'forum')) . '</a>';
< }
< echo '</th>';
< }
< }
< echo '<th class="header lastpost" scope="col">'.get_string('lastpost', 'forum').'</th>';
< if ((!is_guest($context, $USER) && isloggedin()) && has_capability('mod/forum:viewdiscussion', $context)) {
< if (\mod_forum\subscriptions::is_subscribable($forum)) {
< echo '<th class="header discussionsubscription" scope="col">';
< echo forum_get_discussion_subscription_icon_preloaders();
< echo '</th>';
< }
< }
< echo '</tr>';
< echo '</thead>';
< echo '<tbody>';
< }
<
< foreach ($discussions as $discussion) {
< if ($forum->type == 'qanda' && !has_capability('mod/forum:viewqandawithoutposting', $context) &&
< !forum_user_has_posted($forum->id, $discussion->discussion, $USER->id)) {
< $canviewparticipants = false;
< }
<
< if (!empty($replies[$discussion->discussion])) {
< $discussion->replies = $replies[$discussion->discussion]->replies;
< $discussion->lastpostid = $replies[$discussion->discussion]->lastpostid;
< } else {
< $discussion->replies = 0;
< }
<
< // SPECIAL CASE: The front page can display a news item post to non-logged in users.
< // All posts are read in this case.
< if (!$forumtracked) {
< $discussion->unread = '-';
< } else if (empty($USER)) {
< $discussion->unread = 0;
< } else {
< if (empty($unreads[$discussion->discussion])) {
< $discussion->unread = 0;
< } else {
< $discussion->unread = $unreads[$discussion->discussion];
< }
< }
<
< if (isloggedin()) {
< $ownpost = ($discussion->userid == $USER->id);
< } else {
< $ownpost = false;
< }
< // Use discussion name instead of subject of first post.
< $discussion->subject = $discussion->name;
<
< switch ($displayformat) {
< case 'header':
< if ($groupmode > 0) {
< if (isset($groups[$discussion->groupid])) {
< $group = $groups[$discussion->groupid];
< } else {
< $group = $groups[$discussion->groupid] = groups_get_group($discussion->groupid);
< }
< } else {
< $group = -1;
< }
< forum_print_discussion_header($discussion, $forum, $group, $strdatestring, $cantrack, $forumtracked,
< $canviewparticipants, $context, $canviewhiddentimedposts);
< break;
< default:
< $link = false;
<
< if ($discussion->replies) {
< $link = true;
< } else {
< $modcontext = context_module::instance($cm->id);
< $link = forum_user_can_see_discussion($forum, $discussion, $modcontext, $USER);
< }
<
< $discussion->forum = $forum->id;
<
< forum_print_post_start($discussion);
< forum_print_post($discussion, $discussion, $forum, $cm, $course, $ownpost, 0, $link, false,
< '', null, true, $forumtracked);
< forum_print_post_end($discussion);
< break;
< }
< }
<
< if ($displayformat == "header") {
< echo '</tbody>';
< echo '</table>';
< }
<
< if ($olddiscussionlink) {
< if ($forum->type == 'news') {
< $strolder = get_string('oldertopics', 'forum');
< } else {
< $strolder = get_string('olderdiscussions', 'forum');
< }
< echo '<div class="forumolddiscuss">';
< echo '<a href="'.$CFG->wwwroot.'/mod/forum/view.php?f='.$forum->id.'&showall=1">';
< echo $strolder.'</a> ...</div>';
< }
<
< if ($page != -1) {
< // Show the paging bar.
< echo $OUTPUT->paging_bar($numdiscussions, $page, $perpage, "view.php?f=$forum->id");
< }
> function forum_print_latest_discussions() {
> throw new coding_exception(__FUNCTION__ . '() can not be used any more. ');
}
/**
< * Count the number of replies to the specified post.
< *
< * @param object $post
< * @param bool $children
< * @return int
* @deprecated since Moodle 3.7
< * @todo MDL-65252 This will be removed in Moodle 3.11
*/
< function forum_count_replies($post, $children = true) {
< global $USER;
< debugging('forum_count_replies has been deprecated. Please use the Post vault instead.', DEBUG_DEVELOPER);
<
< if (!$children) {
< return $DB->count_records('forum_posts', array('parent' => $post->id));
< }
<
< $entityfactory = mod_forum\local\container::get_entity_factory();
< $postentity = $entityfactory->get_post_from_stdclass($post);
<
< $vaultfactory = mod_forum\local\container::get_vault_factory();
< $postvault = $vaultfactory->get_post_vault();
<
< return $postvault->get_reply_count_for_post_id_in_discussion_id(
< $USER,
< $postentity->get_id(),
< $postentity->get_discussion_id(),
< true
< );
> function forum_count_replies() {
> throw new coding_exception(__FUNCTION__ . ' has been removed. Please use get_reply_count_for_post_id_in_discussion_id in
> the post vault.');
}
/**
* @deprecated since Moodle 3.8
*/
function forum_scale_used() {
throw new coding_exception('forum_scale_used() can not be used anymore. Plugins can implement ' .
'<modname>_scale_used_anywhere, all implementations of <modname>_scale_used are now ignored');
}
/**
< * Return grade for given user or all users.
< *
* @deprecated since Moodle 3.8
< * @param object $forum
< * @param int $userid optional user id, 0 means all users
< * @return array array of grades, false if none
*/
< function forum_get_user_grades($forum, $userid = 0) {
< global $CFG;
<
< require_once($CFG->dirroot.'/rating/lib.php');
<
< $ratingoptions = (object) [
< 'component' => 'mod_forum',
< 'ratingarea' => 'post',
< 'contextid' => $contextid,
<
< 'modulename' => 'forum',
< 'moduleid ' => $forum->id,
< 'userid' => $userid,
< 'aggregationmethod' => $forum->assessed,
< 'scaleid' => $forum->scale,
< 'itemtable' => 'forum_posts',
< 'itemtableusercolumn' => 'userid',
< ];
> function forum_get_user_grades() {
> throw new \coding_exception('forum_get_user_grades() is deprecated and no longer used. ' .
> 'Please use rating_manager::get_user_grades() instead.');
> }
< $rm = new rating_manager();
< return $rm->get_user_grades($ratingoptions);
> /**
> * @deprecated since Moodle 3.11
> */
> function forum_get_completion_state() {
> $completionclass = \mod_forum\completion\custom_completion::class;
> throw new coding_exception(__FUNCTION__ . "() has been removed, please use the '{$completionclass}' class instead");
}
/**
< * Obtains the automatic completion state for this forum based on any conditions
< * in forum settings.
> * Prints the editing button on subscribers page
*
< * @deprecated since Moodle 3.11
< * @todo MDL-71196 Final deprecation in Moodle 4.3
< * @see \mod_forum\completion\custom_completion
> * @deprecated since Moodle 4.0
> * @todo MDL-73956 Final deprecation in Moodle 4.4
* @global object
* @global object
< * @param object $course Course
< * @param object $cm Course-module
< * @param int $userid User ID
< * @param bool $type Type of comparison (or/and; can be used as return value if no conditions)
< * @return bool True if completed, false if not. (If no conditions, then return
< * value depends on comparison type)
< */
< function forum_get_completion_state($course, $cm, $userid, $type) {
< global $DB;
<
< // No need to call debugging here. Deprecation debugging notice already being called in \completion_info::internal_get_state().
<
< // Get forum details.
< if (!($forum = $DB->get_record('forum', array('id' => $cm->instance)))) {
< throw new Exception("Can't find forum {$cm->instance}");
< }
<
< $result = $type; // Default return value.
<
< $postcountparams = array('userid' => $userid, 'forumid' => $forum->id);
< $postcountsql = "
< SELECT
< COUNT(1)
< FROM
< {forum_posts} fp
< INNER JOIN {forum_discussions} fd ON fp.discussion=fd.id
< WHERE
< fp.userid=:userid AND fd.forum=:forumid";
<
< if ($forum->completiondiscussions) {
< $value = $forum->completiondiscussions <=
< $DB->count_records('forum_discussions', array('forum' => $forum->id, 'userid' => $userid));
< if ($type == COMPLETION_AND) {
< $result = $result && $value;
< } else {
< $result = $result || $value;
< }
< }
< if ($forum->completionreplies) {
< $value = $forum->completionreplies <=
< $DB->get_field_sql($postcountsql . ' AND fp.parent<>0', $postcountparams);
< if ($type == COMPLETION_AND) {
< $result = $result && $value;
< } else {
< $result = $result || $value;
< }
< }
< if ($forum->completionposts) {
< $value = $forum->completionposts <= $DB->get_field_sql($postcountsql, $postcountparams);
< if ($type == COMPLETION_AND) {
< $result = $result && $value;
> * @param int $courseid
> * @param int $forumid
> * @return string
> */
> function forum_update_subscriptions_button($courseid, $forumid): string {
> global $CFG, $USER;
>
> debugging('The method forum_update_subscriptions_button() has been deprecated as it is no longer used.' .
> 'The \'Manage subscribers\' button has been replaced with tertiary navigation.', DEBUG_DEVELOPER);
>
> if (!empty($USER->subscriptionsediting)) {
> $string = get_string('managesubscriptionsoff', 'forum');
> $edit = "off";
} else {
< $result = $result || $value;
> $string = get_string('managesubscriptionson', 'forum');
> $edit = "on";
}
>
}
> $subscribers = html_writer::start_tag('form', array('action' => $CFG->wwwroot . '/mod/forum/subscribers.php',
> 'method' => 'get', 'class' => 'form-inline'));
return $result;
> $subscribers .= html_writer::empty_tag('input', array('type' => 'submit', 'value' => $string,
}
> 'class' => 'btn btn-secondary'));
> $subscribers .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'id', 'value' => $forumid));
> $subscribers .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'edit', 'value' => $edit));
> $subscribers .= html_writer::end_tag('form');
>
> return $subscribers;
< return $result;
> /**
> * This function prints the overview of a discussion in the forum listing.
> * It needs some discussion information and some post information, these
> * happen to be combined for efficiency in the $post parameter by the function
> * that calls this one: forum_print_latest_discussions()
> *
> * @deprecated since Moodle 4.3
> */
> function forum_print_discussion_header() {
> throw new \coding_exception('forum_print_discussion_header has been deprecated');