This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilMembershipNotifications:

Public Member Functions
	__construct (int $a_ref_id)

	getMode ()

	switchMode (int $a_new_mode)

	getActiveUsers ()

	activateUser (int $a_user_id=null)

	deactivateUser (int $a_user_id=null)

	isCurrentUserActive ()

	canCurrentUserEdit ()

	cloneSettings (int $new_ref_id)

Static Public Member Functions
static	isActive ()

static	isActiveForRefId (int $ref_id)

static	getActiveUsersforAllObjects ()
	Get active notifications for all objects. More...

static	addToSettingsForm (int $a_ref_id, ?ilPropertyFormGUI $a_form=null, ?ilFormPropertyGUI $a_input=null)
	Add notification settings to form. More...

static	importFromForm (int $a_ref_id, ?ilPropertyFormGUI $a_form=null)

Protected Member Functions
	read ()

	setMode (int $a_value)

	isValidMode (int $a_value)

	getParticipants ()

	getUser (int $a_user_id=null)

	toggleUser (bool $a_status, int $a_user_id=null)

Protected Attributes
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

int	$ref_id

int	$mode

array	$custom

ilParticipants	$participants = null

ilSetting	$setting

ilDBInterface	$db

ilTree	$tree

ilObjUser	$user

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Membership notification settings

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

◆ __construct()

ilMembershipNotifications::__construct ( int $a_ref_id )

Definition at line 46 of file class.ilMembershipNotifications.php.

References $DIC, ILIAS\UI\examples\Chart\Bar\Horizontal\custom(), read(), setMode(), and ILIAS\Repository\user().

     {
         global $DIC;
 
         $this->db = $DIC->database();
         $this->ref_id = $a_ref_id;
         $this->custom = [];
         $this->setting = $DIC->settings();
         $this->tree = $DIC->repositoryTree();
         $this->user = $DIC->user();
 
         $this->setMode(self::MODE_SELF);
         if ($this->ref_id !== 0) {
             $this->read();
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ activateUser()

ilMembershipNotifications::activateUser ( int $a_user_id = null )

Definition at line 246 of file class.ilMembershipNotifications.php.

References toggleUser().

                                                        : bool
     {
         return $this->toggleUser(true, $a_user_id);
     }

Here is the call graph for this function:

◆ addToSettingsForm()

static ilMembershipNotifications::addToSettingsForm	(	int	$a_ref_id,
		?ilPropertyFormGUI	$a_form = `null`,
		?ilFormPropertyGUI	$a_input = `null`
	)

static

Add notification settings to form.

PhpUndefinedVariableInspection

Definition at line 411 of file class.ilMembershipNotifications.php.

References $DIC, $lng, and ilFormPropertyGUI\setRequired().

Referenced by ilContainerNewsSettingsGUI\initForm(), and ilObjectServiceSettingsGUI\initServiceSettingsForm().

      : void {
         global $DIC;
 
         $lng = $DIC->language();
 
         if (self::isActive() &&
             $a_ref_id) {
             $lng->loadLanguageModule("membership");
             $noti = new self($a_ref_id);
 
             $force_noti = new ilRadioGroupInputGUI($lng->txt("mem_force_notification"), "force_noti");
             $force_noti->setRequired(true);
             if ($a_form) {
                 $a_form->addItem($force_noti);
             } else {
                 $a_input->addSubItem($force_noti);
             }
 
             if ($noti->isValidMode(self::MODE_SELF)) {
                 $option = new ilRadioOption($lng->txt("mem_force_notification_mode_self"), (string) self::MODE_SELF);
                 $force_noti->addOption($option);
             }
             if ($noti->isValidMode(self::MODE_ALL_BLOCKED)) {
                 $option = new ilRadioOption(
                     $lng->txt("mem_force_notification_mode_blocked"),
                     (string) self::MODE_ALL_BLOCKED
                 );
                 $force_noti->addOption($option);
 
                 if ($noti->isValidMode(self::MODE_ALL)) {
                     $changeable = new ilCheckboxInputGUI(
                         $lng->txt("mem_force_notification_mode_all_sub_blocked"),
                         "force_noti_allblk"
                     );
                     $option->addSubItem($changeable);
                 }
             } elseif ($noti->isValidMode(self::MODE_ALL)) {
                 $option = new ilRadioOption($lng->txt("mem_force_notification_mode_all"), (string) self::MODE_ALL);
                 $force_noti->addOption($option);
             }
 
             // set current mode
             $current_mode = $noti->getMode();
             $has_changeable_cb = ($noti->isValidMode(self::MODE_ALL_BLOCKED) &&
                 $noti->isValidMode(self::MODE_ALL));
             if (!$has_changeable_cb) {
                 $force_noti->setValue((string) $current_mode);
             } else {
                 switch ($current_mode) {
                     case self::MODE_SELF:
                         $force_noti->setValue((string) $current_mode);
                         $changeable->setChecked(true); // checked as "default" on selection of parent
                         break;
 
                     case self::MODE_ALL_BLOCKED:
                         $force_noti->setValue((string) $current_mode);
                         break;
 
                     case self::MODE_ALL:
                         $force_noti->setValue((string) self::MODE_ALL_BLOCKED);
                         $changeable->setChecked(true);
                         break;
                 }
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ canCurrentUserEdit()

ilMembershipNotifications::canCurrentUserEdit ( )

Definition at line 337 of file class.ilMembershipNotifications.php.

References $user_id, ANONYMOUS_USER_ID, ILIAS\UI\examples\Chart\Bar\Horizontal\custom(), getMode(), and ILIAS\Repository\user().

                                         : bool
     {
         $user_id = $this->user->getId();
         if ($user_id === ANONYMOUS_USER_ID) {
             return false;
         }
 
         switch ($this->getMode()) {
             case self::MODE_SELF:
             case self::MODE_ALL:
                 return true;
 
             case self::MODE_ALL_BLOCKED:
                 return false;
 
             case self::MODE_CUSTOM:
                 return !(array_key_exists($user_id, $this->custom) && $this->custom[$user_id] === self::VALUE_BLOCKED);
         }
         return false;
     }

Here is the call graph for this function:

◆ cloneSettings()

ilMembershipNotifications::cloneSettings ( int $new_ref_id )

Definition at line 527 of file class.ilMembershipNotifications.php.

                                                   : void
     {
         $set = $this->db->queryF(
             "SELECT * FROM member_noti " .
             " WHERE ref_id = %s ",
             array("integer"),
             array($this->ref_id)
         );
         while ($rec = $this->db->fetchAssoc($set)) {
             $this->db->insert("member_noti", array(
                 "ref_id" => array("integer", $new_ref_id),
                 "nmode" => array("integer", $rec["nmode"])
             ));
         }
     }

◆ deactivateUser()

ilMembershipNotifications::deactivateUser ( int $a_user_id = null )

Definition at line 251 of file class.ilMembershipNotifications.php.

References toggleUser().

                                                          : bool
     {
         return $this->toggleUser(false, $a_user_id);
     }

Here is the call graph for this function:

◆ getActiveUsers()

ilMembershipNotifications::getActiveUsers ( )

Definition at line 192 of file class.ilMembershipNotifications.php.

References $user_id, ILIAS\UI\examples\Chart\Bar\Horizontal\custom(), getMode(), getParticipants(), and ILIAS\Repository\int().

Referenced by isCurrentUserActive().

                                     : array
     {
         $users = $all = array();
         $part_obj = $this->getParticipants();
         if ($part_obj) {
             $all = $part_obj->getParticipants();
         }
         if (!$all) {
             return [];
         }
 
         switch ($this->getMode()) {
             // users decide themselves
             case self::MODE_SELF:
                 $set = $this->db->query("SELECT usr_id" .
                     " FROM usr_pref" .
                     " WHERE keyword = " . $this->db->quote("grpcrs_ntf_" . $this->ref_id, "text") .
                     " AND value = " . $this->db->quote(self::VALUE_ON, "text"));
                 while ($row = $this->db->fetchAssoc($set)) {
                     $users[] = (int) $row["usr_id"];
                 }
                 break;
 
                 // all members, mind opt-out
             case self::MODE_ALL:
                 // users who did opt-out
                 $inactive = array();
                 $set = $this->db->query("SELECT usr_id" .
                     " FROM usr_pref" .
                     " WHERE keyword = " . $this->db->quote("grpcrs_ntf_" . $this->ref_id, "text") .
                     " AND value = " . $this->db->quote(self::VALUE_OFF, "text"));
                 while ($row = $this->db->fetchAssoc($set)) {
                     $inactive[] = (int) $row["usr_id"];
                 }
                 $users = array_diff($all, $inactive);
                 break;
 
                 // all members, no opt-out
             case self::MODE_ALL_BLOCKED:
                 $users = $all;
                 break;
 
                 // custom settings
             case self::MODE_CUSTOM:
                 foreach ($this->custom as $user_id => $status) {
                     if ($status !== self::VALUE_OFF) {
                         $users[] = $user_id;
                     }
                 }
                 break;
         }
         return array_intersect($all, $users);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getActiveUsersforAllObjects()

static ilMembershipNotifications::getActiveUsersforAllObjects ( )

static

Get active notifications for all objects.

Definition at line 361 of file class.ilMembershipNotifications.php.

References $DIC, $ilDB, $log, $ref_id, $res, ILIAS\Repository\int(), and ilTree\isDeleted().

Referenced by ilMembershipCronNotificationsData\load().

                                                         : array
     {
         global $DIC;
 
         $ilDB = $DIC->database();
         $tree = $DIC->repositoryTree();
         $log = $DIC->logger()->mmbr();
 
         $res = [];
         if (self::isActive()) {
             $objects = [];
 
             // user-preference data (MODE_SELF)
             $log->debug("read usr_pref");
             $set = $ilDB->query("SELECT DISTINCT(keyword) keyword" .
                 " FROM usr_pref" .
                 " WHERE " . $ilDB->like("keyword", "text", "grpcrs_ntf_%") .
                 " AND value = " . $ilDB->quote("1", "text"));
             while ($row = $ilDB->fetchAssoc($set)) {
                 $ref_id = substr($row["keyword"], 11);
                 $objects[(int) $ref_id] = (int) $ref_id;
             }
 
             // all other modes
             $log->debug("read member_noti");
             $set = $ilDB->query("SELECT ref_id" .
                 " FROM member_noti");
             while ($row = $ilDB->fetchAssoc($set)) {
                 $objects[(int) $row["ref_id"]] = (int) $row["ref_id"];
             }
 
             // this might be slow but it is to be used in CRON JOB ONLY!
             foreach (array_unique($objects) as $ref_id) {
                 // :TODO: enough checking?
                 if (!$tree->isDeleted($ref_id)) {
                     $log->debug("get active users");
                     $noti = new self($ref_id);
                     $active = $noti->getActiveUsers();
                     if (count($active)) {
                         $res[$ref_id] = $active;
                     }
                 }
             }
         }
         return $res;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMode()

ilMembershipNotifications::getMode ( )

Definition at line 113 of file class.ilMembershipNotifications.php.

References $mode.

Referenced by canCurrentUserEdit(), getActiveUsers(), and toggleUser().

                              : int
     {
         return $this->mode;
     }

Here is the caller graph for this function:

◆ getParticipants()

ilMembershipNotifications::getParticipants ( )

protected

Definition at line 174 of file class.ilMembershipNotifications.php.

References $participants, ilCourseParticipants\_getInstanceByObjId(), ilGroupParticipants\_getInstanceByObjId(), and ilObject\_lookupObjId().

Referenced by getActiveUsers().

                                         : ?\ilParticipants
     {
         if ($this->participants === null) {
             $grp_ref_id = $this->tree->checkForParentType($this->ref_id, "grp");
             if ($grp_ref_id) {
                 $this->participants = ilGroupParticipants::_getInstanceByObjId(ilObject::_lookupObjId($grp_ref_id));
             }
 
             if (!$this->participants) {
                 $crs_ref_id = $this->tree->checkForParentType($this->ref_id, "crs");
                 if ($crs_ref_id) {
                     $this->participants = ilCourseParticipants::_getInstanceByObjId(ilObject::_lookupObjId($crs_ref_id));
                 }
             }
         }
         return $this->participants;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUser()

ilMembershipNotifications::getUser ( int $a_user_id = null )

protected

Definition at line 256 of file class.ilMembershipNotifications.php.

References $user, ANONYMOUS_USER_ID, ilObject\getId(), and ILIAS\Repository\user().

Referenced by toggleUser().

                                                      : ?ilObjUser
     {
         if (
             $a_user_id === null ||
             $a_user_id === $this->user->getId()
         ) {
             $user = $this->user;
         } else {
             $user = new ilObjUser($a_user_id);
         }
 
         if (
             $user->getId() &&
             $user->getId() !== ANONYMOUS_USER_ID
         ) {
             return $user;
         }
         return null;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ importFromForm()

static ilMembershipNotifications::importFromForm	(	int	$a_ref_id,
		?ilPropertyFormGUI	$a_form = `null`
	)

static

Definition at line 484 of file class.ilMembershipNotifications.php.

References $DIC, $http, ILIAS\UI\examples\Layout\Page\Standard\$refinery, and ILIAS\Repository\int().

Referenced by ilContainerNewsSettingsGUI\save(), and ilObjectServiceSettingsGUI\updateServiceSettingsForm().

                                                                                            : void
     {
         global $DIC;
 
         $http = $DIC->http();
         $refinery = $DIC->refinery();
 
         if ($a_ref_id && self::isActive()) {
             $noti = new self($a_ref_id);
             $has_changeable_cb = ($noti->isValidMode(self::MODE_ALL_BLOCKED) && $noti->isValidMode(self::MODE_ALL));
             $changeable = null;
             if (!$a_form) {
                 $mode = 0;
                 if ($http->wrapper()->post()->has('force_noti')) {
                     $mode = $http->wrapper()->post()->retrieve(
                         'force_noti',
                         $refinery->kindlyTo()->int()
                     );
                 }
 
                 if ($has_changeable_cb) {
                     $changeable = 0;
                     if ($http->wrapper()->post()->has('force_noti_allblk')) {
                         $changeable = $http->wrapper()->post()->retrieve(
                             'force_noti_allblk',
                             $refinery->kindlyTo()->int()
                         );
                     }
                 }
             } else {
                 $mode = (int) $a_form->getInput("force_noti");
                 if ($has_changeable_cb) {
                     $changeable = $a_form->getInput("force_noti_allblk");
                 }
             }
             // checkbox (all) is subitem of all_blocked
             if ($changeable && $mode === self::MODE_ALL_BLOCKED) {
                 $mode = self::MODE_ALL;
             }
             $noti->switchMode($mode);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isActive()

static ilMembershipNotifications::isActive ( )

static

Definition at line 63 of file class.ilMembershipNotifications.php.

References $DIC, and $ilSetting.

                                      : bool
     {
         global $DIC;
 
         $ilSetting = $DIC['ilSetting'];
         if (!$ilSetting->get("block_activated_news") || !$ilSetting->get("crsgrp_ntf")) {
             return false;
         }
         return true;
     }

◆ isActiveForRefId()

static ilMembershipNotifications::isActiveForRefId ( int $ref_id )

static

Definition at line 74 of file class.ilMembershipNotifications.php.

References ilContainer\_lookupContainerSetting(), and ilObject\_lookupObjId().

Referenced by ilObjGroupGUI\initHeaderAction(), and ilObjCourseGUI\initHeaderAction().

                                                         : bool
     {
         if (!self::isActive()) {
             return false;
         }
         // see #31471, #30687, and ilNewsItem::getNewsForRefId
         $obj_id = ilObject::_lookupObjId($ref_id);
         if (
             !ilContainer::_lookupContainerSetting($obj_id, 'cont_use_news', "1") ||
             (
                 !ilContainer::_lookupContainerSetting($obj_id, 'cont_show_news', "1") &&
                 !ilContainer::_lookupContainerSetting($obj_id, 'news_timeline')
             )
         ) {
             return false;
         }
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isCurrentUserActive()

ilMembershipNotifications::isCurrentUserActive ( )

Definition at line 332 of file class.ilMembershipNotifications.php.

References getActiveUsers(), and ILIAS\Repository\user().

                                          : bool
     {
         return in_array($this->user->getId(), $this->getActiveUsers());
     }

Here is the call graph for this function:

◆ isValidMode()

ilMembershipNotifications::isValidMode ( int $a_value )

protected

Definition at line 125 of file class.ilMembershipNotifications.php.

References $valid.

Referenced by setMode(), and switchMode().

                                                 : bool
     {
         $valid = array(
             self::MODE_SELF
             ,
             self::MODE_ALL
             ,
             self::MODE_ALL_BLOCKED
         );
         return in_array($a_value, $valid);
     }

Here is the caller graph for this function:

◆ read()

ilMembershipNotifications::read ( )

protected

Definition at line 93 of file class.ilMembershipNotifications.php.

References ILIAS\UI\examples\Chart\Bar\Horizontal\custom(), ILIAS\Repository\int(), and setMode().

Referenced by __construct().

                              : void
     {
         $set = $this->db->query("SELECT nmode mode" .
             " FROM member_noti" .
             " WHERE ref_id = " . $this->db->quote($this->ref_id, "integer"));
         if ($this->db->numRows($set)) {
             $row = $this->db->fetchAssoc($set);
             $this->setMode((int) $row["mode"]);
 
             if ((int) $row["mode"] === self::MODE_CUSTOM) {
                 $set = $this->db->query("SELECT *" .
                     " FROM member_noti_user" .
                     " WHERE ref_id = " . $this->db->quote($this->ref_id, "integer"));
                 while ($row = $this->db->fetchAssoc($set)) {
                     $this->custom[(int) $row["user_id"]] = (int) $row["status"];
                 }
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setMode()

ilMembershipNotifications::setMode ( int $a_value )

protected

Definition at line 118 of file class.ilMembershipNotifications.php.

References isValidMode().

Referenced by __construct(), read(), and switchMode().

                                             : void
     {
         if ($this->isValidMode($a_value)) {
             $this->mode = $a_value;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ switchMode()

ilMembershipNotifications::switchMode ( int $a_new_mode )

Definition at line 137 of file class.ilMembershipNotifications.php.

References isValidMode(), and setMode().

                                                : void
     {
         if (!$this->ref_id) {
             return;
         }
 
         if (
             $this->mode &&
             $this->mode !== $a_new_mode &&
             $this->isValidMode($a_new_mode)
         ) {
             $this->db->manipulate("DELETE FROM member_noti" .
                 " WHERE ref_id = " . $this->db->quote($this->ref_id, "integer"));
 
             // no custom data
             if ($a_new_mode !== self::MODE_CUSTOM) {
                 $this->db->manipulate("DELETE FROM member_noti_user" .
                     " WHERE ref_id = " . $this->db->quote($this->ref_id, "integer"));
             }
 
             // mode self is default
             if ($a_new_mode !== self::MODE_SELF) {
                 $this->db->insert("member_noti", array(
                     "ref_id" => array("integer", $this->ref_id),
                     "nmode" => array("integer", $a_new_mode)
                 ));
             }
 
             // remove all user settings (all active is preset, optional opt out)
             if ($a_new_mode === self::MODE_ALL) {
                 $this->db->manipulate("DELETE FROM usr_pref" .
                     " WHERE " . $this->db->like("keyword", "text", "grpcrs_ntf_" . $this->ref_id));
             }
         }
         $this->setMode($a_new_mode);
     }

Here is the call graph for this function:

◆ toggleUser()

ilMembershipNotifications::toggleUser	(	bool	$a_status,
		int	$a_user_id = `null`
	)

protected

Definition at line 276 of file class.ilMembershipNotifications.php.

References $user_id, ILIAS\UI\examples\Chart\Bar\Horizontal\custom(), ilObject\getId(), getMode(), getUser(), ILIAS\Repository\int(), ilObjUser\setPref(), and ilObjUser\writePrefs().

Referenced by activateUser(), and deactivateUser().

                                                                         : bool
     {
         if (!self::isActive()) {
             return false;
         }
 
         switch ($this->getMode()) {
             case self::MODE_ALL:
             case self::MODE_SELF:
                 // current user!
                 $user = $this->getUser();
                 if ($user instanceof ilObjUser) {
                     // blocked value not supported in user pref!
                     if ($a_status === true) {
                         $string_value = '1';
                     } else {
                         $string_value = '0';
                     }
 
                     $user->setPref("grpcrs_ntf_" . $this->ref_id, $string_value);
                     $user->writePrefs();
                     return true;
                 }
                 break;
 
             case self::MODE_CUSTOM:
                 $user = $this->getUser($a_user_id);
                 if ($user instanceof ilObjUser) {
                     $user_id = $user->getId();
 
                     // did status change at all?
                     if (!array_key_exists($user_id, $this->custom) || $this->custom[$user_id] !== (int) $a_status) {
                         $this->custom[$user_id] = (int) $a_status;
 
                         $this->db->replace(
                             "member_noti_user",
                             array(
                                 "ref_id" => array("integer", $this->ref_id),
                                 "user_id" => array("integer", $user_id),
                             ),
                             array(
                                 "status" => array("integer", (int) $a_status)
                             )
                         );
                     }
                     return true;
                 }
                 break;
 
             case self::MODE_ALL_BLOCKED:
                 // no individual settings
                 break;
         }
         return false;
     }