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

Inheritance diagram for ilWaitingList:

Collaboration diagram for ilWaitingList:

Public Member Functions
	__construct (int $a_obj_id)

	getObjId ()

	addToList (int $a_usr_id)

	updateSubscriptionTime (int $a_usr_id, int $a_subtime)

	removeFromList (int $a_usr_id)

	isOnList (int $a_usr_id)

	getCountUsers ()

	getPosition (int $a_usr_id)

	getAllUsers ()
	get all users on waiting list public More...

	getUser (int $a_usr_id)
	get user More...

	getUserIds ()

Static Public Member Functions
static	lookupListSize (int $a_obj_id)

static	_deleteAll (int $a_obj_id)

static	_deleteUser (int $a_usr_id)

static	deleteUserEntry (int $a_usr_id, int $a_obj_id)

static	_isOnList (int $a_usr_id, int $a_obj_id)

static	_preloadOnListInfo (array $a_usr_ids, array $a_obj_ids)
	Preload on list info. More...

Static Public Attributes
static array	$is_on_list = []

Protected Attributes
ilDBInterface	$db

ilAppEventHandler	$eventHandler

Private Member Functions
	read ()

Private Attributes
int	$obj_id = 0

array	$user_ids = []

array	$users = []

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

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

Constructor & Destructor Documentation

◆ __construct()

ilWaitingList::__construct ( int $a_obj_id )

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

References $DIC, and read().

     {
         global $DIC;
 
         $this->db = $DIC->database();
         $this->eventHandler = $DIC->event();
         $this->obj_id = $a_obj_id;
         if ($a_obj_id) {
             $this->read();
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ _deleteAll()

static ilWaitingList::_deleteAll ( int $a_obj_id )

static

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

References $DIC, $ilDB, and $res.

Referenced by ilSoapCourseAdministration\excludeCourseMember().

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

Here is the caller graph for this function:

◆ _deleteUser()

static ilWaitingList::_deleteUser ( int $a_usr_id )

static

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

References $DIC, $ilDB, and $res.

Referenced by ilParticipants\_deleteUser().

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

Here is the caller graph for this function:

◆ _isOnList()

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

static

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

References $DIC, $ilDB, and $res.

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

                                                                   : bool
     {
         global $DIC;
 
         $ilDB = $DIC['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 (bool) $res->numRows();
     }

Here is the caller graph for this function:

◆ _preloadOnListInfo()

static ilWaitingList::_preloadOnListInfo	(	array	$a_usr_ids,
		array	$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.

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

References $DIC, $ilDB, $obj_id, $res, and ILIAS\Repository\int().

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

                                                                                  : void
     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
         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[(int) $rec["usr_id"]][(int) $rec["obj_id"]] = true;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addToList()

ilWaitingList::addToList ( int $a_usr_id )

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

References $res, getObjId(), isOnList(), and read().

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

Here is the call graph for this function:

◆ deleteUserEntry()

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

static

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

References $DIC, and $ilDB.

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

                                                                         : void
     {
         global $DIC;
 
         $ilDB = $DIC->database();
         $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);
     }

Here is the caller graph for this function:

◆ getAllUsers()

ilWaitingList::getAllUsers ( )

get all users on waiting list public

Returns: array<int, array<{position: int, time: int, usr_id: int}>>

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

References $users.

Referenced by ilCourseXMLWriter\__buildWaitingList().

                                  : array
     {
         return $this->users;
     }

Here is the caller graph for this function:

◆ getCountUsers()

ilWaitingList::getCountUsers ( )

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

Referenced by ilGroupRegistrationGUI\fillMaxMembers(), and ilCourseRegistrationGUI\fillMaxMembers().

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

Here is the caller graph for this function:

◆ getObjId()

ilWaitingList::getObjId ( )

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

References $obj_id.

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

                               : int
     {
         return $this->obj_id;
     }

Here is the caller graph for this function:

◆ getPosition()

ilWaitingList::getPosition ( int $a_usr_id )

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

Referenced by ilGroupRegistrationGUI\fillMaxMembers(), and ilCourseRegistrationGUI\fillMaxMembers().

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

Here is the caller graph for this function:

◆ getUser()

ilWaitingList::getUser ( int $a_usr_id )

get user

Parameters

int usr_id

Returns: array<{position: int, time: int, usr_id: int}>

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

                                           : array
     {
         return $this->users[$a_usr_id] ?? [];
     }

◆ getUserIds()

ilWaitingList::getUserIds ( )

Returns: int[]

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

References $user_ids.

                                 : array
     {
         return $this->user_ids;
     }

◆ isOnList()

ilWaitingList::isOnList ( int $a_usr_id )

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

Referenced by addToList(), ilGroupRegistrationGUI\fillMaxMembers(), and ilCourseRegistrationGUI\fillMaxMembers().

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

Here is the caller graph for this function:

◆ lookupListSize()

static ilWaitingList::lookupListSize ( int $a_obj_id )

static

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

References $DIC, $ilDB, $res, and ilDBConstants\FETCHMODE_OBJECT.

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

                                                         : int
     {
         global $DIC;
 
         $ilDB = $DIC->database();
         $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

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

References $res, ilDBConstants\FETCHMODE_OBJECT, getObjId(), and ILIAS\Repository\int().

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

                            : void
     {
         $this->users = [];
         $query = "SELECT * FROM crs_waiting_list " .
             "WHERE obj_id = " . $this->db->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[(int) $row->usr_id]['position'] = $counter;
             $this->users[(int) $row->usr_id]['time'] = (int) $row->sub_time;
             $this->users[(int) $row->usr_id]['usr_id'] = (int) $row->usr_id;
 
             $this->user_ids[] = (int) $row->usr_id;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeFromList()

ilWaitingList::removeFromList ( int $a_usr_id )

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

References getObjId(), and read().

                                                  : bool
     {
         $query = "DELETE FROM crs_waiting_list " .
             " WHERE obj_id = " . $this->db->quote($this->getObjId(), 'integer') . " " .
             " AND usr_id = " . $this->db->quote($a_usr_id, 'integer') . " ";
         $affected = $this->db->manipulate($query);
         $this->read();
         return $affected > 0;
     }

Here is the call graph for this function:

◆ updateSubscriptionTime()

ilWaitingList::updateSubscriptionTime	(	int	$a_usr_id,
		int	$a_subtime
	)

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

References $res, and getObjId().

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

Here is the call graph for this function:

Field Documentation

◆ $db

ilDBInterface ilWaitingList::$db

protected

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

◆ $eventHandler

ilAppEventHandler ilWaitingList::$eventHandler

protected

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

◆ $is_on_list

array ilWaitingList::$is_on_list = []

static

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

◆ $obj_id

int ilWaitingList::$obj_id = 0

private

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

Referenced by _preloadOnListInfo(), and getObjId().

◆ $user_ids

array ilWaitingList::$user_ids = []

private

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

Referenced by getUserIds().

◆ $users

array ilWaitingList::$users = []

private

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

Referenced by getAllUsers().

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

components/ILIAS/Membership/classes/class.ilWaitingList.php

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected 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

◆ $eventHandler

◆ $is_on_list

◆ $obj_id

◆ $user_ids

◆ $users