|
ILIAS
release_6 Revision v6.24-5-g0c8bfefb3b8
|
Membership notification settings. More...
Collaboration diagram for ilMembershipNotifications:Public Member Functions | |
| __construct ($a_ref_id) | |
| Constructor. More... | |
| getMode () | |
| Get mode. More... | |
| switchMode ($a_new_mode) | |
| Switch mode for object. More... | |
| getActiveUsers () | |
| Get active notifications for current object. More... | |
| activateUser ($a_user_id=null) | |
| Activate notification for user. More... | |
| deactivateUser ($a_user_id=null) | |
| Deactivate notification for user. More... | |
| isCurrentUserActive () | |
| Get user notification status. More... | |
| canCurrentUserEdit () | |
| Can user change notification status? More... | |
| cloneSettings ($new_ref_id) | |
| Clone notification object settings. More... | |
Static Public Member Functions | |
| static | isActive () |
| Is feature active? More... | |
| static | isActiveForRefId (int $ref_id) |
| static | getActiveUsersforAllObjects () |
| Get active notifications for all objects. More... | |
| static | addToSettingsForm ($a_ref_id, ilPropertyFormGUI $a_form=null, ilFormPropertyGUI $a_input=null) |
| Add notification settings to form. More... | |
| static | importFromForm ($a_ref_id, ilPropertyFormGUI $a_form=null) |
| Import notification settings from form. More... | |
Data Fields | |
| const | VALUE_OFF = 0 |
| const | VALUE_ON = 1 |
| const | VALUE_BLOCKED = 2 |
| const | MODE_SELF = 1 |
| const | MODE_ALL = 2 |
| const | MODE_ALL_BLOCKED = 3 |
| const | MODE_CUSTOM = 4 |
Protected Member Functions | |
| read () | |
| Read from DB. More... | |
| setMode ($a_value) | |
| Set mode. More... | |
| isValidMode ($a_value) | |
| Is given mode valid? More... | |
| getParticipants () | |
| Init participants for current object. More... | |
| getUser ($a_user_id=null) | |
| Init user instance. More... | |
| toggleUser ($a_status, $a_user_id=null) | |
| Toggle user notification status. More... | |
Protected Attributes | |
| $ref_id | |
| $mode | |
| $custom | |
| $participants | |
Membership notification settings.
Definition at line 10 of file class.ilMembershipNotifications.php.
| ilMembershipNotifications::__construct | ( | $a_ref_id | ) |
Constructor.
| int | $a_ref_id |
Definition at line 32 of file class.ilMembershipNotifications.php.
References read(), and setMode().
Here is the call graph for this function:| ilMembershipNotifications::activateUser | ( | $a_user_id = null | ) |
Activate notification for user.
| int | $a_user_id |
Definition at line 317 of file class.ilMembershipNotifications.php.
References toggleUser().
Here is the call graph for this function:
|
static |
Add notification settings to form.
| int | $a_ref_id | |
| ilPropertyFormGUI | $a_form | |
| ilPropertyFormGUI | $a_input |
Definition at line 543 of file class.ilMembershipNotifications.php.
References $DIC, $lng, MODE_ALL, MODE_ALL_BLOCKED, and MODE_SELF.
Referenced by ilContainerNewsSettingsGUI\initForm(), and ilObjectServiceSettingsGUI\initServiceSettingsForm().
Here is the caller graph for this function:| ilMembershipNotifications::canCurrentUserEdit | ( | ) |
Can user change notification status?
Definition at line 445 of file class.ilMembershipNotifications.php.
References $DIC, $ilUser, getMode(), MODE_ALL, MODE_ALL_BLOCKED, MODE_CUSTOM, MODE_SELF, and VALUE_BLOCKED.
Here is the call graph for this function:| ilMembershipNotifications::cloneSettings | ( | $new_ref_id | ) |
Clone notification object settings.
| $new_ref_id |
Definition at line 652 of file class.ilMembershipNotifications.php.
References $ilDB.
| ilMembershipNotifications::deactivateUser | ( | $a_user_id = null | ) |
Deactivate notification for user.
| int | $a_user_id |
Definition at line 328 of file class.ilMembershipNotifications.php.
References toggleUser().
Here is the call graph for this function:| ilMembershipNotifications::getActiveUsers | ( | ) |
Get active notifications for current object.
Definition at line 245 of file class.ilMembershipNotifications.php.
References $DIC, $ilDB, getMode(), getParticipants(), MODE_ALL, MODE_ALL_BLOCKED, MODE_CUSTOM, and MODE_SELF.
Here is the call graph for this function:
|
static |
Get active notifications for all objects.
Definition at line 480 of file class.ilMembershipNotifications.php.
References $DIC, $ilDB, $log, $ref_id, $res, and ilLoggerFactory\getLogger().
Referenced by ilMembershipCronNotificationsData\load().
Here is the call graph for this function:
Here is the caller graph for this function:| ilMembershipNotifications::getMode | ( | ) |
Get mode.
Definition at line 123 of file class.ilMembershipNotifications.php.
References $mode.
Referenced by canCurrentUserEdit(), getActiveUsers(), and toggleUser().
Here is the caller graph for this function:
|
protected |
Init participants for current object.
Definition at line 213 of file class.ilMembershipNotifications.php.
References $DIC, $participants, ilCourseParticipants\_getInstanceByObjId(), ilGroupParticipants\_getInstanceByObjId(), and ilObject\_lookupObjId().
Referenced by getActiveUsers().
Here is the call graph for this function:
Here is the caller graph for this function:
|
protected |
Init user instance.
| int | $a_user_id |
Definition at line 339 of file class.ilMembershipNotifications.php.
Referenced by toggleUser().
Here is the caller graph for this function:
|
static |
Import notification settings from form.
| int | $a_ref_id | |
| ilPropertyFormGUI | $a_form |
Definition at line 619 of file class.ilMembershipNotifications.php.
References $_POST, $mode, and MODE_ALL.
Referenced by ilContainerNewsSettingsGUI\save(), and ilObjectServiceSettingsGUI\updateServiceSettingsForm().
Here is the caller graph for this function:
|
static |
Is feature active?
Definition at line 48 of file class.ilMembershipNotifications.php.
References $DIC, and $ilSetting.
|
static |
Definition at line 60 of file class.ilMembershipNotifications.php.
References $ref_id, ilContainer\_lookupContainerSetting(), and ilObject\_lookupObjId().
Referenced by ilObjCourseGUI\initHeaderAction(), and ilObjGroupGUI\initHeaderAction().
Here is the call graph for this function:
Here is the caller graph for this function:| ilMembershipNotifications::isCurrentUserActive | ( | ) |
|
protected |
Is given mode valid?
| int | $a_value |
Definition at line 146 of file class.ilMembershipNotifications.php.
References $valid.
Referenced by setMode(), and switchMode().
Here is the caller graph for this function:
|
protected |
Read from DB.
Definition at line 89 of file class.ilMembershipNotifications.php.
References $DIC, $ilDB, and setMode().
Referenced by __construct().
Here is the call graph for this function:
Here is the caller graph for this function:
|
protected |
Set mode.
| int | $a_value |
Definition at line 133 of file class.ilMembershipNotifications.php.
References isValidMode().
Referenced by __construct(), read(), and switchMode().
Here is the call graph for this function:
Here is the caller graph for this function:| ilMembershipNotifications::switchMode | ( | $a_new_mode | ) |
Switch mode for object.
| int | $a_new_mode |
Definition at line 163 of file class.ilMembershipNotifications.php.
References $DIC, $ilDB, isValidMode(), and setMode().
Here is the call graph for this function:
|
protected |
Toggle user notification status.
| bool | $a_status | |
| int | $a_user_id |
Definition at line 365 of file class.ilMembershipNotifications.php.
References $DIC, $ilDB, getMode(), getUser(), MODE_ALL, MODE_ALL_BLOCKED, MODE_CUSTOM, and MODE_SELF.
Referenced by activateUser(), and deactivateUser().
Here is the call graph for this function:
Here is the caller graph for this function:
|
protected |
Definition at line 14 of file class.ilMembershipNotifications.php.
|
protected |
Definition at line 13 of file class.ilMembershipNotifications.php.
Referenced by getMode(), and importFromForm().
|
protected |
Definition at line 15 of file class.ilMembershipNotifications.php.
Referenced by getParticipants().
|
protected |
Definition at line 12 of file class.ilMembershipNotifications.php.
Referenced by getActiveUsersforAllObjects(), and isActiveForRefId().
| const ilMembershipNotifications::MODE_ALL = 2 |
Definition at line 22 of file class.ilMembershipNotifications.php.
Referenced by addToSettingsForm(), canCurrentUserEdit(), getActiveUsers(), importFromForm(), and toggleUser().
| const ilMembershipNotifications::MODE_ALL_BLOCKED = 3 |
Definition at line 23 of file class.ilMembershipNotifications.php.
Referenced by addToSettingsForm(), canCurrentUserEdit(), getActiveUsers(), and toggleUser().
| const ilMembershipNotifications::MODE_CUSTOM = 4 |
Definition at line 24 of file class.ilMembershipNotifications.php.
Referenced by canCurrentUserEdit(), getActiveUsers(), and toggleUser().
| const ilMembershipNotifications::MODE_SELF = 1 |
Definition at line 21 of file class.ilMembershipNotifications.php.
Referenced by addToSettingsForm(), canCurrentUserEdit(), getActiveUsers(), and toggleUser().
| const ilMembershipNotifications::VALUE_BLOCKED = 2 |
Definition at line 19 of file class.ilMembershipNotifications.php.
Referenced by canCurrentUserEdit().
| const ilMembershipNotifications::VALUE_OFF = 0 |
Definition at line 17 of file class.ilMembershipNotifications.php.
| const ilMembershipNotifications::VALUE_ON = 1 |
Definition at line 18 of file class.ilMembershipNotifications.php.