Class to manage subscriptions. More...

Static Public Member Functions
static	activate_subscriptions (array $ids)
	Activates a group of subscriptions based on an input array of ids. More...

static	count_rule_subscriptions ($ruleid)
	Get count of subscriptions for a given rule. More...

static	count_user_subscriptions ($userid=0)
	Get count of subscriptions for a given user. More...

static	count_user_subscriptions_for_course ($courseid, $userid=0)
	Get count of subscriptions for a given user in a given course. More...

static	create_subscription ($ruleid, $courseid, $cmid, $userid=0)
	Subscribe a user to a given rule. More...

static	deactivate_subscriptions (array $ids)
	Deactivates a group of subscriptions based on an input array of ids. More...

static	delete_cm_subscriptions ($cmid)
	Delete all subscriptions for a course module. More...

static	delete_stale_subscriptions ($userid=0)
	Deletes subscriptions which have been inactive for a period of time. More...

static	delete_subscription ($subscriptionorid, $checkuser=true)
	Delete a subscription. More...

static	delete_user_subscriptions ($userid)
	Delete all subscriptions for a user. More...

static	event_has_subscriptions ($eventname, $courseid)
	Returns true if an event in a particular course has a subscription. More...

static	get_subscription ($subscriptionorid)
	Get a subscription instance for an given subscription id. More...

static	get_subscriptions_by_event (\stdClass $event)
	Return a list of subscriptions for a given event. More...

static	get_user_subscriptions ($limitfrom=0, $limitto=0, $userid=0, $order='s.courseid ASC, r.name')
	Get an array of subscriptions for a given user. More...

static	get_user_subscriptions_for_course ($courseid, $limitfrom=0, $limitto=0, $userid=0, $order='s.timecreated DESC')
	Get an array of subscriptions for a given user in a given course. More...

static	remove_all_subscriptions_for_rule ($ruleid, $coursecontext=null)
	Delete all subscribers for a given rule. More...

static	remove_all_subscriptions_in_course ($coursecontext)
	Delete all subscriptions in a course. More...

static	subscription_is_active (subscription $subscription)
	Check whether a subscription is active. More...

Public Attributes
const	INACTIVE_SUBSCRIPTION_LIFESPAN_IN_DAYS = 30
	@const Period of time, in days, after which an inactive subscription will be removed completely.

Static Protected Member Functions
static	get_instances ($arr)
	Helper method to convert db records to instances. More...

static	get_subscription_join_rule_sql ($count=false)
	Return sql to join rule and subscription table. More...

Detailed Description

Class to manage subscriptions.

Since: Moodle 2.8

Copyright: 2014 onwards Ankit Agarwal ankit.nosp@m..agr.nosp@m.r@gma.nosp@m.il.c.nosp@m.om

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

Member Function Documentation

◆ activate_subscriptions()

static tool_monitor\subscription_manager::activate_subscriptions ( array $ids )

static

Activates a group of subscriptions based on an input array of ids.

Since: 3.2.0

Parameters

array $ids of subscription ids.

Return values

bool	true if the operation was successful, false otherwise.

◆ count_rule_subscriptions()

static tool_monitor\subscription_manager::count_rule_subscriptions ( $ruleid )

static

Get count of subscriptions for a given rule.

Parameters

int $ruleid rule id of the subscription.

Return values

int	number of subscriptions

◆ count_user_subscriptions()

static tool_monitor\subscription_manager::count_user_subscriptions ( $userid = 0 )

static

Get count of subscriptions for a given user.

Parameters

int $userid Id of the user for which the subscription needs to be fetched. Defaults to $USER;

Return values

int	number of subscriptions

◆ count_user_subscriptions_for_course()

static tool_monitor\subscription_manager::count_user_subscriptions_for_course	(	$courseid,
		$userid = `0`
	)

static

Get count of subscriptions for a given user in a given course.

Parameters

int	$courseid	course id.
int	$userid	Id of the user for which the subscription needs to be fetched. Defaults to $USER;

Return values

int	number of subscriptions

◆ create_subscription()

static tool_monitor\subscription_manager::create_subscription	(	$ruleid,
		$courseid,
		$cmid,
		$userid = `0`
	)

static

Subscribe a user to a given rule.

Parameters

int	$ruleid	Rule id.
int	$courseid	Course id.
int	$cmid	Course module id.
int	$userid	User who is subscribing, defaults to $USER.

Return values

bool|int returns id of the created subscription.

◆ deactivate_subscriptions()

static tool_monitor\subscription_manager::deactivate_subscriptions ( array $ids )

static

Deactivates a group of subscriptions based on an input array of ids.

Since: 3.2.0

Parameters

array $ids of subscription ids.

Return values

bool	true if the operation was successful, false otherwise.

◆ delete_cm_subscriptions()

static tool_monitor\subscription_manager::delete_cm_subscriptions ( $cmid )

static

Delete all subscriptions for a course module.

Parameters

int $cmid cm id.

Return values

mixed

◆ delete_stale_subscriptions()

static tool_monitor\subscription_manager::delete_stale_subscriptions ( $userid = 0 )

static

Deletes subscriptions which have been inactive for a period of time.

Since: 3.2.0

Parameters

int $userid if provided, only this user's stale subscriptions will be deleted.

Return values

bool	true if the operation was successful, false otherwise.

◆ delete_subscription()

static tool_monitor\subscription_manager::delete_subscription	(	$subscriptionorid,
		$checkuser = `true`
	)

static

Delete a subscription.

Parameters

subscription \| int	$subscriptionorid	an instance of subscription class or id.
bool	$checkuser	Check if the subscription belongs to current user before deleting.

Return values

bool

Exceptions

coding_exception if $checkuser is true and the subscription doesn't belong to the current user.

◆ delete_user_subscriptions()

static tool_monitor\subscription_manager::delete_user_subscriptions ( $userid )

static

Delete all subscriptions for a user.

Parameters

int $userid user id.

Return values

mixed

◆ event_has_subscriptions()

static tool_monitor\subscription_manager::event_has_subscriptions	(	$eventname,
		$courseid
	)

static

Returns true if an event in a particular course has a subscription.

Parameters

string	$eventname	the name of the event
int	$courseid	the course id

Return values

bool	returns true if the event has subscriptions in a given course, false otherwise.

◆ get_instances()

static tool_monitor\subscription_manager::get_instances ( $arr )

staticprotected

Helper method to convert db records to instances.

Parameters

array $arr of subscriptions.

Return values

array of subscriptions as instances.

◆ get_subscription()

static tool_monitor\subscription_manager::get_subscription ( $subscriptionorid )

static

Get a subscription instance for an given subscription id.

Parameters

subscription | int $subscriptionorid an instance of subscription class or id.

Return values

subscription returns a instance of subscription class.

◆ get_subscription_join_rule_sql()

static tool_monitor\subscription_manager::get_subscription_join_rule_sql ( $count = false )

staticprotected

Return sql to join rule and subscription table.

Parameters

bool $count Weather if this is a count query or not.

Return values

string the sql.

◆ get_subscriptions_by_event()

static tool_monitor\subscription_manager::get_subscriptions_by_event ( \stdClass $event )

static

Return a list of subscriptions for a given event.

Parameters

stdClass $event the event object.

Return values

array

◆ get_user_subscriptions()

static tool_monitor\subscription_manager::get_user_subscriptions	(		$limitfrom = `0`,
			$limitto = `0`,
			$userid = `0`,
			$order = `'s.courseid ASC`,
		r.name'
	)

static

Get an array of subscriptions for a given user.

Parameters

int	$limitfrom	Limit from which to fetch rules.
int	$limitto	Limit to which rules need to be fetched.
int	$userid	Id of the user for which the subscription needs to be fetched. Defaults to $USER;
string	$order	Order to sort the subscriptions.

Return values

array list of subscriptions

◆ get_user_subscriptions_for_course()

static tool_monitor\subscription_manager::get_user_subscriptions_for_course	(	$courseid,
		$limitfrom = `0`,
		$limitto = `0`,
		$userid = `0`,
		$order = `'s.timecreated DESC'`
	)

static

Get an array of subscriptions for a given user in a given course.

Parameters

int	$courseid	course id.
int	$limitfrom	Limit from which to fetch rules.
int	$limitto	Limit to which rules need to be fetched.
int	$userid	Id of the user for which the subscription needs to be fetched. Defaults to $USER;
string	$order	Order to sort the subscriptions.

Return values

array list of subscriptions

◆ remove_all_subscriptions_for_rule()

static tool_monitor\subscription_manager::remove_all_subscriptions_for_rule	(	$ruleid,
		$coursecontext = `null`
	)

static

Delete all subscribers for a given rule.

Parameters

int	$ruleid	rule id.
context \| null	$coursecontext	the context of the course - this is passed when we can not get the context via context_course as the course has been deleted.

Return values

bool

◆ remove_all_subscriptions_in_course()

static tool_monitor\subscription_manager::remove_all_subscriptions_in_course ( $coursecontext )

static

Delete all subscriptions in a course.

This is called after a course was deleted, context no longer exists but we kept the object

Parameters

context_course $coursecontext the context of the course

◆ subscription_is_active()

static tool_monitor\subscription_manager::subscription_is_active ( subscription $subscription )

static

Check whether a subscription is active.

Since: 3.2.0

Parameters

tool_monitor::subscription $subscription instance.

Return values

bool	true if the subscription is active, false otherwise.

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

admin/tool/monitor/classes/subscription_manager.php

Static Public Member Functions

Public Attributes

Static Protected Member Functions

Detailed Description

Member Function Documentation

◆ activate_subscriptions()

◆ count_rule_subscriptions()

◆ count_user_subscriptions()

◆ count_user_subscriptions_for_course()

◆ create_subscription()

◆ deactivate_subscriptions()

◆ delete_cm_subscriptions()

◆ delete_stale_subscriptions()

◆ delete_subscription()

◆ delete_user_subscriptions()

◆ event_has_subscriptions()

◆ get_instances()

◆ get_subscription()

◆ get_subscription_join_rule_sql()

◆ get_subscriptions_by_event()

◆ get_user_subscriptions()

◆ get_user_subscriptions_for_course()

◆ remove_all_subscriptions_for_rule()

◆ remove_all_subscriptions_in_course()

◆ subscription_is_active()