Class used to return information to display for the message popup. More...

Static Public Member Functions
static	count_unread_popup_notifications ($useridto=0)
	Count the unread notifications for a user. More...

static	get_popup_notifications ($useridto=0, $sort='DESC', $limit=0, $offset=0)
	Get popup notifications for the specified users. More...

Detailed Description

Class used to return information to display for the message popup.

Member Function Documentation

static message_popup\api::count_unread_popup_notifications ( $useridto = 0 )

static

Count the unread notifications for a user.

Parameters

int $useridto the user id who received the notification

Return values

int	count of the unread notifications

static message_popup\api::get_popup_notifications	(	$useridto = `0`,
		$sort = `'DESC'`,
		$limit = `0`,
		$offset = `0`
	)

static

Get popup notifications for the specified users.

Nothing is returned if notifications are disabled.

Parameters

int	$useridto	the user id who received the notification
string	$sort	the column name to order by including optionally direction
int	$limit	limit the number of result returned
int	$offset	offset the result set by this amount

Return values

array notification records

Exceptions

moodle_exception

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