Base class for course and group waiting lists. More...

Inheritance diagram for ilWaitingList:

Collaboration diagram for ilWaitingList:

Public Member Functions
	__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...

Static Public Member Functions
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
static	$is_on_list = array()

Private Member Functions
	read ()
	Read waiting list. More...

Private Attributes
	$db = null

	$obj_id = 0

	$user_ids = array()

	$users = array()

Detailed Description

Base class for course and group waiting lists.

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

Version: $Id$

Definition at line 33 of file class.ilWaitingList.php.

Constructor & Destructor Documentation

◆ __construct()

ilWaitingList::__construct ( $a_obj_id )

Constructor.

public

Parameters

int obj_id

Definition at line 49 of file class.ilWaitingList.php.

References $ilDB, and read().

     {
         global $ilDB;
 
         $this->db = $ilDB;
         $this->obj_id = $a_obj_id;
 
         $this->read();
     }

Here is the call graph for this function:

Member Function Documentation

◆ _deleteAll()

static ilWaitingList::_deleteAll ( $a_obj_id )

static

delete all

public

Parameters

int obj_id

Definition at line 83 of file class.ilWaitingList.php.

References $ilDB, $query, and $res.

Referenced by ilMembershipTest\testMembership(), and ilSoapCourseAdministration\updateCourse().

     {
         global $ilDB;
 
         $query = "DELETE FROM crs_waiting_list WHERE obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " ";
         $res = $ilDB->manipulate($query);
 
         return true;
     }

Here is the caller graph for this function:

◆ _deleteUser()

static ilWaitingList::_deleteUser ( $a_usr_id )

static

Delete user.

public

Parameters

int user_id

Definition at line 100 of file class.ilWaitingList.php.

References $ilDB, $query, and $res.

Referenced by ilParticipants\_deleteUser(), and ilMembershipTest\testMembership().

     {
         global $ilDB;
 
         $query = "DELETE FROM crs_waiting_list WHERE usr_id = " . $ilDB->quote($a_usr_id, 'integer');
         $res = $ilDB->manipulate($query);
 
         return true;
     }

Here is the caller graph for this function:

◆ _isOnList()

static ilWaitingList::_isOnList	(	$a_usr_id,
		$a_obj_id
	)

static

Check if a user on the waiting list.

Returns: bool

Parameters

object	$a_usr_id
object	$a_obj_id	public

Definition at line 223 of file class.ilWaitingList.php.

References $ilDB, $query, and $res.

Referenced by ilObjGroupAccess\_checkAccess(), ilObjCourseAccess\_checkAccess(), ilObjSessionAccess\_checkAccess(), ilObjCourseListGUI\getProperties(), ilObjGroupListGUI\getProperties(), ilObjGroupGUI\getTabs(), ilObjCourseGUI\getTabs(), and ilObjSessionGUI\showJoinRequestButton().

     {
         global $ilDB;
         
         if (isset(self::$is_on_list[$a_usr_id][$a_obj_id])) {
             return self::$is_on_list[$a_usr_id][$a_obj_id];
         }
         
         $query = "SELECT usr_id " .
             "FROM crs_waiting_list " .
             "WHERE obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " " .
             "AND usr_id = " . $ilDB->quote($a_usr_id, 'integer');
         $res = $ilDB->query($query);
         return $res->numRows() ? true : false;
     }

Here is the caller graph for this function:

◆ _preloadOnListInfo()

static ilWaitingList::_preloadOnListInfo	(	$a_usr_ids,
		$a_obj_ids
	)

static

Preload on list info.

This is used, e.g. in the repository to prevent multiple reads on the waiting list table. The function is triggered in the preload functions of ilObjCourseAccess and ilObjGroupAccess.

Parameters

array	$a_usr_ids	array of user ids
array	$a_obj_ids	array of object ids

Definition at line 248 of file class.ilWaitingList.php.

References $ilDB, $obj_id, $query, $res, and array.

Referenced by ilObjGroupAccess\_preloadData(), and ilObjCourseAccess\_preloadData().

     {
         global $ilDB;
         
         if (!is_array($a_usr_ids)) {
             $a_usr_ids = array($a_usr_ids);
         }
         if (!is_array($a_obj_ids)) {
             $a_obj_ids = array($a_obj_ids);
         }
         foreach ($a_usr_ids as $usr_id) {
             foreach ($a_obj_ids as $obj_id) {
                 self::$is_on_list[$usr_id][$obj_id] = false;
             }
         }
         $query = "SELECT usr_id, obj_id " .
             "FROM crs_waiting_list " .
             "WHERE " .
             $ilDB->in("obj_id", $a_obj_ids, false, "integer") . " AND " .
             $ilDB->in("usr_id", $a_usr_ids, false, "integer");
         $res = $ilDB->query($query);
         while ($rec = $ilDB->fetchAssoc($res)) {
             self::$is_on_list[$rec["usr_id"]][$rec["obj_id"]] = true;
         }
     }

Here is the caller graph for this function:

◆ addToList()

ilWaitingList::addToList ( $a_usr_id )

add to list

public

Parameters

int usr_id

Definition at line 145 of file class.ilWaitingList.php.

References $ilDB, $query, $res, getObjId(), isOnList(), read(), and time.

     {
         global $ilDB;
         
         if ($this->isOnList($a_usr_id)) {
             return false;
         }
         $query = "INSERT INTO crs_waiting_list (obj_id,usr_id,sub_time) " .
             "VALUES (" .
             $ilDB->quote($this->getObjId(), 'integer') . ", " .
             $ilDB->quote($a_usr_id, 'integer') . ", " .
             $ilDB->quote(time(), 'integer') . " " .
             ")";
         $res = $ilDB->manipulate($query);
         $this->read();
 
         return true;
     }

Here is the call graph for this function:

◆ deleteUserEntry()

static ilWaitingList::deleteUserEntry	(	$a_usr_id,
		$a_obj_id
	)

static

Delete one user entry.

Parameters

int	$a_usr_id
int	$a_obj_id

Returns

Definition at line 116 of file class.ilWaitingList.php.

References $ilDB, and $query.

Referenced by ilParticipant\add(), ilParticipants\add(), and ilObjSessionGUI\unregisterObject().

     {
         global $ilDB;
         
         $query = "DELETE FROM crs_waiting_list " .
             "WHERE usr_id = " . $ilDB->quote($a_usr_id, 'integer') . ' ' .
             "AND obj_id = " . $ilDB->quote($a_obj_id, 'integer');
         $ilDB->query($query);
         return true;
     }

Here is the caller graph for this function:

◆ getAllUsers()

ilWaitingList::getAllUsers ( )

get all users on waiting list

public

Returns: array array(position,time,usr_id)

Definition at line 304 of file class.ilWaitingList.php.

References array.

Referenced by ilCourseXMLWriter\__buildWaitingList().

     {
         return $this->users ? $this->users : array();
     }

Here is the caller graph for this function:

◆ getCountUsers()

ilWaitingList::getCountUsers ( )

get number of users

public

Returns: int number of users

Definition at line 281 of file class.ilWaitingList.php.

     {
         return count($this->users);
     }

◆ getObjId()

ilWaitingList::getObjId ( )

get obj id

public

Returns: int obj_id

Definition at line 134 of file class.ilWaitingList.php.

References $obj_id.

Referenced by ilSessionWaitingList\addToList(), ilCourseWaitingList\addToList(), ilGroupWaitingList\addToList(), addToList(), read(), ilCourseWaitingList\removeFromList(), removeFromList(), and updateSubscriptionTime().

     {
         return $this->obj_id;
     }

Here is the caller graph for this function:

◆ getPosition()

ilWaitingList::getPosition ( $a_usr_id )

get position

public

Parameters

int usr_id

Returns: position of user otherwise -1

Definition at line 293 of file class.ilWaitingList.php.

     {
         return isset($this->users[$a_usr_id]) ? $this->users[$a_usr_id]['position'] : -1;
     }

◆ getUser()

ilWaitingList::getUser ( $a_usr_id )

get user

public

Parameters

int usr_id

Returns

Definition at line 316 of file class.ilWaitingList.php.

     {
         return isset($this->users[$a_usr_id]) ? $this->users[$a_usr_id] : false;
     }

◆ getUserIds()

ilWaitingList::getUserIds ( )

Get all user ids of users on waiting list.

Definition at line 326 of file class.ilWaitingList.php.

References array.

     {
         return $this->user_ids ? $this->user_ids : array();
     }

◆ isOnList()

ilWaitingList::isOnList ( $a_usr_id )

check if is on waiting list

public

Parameters

int usr_id

Returns

Definition at line 210 of file class.ilWaitingList.php.

Referenced by addToList().

     {
         return isset($this->users[$a_usr_id]) ? true : false;
     }

Here is the caller graph for this function:

◆ lookupListSize()

static ilWaitingList::lookupListSize ( $a_obj_id )

static

Lookup waiting lit size.

Parameters

int $a_obj_id

Definition at line 63 of file class.ilWaitingList.php.

References $ilDB, $query, $res, $row, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilObjGroupAccess\lookupRegistrationInfo(), and ilObjCourseAccess\lookupRegistrationInfo().

     {
         global $ilDB;
         
         $query = 'SELECT count(usr_id) num from crs_waiting_list WHERE obj_id = ' . $ilDB->quote($a_obj_id, 'integer');
         $res = $ilDB->query($query);
         
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             return (int) $row->num;
         }
         return 0;
     }

Here is the caller graph for this function:

◆ read()

ilWaitingList::read ( )

private

Read waiting list.

private

Parameters

Definition at line 339 of file class.ilWaitingList.php.

References $counter, $ilDB, $query, $res, $row, array, ilDBConstants\FETCHMODE_OBJECT, and getObjId().

Referenced by __construct(), addToList(), and removeFromList().

     {
         global $ilDB;
         
         $this->users = array();
 
         $query = "SELECT * FROM crs_waiting_list " .
             "WHERE obj_id = " . $ilDB->quote($this->getObjId(), 'integer') . " ORDER BY sub_time";
 
         $res = $this->db->query($query);
         $counter = 0;
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             ++$counter;
             $this->users[$row->usr_id]['position']      = $counter;
             $this->users[$row->usr_id]['time']          = $row->sub_time;
             $this->users[$row->usr_id]['usr_id']        = $row->usr_id;
             
             $this->user_ids[] = $row->usr_id;
         }
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeFromList()

ilWaitingList::removeFromList ( $a_usr_id )

remove usr from list

public

Parameters

int usr_id

Returns

Definition at line 190 of file class.ilWaitingList.php.

References $ilDB, $query, $res, getObjId(), and read().

     {
         global $ilDB;
         
         $query = "DELETE FROM crs_waiting_list " .
             " WHERE obj_id = " . $ilDB->quote($this->getObjId(), 'integer') . " " .
             " AND usr_id = " . $ilDB->quote($a_usr_id, 'integer') . " ";
         $res = $ilDB->manipulate($query);
         $this->read();
 
         return true;
     }

Here is the call graph for this function:

◆ updateSubscriptionTime()

ilWaitingList::updateSubscriptionTime	(	$a_usr_id,
		$a_subtime
	)

update subscription time

public

Parameters

int	usr_id
int	subsctription time

Definition at line 171 of file class.ilWaitingList.php.

References $ilDB, $query, $res, and getObjId().

     {
         global $ilDB;
         
         $query = "UPDATE crs_waiting_list " .
             "SET sub_time = " . $ilDB->quote($a_subtime, 'integer') . " " .
             "WHERE usr_id = " . $ilDB->quote($a_usr_id, 'integer') . " " .
             "AND obj_id = " . $ilDB->quote($this->getObjId(), 'integer') . " ";
         $res = $ilDB->manipulate($query);
         return true;
     }

Here is the call graph for this function:

Field Documentation

◆ $db

ilWaitingList::$db = null

private

Definition at line 35 of file class.ilWaitingList.php.

◆ $is_on_list

ilWaitingList::$is_on_list = array()

static

Definition at line 40 of file class.ilWaitingList.php.

◆ $obj_id

ilWaitingList::$obj_id = 0

private

Definition at line 36 of file class.ilWaitingList.php.

Referenced by _preloadOnListInfo(), and getObjId().

◆ $user_ids

ilWaitingList::$user_ids = array()

private

Definition at line 37 of file class.ilWaitingList.php.

◆ $users

ilWaitingList::$users = array()

private

Definition at line 38 of file class.ilWaitingList.php.

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

Services/Membership/classes/class.ilWaitingList.php

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _deleteAll()

◆ _deleteUser()

◆ _isOnList()

◆ _preloadOnListInfo()

◆ addToList()

◆ deleteUserEntry()

◆ getAllUsers()

◆ getCountUsers()

◆ getObjId()

◆ getPosition()

◆ getUser()

◆ getUserIds()

◆ isOnList()

◆ lookupListSize()

◆ read()

◆ removeFromList()

◆ updateSubscriptionTime()

Field Documentation

◆ $db

◆ $is_on_list

◆ $obj_id

◆ $user_ids

◆ $users