ILIAS
release_4-3 Revision
|
Public Member Functions | |
__construct ($a_obj_id) | |
Singleton Constructor. | |
getType () | |
Get object type. | |
getNotificationRecipients () | |
Get admin, tutor which have notification enabled. | |
getCountMembers () | |
Get number of members (not participants) | |
getCountParticipants () | |
Get number of participants. | |
getParticipants () | |
Get all participants ids. | |
getMembers () | |
Get all members ids (admins and tutors are not members) Use get participants to fetch all. | |
getAdmins () | |
Get all admins ids. | |
getCountAdmins () | |
Get number of admins. | |
getTutors () | |
Get all tutors ids. | |
isAdmin ($a_usr_id) | |
is user admin | |
isTutor ($a_usr_id) | |
is user tutor | |
isMember ($a_usr_id) | |
is user member | |
isAssigned ($a_usr_id) | |
check if user is assigned | |
isLastAdmin ($a_usr_id) | |
Check if user is last admin. | |
getRoles () | |
Get course roles. | |
getAssignedRoles ($a_usr_id) | |
Get assigned roles. | |
updateRoleAssignments ($a_usr_id, $a_roles) | |
Update role assignments. | |
checkLastAdmin ($a_usr_ids) | |
Check if user for deletion are last admins. | |
isBlocked ($a_usr_id) | |
Check if user is blocked. | |
hasPassed ($a_usr_id) | |
Check if user has passed course. | |
delete ($a_usr_id) | |
Drop user from all roles. | |
updateBlocked ($a_usr_id, $a_blocked) | |
Update blocked status. | |
updateNotification ($a_usr_id, $a_notification) | |
Update notification status. | |
add ($a_usr_id, $a_role) | |
Add user to course. | |
deleteParticipants ($a_user_ids) | |
Delete users. | |
addDesktopItem ($a_usr_id) | |
Add desktop item. | |
dropDesktopItem ($a_usr_id) | |
Drop desktop item. | |
isNotificationEnabled ($a_usr_id) | |
check if notification is enabled | |
isGroupingMember ($a_usr_id, $a_field= '') | |
Check grouping membership. | |
getSubscribers () | |
get all subscribers | |
getCountSubscribers () | |
get number of subscribers | |
getSubscriberData ($a_usr_id) | |
get subscriber data | |
assignSubscribers ($a_usr_ids) | |
Assign subscribers. | |
assignSubscriber ($a_usr_id) | |
Assign subscriber. | |
autoFillSubscribers () | |
Assign subscriber. | |
addSubscriber ($a_usr_id) | |
Add subscriber. | |
updateSubscriptionTime ($a_usr_id, $a_subtime) | |
Update subscription time. | |
updateSubject ($a_usr_id, $a_subject) | |
update subject | |
deleteSubscriber ($a_usr_id) | |
Delete subsciber. | |
deleteSubscribers ($a_usr_ids) | |
Delete subscibers. | |
isSubscriber ($a_usr_id) | |
check if is subscriber |
Static Public Member Functions | |
static | getInstanceByObjId ($a_obj_id) |
Get instance by obj type. | |
static | hasParticipantListAccess ($a_obj_id, $a_usr_id=null) |
Check if (current) user has access to the participant list. | |
static | _getMembershipByType ($a_usr_id, $a_type, $a_only_member_role=false) |
get membership by type Get course or group membership | |
static | _isParticipant ($a_ref_id, $a_usr_id) |
Static function to check if a user is a participant of the container object. | |
static | lookupNumberOfParticipants ($a_ref_id) |
Lookup the number of participants (crs admins, tutors, members, grp admins, members) | |
static | lookupNumberOfMembers ($a_ref_id) |
Lookup number of members ilRbacReview $rbacreview <type> $ilObjDataCache. | |
static | _isBlocked ($a_obj_id, $a_usr_id) |
Check if user is blocked. | |
static | _hasPassed ($a_obj_id, $a_usr_id) |
Check if user has passed course. | |
static | _deleteAllEntries ($a_obj_id) |
Delete all entries Normally called for course deletion. | |
static | _deleteUser ($a_usr_id) |
Delete user data. | |
static | getDefaultMemberRole ($a_ref_id) |
static | lookupSubscribers ($a_obj_id) |
static | _isSubscriber ($a_obj_id, $a_usr_id) |
check if user is subscriber | |
static | lookupSubscribersData ($a_obj_id) |
Protected Member Functions | |
readSubscribers () | |
read subscribers | |
readSubscriberData ($a_usr_id) | |
read subscribers |
Protected Attributes | |
$obj_id = 0 | |
$type = '' | |
$ref_id = 0 | |
$roles = array() | |
$role_data = array() | |
$participants = array() | |
$participants_status = array() | |
$members = array() | |
$tutors = array() | |
$admins = array() | |
$subscribers = array() | |
$ilDB | |
$lng |
Private Member Functions | |
readParticipants () | |
Read participants. | |
readParticipantsStatus () | |
Read stati of participants (blocked, notification, passed) |
Definition at line 20 of file class.ilParticipants.php.
ilParticipants::__construct | ( | $a_obj_id | ) |
Singleton Constructor.
public
int | obj_id of container |
Reimplemented in ilGroupParticipants, and ilCourseParticipants.
Definition at line 48 of file class.ilParticipants.php.
References $ilDB, $lng, ilObject\_getAllReferences(), ilObject\_lookupType(), readParticipants(), and readParticipantsStatus().
|
static |
Delete all entries Normally called for course deletion.
public
int | obj_id |
Definition at line 303 of file class.ilParticipants.php.
References $ilDB, $query, and $res.
Referenced by ilObjGroup\delete(), ilObjCourse\delete(), and ilSoapCourseAdministration\updateCourse().
|
static |
Delete user data.
public
int | user id |
Definition at line 330 of file class.ilParticipants.php.
References $ilDB, $query, and $res.
|
static |
get membership by type Get course or group membership
public
int | $a_usr_id | usr_id |
string | $a_type | crs or grp |
bool | $a_only_member_role |
Definition at line 137 of file class.ilParticipants.php.
References $ilDB, $query, $res, and $row.
Referenced by ilNewsItem\_getNewsItemsOfUser(), ilBasicSkill\getCompletionDateForTriggerRefId(), ilLPProgressTableGUI\getItems(), ilPDSelectedItemsBlockGUI\getObjectsByMembership(), ilTestEvaluationData\getParticipants(), ilPortfolioAccessHandler\getPossibleSharedTargets(), ilWorkspaceAccessHandler\getPossibleSharedTargets(), ilCalendarCategories\readPDCalendars(), ilWorkspaceAccessGUI\share(), and ilMailSearchGroupsGUI\showMyGroups().
|
static |
Check if user has passed course.
public
int | obj_id |
int | user id |
Definition at line 282 of file class.ilParticipants.php.
References $ilDB, $query, and $res.
Referenced by ilObjCourse\_checkCondition().
|
static |
Check if user is blocked.
public
int | course id |
int | usr_id |
Definition at line 261 of file class.ilParticipants.php.
|
static |
Static function to check if a user is a participant of the container object.
public
int | ref_id |
int | user id |
Reimplemented in ilGroupParticipants.
Definition at line 179 of file class.ilParticipants.php.
References $ilDB, $ilLog, and $title.
Referenced by ilForumModeratorsGUI\detachModeratorRole(), ilObjCourseGUI\executeCommand(), ilObjCourseGUI\getTabs(), and ilObjCourseGUI\initHeaderAction().
|
static |
check if user is subscriber
public
Definition at line 1321 of file class.ilParticipants.php.
References $ilDB, $query, $res, $row, and DB_FETCHMODE_OBJECT.
Referenced by ilObjCourseListGUI\getProperties(), and ilMembershipTest\testSubscription().
ilParticipants::add | ( | $a_usr_id, | |
$a_role | |||
) |
Add user to course.
public
int | user id |
int | role IL_CRS_ADMIN || IL_CRS_TUTOR || IL_CRS_MEMBER |
Definition at line 787 of file class.ilParticipants.php.
References $ilLog, addDesktopItem(), deleteSubscriber(), ilWaitingList\deleteUserEntry(), IL_CRS_ADMIN, IL_CRS_MEMBER, IL_CRS_TUTOR, IL_GRP_ADMIN, IL_GRP_MEMBER, and isAssigned().
Referenced by ilGroupXMLParser\__assignMembers(), and assignSubscriber().
ilParticipants::addDesktopItem | ( | $a_usr_id | ) |
Add desktop item.
public
int | usr_id |
Definition at line 868 of file class.ilParticipants.php.
References ilObjUser\_addDesktopItem(), and ilObjUser\_isDesktopItem().
Referenced by add().
ilParticipants::addSubscriber | ( | $a_usr_id | ) |
Add subscriber.
public
Definition at line 1197 of file class.ilParticipants.php.
ilParticipants::assignSubscriber | ( | $a_usr_id | ) |
Assign subscriber.
public
Definition at line 1132 of file class.ilParticipants.php.
References $ilErr, add(), deleteSubscriber(), getInstanceByObjId(), ilObjectFactory\getInstanceByObjId(), IL_CRS_MEMBER, isAssigned(), and isSubscriber().
Referenced by assignSubscribers(), and autoFillSubscribers().
ilParticipants::assignSubscribers | ( | $a_usr_ids | ) |
Assign subscribers.
public
Definition at line 1111 of file class.ilParticipants.php.
References assignSubscriber().
ilParticipants::autoFillSubscribers | ( | ) |
Assign subscriber.
public
Definition at line 1170 of file class.ilParticipants.php.
References assignSubscriber(), and readSubscribers().
ilParticipants::checkLastAdmin | ( | $a_usr_ids | ) |
Check if user for deletion are last admins.
public
array | array of user ids for deletion |
Definition at line 622 of file class.ilParticipants.php.
References getAdmins().
ilParticipants::delete | ( | $a_usr_id | ) |
Drop user from all roles.
public
int | usr_id |
Definition at line 673 of file class.ilParticipants.php.
References $ilDB, $query, $res, dropDesktopItem(), readParticipants(), and readParticipantsStatus().
ilParticipants::deleteParticipants | ( | $a_user_ids | ) |
Delete users.
public
array | user ids |
Definition at line 852 of file class.ilParticipants.php.
ilParticipants::deleteSubscriber | ( | $a_usr_id | ) |
Delete subsciber.
public
Definition at line 1257 of file class.ilParticipants.php.
References $ilDB, $query, and $res.
Referenced by add(), assignSubscriber(), and readSubscribers().
ilParticipants::deleteSubscribers | ( | $a_usr_ids | ) |
Delete subscibers.
public
Definition at line 1275 of file class.ilParticipants.php.
References $ilDB, $ilErr, $query, and $res.
ilParticipants::dropDesktopItem | ( | $a_usr_id | ) |
Drop desktop item.
public
int | usr_id |
Definition at line 884 of file class.ilParticipants.php.
References ilObjUser\_dropDesktopItem(), and ilObjUser\_isDesktopItem().
Referenced by delete().
ilParticipants::getAdmins | ( | ) |
Get all admins ids.
public
Definition at line 459 of file class.ilParticipants.php.
Referenced by checkLastAdmin(), getCountAdmins(), and isLastAdmin().
ilParticipants::getAssignedRoles | ( | $a_usr_id | ) |
Get assigned roles.
public
int | user_id |
Definition at line 566 of file class.ilParticipants.php.
ilParticipants::getCountAdmins | ( | ) |
Get number of admins.
Definition at line 468 of file class.ilParticipants.php.
References getAdmins().
ilParticipants::getCountMembers | ( | ) |
Get number of members (not participants)
public
Definition at line 412 of file class.ilParticipants.php.
ilParticipants::getCountParticipants | ( | ) |
Get number of participants.
public
Definition at line 423 of file class.ilParticipants.php.
ilParticipants::getCountSubscribers | ( | ) |
get number of subscribers
public
Definition at line 1089 of file class.ilParticipants.php.
References getSubscribers().
|
static |
Definition at line 344 of file class.ilParticipants.php.
References $ilCtrl, $obj_id, $roles, $title, $type, ilObject\_lookupObjId(), ilObject\_lookupTitle(), and ilObject\_lookupType().
Referenced by ilStartUpGUI\_checkGoto(), and ilRbacSystem\initMemberView().
|
static |
Get instance by obj type.
int | $a_obj_id |
Definition at line 70 of file class.ilParticipants.php.
References $type, ilGroupParticipants\_getInstanceByObjId(), ilCourseParticipants\_getInstanceByObjId(), and ilObject\_lookupType().
Referenced by assignSubscriber(), hasParticipantListAccess(), isGroupingMember(), ilRepositorySearchGUI\listUsers(), and ilRepositoryObjectResultTableGUI\parseObjectIds().
ilParticipants::getMembers | ( | ) |
Get all members ids (admins and tutors are not members) Use get participants to fetch all.
public
Definition at line 449 of file class.ilParticipants.php.
ilParticipants::getNotificationRecipients | ( | ) |
Get admin, tutor which have notification enabled.
public
Definition at line 388 of file class.ilParticipants.php.
References $ilDB, $query, $res, $row, DB_FETCHMODE_OBJECT, isAdmin(), and isTutor().
Referenced by ilGroupParticipants\sendNotification(), ilCourseParticipants\sendNotificationToAdmins(), ilCourseParticipants\sendSubscriptionRequestToAdmins(), and ilCourseParticipants\sendUnsubscribeNotificationToAdmins().
ilParticipants::getParticipants | ( | ) |
Get all participants ids.
public
Definition at line 437 of file class.ilParticipants.php.
Referenced by isGroupingMember().
ilParticipants::getRoles | ( | ) |
Get course roles.
public
Definition at line 554 of file class.ilParticipants.php.
Referenced by updateRoleAssignments().
ilParticipants::getSubscriberData | ( | $a_usr_id | ) |
get subscriber data
public
Definition at line 1099 of file class.ilParticipants.php.
References readSubscriberData().
ilParticipants::getSubscribers | ( | ) |
get all subscribers
public
Definition at line 1076 of file class.ilParticipants.php.
References $subscribers, and readSubscribers().
Referenced by getCountSubscribers().
ilParticipants::getTutors | ( | ) |
Get all tutors ids.
public
Definition at line 480 of file class.ilParticipants.php.
ilParticipants::getType | ( | ) |
Get object type.
Definition at line 377 of file class.ilParticipants.php.
References $type.
|
static |
Check if (current) user has access to the participant list.
type | $a_obj | |
type | $a_usr_id |
Definition at line 93 of file class.ilParticipants.php.
References $GLOBALS, $ref_id, ilObject\_getAllReferences(), getInstanceByObjId(), and ilObjCourse\lookupShowMembersEnabled().
Referenced by ilRepositorySearchGUI\listUsers(), ilRepositoryObjectResultTableGUI\parseObjectIds(), and ilMailSearchGUI\showResults().
ilParticipants::hasPassed | ( | $a_usr_id | ) |
Check if user has passed course.
public
int | user_id |
Definition at line 657 of file class.ilParticipants.php.
Referenced by ilCourseParticipants\__buildStatusBody().
ilParticipants::isAdmin | ( | $a_usr_id | ) |
is user admin
public
int | usr_id |
Definition at line 492 of file class.ilParticipants.php.
Referenced by ilCourseParticipants\__buildStatusBody(), and getNotificationRecipients().
ilParticipants::isAssigned | ( | $a_usr_id | ) |
check if user is assigned
public
Definition at line 531 of file class.ilParticipants.php.
Referenced by add(), and assignSubscriber().
ilParticipants::isBlocked | ( | $a_usr_id | ) |
Check if user is blocked.
public
int | user_id |
Definition at line 641 of file class.ilParticipants.php.
Referenced by ilCourseParticipants\__buildStatusBody().
ilParticipants::isGroupingMember | ( | $a_usr_id, | |
$a_field = '' |
|||
) |
Check grouping membership.
public
Definition at line 1013 of file class.ilParticipants.php.
References $ilDB, $query, $res, getInstanceByObjId(), and getParticipants().
ilParticipants::isLastAdmin | ( | $a_usr_id | ) |
Check if user is last admin.
int | $a_usr_id |
Definition at line 541 of file class.ilParticipants.php.
References getAdmins().
ilParticipants::isMember | ( | $a_usr_id | ) |
is user member
public
int | usr_id |
Definition at line 516 of file class.ilParticipants.php.
Referenced by ilCourseParticipants\__buildStatusBody().
ilParticipants::isNotificationEnabled | ( | $a_usr_id | ) |
check if notification is enabled
public
Definition at line 903 of file class.ilParticipants.php.
Referenced by ilCourseParticipants\__buildStatusBody().
ilParticipants::isSubscriber | ( | $a_usr_id | ) |
check if is subscriber
public
Definition at line 1299 of file class.ilParticipants.php.
References $ilDB, $query, $res, $row, and DB_FETCHMODE_OBJECT.
Referenced by assignSubscriber().
ilParticipants::isTutor | ( | $a_usr_id | ) |
is user tutor
public
int | usr_id |
Definition at line 504 of file class.ilParticipants.php.
Referenced by ilCourseParticipants\__buildStatusBody(), and getNotificationRecipients().
|
static |
Lookup number of members ilRbacReview $rbacreview <type> $ilObjDataCache.
<type> | $a_ref_id |
Definition at line 220 of file class.ilParticipants.php.
References $title.
Referenced by ilObjCourseGUI\infoScreen().
|
static |
Lookup the number of participants (crs admins, tutors, members, grp admins, members)
ilRbacReview $rbacreview
int | $a_ref_id |
Definition at line 204 of file class.ilParticipants.php.
|
static |
Definition at line 1054 of file class.ilParticipants.php.
References $ilDB, $query, $res, $row, $subscribers, and DB_FETCHMODE_OBJECT.
Referenced by ilObjCourseGUI\membersObject().
|
static |
Definition at line 1388 of file class.ilParticipants.php.
References $data, $ilDB, $query, $res, $row, and DB_FETCHMODE_OBJECT.
Referenced by ilSubscriberTableGUI\readSubscriberData().
|
private |
Read participants.
private
Definition at line 920 of file class.ilParticipants.php.
References $ilLog, $participants, $title, IL_CRS_ADMIN, IL_CRS_MEMBER, IL_CRS_TUTOR, IL_GRP_ADMIN, and IL_GRP_MEMBER.
Referenced by __construct(), delete(), and updateRoleAssignments().
|
private |
Read stati of participants (blocked, notification, passed)
private
Definition at line 990 of file class.ilParticipants.php.
References $ilDB, $query, $res, $row, and DB_FETCHMODE_OBJECT.
Referenced by __construct(), delete(), and updateRoleAssignments().
|
protected |
read subscribers
protected
Definition at line 1370 of file class.ilParticipants.php.
References $data, $ilDB, $query, $res, $row, DB_FETCHMODE_OBJECT, and ilDB\query().
Referenced by getSubscriberData().
|
protected |
read subscribers
protected
Definition at line 1342 of file class.ilParticipants.php.
References $ilDB, $query, $res, $row, DB_FETCHMODE_OBJECT, deleteSubscriber(), ilObjectFactory\getInstanceByObjId(), and ilDB\query().
Referenced by autoFillSubscribers(), and getSubscribers().
ilParticipants::updateBlocked | ( | $a_usr_id, | |
$a_blocked | |||
) |
Update blocked status.
public
int | usr_id |
bool | blocked |
Definition at line 702 of file class.ilParticipants.php.
References $ilDB, $query, and $res.
ilParticipants::updateNotification | ( | $a_usr_id, | |
$a_notification | |||
) |
Update notification status.
public
int | usr_id |
bool | passed |
Definition at line 743 of file class.ilParticipants.php.
References $ilDB, $query, and $res.
ilParticipants::updateRoleAssignments | ( | $a_usr_id, | |
$a_roles | |||
) |
Update role assignments.
public
int | usr_id |
array | array of new roles |
Definition at line 588 of file class.ilParticipants.php.
References $roles, getRoles(), readParticipants(), and readParticipantsStatus().
ilParticipants::updateSubject | ( | $a_usr_id, | |
$a_subject | |||
) |
ilParticipants::updateSubscriptionTime | ( | $a_usr_id, | |
$a_subtime | |||
) |
|
protected |
Definition at line 33 of file class.ilParticipants.php.
|
protected |
Definition at line 37 of file class.ilParticipants.php.
Referenced by ilCourseParticipants\__buildStatusBody(), __construct(), _deleteAllEntries(), _deleteUser(), _getMembershipByType(), _hasPassed(), _isBlocked(), ilGroupParticipants\_isParticipant(), _isParticipant(), _isSubscriber(), ilCourseParticipants\_updatePassed(), addSubscriber(), delete(), deleteSubscriber(), deleteSubscribers(), ilCourseParticipants\getDateTimeOfPassed(), getNotificationRecipients(), ilCourseParticipants\getPassedInfo(), ilCourseParticipants\getPassedUsersForObjects(), isGroupingMember(), isSubscriber(), lookupSubscribers(), lookupSubscribersData(), readParticipantsStatus(), readSubscriberData(), readSubscribers(), ilCourseParticipants\sendNotificationToAdmins(), ilCourseParticipants\sendSubscriptionRequestToAdmins(), ilCourseParticipants\sendUnsubscribeNotificationToAdmins(), updateBlocked(), updateNotification(), updateSubject(), and updateSubscriptionTime().
|
protected |
Definition at line 38 of file class.ilParticipants.php.
Referenced by __construct().
|
protected |
Definition at line 31 of file class.ilParticipants.php.
|
protected |
Definition at line 22 of file class.ilParticipants.php.
Referenced by getDefaultMemberRole().
|
protected |
Definition at line 29 of file class.ilParticipants.php.
Referenced by readParticipants().
|
protected |
Definition at line 30 of file class.ilParticipants.php.
|
protected |
Definition at line 24 of file class.ilParticipants.php.
Referenced by hasParticipantListAccess().
|
protected |
Definition at line 27 of file class.ilParticipants.php.
|
protected |
Definition at line 26 of file class.ilParticipants.php.
Referenced by getDefaultMemberRole(), ilGroupParticipants\getMemberRoles(), ilCourseParticipants\getMemberRoles(), and updateRoleAssignments().
|
protected |
Definition at line 35 of file class.ilParticipants.php.
Referenced by getSubscribers(), and lookupSubscribers().
|
protected |
Definition at line 32 of file class.ilParticipants.php.
|
protected |
Definition at line 23 of file class.ilParticipants.php.
Referenced by getDefaultMemberRole(), getInstanceByObjId(), and getType().