ILIAS
release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
|
Base class for course and group waiting lists. More...
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... | |
_preloadOnListInfo ($a_usr_ids, $a_obj_ids) | |
Preload on list info. 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 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() | |
Base class for course and group waiting lists.
Definition at line 33 of file class.ilWaitingList.php.
ilWaitingList::__construct | ( | $a_obj_id | ) |
Constructor.
@access public
int | obj_id |
Definition at line 49 of file class.ilWaitingList.php.
|
static |
delete all
@access public
int | obj_id |
Definition at line 84 of file class.ilWaitingList.php.
References $ilDB, $query, and $res.
Referenced by ilMembershipTest\testMembership(), and ilSoapCourseAdministration\updateCourse().
|
static |
Delete user.
@access public
int | user_id |
Definition at line 101 of file class.ilWaitingList.php.
References $ilDB, $query, and $res.
Referenced by ilParticipants\_deleteUser(), and ilMembershipTest\testMembership().
|
static |
Check if a user on the waiting list.
object | $a_usr_id | |
object | $a_obj_id | @access public |
Definition at line 225 of file class.ilWaitingList.php.
References $ilDB, $query, and $res.
Referenced by ilObjCourseAccess\_checkAccess(), ilObjGroupAccess\_checkAccess(), ilObjCourseListGUI\getProperties(), ilObjGroupListGUI\getProperties(), ilObjCourseGUI\getTabs(), ilObjGroupGUI\getTabs(), and ilObjSessionGUI\showJoinRequestButton().
ilWaitingList::_preloadOnListInfo | ( | $a_usr_ids, | |
$a_obj_ids | |||
) |
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.
array | $a_usr_ids | array of user ids |
array | $a_obj_ids | array of object ids |
Definition at line 251 of file class.ilWaitingList.php.
References $ilDB, $obj_id, $query, and $res.
Referenced by ilObjCourseAccess\_preloadData(), and ilObjGroupAccess\_preloadData().
ilWaitingList::addToList | ( | $a_usr_id | ) |
add to list
@access public
int | usr_id |
Reimplemented in ilCourseWaitingList, ilGroupWaitingList, and ilSessionWaitingList.
Definition at line 146 of file class.ilWaitingList.php.
References $ilDB, $query, $res, getObjId(), isOnList(), and read().
|
static |
Delete one user entry.
int | $a_usr_id | |
int | $a_obj_id |
Definition at line 117 of file class.ilWaitingList.php.
Referenced by ilParticipant\add(), ilParticipants\add(), and ilObjSessionGUI\unregisterObject().
ilWaitingList::getAllUsers | ( | ) |
get all users on waiting list
@access public
Definition at line 312 of file class.ilWaitingList.php.
ilWaitingList::getCountUsers | ( | ) |
get number of users
@access public
Definition at line 289 of file class.ilWaitingList.php.
ilWaitingList::getObjId | ( | ) |
get obj id
@access public
Definition at line 135 of file class.ilWaitingList.php.
References $obj_id.
Referenced by ilCourseWaitingList\addToList(), ilGroupWaitingList\addToList(), ilSessionWaitingList\addToList(), addToList(), read(), ilCourseWaitingList\removeFromList(), removeFromList(), and updateSubscriptionTime().
ilWaitingList::getPosition | ( | $a_usr_id | ) |
get position
@access public
int | usr_id |
Definition at line 301 of file class.ilWaitingList.php.
ilWaitingList::getUser | ( | $a_usr_id | ) |
get user
@access public
int | usr_id |
Definition at line 324 of file class.ilWaitingList.php.
ilWaitingList::getUserIds | ( | ) |
Get all user ids of users on waiting list.
Definition at line 334 of file class.ilWaitingList.php.
ilWaitingList::isOnList | ( | $a_usr_id | ) |
check if is on waiting list
@access public
int | usr_id |
Definition at line 212 of file class.ilWaitingList.php.
Referenced by addToList().
|
static |
Lookup waiting lit size.
int | $a_obj_id |
Definition at line 63 of file class.ilWaitingList.php.
References $ilDB, $query, $res, $row, and DB_FETCHMODE_OBJECT.
Referenced by ilObjCourseAccess\lookupRegistrationInfo(), and ilObjGroupAccess\lookupRegistrationInfo().
|
private |
Read waiting list.
@access private
return
Definition at line 347 of file class.ilWaitingList.php.
References $ilDB, $query, $res, $row, DB_FETCHMODE_OBJECT, and getObjId().
Referenced by __construct(), addToList(), and removeFromList().
ilWaitingList::removeFromList | ( | $a_usr_id | ) |
remove usr from list
@access public
int | usr_id |
Reimplemented in ilCourseWaitingList.
Definition at line 192 of file class.ilWaitingList.php.
References $ilDB, $query, $res, getObjId(), and read().
ilWaitingList::updateSubscriptionTime | ( | $a_usr_id, | |
$a_subtime | |||
) |
update subscription time
@access public
int | usr_id |
int | subsctription time |
Definition at line 173 of file class.ilWaitingList.php.
References $ilDB, $query, $res, and getObjId().
|
private |
Definition at line 35 of file class.ilWaitingList.php.
|
static |
Definition at line 40 of file class.ilWaitingList.php.
|
private |
Definition at line 36 of file class.ilWaitingList.php.
Referenced by _preloadOnListInfo(), and getObjId().
|
private |
Definition at line 37 of file class.ilWaitingList.php.
|
private |
Definition at line 38 of file class.ilWaitingList.php.