Forum notifications. More...

Inheritance diagram for ilForumCronNotification:

Collaboration diagram for ilForumCronNotification:

Public Member Functions
	__construct (\ilDBInterface $database=null, \ilForumNotificationCache $notificationCache=null)

	getId ()

	getTitle ()

	getDescription ()

	getDefaultScheduleType ()

	getDefaultScheduleValue ()

	hasAutoActivation ()

	hasFlexibleSchedule ()

	hasCustomSettings ()

	keepAlive ()

	run ()

	sendCronForumNotification ($res, $notification_type)

	existsProviderObject ($post_id)

	addToExternalSettingsForm ($a_form_id, array &$a_fields, $a_is_active)

	activationWasToggled ($a_currently_active)

	addCustomSettingsToForm (ilPropertyFormGUI $a_form)

	saveCustomSettings (ilPropertyFormGUI $a_form)

Public Member Functions inherited from ilCronJob
	isActive ($a_ts_last_run, $a_schedule_type, $a_schedule_value, $a_manual=false)
	Is job currently active? More...

	getScheduleType ()
	Get current schedule type (if flexible) More...

	getScheduleValue ()
	Get current schedule value (if flexible) More...

	setSchedule ($a_type, $a_value)
	Update current schedule (if flexible) More...

	getAllScheduleTypes ()
	Get all available schedule types. More...

	getScheduleTypesWithValues ()

	getValidScheduleTypes ()
	Returns a collection of all valid schedule types for a specific job. More...

	getTitle ()
	Get title. More...

	getDescription ()
	Get description. More...

	isManuallyExecutable ()
	Defines whether or not a cron job can be started manually. More...

	hasCustomSettings ()
	Has cron job any custom setting which can be edited? More...

	addCustomSettingsToForm (ilPropertyFormGUI $a_form)
	Add custom settings to form. More...

	saveCustomSettings (ilPropertyFormGUI $a_form)
	Save custom settings. More...

	addToExternalSettingsForm ($a_form_id, array &$a_fields, $a_is_active)
	Add external settings to form. More...

	activationWasToggled ($a_currently_active)
	Cron job status was changed. More...

	getId ()
	Get id. More...

	hasAutoActivation ()
	Is to be activated on "installation". More...

	hasFlexibleSchedule ()
	Can the schedule be configured? More...

	getDefaultScheduleType ()
	Get schedule type. More...

	getDefaultScheduleValue ()
	Get schedule value. More...

	run ()
	Run job. More...

Data Fields
const	KEEP_ALIVE_CHUNK_SIZE = 25

Data Fields inherited from ilCronJob
const	SCHEDULE_TYPE_DAILY = 1

const	SCHEDULE_TYPE_IN_MINUTES = 2

const	SCHEDULE_TYPE_IN_HOURS = 3

const	SCHEDULE_TYPE_IN_DAYS = 4

const	SCHEDULE_TYPE_WEEKLY = 5

const	SCHEDULE_TYPE_MONTHLY = 6

const	SCHEDULE_TYPE_QUARTERLY = 7

const	SCHEDULE_TYPE_YEARLY = 8

Static Public Attributes
static	$providerObject = array()

Protected Member Functions
	getRefIdsByObjId ($a_obj_id)

	getFirstAccessibleRefIdBUserAndObjId ($a_user_id, $a_obj_id)

Protected Member Functions inherited from ilCronJob
	checkSchedule ($a_ts_last_run, $a_schedule_type, $a_schedule_value)

Protected Attributes
	$settings

	$logger

	$tree

	$num_sent_messages = 0

Static Protected Attributes
static	$deleted_ids_cache = array()

static	$ref_ids_by_obj_id = array()

static	$accessible_ref_ids_by_user = array()

Private Member Functions
	addProviderObject ($row)

	resetProviderCache ()

	sendNotificationForNewPosts (string $threshold_date)

	sendNotificationForUpdatedPosts (string $threshold_date)

	sendNotificationForCensoredPosts (string $threshold_date)

	sendNotificationForUncensoredPosts (string $threshold_date)

	sendNotificationForDeletedThreads ()

	sendNotifcationForDeletedPosts ()

	sendNotification (\ilPDOStatement $res, string $actionName, int $notificationType)

	sendDeleteNotifcations (\ilPDOStatement $res, string $action, string $actionDescription, int $notificationType)

	createForumPostSql ($condition)

	createSelectOfDeletionNotificationsSql ()

Private Attributes
	$ilDB

	$notificationCache

Static Private Attributes
static	$container_by_frm_ref_id = []

Detailed Description

Forum notifications.

Author: Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de; Nadia Matuschek nmatu.nosp@m.sche.nosp@m.k@dat.nosp@m.abay.nosp@m..de

Definition at line 10 of file class.ilForumCronNotification.php.

Constructor & Destructor Documentation

◆ __construct()

ilForumCronNotification::__construct	(	\ilDBInterface	$database = `null`,
		\ilForumNotificationCache	$notificationCache = `null`
	)

Parameters

ilDBInterface \| null	$database
ilForumNotificationCache \| null	$notificationCache

Definition at line 67 of file class.ilForumCronNotification.php.

References $DIC, $ilDB, $notificationCache, and settings().

     {
         $this->settings = new ilSetting('frma');
 
         global $DIC;
         if ($database === null) {
             $ilDB = $DIC->database();
         }
         $this->ilDB = $ilDB;
 
         if ($notificationCache === null) {
             $notificationCache = new \ilForumNotificationCache();
         }
         $this->notificationCache = $notificationCache;
     }

Here is the call graph for this function:

Member Function Documentation

◆ activationWasToggled()

ilForumCronNotification::activationWasToggled ( $a_currently_active )

Parameters

bool $a_currently_active

Definition at line 410 of file class.ilForumCronNotification.php.

References $DIC.

     {
         global $DIC;
 
         $value = 1;
         // propagate cron-job setting to object setting
         if ((bool) $a_currently_active) {
             $value = 2;
         }
         $DIC->settings()->set('forum_notification', $value);
     }

◆ addCustomSettingsToForm()

ilForumCronNotification::addCustomSettingsToForm ( ilPropertyFormGUI $a_form )

Parameters

ilPropertyFormGUI $a_form

Definition at line 425 of file class.ilForumCronNotification.php.

References $DIC, $lng, ilPropertyFormGUI\addItem(), ilNumberInputGUI\setSize(), and settings().

     {
         global $DIC;
         $lng = $DIC->language();
 
         $lng->loadLanguageModule('forum');
 
         $max_notification_age = new ilNumberInputGUI($lng->txt('frm_max_notification_age'), 'max_notification_age');
         $max_notification_age->setSize(5);
         $max_notification_age->setSuffix($lng->txt('frm_max_notification_age_unit'));
         $max_notification_age->setRequired(true);
         $max_notification_age->allowDecimals(false);
         $max_notification_age->setMinValue(1);
         $max_notification_age->setInfo($lng->txt('frm_max_notification_age_info'));
         $max_notification_age->setValue($this->settings->get('max_notification_age', 30));
 
         $a_form->addItem($max_notification_age);
     }

Here is the call graph for this function:

◆ addProviderObject()

ilForumCronNotification::addProviderObject ( $row )

private

Parameters

$row

Definition at line 372 of file class.ilForumCronNotification.php.

Referenced by sendCronForumNotification().

     {
         $tmp_provider = new ilForumCronNotificationDataProvider($row, $this->notificationCache);
 
         self::$providerObject[$row['pos_pk']] = $tmp_provider;
         self::$providerObject[$row['pos_pk']]->addRecipient($row['user_id']);
     }

Here is the caller graph for this function:

◆ addToExternalSettingsForm()

ilForumCronNotification::addToExternalSettingsForm	(		$a_form_id,
		array &	$a_fields,
			$a_is_active
	)

Parameters

int	$a_form_id
array	$a_fields
bool	$a_is_active

Definition at line 393 of file class.ilForumCronNotification.php.

References $DIC, $lng, and ilAdministrationSettingsFormHandler\FORM_FORUM.

     {
         global $DIC;
         $lng = $DIC->language();
 
         switch ($a_form_id) {
             case ilAdministrationSettingsFormHandler::FORM_FORUM:
                 $a_fields['cron_forum_notification'] = $a_is_active ?
                     $lng->txt('enabled') :
                     $lng->txt('disabled');
                 break;
         }
     }

◆ createForumPostSql()

ilForumCronNotification::createForumPostSql ( $condition )

private

Parameters

$condition

Returns: string

Definition at line 627 of file class.ilForumCronNotification.php.

Referenced by sendNotificationForCensoredPosts(), sendNotificationForNewPosts(), sendNotificationForUncensoredPosts(), and sendNotificationForUpdatedPosts().

                                                     : string
     {
         return '
                         SELECT  frm_threads.thr_subject thr_subject,
                                         frm_data.top_name top_name,
                                         frm_data.top_frm_fk obj_id,
                                         frm_notification.user_id user_id,
                                         frm_threads.thr_pk thread_id,
                                         frm_posts.*
                         FROM    frm_notification, frm_posts, frm_threads, frm_data, frm_posts_tree
                         WHERE   frm_posts.pos_thr_fk = frm_threads.thr_pk AND ' . $condition . '
                         AND     ((frm_threads.thr_top_fk = frm_data.top_pk AND  frm_data.top_frm_fk = frm_notification.frm_id)
                                         OR (frm_threads.thr_pk = frm_notification.thread_id
                         AND     frm_data.top_pk = frm_threads.thr_top_fk) )
                         AND     frm_posts.pos_display_user_id != frm_notification.user_id
                         AND     frm_posts_tree.pos_fk = frm_posts.pos_pk AND frm_posts_tree.parent_pos != 0
                         ORDER BY frm_posts.pos_date ASC';
     }

Here is the caller graph for this function:

◆ createSelectOfDeletionNotificationsSql()

ilForumCronNotification::createSelectOfDeletionNotificationsSql ( )

private

Returns: string

Definition at line 649 of file class.ilForumCronNotification.php.

Referenced by sendNotifcationForDeletedPosts(), and sendNotificationForDeletedThreads().

                                                               : string
     {
         return '
                         SELECT  frm_posts_deleted.thread_title thr_subject,
                                         frm_posts_deleted.forum_title  top_name,
                                         frm_posts_deleted.obj_id obj_id,
                                         frm_notification.user_id user_id,
                                         frm_posts_deleted.pos_display_user_id,
                                         frm_posts_deleted.pos_usr_alias,
                                         frm_posts_deleted.deleted_id,
                                         frm_posts_deleted.post_date pos_date,
                                         frm_posts_deleted.post_title pos_subject,
                                         frm_posts_deleted.post_message pos_message,
                                         frm_posts_deleted.deleted_by
                                         
                         FROM    frm_notification, frm_posts_deleted
                         
                         WHERE   ( frm_posts_deleted.obj_id = frm_notification.frm_id
                                         OR frm_posts_deleted.thread_id = frm_notification.thread_id)
                         AND     frm_posts_deleted.pos_display_user_id != frm_notification.user_id
                         AND     frm_posts_deleted.is_thread_deleted = %s
                         ORDER BY frm_posts_deleted.post_date ASC';
     }

Here is the caller graph for this function:

◆ existsProviderObject()

ilForumCronNotification::existsProviderObject ( $post_id )

Parameters

$post_id

Returns: bool

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

Referenced by sendCronForumNotification().

     {
         if (isset(self::$providerObject[$post_id])) {
             return true;
         }
         return false;
     }

Here is the caller graph for this function:

◆ getDefaultScheduleType()

ilForumCronNotification::getDefaultScheduleType ( )

Definition at line 102 of file class.ilForumCronNotification.php.

     {
         return self::SCHEDULE_TYPE_IN_HOURS;
     }

◆ getDefaultScheduleValue()

ilForumCronNotification::getDefaultScheduleValue ( )

Definition at line 107 of file class.ilForumCronNotification.php.

     {
         return 1;
     }

◆ getDescription()

ilForumCronNotification::getDescription ( )

Definition at line 95 of file class.ilForumCronNotification.php.

References $DIC.

     {
         global $DIC;
 
         return $DIC->language()->txt("cron_forum_notification_crob_desc");
     }

◆ getFirstAccessibleRefIdBUserAndObjId()

ilForumCronNotification::getFirstAccessibleRefIdBUserAndObjId	(	$a_user_id,
		$a_obj_id
	)

protected

Parameters

int	$a_user_id
int	$a_obj_id

Returns: int

Definition at line 223 of file class.ilForumCronNotification.php.

References $DIC, and getRefIdsByObjId().

Referenced by sendCronForumNotification().

     {
         global $DIC;
         $ilAccess = $DIC->access();
 
         if (!array_key_exists($a_user_id, self::$accessible_ref_ids_by_user)) {
             self::$accessible_ref_ids_by_user[$a_user_id] = array();
         }
 
         if (!array_key_exists($a_obj_id, self::$accessible_ref_ids_by_user[$a_user_id])) {
             $accessible_ref_id = 0;
             foreach ($this->getRefIdsByObjId($a_obj_id) as $ref_id) {
                 if ($ilAccess->checkAccessOfUser($a_user_id, 'read', '', $ref_id)) {
                     $accessible_ref_id = $ref_id;
                     break;
                 }
             }
             self::$accessible_ref_ids_by_user[$a_user_id][$a_obj_id] = $accessible_ref_id;
         }
 
         return (int) self::$accessible_ref_ids_by_user[$a_user_id][$a_obj_id];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getId()

ilForumCronNotification::getId ( )

Definition at line 83 of file class.ilForumCronNotification.php.

Referenced by keepAlive().

     {
         return "frm_notification";
     }

Here is the caller graph for this function:

◆ getRefIdsByObjId()

ilForumCronNotification::getRefIdsByObjId ( $a_obj_id )

protected

Parameters

int $a_obj_id

Returns: array

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

References ilObject\_getAllReferences().

Referenced by getFirstAccessibleRefIdBUserAndObjId().

     {
         if (!array_key_exists($a_obj_id, self::$ref_ids_by_obj_id)) {
             self::$ref_ids_by_obj_id[$a_obj_id] = ilObject::_getAllReferences($a_obj_id);
         }
 
         return (array) self::$ref_ids_by_obj_id[$a_obj_id];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTitle()

ilForumCronNotification::getTitle ( )

Definition at line 88 of file class.ilForumCronNotification.php.

References $DIC.

     {
         global $DIC;
 
         return $DIC->language()->txt("cron_forum_notification");
     }

◆ hasAutoActivation()

ilForumCronNotification::hasAutoActivation ( )

Definition at line 112 of file class.ilForumCronNotification.php.

     {
         return false;
     }

◆ hasCustomSettings()

ilForumCronNotification::hasCustomSettings ( )

Returns: bool

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

     {
         return true;
     }

◆ hasFlexibleSchedule()

ilForumCronNotification::hasFlexibleSchedule ( )

Definition at line 117 of file class.ilForumCronNotification.php.

     {
         return true;
     }

◆ keepAlive()

ilForumCronNotification::keepAlive ( )

Definition at line 133 of file class.ilForumCronNotification.php.

References getId(), and ilCronManager\ping().

Referenced by sendCronForumNotification(), sendDeleteNotifcations(), and sendNotification().

     {
         $this->logger->debug('Sending ping to cron manager ...');
         \ilCronManager::ping($this->getId());
         $this->logger->debug(sprintf('Current memory usage: %s', memory_get_usage(true)));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetProviderCache()

ilForumCronNotification::resetProviderCache ( )

private

Definition at line 383 of file class.ilForumCronNotification.php.

Referenced by sendCronForumNotification().

     {
         self::$providerObject = array();
     }

Here is the caller graph for this function:

◆ run()

ilForumCronNotification::run ( )

Returns: ilCronJobResult

Definition at line 143 of file class.ilForumCronNotification.php.

References $DIC, $ilSetting, $lng, $result, sendNotifcationForDeletedPosts(), sendNotificationForCensoredPosts(), sendNotificationForDeletedThreads(), sendNotificationForNewPosts(), sendNotificationForUncensoredPosts(), sendNotificationForUpdatedPosts(), settings(), ilCronJobResult\STATUS_NO_ACTION, and ilCronJobResult\STATUS_OK.

     {
         global $DIC;
 
         $ilSetting = $DIC->settings();
         $lng = $DIC->language();
         $this->tree = $DIC->repositoryTree();
 
         $this->logger = $DIC->logger()->frm();
 
         $status = ilCronJobResult::STATUS_NO_ACTION;
 
         $lng->loadLanguageModule('forum');
 
         $this->logger->info('Started forum notification job ...');
 
         if (!($last_run_datetime = $ilSetting->get('cron_forum_notification_last_date'))) {
             $last_run_datetime = null;
         }
 
         $this->num_sent_messages = 0;
         $cj_start_date = date('Y-m-d H:i:s');
 
         if ($last_run_datetime != null &&
             checkDate(date('m', strtotime($last_run_datetime)), date('d', strtotime($last_run_datetime)), date('Y', strtotime($last_run_datetime)))) {
             $threshold = max(strtotime($last_run_datetime), strtotime('-' . (int) $this->settings->get('max_notification_age', 30) . ' days', time()));
         } else {
             $threshold = strtotime('-' . (int) $this->settings->get('max_notification_age', 30) . ' days', time());
         }
 
         $this->logger->info(sprintf('Threshold for forum event determination is: %s', date('Y-m-d H:i:s', $threshold)));
 
         $threshold_date = date('Y-m-d H:i:s', $threshold);
 
         $this->sendNotificationForNewPosts($threshold_date);
 
         $this->sendNotificationForUpdatedPosts($threshold_date);
 
         $this->sendNotificationForCensoredPosts($threshold_date);
 
         $this->sendNotificationForUncensoredPosts($threshold_date);
 
         $this->sendNotificationForDeletedThreads();
 
         $this->sendNotifcationForDeletedPosts();
 
         $ilSetting->set('cron_forum_notification_last_date', $cj_start_date);
 
         $mess = 'Sent ' . $this->num_sent_messages . ' messages.';
 
         $this->logger->info($mess);
         $this->logger->info('Finished forum notification job');
 
         $result = new ilCronJobResult();
         if ($this->num_sent_messages) {
             $status = ilCronJobResult::STATUS_OK;
             $result->setMessage($mess);
         };
         $result->setStatus($status);
         return $result;
     }

Here is the call graph for this function:

◆ saveCustomSettings()

ilForumCronNotification::saveCustomSettings ( ilPropertyFormGUI $a_form )

Parameters

ilPropertyFormGUI $a_form

Returns: bool

Definition at line 448 of file class.ilForumCronNotification.php.

References ilPropertyFormGUI\getInput(), and settings().

     {
         $this->settings->set('max_notification_age', $a_form->getInput('max_notification_age'));
         return true;
     }

Here is the call graph for this function:

◆ sendCronForumNotification()

ilForumCronNotification::sendCronForumNotification	(	$res,
		$notification_type
	)

Parameters

$res
$notification_type

Definition at line 250 of file class.ilForumCronNotification.php.

References $container, $DIC, $i, $ilDB, $res, addProviderObject(), existsProviderObject(), getFirstAccessibleRefIdBUserAndObjId(), ilObjectFactory\getInstanceByRefId(), keepAlive(), ilForumAuthorInformationCache\preloadUserObjects(), resetProviderCache(), ilForumMailNotification\TYPE_POST_DELETED, and ilForumMailNotification\TYPE_THREAD_DELETED.

Referenced by sendDeleteNotifcations(), and sendNotification().

     {
         global $DIC;
         $ilDB = $DIC->database();
 
         while ($row = $ilDB->fetchAssoc($res)) {
             if ($notification_type == ilForumMailNotification::TYPE_POST_DELETED
                 || $notification_type == ilForumMailNotification::TYPE_THREAD_DELETED) {
                 // important! save the deleted_id to cache before proceeding getFirstAccessibleRefIdBUserAndObjId !
                 self::$deleted_ids_cache[$row['deleted_id']] = $row['deleted_id'];
             }
             
             $ref_id = $this->getFirstAccessibleRefIdBUserAndObjId($row['user_id'], $row['obj_id']);
             if ($ref_id < 1) {
                 $this->logger->debug(sprintf(
                     'The recipient with id %s has no "read" permission for object with id %s',
                     $row['user_id'],
                     $row['obj_id']
                 ));
                 continue;
             }
 
             $row['ref_id'] = $ref_id;
 
             $container = $this->determineClosestContainer($ref_id);
             if ($container instanceof ilObjCourse || $container instanceof ilObjGroup) {
                 $row['closest_container'] = $container;
             }
 
             if ($this->existsProviderObject($row['pos_pk'])) {
                 self::$providerObject[$row['pos_pk']]->addRecipient($row['user_id']);
             } else {
                 $this->addProviderObject($row);
             }
         }
 
         $usrIdsToPreload = array();
         foreach (self::$providerObject as $provider) {
             if ($provider->getPosAuthorId()) {
                 $usrIdsToPreload[$provider->getPosAuthorId()] = $provider->getPosAuthorId();
             }
             if ($provider->getPosDisplayUserId()) {
                 $usrIdsToPreload[$provider->getPosDisplayUserId()] = $provider->getPosDisplayUserId();
             }
             if ($provider->getPostUpdateUserId()) {
                 $usrIdsToPreload[$provider->getPostUpdateUserId()] = $provider->getPostUpdateUserId();
             }
         }
 
         ilForumAuthorInformationCache::preloadUserObjects(array_unique($usrIdsToPreload));
 
         $i = 0;
         foreach (self::$providerObject as $provider) {
             if ($i > 0 && ($i % self::KEEP_ALIVE_CHUNK_SIZE) == 0) {
                 $this->keepAlive();
             }
 
             $recipients = array_unique($provider->getCronRecipients());
 
             $this->logger->info(sprintf(
                 'Trying to send forum notifications for posting id "%s", type "%s" and recipients: %s',
                 $provider->getPostId(),
                 $notification_type,
                 implode(', ', $recipients)
             ));
 
             $mailNotification = new ilForumMailNotification($provider, $this->logger);
             $mailNotification->setIsCronjob(true);
             $mailNotification->setType($notification_type);
             $mailNotification->setRecipients($recipients);
 
             $mailNotification->send();
 
             $this->num_sent_messages += count($provider->getCronRecipients());
             $this->logger->info(sprintf("Sent notifications ... "));
 
             ++$i;
         }
         
         $this->resetProviderCache();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendDeleteNotifcations()

ilForumCronNotification::sendDeleteNotifcations	(	\ilPDOStatement	$res,
		string	$action,
		string	$actionDescription,
		int	$notificationType
	)

private

Parameters

$res
$action
$actionDescription
$notificationType

Definition at line 607 of file class.ilForumCronNotification.php.

References keepAlive(), and sendCronForumNotification().

Referenced by sendNotifcationForDeletedPosts(), and sendNotificationForDeletedThreads().

     {
         $numRows = $this->ilDB->numRows($res);
         if ($numRows > 0) {
             $this->logger->info(sprintf('Sending notifications for %s "%s" events ...', $numRows, $actionDescription));
             $this->sendCronForumNotification($res, $notificationType);
             if (count(self::$deleted_ids_cache) > 0) {
                 $this->ilDB->manipulate('DELETE FROM frm_posts_deleted WHERE ' . $this->ilDB->in('deleted_id', self::$deleted_ids_cache, false, 'integer'));
                 $this->logger->info('Deleted obsolete entries of table "' . $action . '" ...');
             }
             $this->logger->info(sprintf('Sent notifications for %s ...', $actionDescription));
         }
 
         $this->keepAlive();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendNotifcationForDeletedPosts()

ilForumCronNotification::sendNotifcationForDeletedPosts ( )

private

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

References $res, createSelectOfDeletionNotificationsSql(), sendDeleteNotifcations(), and ilForumMailNotification\TYPE_POST_DELETED.

Referenced by run().

     {
         $res = $this->ilDB->queryF(
             $this->createSelectOfDeletionNotificationsSql(),
             array('integer'),
             array(0)
         );
 
         $this->sendDeleteNotifcations(
             $res,
             'frm_posts_deleted',
             'deleted postings',
             ilForumMailNotification::TYPE_POST_DELETED
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendNotification()

ilForumCronNotification::sendNotification	(	\ilPDOStatement	$res,
		string	$actionName,
		int	$notificationType
	)

private

Parameters

$res
$actionName
$notificationType

Definition at line 589 of file class.ilForumCronNotification.php.

References keepAlive(), and sendCronForumNotification().

Referenced by sendNotificationForCensoredPosts(), sendNotificationForNewPosts(), sendNotificationForUncensoredPosts(), and sendNotificationForUpdatedPosts().

     {
         $numRows = $this->ilDB->numRows($res);
         if ($numRows > 0) {
             $this->logger->info(sprintf('Sending notifications for %s "%s" events ...', $numRows, $actionName));
             $this->sendCronForumNotification($res, $notificationType);
             $this->logger->info(sprintf('Sent notifications for %s ...', $actionName));
         }
 
         $this->keepAlive();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendNotificationForCensoredPosts()

ilForumCronNotification::sendNotificationForCensoredPosts ( string $threshold_date )

private

Parameters

$threshold_date

Definition at line 507 of file class.ilForumCronNotification.php.

References $res, createForumPostSql(), sendNotification(), and ilForumMailNotification\TYPE_POST_CENSORED.

Referenced by run().

     {
         $condition = '
                         frm_posts.pos_cens = %s AND frm_posts.pos_status = %s AND  
             (frm_posts.pos_cens_date >= %s AND frm_posts.pos_cens_date > frm_posts.pos_activation_date ) ';
         $types = array('integer', 'integer', 'timestamp');
         $values = array(1, 1, $threshold_date);
 
         $res = $this->ilDB->queryf(
             $this->createForumPostSql($condition),
             $types,
             $values
         );
 
         $this->sendNotification(
             $res,
             'censored posting',
             ilForumMailNotification::TYPE_POST_CENSORED
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendNotificationForDeletedThreads()

ilForumCronNotification::sendNotificationForDeletedThreads ( )

private

Definition at line 552 of file class.ilForumCronNotification.php.

References $res, createSelectOfDeletionNotificationsSql(), sendDeleteNotifcations(), and ilForumMailNotification\TYPE_THREAD_DELETED.

Referenced by run().

     {
         $res = $this->ilDB->queryF(
             $this->createSelectOfDeletionNotificationsSql(),
             array('integer'),
             array(1)
         );
 
         $this->sendDeleteNotifcations(
             $res,
             'frm_threads_deleted',
             'deleted threads',
             ilForumMailNotification::TYPE_THREAD_DELETED
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendNotificationForNewPosts()

ilForumCronNotification::sendNotificationForNewPosts ( string $threshold_date )

private

Parameters

$threshold_date

Definition at line 457 of file class.ilForumCronNotification.php.

References $res, createForumPostSql(), sendNotification(), and ilForumMailNotification\TYPE_POST_NEW.

Referenced by run().

     {
         $condition = '
                         frm_posts.pos_status = %s AND (
                                 (frm_posts.pos_date >= %s AND frm_posts.pos_date = frm_posts.pos_activation_date) OR 
                                 (frm_posts.pos_activation_date >= %s AND frm_posts.pos_date < frm_posts.pos_activation_date)
                         ) ';
         $types = array('integer', 'timestamp', 'timestamp');
         $values = array(1, $threshold_date, $threshold_date);
 
         $res = $this->ilDB->queryf(
             $this->createForumPostSql($condition),
             $types,
             $values
         );
 
         $this->sendNotification(
             $res,
             'new posting',
             ilForumMailNotification::TYPE_POST_NEW
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendNotificationForUncensoredPosts()

ilForumCronNotification::sendNotificationForUncensoredPosts ( string $threshold_date )

private

Parameters

$threshold_date

Definition at line 531 of file class.ilForumCronNotification.php.

References $res, createForumPostSql(), sendNotification(), and ilForumMailNotification\TYPE_POST_UNCENSORED.

Referenced by run().

     {
         $condition = '
                         frm_posts.pos_cens = %s AND frm_posts.pos_status = %s AND  
             (frm_posts.pos_cens_date >= %s AND frm_posts.pos_cens_date > frm_posts.pos_activation_date ) ';
         $types = array('integer', 'integer', 'timestamp');
         $values = array(0, 1, $threshold_date);
 
         $res = $this->ilDB->queryf(
             $this->createForumPostSql($condition),
             $types,
             $values
         );
 
         $this->sendNotification(
             $res,
             'uncensored posting',
             ilForumMailNotification::TYPE_POST_UNCENSORED
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendNotificationForUpdatedPosts()

ilForumCronNotification::sendNotificationForUpdatedPosts ( string $threshold_date )

private

Parameters

$threshold_date

Definition at line 483 of file class.ilForumCronNotification.php.

References $res, createForumPostSql(), sendNotification(), and ilForumMailNotification\TYPE_POST_UPDATED.

Referenced by run().

     {
         $condition = '
                         frm_posts.pos_cens = %s AND frm_posts.pos_status = %s AND 
                         (frm_posts.pos_update > frm_posts.pos_date AND frm_posts.pos_update >= %s) ';
         $types = array('integer', 'integer', 'timestamp');
         $values = array(0, 1, $threshold_date);
 
         $res = $this->ilDB->queryf(
             $this->createForumPostSql($condition),
             $types,
             $values
         );
 
         $this->sendNotification(
             $res,
             'updated posting',
             ilForumMailNotification::TYPE_POST_UPDATED
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $accessible_ref_ids_by_user

ilForumCronNotification::$accessible_ref_ids_by_user = array()

staticprotected

Definition at line 47 of file class.ilForumCronNotification.php.

◆ $container_by_frm_ref_id

ilForumCronNotification::$container_by_frm_ref_id = []

staticprivate

Definition at line 50 of file class.ilForumCronNotification.php.

◆ $deleted_ids_cache

ilForumCronNotification::$deleted_ids_cache = array()

staticprotected

Definition at line 37 of file class.ilForumCronNotification.php.

◆ $ilDB

ilForumCronNotification::$ilDB

private

Definition at line 58 of file class.ilForumCronNotification.php.

Referenced by __construct(), and sendCronForumNotification().

◆ $logger

ilForumCronNotification::$logger

protected

Definition at line 22 of file class.ilForumCronNotification.php.

◆ $notificationCache

ilForumCronNotification::$notificationCache

private

Definition at line 61 of file class.ilForumCronNotification.php.

Referenced by __construct().

◆ $num_sent_messages

ilForumCronNotification::$num_sent_messages = 0

protected

Definition at line 55 of file class.ilForumCronNotification.php.

◆ $providerObject

ilForumCronNotification::$providerObject = array()

static

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

◆ $ref_ids_by_obj_id

ilForumCronNotification::$ref_ids_by_obj_id = array()

staticprotected

Definition at line 42 of file class.ilForumCronNotification.php.

◆ $settings

ilForumCronNotification::$settings

protected

Definition at line 17 of file class.ilForumCronNotification.php.

◆ $tree

ilForumCronNotification::$tree

protected

Definition at line 27 of file class.ilForumCronNotification.php.

◆ KEEP_ALIVE_CHUNK_SIZE

const ilForumCronNotification::KEEP_ALIVE_CHUNK_SIZE = 25

Definition at line 12 of file class.ilForumCronNotification.php.

The documentation for this class was generated from the following file:

Modules/Forum/classes/class.ilForumCronNotification.php

Public Member Functions

Data Fields

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ activationWasToggled()

◆ addCustomSettingsToForm()

◆ addProviderObject()

◆ addToExternalSettingsForm()

◆ createForumPostSql()

◆ createSelectOfDeletionNotificationsSql()

◆ existsProviderObject()

◆ getDefaultScheduleType()

◆ getDefaultScheduleValue()

◆ getDescription()

◆ getFirstAccessibleRefIdBUserAndObjId()

◆ getId()

◆ getRefIdsByObjId()

◆ getTitle()

◆ hasAutoActivation()

◆ hasCustomSettings()

◆ hasFlexibleSchedule()

◆ keepAlive()

◆ resetProviderCache()

◆ run()

◆ saveCustomSettings()

◆ sendCronForumNotification()

◆ sendDeleteNotifcations()

◆ sendNotifcationForDeletedPosts()

◆ sendNotification()

◆ sendNotificationForCensoredPosts()

◆ sendNotificationForDeletedThreads()

◆ sendNotificationForNewPosts()

◆ sendNotificationForUncensoredPosts()

◆ sendNotificationForUpdatedPosts()

Field Documentation

◆ $accessible_ref_ids_by_user

◆ $container_by_frm_ref_id

◆ $deleted_ids_cache

◆ $ilDB

◆ $logger

◆ $notificationCache

◆ $num_sent_messages

◆ $providerObject

◆ $ref_ids_by_obj_id

◆ $settings

◆ $tree

◆ KEEP_ALIVE_CHUNK_SIZE