Inheritance diagram for ilGroupParticipants:
Collaboration diagram for ilGroupParticipants:
Public Member Functions | |
| __construct ($a_obj_id) | |
| Constructor. More... | |
| add ($a_usr_id, $a_role) | |
| Add user to role. More... | |
| addSubscriber ($a_usr_id) | |
| Add subscriber. More... | |
| sendNotification ($a_type, $a_usr_id, $a_force_sending_mail=false) | |
| Send notification mail. More... | |
| Public Member Functions inherited from ilParticipants | |
| __construct ($a_component_name, $a_ref_id) | |
| Singleton Constructor. More... | |
| getObjId () | |
| get current obj_id More... | |
| getType () | |
| Get object type. More... | |
| getNotificationRecipients () | |
| Get admin, tutor which have notification enabled. More... | |
| getCountMembers () | |
| Get number of members (not participants) More... | |
| getCountParticipants () | |
| Get number of participants. More... | |
| getParticipants () | |
| Get all participants ids. More... | |
| getMembers () | |
| Get all members ids (admins and tutors are not members) Use get participants to fetch all. More... | |
| getAdmins () | |
| Get all admins ids. More... | |
| getCountAdmins () | |
| Get number of admins. More... | |
| getTutors () | |
| Get all tutors ids. More... | |
| isAdmin ($a_usr_id) | |
| is user admin More... | |
| isTutor ($a_usr_id) | |
| is user tutor More... | |
| isMember ($a_usr_id) | |
| is user member More... | |
| isAssigned ($a_usr_id) | |
| check if user is assigned More... | |
| isLastAdmin ($a_usr_id) | |
| Check if user is last admin. More... | |
| getRoles () | |
| Get course roles. More... | |
| getAssignedRoles ($a_usr_id) | |
| Get assigned roles. More... | |
| updateRoleAssignments ($a_usr_id, $a_roles) | |
| Update role assignments. More... | |
| checkLastAdmin ($a_usr_ids) | |
| Check if user for deletion are last admins. More... | |
| isBlocked ($a_usr_id) | |
| Check if user is blocked. More... | |
| hasPassed ($a_usr_id) | |
| Check if user has passed course. More... | |
| delete ($a_usr_id) | |
| Drop user from all roles. More... | |
| updateBlocked ($a_usr_id, $a_blocked) | |
| Update blocked status. More... | |
| updateContact ($a_usr_id, $a_contact) | |
| Update contact setting @global type $ilDB. More... | |
| getContacts () | |
| get user ids which are confirgured as contact More... | |
| updateNotification ($a_usr_id, $a_notification) | |
| Update notification status. More... | |
| add ($a_usr_id, $a_role) | |
| Add user to object. More... | |
| deleteParticipants ($a_user_ids) | |
| Delete users. More... | |
| addDesktopItem ($a_usr_id) | |
| Add desktop item. More... | |
| dropDesktopItem ($a_usr_id) | |
| Drop desktop item. More... | |
| isNotificationEnabled ($a_usr_id) | |
| check if notification is enabled More... | |
| isContact ($a_usr_id) | |
| Check if user is contact. More... | |
| getAutoGeneratedRoleId ($a_role_type) | |
| Get role id of auto generated role type. More... | |
| isGroupingMember ($a_usr_id, $a_field='') | |
| Check grouping membership. More... | |
| getSubscribers () | |
| get all subscribers More... | |
| getCountSubscribers () | |
| get number of subscribers More... | |
| getSubscriberData ($a_usr_id) | |
| get subscriber data More... | |
| assignSubscribers ($a_usr_ids) | |
| Assign subscribers. More... | |
| assignSubscriber ($a_usr_id) | |
| Assign subscriber. More... | |
| autoFillSubscribers () | |
| Assign subscriber. More... | |
| addSubscriber ($a_usr_id) | |
| Add subscriber. More... | |
| updateSubscriptionTime ($a_usr_id, $a_subtime) | |
| Update subscription time. More... | |
| updateSubject ($a_usr_id, $a_subject) | |
| update subject More... | |
| deleteSubscriber ($a_usr_id) | |
| Delete subsciber. More... | |
| deleteSubscribers ($a_usr_ids) | |
| Delete subscibers. More... | |
| isSubscriber ($a_usr_id) | |
| check if is subscriber More... | |
| setRoleOrderPosition ($a_user_id) | |
| Set role order position. More... | |
Static Public Member Functions | |
| static | _getInstanceByObjId ($a_obj_id) |
| Get singleton instance. More... | |
| static | getMemberRoles ($a_ref_id) |
| Get member roles (not auto generated) More... | |
| static | _isParticipant ($a_ref_id, $a_usr_id) |
| Static function to check if a user is a participant of the container object. More... | |
| Static Public Member Functions inherited from ilParticipants | |
| static | getInstance ($a_ref_id) |
| Get instance by ref_id. More... | |
| static | getInstanceByObjId ($a_obj_id) |
| Get instance by obj type. More... | |
| static | hasParticipantListAccess ($a_obj_id, $a_usr_id=null) |
| Check if (current) user has access to the participant list. More... | |
| static | getUserMembershipAssignmentsByType ($a_user_ids, $a_type, $a_only_member_roles) |
| Get user membership assignments by type. More... | |
| static | _getMembershipByType ($a_usr_id, $a_type, $a_only_member_role=false) |
| get membership by type Get course or group membership More... | |
| static | _isParticipant ($a_ref_id, $a_usr_id) |
| Static function to check if a user is a participant of the container object. More... | |
| static | lookupNumberOfParticipants ($a_ref_id) |
| Lookup the number of participants (crs admins, tutors, members, grp admins, members) More... | |
| static | lookupNumberOfMembers ($a_ref_id) |
| Lookup number of members @global ilRbacReview $rbacreview @global <type> $ilObjDataCache. More... | |
| static | _isBlocked ($a_obj_id, $a_usr_id) |
| Check if user is blocked. More... | |
| static | _hasPassed ($a_obj_id, $a_usr_id) |
| Check if user has passed course. More... | |
| static | _deleteAllEntries ($a_obj_id) |
| Delete all entries Normally called for course deletion. More... | |
| static | _deleteUser ($a_usr_id) |
| Delete user data. More... | |
| static | getDefaultMemberRole ($a_ref_id) |
| static | lookupSubscribers ($a_obj_id) |
| static | _isSubscriber ($a_obj_id, $a_usr_id) |
| check if user is subscriber More... | |
| static | lookupSubscribersData ($a_obj_id) |
| static | _getAllSupportContactsOfUser ($a_usr_id, $a_type) |
| Get all support contacts for a user. More... | |
Data Fields | |
| const | COMPONENT_NAME = 'Modules/Group' |
Static Protected Attributes | |
| static | $instances = array() |
Additional Inherited Members | |
| Protected Member Functions inherited from ilParticipants | |
| getComponent () | |
| Get component name Used for raising events. More... | |
| readParticipants () | |
| Read participants. More... | |
| readParticipantsStatus () | |
| Read status of participants (blocked, notification, passed) More... | |
| readSubscribers () | |
| read subscribers More... | |
| readSubscriberData ($a_usr_id) | |
| read subscribers More... | |
| Protected Attributes inherited from ilParticipants | |
| $component = '' | |
| $obj_id = 0 | |
| $type = '' | |
| $ref_id = 0 | |
| $roles = array() | |
| $role_data = array() | |
| $roles_sorted = [] | |
| $role_assignments = [] | |
| $participants = array() | |
| $participants_status = array() | |
| $members = array() | |
| $tutors = array() | |
| $admins = array() | |
| $subscribers = array() | |
| $ilDB | |
| $lng | |
| $logger = null | |
Detailed Description
- Version
- $Id$
Definition at line 36 of file class.ilGroupParticipants.php.
Constructor & Destructor Documentation
◆ __construct()
| ilGroupParticipants::__construct | ( | $a_obj_id | ) |
Constructor.
@access protected
- Parameters
-
int obj_id of container
Definition at line 48 of file class.ilGroupParticipants.php.
References ilObject\_getAllReferences().
Here is the call graph for this function:
Member Function Documentation
◆ _getInstanceByObjId()
|
static |
Get singleton instance.
@access public
- Parameters
-
int obj_id
- Returns
- ilGroupParticipants
Definition at line 64 of file class.ilGroupParticipants.php.
Referenced by ilGroupEditParticipantsTableGUI\__construct(), ilGroupXMLWriter\__construct(), ilObjCourseGrouping\_checkGroupingDependencies(), ilCourseParticipantsGroupsGUI\add(), ilObjGroupGUI\afterSave(), ilModulesGroupTasks\assignAdminsToGroup(), ilSoapGroupAdministration\assignGroupMember(), ilModulesGroupTasks\assignMembersToGroup(), ilPortfolioAccessHandler\checkAccessOfUser(), ilWorkspaceAccessHandler\checkAccessOfUser(), ilForumNotification\checkParentNodeTree(), ilObjGroup\cloneObject(), ilGroupMembershipMailNotification\createGroupStatus(), ilParticipants\getInstanceByObjId(), ilLPStatusCollection\getMembers(), ilGroupLP\getMembers(), ilNotification\getNotificationsForObject(), ilMembershipNotifications\getParticipants(), ilMilestoneResponsiblesTableGUI\getParticipantsAndResponsibles(), ilBadgeHandler\getUserIds(), ilObjSessionGUI\initContainer(), ilCourseParticipantsGroupsTableGUI\initGroups(), ilMemberExport\initGroups(), ilMemberExport\initMembers(), ilGroupRegistrationGUI\initParticipants(), ilObjGroup\initParticipants(), ilSoapGroupAdministration\isAssignedToGroup(), ilObjGroupGUI\leaveObject(), ilObjGroupAccess\lookupRegistrationInfo(), ilGroupParticipantsTableGUI\parse(), ilModulesGroupTasks\readAdminsFromGroup(), ilModulesGroupTasks\readMembersFromGroup(), ilECSCmsCourseMemberCommandQueueHandler\refreshAssignmentStatus(), ilObjGroup\register(), and ilCourseParticipantsGroupsGUI\remove().
Here is the caller graph for this function:
◆ _isParticipant()
|
static |
Static function to check if a user is a participant of the container object.
@access public
- Parameters
-
int ref_id int user id
Reimplemented from ilParticipants.
Definition at line 144 of file class.ilGroupParticipants.php.
References $DIC, ilParticipants\$ilDB, and $ilLog.
Referenced by ilObjGroupAccess\_checkAccess(), ilStartUpGUI\_checkGoto(), ilObjGroupGUI\getTabs(), ilNotification\hasNotification(), and ilObjGroupGUI\initHeaderAction().
Here is the caller graph for this function:
◆ add()
| ilGroupParticipants::add | ( | $a_usr_id, | |
| $a_role | |||
| ) |
Add user to role.
- Parameters
-
int $a_usr_id int $a_role
- Returns
- boolean
Reimplemented from ilParticipants.
Definition at line 105 of file class.ilGroupParticipants.php.
References add(), and ilParticipants\addDesktopItem().
Here is the call graph for this function:
◆ addSubscriber()
| ilGroupParticipants::addSubscriber | ( | $a_usr_id | ) |
Add subscriber.
@access public
Reimplemented from ilParticipants.
Definition at line 114 of file class.ilGroupParticipants.php.
References $DIC, $GLOBALS, $ilLog, and ilParticipants\getObjId().
Here is the call graph for this function:
◆ getMemberRoles()
|
static |
Get member roles (not auto generated)
- Parameters
-
int $a_ref_id
Definition at line 76 of file class.ilGroupParticipants.php.
References $DIC, ilParticipants\$roles, $title, and ilObject\_lookupTitle().
Here is the call graph for this function:
◆ sendNotification()
| ilGroupParticipants::sendNotification | ( | $a_type, | |
| $a_usr_id, | |||
$a_force_sending_mail = false |
|||
| ) |
Send notification mail.
- Parameters
-
int $a_type int $a_usr_id
- Returns
Definition at line 163 of file class.ilGroupParticipants.php.
References $a_type, ilParticipants\getNotificationRecipients(), ilGroupMembershipMailNotification\TYPE_ACCEPTED_SUBSCRIPTION_MEMBER, ilGroupMembershipMailNotification\TYPE_ADMISSION_MEMBER, ilGroupMembershipMailNotification\TYPE_DISMISS_MEMBER, ilGroupMembershipMailNotification\TYPE_NOTIFICATION_REGISTRATION, ilGroupMembershipMailNotification\TYPE_NOTIFICATION_REGISTRATION_REQUEST, ilGroupMembershipMailNotification\TYPE_NOTIFICATION_UNSUBSCRIBE, ilGroupMembershipMailNotification\TYPE_REFUSED_SUBSCRIPTION_MEMBER, ilGroupMembershipMailNotification\TYPE_STATUS_CHANGED, ilGroupMembershipMailNotification\TYPE_SUBSCRIBE_MEMBER, ilGroupMembershipMailNotification\TYPE_UNSUBSCRIBE_MEMBER, and ilGroupMembershipMailNotification\TYPE_WAITING_LIST_MEMBER.
Here is the call graph for this function:
Field Documentation
◆ $instances
|
staticprotected |
Definition at line 40 of file class.ilGroupParticipants.php.
◆ COMPONENT_NAME
| const ilGroupParticipants::COMPONENT_NAME = 'Modules/Group' |
Definition at line 38 of file class.ilGroupParticipants.php.
The documentation for this class was generated from the following file:
- Modules/Group/classes/class.ilGroupParticipants.php
