ForumAbo Class Reference

Static Public Member Functions
static	add ($topic_id, $user_id=null)
static	delete ($topic_id, $user_id=null)
static	has ($topic_id, $user_id=null)
static	notify ($topic_id)
static	removeForCourseAndUser ($course_id, $user_id)

Member Function Documentation

add()

static add (   $topic_id,   $user_id = null  )

static

add the passed user as a watcher for the passed topic (including all current and future childs)

Parameters

string	$topic_id
string	$user_id

delete()

static delete (   $topic_id,   $user_id = null  )

static

remove the passed user as a watcher from the passed topic (including all current and future childs)

Parameters

string	$topic_id
string	$user_id

has()

static has (   $topic_id,   $user_id = null  )

static

check, if the passed user watches the passed topic. If no user_id is passed, the currently logged in user is used

Parameters

string	$topic_id
string	$user_id

Returns

boolean returns true if user is watching, false otherwise

notify()

static notify (   $topic_id )

static

send out the notification messages for the passed topic. The contents and a link directly to the topic are added to the message.

Parameters

string

$topic_id

removeForCourseAndUser()

static removeForCourseAndUser (   $course_id,   $user_id  )

static

Removes all abos for a given course and user

Parameters

String	$course_id	Id of the course
String	$user_id	Id of the user

Returns

int number of removed abos

---

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

• lib/classes/ForumAbo.php