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

Detailed Description

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 10 of file class.ilMembershipNotifications.php.

Constructor & Destructor Documentation

◆ __construct()

ilMembershipNotifications::__construct ( $a_ref_id )

Constructor.

Parameters

int $a_ref_id

Returns: self

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

References array, read(), and setMode().

     {
         $this->ref_id = (int) $a_ref_id;
         $this->custom = array();
         $this->setMode(self::MODE_SELF);
         
         if ($this->ref_id) {
             $this->read();
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ activateUser()

ilMembershipNotifications::activateUser ( $a_user_id = null )

Activate notification for user.

Parameters

int $a_user_id

Returns: bool

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

References toggleUser().

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

Here is the call graph for this function:

◆ addToSettingsForm()

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

static

Add notification settings to form.

Parameters

int	$a_ref_id
ilPropertyFormGUI	$a_form
ilPropertyFormGUI	$a_input

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

References $lng, ilSubEnabledFormPropertyGUI\addSubItem(), ilFormPropertyGUI\setRequired(), and ilRadioOption\setValue().

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

     {
         global $lng;
     
         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"), self::MODE_SELF);
                 $force_noti->addOption($option);
             }
             if ($noti->isValidMode(self::MODE_ALL_BLOCKED)) {
                 $option = new ilRadioOption($lng->txt("mem_force_notification_mode_blocked"), 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"), self::MODE_ALL);
                 $force_noti->addOption($option);
             }
             /* not supported in GUI
             if($noti->isValidMode(self::MODE_CUSTOM))
             {
                 $option = new ilRadioOption($lng->txt("mem_force_notification_mode_custom"), self::MODE_CUSTOM);
                 $option->setInfo($lng->txt("mem_force_notification_mode_custom_info"));
                 $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($current_mode);
             } else {
                 switch ($current_mode) {
                     case self::MODE_SELF:
                         $force_noti->setValue($current_mode);
                         $changeable->setChecked(true); // checked as "default" on selection of parent
                         break;
                     
                     case self::MODE_ALL_BLOCKED:
                         $force_noti->setValue($current_mode);
                         break;
                     
                     case self::MODE_ALL:
                         $force_noti->setValue(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 ( )

Can user change notification status?

Returns: boolean

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

References $ilUser, and getMode().

     {
         global $ilUser;
         
         $user_id = $ilUser->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);
         }
     }

Here is the call graph for this function:

◆ cloneSettings()

ilMembershipNotifications::cloneSettings ( $new_ref_id )

Clone notification object settings.

Parameters

$new_ref_id

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

References $ilDB, and array.

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

◆ deactivateUser()

ilMembershipNotifications::deactivateUser ( $a_user_id = null )

Deactivate notification for user.

Parameters

int $a_user_id

Returns: bool

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

References toggleUser().

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

Here is the call graph for this function:

◆ getActiveUsers()

ilMembershipNotifications::getActiveUsers ( )

Get active notifications for current object.

Returns: array

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

References $ilDB, $row, $users, array, getMode(), and getParticipants().

Referenced by isCurrentUserActive().

     {
         global $ilDB;
         
         $users = $all = array();
         
         $part_obj = $this->getParticipants();
         if ($part_obj) {
             $all = $part_obj->getParticipants();
         }
         if (!sizeof($all)) {
             return array();
         }
         
         switch ($this->getMode()) {
             // users decide themselves
             case self::MODE_SELF:
                 $set = $ilDB->query("SELECT usr_id" .
                     " FROM usr_pref" .
                     " WHERE " . $ilDB->like("keyword", "text", "grpcrs_ntf_" . $this->ref_id) .
                     " AND value = " . $ilDB->quote(self::VALUE_ON, "text"));
                 while ($row = $ilDB->fetchAssoc($set)) {
                     $users[] = $row["usr_id"];
                 }
                 break;
             
             // all members, mind opt-out
             case self::MODE_ALL:
                 // users who did opt-out
                 $inactive = array();
                 $set = $ilDB->query("SELECT usr_id" .
                     " FROM usr_pref" .
                     " WHERE " . $ilDB->like("keyword", "text", "grpcrs_ntf_" . $this->ref_id) .
                     " AND value = " . $ilDB->quote(self::VALUE_OFF, "text"));
                 while ($row = $ilDB->fetchAssoc($set)) {
                     $inactive[] = $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;
         }
         
         // only valid participants
         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.

Returns: array

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

References $ilDB, $log, $ref_id, $res, $row, array, and ilLoggerFactory\getLogger().

Referenced by ilMembershipCronNotifications\run().

     {
         global $ilDB, $tree;
 
         $log = ilLoggerFactory::getLogger("mmbr");
 
 
         $res = array();
                 
         if (self::isActive()) {
             $objects = array();
             
             // 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 (sizeof($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 ( )

Get mode.

Returns: int

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

References $mode.

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

     {
         return $this->mode;
     }

Here is the caller graph for this function:

◆ getParticipants()

ilMembershipNotifications::getParticipants ( )

protected

Init participants for current object.

Returns: ilParticipants

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

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

Referenced by getActiveUsers().

     {
         global $tree;
         
         if ($this->participants === null) {
             $this->participants = false;
             
             $grp_ref_id = $tree->checkForParentType($this->ref_id, "grp");
             if ($grp_ref_id) {
                 include_once "Modules/Group/classes/class.ilGroupParticipants.php";
                 $this->participants = ilGroupParticipants::_getInstanceByObjId(ilObject::_lookupObjId($grp_ref_id));
             }
 
             if (!$this->participants) {
                 $crs_ref_id = $tree->checkForParentType($this->ref_id, "crs");
                 if ($crs_ref_id) {
                     include_once "Modules/Course/classes/class.ilCourseParticipants.php";
                     $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 ( $a_user_id = null )

protected

Init user instance.

Parameters

int $a_user_id

Returns: ilUser

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

References $ilUser.

Referenced by toggleUser().

     {
         global $ilUser;
         
         if ($a_user_id === null ||
             $a_user_id == $ilUser->getId()) {
             $user = $ilUser;
         } else {
             $user = new ilUser($a_user_id);
         }
         
         if ($user->getId() &&
             $user->getId() != ANONYMOUS_USER_ID) {
             return $user;
         }
     }

Here is the caller graph for this function:

◆ importFromForm()

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

static

Import notification settings from form.

Parameters

int	$a_ref_id
ilPropertyFormGUI	$a_form

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

References $_POST, and $mode.

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

     {
         if (self::isActive() &&
             $a_ref_id) {
             $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 = (int) $_POST["force_noti"];
                 if ($has_changeable_cb) {
                     $changeable = (int) $_POST["force_noti_allblk"];
                 }
             } else {
                 $mode = $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 caller graph for this function:

◆ isActive()

static ilMembershipNotifications::isActive ( )

static

Is feature active?

Returns: bool

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

References $ilSetting.

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

     {
         global $ilSetting;
                     
         return ($ilSetting->get("block_activated_news") &&
             $ilSetting->get("crsgrp_ntf"));
     }

Here is the caller graph for this function:

◆ isCurrentUserActive()

ilMembershipNotifications::isCurrentUserActive ( )

Get user notification status.

Returns: boolean

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

References $ilUser, and getActiveUsers().

     {
         global $ilUser;
         
         return in_array($ilUser->getId(), $this->getActiveUsers());
     }

Here is the call graph for this function:

◆ isValidMode()

ilMembershipNotifications::isValidMode ( $a_value )

protected

Is given mode valid?

Parameters

int $a_value

Returns: bool

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

References $valid, and array.

Referenced by setMode(), and switchMode().

     {
         $valid = array(
             self::MODE_SELF
             ,self::MODE_ALL
             ,self::MODE_ALL_BLOCKED
             // ,self::MODE_CUSTOM currently used in forum
         );
         return in_array($a_value, $valid);
     }

Here is the caller graph for this function:

◆ read()

ilMembershipNotifications::read ( )

protected

Read from DB.

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

References $ilDB, $row, and setMode().

Referenced by __construct().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setMode()

ilMembershipNotifications::setMode ( $a_value )

protected

Set mode.

Parameters

int $a_value

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

References isValidMode().

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

     {
         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 ( $a_new_mode )

Switch mode for object.

Parameters

int $a_new_mode

Returns: bool

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

References $ilDB, array, isValidMode(), and setMode().

     {
         global $ilDB;
         
         if (!$this->ref_id) {
             return;
         }
                 
         if ($this->mode &&
             $this->mode != $a_new_mode &&
             $this->isValidMode($a_new_mode)) {
             $ilDB->manipulate("DELETE FROM member_noti" .
                 " WHERE ref_id = " . $ilDB->quote($this->ref_id, "integer"));
 
             // no custom data
             if ($a_new_mode != self::MODE_CUSTOM) {
                 $ilDB->manipulate("DELETE FROM member_noti_user" .
                     " WHERE ref_id = " . $ilDB->quote($this->ref_id, "integer"));
             }
             
             // mode self is default
             if ($a_new_mode != self::MODE_SELF) {
                 $ilDB->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) {
                 $ilDB->manipulate("DELETE FROM usr_pref" .
                     " WHERE " . $ilDB->like("keyword", "text", "grpcrs_ntf_" . $this->ref_id));
             }
         }
         
         $this->setMode($a_new_mode);
     }

Here is the call graph for this function:

◆ toggleUser()

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

protected

Toggle user notification status.

Parameters

bool	$a_status
int	$a_user_id

Returns: boolean

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

References $ilDB, array, getMode(), and getUser().

Referenced by activateUser(), and deactivateUser().

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