ilCourseWaitingList Class Reference

Course waiting list. More...

Inheritance diagram for ilCourseWaitingList:

Collaboration diagram for ilCourseWaitingList:

Public Member Functions
	addToList ($a_usr_id)
	Add to waiting list and raise event. More...
	removeFromList ($a_usr_id)
	Remove from waiting list and raise event. More...
Public Member Functions inherited from ilWaitingList
	__construct ($a_obj_id)
	Constructor. More...
	getObjId ()
	get obj id More...
	addToList ($a_usr_id)
	add to list More...
	updateSubscriptionTime ($a_usr_id, $a_subtime)
	update subscription time More...
	removeFromList ($a_usr_id)
	remove usr from list More...
	isOnList ($a_usr_id)
	check if is on waiting list More...
	getCountUsers ()
	get number of users More...
	getPosition ($a_usr_id)
	get position More...
	getAllUsers ()
	get all users on waiting list More...
	getUser ($a_usr_id)
	get user More...
	getUserIds ()
	Get all user ids of users on waiting list. More...

Additional Inherited Members
Static Public Member Functions inherited from ilWaitingList
static	lookupListSize ($a_obj_id)
	Lookup waiting lit size. More...
static	_deleteAll ($a_obj_id)
	delete all More...
static	_deleteUser ($a_usr_id)
	Delete user. More...
static	deleteUserEntry ($a_usr_id, $a_obj_id)
	Delete one user entry. More...
static	_isOnList ($a_usr_id, $a_obj_id)
	Check if a user on the waiting list. More...
static	_preloadOnListInfo ($a_usr_ids, $a_obj_ids)
	Preload on list info. More...
Static Public Attributes inherited from ilWaitingList
static	$is_on_list = array()

Detailed Description

Course waiting list.

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

Definition at line 16 of file class.ilCourseWaitingList.php.

Member Function Documentation

addToList()

ilCourseWaitingList::addToList

(

$a_usr_id

)

Add to waiting list and raise event.

Parameters

int

$a_usr_id

Reimplemented from ilWaitingList.

Definition at line 22 of file class.ilCourseWaitingList.php.

    {
        global $DIC;
 
        $ilAppEventHandler = $DIC['ilAppEventHandler'];
        $ilLog = $DIC['ilLog'];
        
        if (!parent::addToList($a_usr_id)) {
            return false;
        }
        
        $ilLog->write(__METHOD__ . ': Raise new event: Modules/Course addToList');
        $ilAppEventHandler->raise(
            "Modules/Course",
            'addToWaitingList',
            array(
                    'obj_id' => $this->getObjId(),
                    'usr_id' => $a_usr_id
                )
        );
        return true;
    }

References $DIC, $ilLog, and ilWaitingList\getObjId().

Here is the call graph for this function:

removeFromList()

ilCourseWaitingList::removeFromList

(

$a_usr_id

)

Remove from waiting list and raise event.

Parameters

int

$a_usr_id

Reimplemented from ilWaitingList.

Definition at line 50 of file class.ilCourseWaitingList.php.

    {
        global $DIC;
 
        $ilAppEventHandler = $DIC['ilAppEventHandler'];
        $ilLog = $DIC['ilLog'];
 
        if (!parent::removeFromList($a_usr_id)) {
            return false;
        }
 
        $ilLog->write(__METHOD__ . ': Raise new event: Modules/Course removeFromList');
        $ilAppEventHandler->raise(
            "Modules/Course",
            'removeFromWaitingList',
            array(
                'obj_id' => $this->getObjId(),
                'usr_id' => $a_usr_id
            )
        );
        return true;
    }

References $DIC, $ilLog, and ilWaitingList\getObjId().

Here is the call graph for this function:

---

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

• Modules/Course/classes/class.ilCourseWaitingList.php