Forum subscription manager. More...

Static Public Member Functions
static	fetch_discussion_subscription ($forumid, $userid=null)
	Retrieve the discussion subscription data for the specified userid and forum. More...

static	fetch_subscribed_users ($forum, $groupid=0, $context=null, $fields=null, $includediscussionsubscriptions=false)
	Returns a list of user objects who are subscribed to this forum. More...

static	fetch_subscription_cache ($forumid, $userid)
	Fetch the forum subscription data for the specified userid and forum. More...

static	fill_discussion_subscription_cache ($forumid, $userid=null)
	Fill the discussion subscription data for the specified userid and forum. More...

static	fill_subscription_cache ($forumid, $userid=null)
	Fill the forum subscription data for the specified userid and forum. More...

static	fill_subscription_cache_for_course ($courseid, $userid)
	Fill the forum subscription data for all forums that the specified userid can subscribe to in the specified course. More...

static	get_potential_subscribers ($context, $groupid, $fields, $sort='')
	Get the list of potential subscribers to a forum. More...

static	get_subscription_mode ($forum)
	Returns the current subscription mode for the forum. More...

static	get_unsubscribable_forums ()
	Returns an array of forums that the current user is subscribed to and is allowed to unsubscribe from. More...

static	get_user_default_subscription ($forum, $context, $cm, ?int $discussionid)
	Gets the default subscription value for the logged in user. More...

static	is_forcesubscribed ($forum)
	Helper to determine whether a forum has it's subscription mode set to forced subscription. More...

static	is_subscribable ($forum)
	Helper to determine whether the specified forum can be subscribed to. More...

static	is_subscribed ($userid, $forum, $discussionid=null, $cm=null)
	Whether a user is subscribed to this forum, or a discussion within the forum. More...

static	reset_discussion_cache ()
	Reset the discussion cache. More...

static	reset_forum_cache ()
	Reset the forum cache. More...

static	set_subscription_mode ($forumid, $status=1)
	Set the forum subscription mode. More...

static	subscribe_user ($userid, $forum, $context=null, $userrequest=false)
	Adds user to the subscriber list. More...

static	subscribe_user_to_discussion ($userid, $discussion, $context=null)
	Subscribes the user to the specified discussion. More...

static	subscription_disabled ($forum)
	Helper to determine whether a forum has it's subscription mode set to disabled. More...

static	unsubscribe_user ($userid, $forum, $context=null, $userrequest=false)
	Removes user from the subscriber list. More...

static	unsubscribe_user_from_discussion ($userid, $discussion, $context=null)
	Unsubscribes the user from the specified discussion. More...

Public Attributes
int const	FORUM_DISCUSSION_UNSUBSCRIBED = -1
	The status value for an unsubscribed discussion.

Static Protected Member Functions
static	add_to_discussion_cache ($forumid, $userid, $discussion, $preference)
	Add the specified discussion and user preference to the discussion subscription cache. More...

static	is_subscribed_to_forum ($userid, $forum)
	Whether a user is subscribed to this forum. More...

Static Protected Attributes
static bool[]	$discussionfetchedforums = array()
	The list of forums which have been wholly retrieved for the forum discussion subscription cache. More...

static bool[]	$fetchedforums = array()
	The list of forums which have been wholly retrieved for the forum subscription cache. More...

static array[]	$forumcache = array()
	The subscription cache for forums. More...

static array[]	$forumdiscussioncache = array()
	The subscription cache for forum discussions. More...

Detailed Description

Forum subscription manager.

Copyright: 2014 Andrew Nicols andre.nosp@m.w@ni.nosp@m.cols..nosp@m.co.u.nosp@m.k

License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

◆ add_to_discussion_cache()

static mod_forum\subscriptions::add_to_discussion_cache	(	$forumid,
		$userid,
		$discussion,
		$preference
	)

staticprotected

Add the specified discussion and user preference to the discussion subscription cache.

Parameters

int	$forumid	The ID of the forum that this preference belongs to
int	$userid	The ID of the user that this preference belongs to
int	$discussion	The ID of the discussion that this preference relates to
int	$preference	The preference to store

◆ fetch_discussion_subscription()

static mod_forum\subscriptions::fetch_discussion_subscription	(	$forumid,
		$userid = `null`
	)

static

Retrieve the discussion subscription data for the specified userid and forum.

This is returned as an array of discussions for that forum which contain the preference in a stdClass.

Parameters

int	$forumid	The forum to retrieve a cache for
int	$userid	The user ID

Return values

array of stdClass objects with one per discussion in the forum.

◆ fetch_subscribed_users()

static mod_forum\subscriptions::fetch_subscribed_users	(	$forum,
		$groupid = `0`,
		$context = `null`,
		$fields = `null`,
		$includediscussionsubscriptions = `false`
	)

static

Returns a list of user objects who are subscribed to this forum.

Parameters

stdClass	$forum	The forum record.
int	$groupid	The group id if restricting subscriptions to a group of users, or 0 for all.
context_module	$context	the forum context, to save re-fetching it where possible.
string	$fields	requested user fields (with "u." table prefix).
boolean	$includediscussionsubscriptions	Whether to take discussion subscriptions and unsubscriptions into consideration.

Return values

array list of users.

◆ fetch_subscription_cache()

static mod_forum\subscriptions::fetch_subscription_cache	(	$forumid,
		$userid
	)

static

Fetch the forum subscription data for the specified userid and forum.

Parameters

int	$forumid	The forum to retrieve a cache for
int	$userid	The user ID

Return values

boolean

◆ fill_discussion_subscription_cache()

static mod_forum\subscriptions::fill_discussion_subscription_cache	(	$forumid,
		$userid = `null`
	)

static

Fill the discussion subscription data for the specified userid and forum.

If the userid is not specified, then all discussion subscription data for that forum is fetched in a single query and used for subsequent lookups without requiring further database queries.

Parameters

int	$forumid	The forum to retrieve a cache for
int	$userid	The user ID

Return values

void

◆ fill_subscription_cache()

static mod_forum\subscriptions::fill_subscription_cache	(	$forumid,
		$userid = `null`
	)

static

Fill the forum subscription data for the specified userid and forum.

If the userid is not specified, then all subscription data for that forum is fetched in a single query and used for subsequent lookups without requiring further database queries.

Parameters

int	$forumid	The forum to retrieve a cache for
int	$userid	The user ID

Return values

void

◆ fill_subscription_cache_for_course()

static mod_forum\subscriptions::fill_subscription_cache_for_course	(	$courseid,
		$userid
	)

static

Fill the forum subscription data for all forums that the specified userid can subscribe to in the specified course.

Parameters

int	$courseid	The course to retrieve a cache for
int	$userid	The user ID

Return values

void

◆ get_potential_subscribers()

static mod_forum\subscriptions::get_potential_subscribers	(	$context,
		$groupid,
		$fields,
		$sort = `''`
	)

static

Get the list of potential subscribers to a forum.

Parameters

context_module	$context	the forum context.
integer	$groupid	the id of a group, or 0 for all groups.
string	$fields	the list of fields to return for each user. As for get_users_by_capability.
string	$sort	sort order. As for get_users_by_capability.

Return values

array list of users.

◆ get_subscription_mode()

static mod_forum\subscriptions::get_subscription_mode ( $forum )

static

Returns the current subscription mode for the forum.

Parameters

stdClass $forum The record of the forum to set

Return values

int	The forum subscription mode

◆ get_unsubscribable_forums()

static mod_forum\subscriptions::get_unsubscribable_forums ( )

static

Returns an array of forums that the current user is subscribed to and is allowed to unsubscribe from.

Return values

array An array of unsubscribable forums

◆ get_user_default_subscription()

static mod_forum\subscriptions::get_user_default_subscription	(		$forum,
			$context,
			$cm,
		?int	$discussionid
	)

static

Gets the default subscription value for the logged in user.

Parameters

stdClass	$forum	The forum record
context	$context	The course context
cm_info	$cm	cm_info
int \| null	$discussionid	The discussion we are checking against

Return values

bool	Default subscription

Exceptions

coding_exception

◆ is_forcesubscribed()

static mod_forum\subscriptions::is_forcesubscribed ( $forum )

static

Helper to determine whether a forum has it's subscription mode set to forced subscription.

Parameters

stdClass $forum The record of the forum to test

Return values

bool

◆ is_subscribable()

static mod_forum\subscriptions::is_subscribable ( $forum )

static

Helper to determine whether the specified forum can be subscribed to.

Parameters

stdClass $forum The record of the forum to test

Return values

bool

◆ is_subscribed()

static mod_forum\subscriptions::is_subscribed	(	$userid,
		$forum,
		$discussionid = `null`,
		$cm = `null`
	)

static

Whether a user is subscribed to this forum, or a discussion within the forum.

If a discussion is specified, then report whether the user is subscribed to posts to this particular discussion, taking into account the forum preference.

If it is not specified then only the forum preference is considered.

Parameters

int	$userid	The user ID
stdClass	$forum	The record of the forum to test
int	$discussionid	The ID of the discussion to check
	$cm	The coursemodule record. If not supplied, this will be calculated using get_fast_modinfo instead.

Return values

boolean

◆ is_subscribed_to_forum()

static mod_forum\subscriptions::is_subscribed_to_forum	(	$userid,
		$forum
	)

staticprotected

Whether a user is subscribed to this forum.

Parameters

int	$userid	The user ID
stdClass	$forum	The record of the forum to test

Return values

boolean

◆ reset_discussion_cache()

static mod_forum\subscriptions::reset_discussion_cache ( )

static

Reset the discussion cache.

This cache is used to reduce the number of database queries when checking forum discussion subscription states.

◆ reset_forum_cache()

static mod_forum\subscriptions::reset_forum_cache ( )

static

Reset the forum cache.

This cache is used to reduce the number of database queries when checking forum subscription states.

◆ set_subscription_mode()

static mod_forum\subscriptions::set_subscription_mode	(	$forumid,
		$status = `1`
	)

static

Set the forum subscription mode.

By default when called without options, this is set to FORUM_FORCESUBSCRIBE.

Parameters

stdClass	$forum	The record of the forum to set
int	$status	The new subscription state

Return values

bool

◆ subscribe_user()

static mod_forum\subscriptions::subscribe_user	(	$userid,
		$forum,
		$context = `null`,
		$userrequest = `false`
	)

static

Adds user to the subscriber list.

Parameters

int	$userid	The ID of the user to subscribe
stdClass	$forum	The forum record for this forum.
context_module \| null	$context	Module context, may be omitted if not known or if called for the current module set in page.
boolean	$userrequest	Whether the user requested this change themselves. This has an effect on whether discussion subscriptions are removed too.

Return values

bool|int Returns true if the user is already subscribed, or the forum_subscriptions ID if the user was successfully subscribed.

◆ subscribe_user_to_discussion()

static mod_forum\subscriptions::subscribe_user_to_discussion	(	$userid,
		$discussion,
		$context = `null`
	)

static

Subscribes the user to the specified discussion.

Parameters

int	$userid	The userid of the user being subscribed
stdClass	$discussion	The discussion to subscribe to
context_module \| null	$context	Module context, may be omitted if not known or if called for the current module set in page.

Return values

boolean Whether a change was made

◆ subscription_disabled()

static mod_forum\subscriptions::subscription_disabled ( $forum )

static

Helper to determine whether a forum has it's subscription mode set to disabled.

Parameters

stdClass $forum The record of the forum to test

Return values

bool

◆ unsubscribe_user()

static mod_forum\subscriptions::unsubscribe_user	(	$userid,
		$forum,
		$context = `null`,
		$userrequest = `false`
	)

static

Removes user from the subscriber list.

Parameters

int	$userid	The ID of the user to unsubscribe
stdClass	$forum	The forum record for this forum.
context_module \| null	$context	Module context, may be omitted if not known or if called for the current module set in page.
boolean	$userrequest	Whether the user requested this change themselves. This has an effect on whether discussion subscriptions are removed too.

Return values

boolean Always returns true.

◆ unsubscribe_user_from_discussion()

static mod_forum\subscriptions::unsubscribe_user_from_discussion	(	$userid,
		$discussion,
		$context = `null`
	)

static

Unsubscribes the user from the specified discussion.

Parameters

int	$userid	The userid of the user being unsubscribed
stdClass	$discussion	The discussion to unsubscribe from
context_module \| null	$context	Module context, may be omitted if not known or if called for the current module set in page.

Return values

boolean Whether a change was made

Member Data Documentation

◆ $discussionfetchedforums

bool [] mod_forum\subscriptions::$discussionfetchedforums = array()

staticprotected

The list of forums which have been wholly retrieved for the forum discussion subscription cache.

This allows for prior caching of an entire forum to reduce the number of DB queries in a subscription check loop.

◆ $fetchedforums

bool [] mod_forum\subscriptions::$fetchedforums = array()

staticprotected

The list of forums which have been wholly retrieved for the forum subscription cache.

This allows for prior caching of an entire forum to reduce the number of DB queries in a subscription check loop.

◆ $forumcache

array [] mod_forum\subscriptions::$forumcache = array()

staticprotected

The subscription cache for forums.

The first level key is the user ID The second level is the forum ID The Value then is bool for subscribed of not.

An array of arrays.

◆ $forumdiscussioncache

array [] mod_forum\subscriptions::$forumdiscussioncache = array()

staticprotected

The subscription cache for forum discussions.

The first level key is the user ID The second level is the forum ID The third level key is the discussion ID The value is then the users preference (int)

The documentation for this class was generated from the following file:

mod/forum/classes/subscriptions.php

Static Public Member Functions

Public Attributes

Static Protected Member Functions

Static Protected Attributes

Detailed Description

Member Function Documentation

◆ add_to_discussion_cache()

◆ fetch_discussion_subscription()

◆ fetch_subscribed_users()

◆ fetch_subscription_cache()

◆ fill_discussion_subscription_cache()

◆ fill_subscription_cache()

◆ fill_subscription_cache_for_course()

◆ get_potential_subscribers()

◆ get_subscription_mode()

◆ get_unsubscribable_forums()

◆ get_user_default_subscription()

◆ is_forcesubscribed()

◆ is_subscribable()

◆ is_subscribed()

◆ is_subscribed_to_forum()

◆ reset_discussion_cache()

◆ reset_forum_cache()

◆ set_subscription_mode()

◆ subscribe_user()

◆ subscribe_user_to_discussion()

◆ subscription_disabled()

◆ unsubscribe_user()

◆ unsubscribe_user_from_discussion()

Member Data Documentation

◆ $discussionfetchedforums

◆ $fetchedforums

◆ $forumcache

◆ $forumdiscussioncache