mirror of
https://github.com/moodle/moodle.git
synced 2025-02-22 10:57:20 +01:00
e6a4eb3c36
This issue is a followup for changes made in forum. And hence addresses the following issues spotted for forum: 1. Bring back the "Forums" header in the search page. 2. Remove the stale function forum_update_subscriptions_button 3. Fix the redirection to activity tab when subscription is changed, in the subscription tab.
515 lines
16 KiB
PHP
515 lines
16 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/>.
|
|
|
|
/**
|
|
* @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');
|
|
}
|
|
|
|
/**
|
|
* @deprecated since Moodle 3.0 use \mod_forum\output\forum_post_email instead
|
|
*/
|
|
function forum_make_mail_text() {
|
|
throw new coding_exception(__FUNCTION__ . '() can not be used any more. Please use '
|
|
. '\mod_forum\output\forum_post_email');
|
|
}
|
|
|
|
/**
|
|
* @deprecated since Moodle 3.0 use \mod_forum\output\forum_post_email instead
|
|
*/
|
|
function forum_make_mail_html() {
|
|
throw new coding_exception(__FUNCTION__ . '() can not be used any more. Please use '
|
|
. '\mod_forum\output\forum_post_email');
|
|
}
|
|
|
|
/**
|
|
* @deprecated since Moodle 3.0 use \mod_forum\output\forum_post_email instead
|
|
*/
|
|
function forum_make_mail_post() {
|
|
throw new coding_exception(__FUNCTION__ . '() can not be used any more. Please use '
|
|
. '\mod_forum\output\forum_post_email');
|
|
}
|
|
|
|
/**
|
|
* @deprecated since Moodle 3.7
|
|
*/
|
|
function forum_cron_minimise_user_record() {
|
|
throw new coding_exception(__FUNCTION__ . '() can not be used any more. It has not been replaced.');
|
|
}
|
|
|
|
/**
|
|
* @deprecated since Moodle 3.7
|
|
*/
|
|
function forum_cron() {
|
|
throw new coding_exception(__FUNCTION__ . '() can not be used any more. Please use the forum tasks');
|
|
}
|
|
|
|
/**
|
|
* @deprecated since Moodle 3.7
|
|
*/
|
|
function forum_print_discussion() {
|
|
throw new coding_exception(__FUNCTION__ . '() can not be used any more. ' .
|
|
'please use \mod_forum\local\renderers\discussion instead');
|
|
}
|
|
|
|
|
|
/**
|
|
* @deprecated since Moodle 3.7
|
|
*/
|
|
function forum_post_nesting_cache() {
|
|
throw new coding_exception(__FUNCTION__ . '() can not be used any more. ' .
|
|
'please use \mod_forum\local\renderers\posts instead');
|
|
}
|
|
|
|
/**
|
|
* @deprecated since Moodle 3.7
|
|
*/
|
|
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');
|
|
}
|
|
|
|
/**
|
|
* @deprecated since Moodle 3.7
|
|
*/
|
|
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');
|
|
}
|
|
|
|
/**
|
|
* @deprecated since Moodle 3.7
|
|
*/
|
|
function forum_print_post_start() {
|
|
throw new coding_exception(__FUNCTION__ . '() can not be used any more. ' .
|
|
'please use \mod_forum\local\renderers\posts instead');
|
|
}
|
|
|
|
/**
|
|
* @deprecated since Moodle 3.7
|
|
*/
|
|
function forum_print_post_end() {
|
|
throw new coding_exception(__FUNCTION__ . '() can not be used any more. ' .
|
|
'please use \mod_forum\local\renderers\posts instead');
|
|
}
|
|
|
|
/**
|
|
* @deprecated since Moodle 3.7
|
|
*/
|
|
function forum_print_post() {
|
|
throw new coding_exception(__FUNCTION__ . '() can not be used any more. ' .
|
|
'please use \mod_forum\local\renderers\posts instead');
|
|
}
|
|
|
|
/**
|
|
* @deprecated since Moodle 3.7
|
|
*/
|
|
function forum_print_posts_flat() {
|
|
throw new coding_exception(__FUNCTION__ . '() can not be used any more. ' .
|
|
'please use \mod_forum\local\renderers\posts instead');
|
|
}
|
|
|
|
/**
|
|
* @deprecated since Moodle 3.7
|
|
*/
|
|
function forum_print_posts_threaded() {
|
|
throw new coding_exception(__FUNCTION__ . '() can not be used any more. ' .
|
|
'please use \mod_forum\local\renderers\posts instead');
|
|
}
|
|
|
|
/**
|
|
* @deprecated since Moodle 3.7
|
|
*/
|
|
function forum_print_posts_nested() {
|
|
throw new coding_exception(__FUNCTION__ . '() can not be used any more. ' .
|
|
'please use \mod_forum\local\renderers\posts instead');
|
|
}
|
|
|
|
/**
|
|
* @deprecated since Moodle 3.7
|
|
*/
|
|
function forum_print_latest_discussions() {
|
|
throw new coding_exception(__FUNCTION__ . '() can not be used any more. ');
|
|
}
|
|
|
|
/**
|
|
* @deprecated since Moodle 3.7
|
|
*/
|
|
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');
|
|
}
|
|
|
|
/**
|
|
* @deprecated since Moodle 3.8
|
|
*/
|
|
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.');
|
|
}
|
|
|
|
/**
|
|
* Obtains the automatic completion state for this forum based on any conditions
|
|
* in forum settings.
|
|
*
|
|
* @deprecated since Moodle 3.11
|
|
* @todo MDL-71196 Final deprecation in Moodle 4.3
|
|
* @see \mod_forum\completion\custom_completion
|
|
* @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;
|
|
} else {
|
|
$result = $result || $value;
|
|
}
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* Prints the editing button on subscribers page
|
|
*
|
|
* @deprecated since Moodle 4.0
|
|
* @todo MDL-73956 Final deprecation in Moodle 4.4
|
|
* @global object
|
|
* @global object
|
|
* @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 {
|
|
$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'));
|
|
$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;
|
|
}
|