ilForumCronNotification Class Reference

Forum notifications. More...

Inheritance diagram for ilForumCronNotification:

Collaboration diagram for ilForumCronNotification:

Public Member Functions
	__construct (ilDBInterface $database=null, ilForumNotificationCache $notificationCache=null, ilLanguage $lng=null, ilSetting $settings=null, \ILIAS\Refinery\Factory $refinery=null, ilCronManager $cronManager=null)
	getId ()
	getTitle ()
	getDescription ()
	getDefaultScheduleType ()
	getDefaultScheduleValue ()
	hasAutoActivation ()
	hasFlexibleSchedule ()
	hasCustomSettings ()
	keepAlive ()
	run ()
	sendCronForumNotification (ilDBStatement $res, int $notification_type)
	existsProviderObject (int $provider_id, int $notification_type)
	addToExternalSettingsForm (int $a_form_id, array &$a_fields, bool $a_is_active)
	activationWasToggled (ilDBInterface $db, ilSetting $setting, bool $a_currently_active)
	addCustomSettingsToForm (ilPropertyFormGUI $a_form)
	saveCustomSettings (ilPropertyFormGUI $a_form)
Public Member Functions inherited from ilCronJob
	setDateTimeProvider (?Closure $date_time_provider)
	isDue (?DateTimeImmutable $last_run, ?int $schedule_type, ?int $schedule_value, bool $is_manually_executed=false)
	getScheduleType ()
	Get current schedule type (if flexible) More...
	getScheduleValue ()
	Get current schedule value (if flexible) More...
	setSchedule (?int $a_type, ?int $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...
	isManuallyExecutable ()
	hasCustomSettings ()
	addCustomSettingsToForm (ilPropertyFormGUI $a_form)
	saveCustomSettings (ilPropertyFormGUI $a_form)
	addToExternalSettingsForm (int $a_form_id, array &$a_fields, bool $a_is_active)
	activationWasToggled (ilDBInterface $db, ilSetting $setting, bool $a_currently_active)
	Important: This method is (also) called from the setup process, where the constructor of an ilCronJob ist NOT executed. More...
	getId ()
	getTitle ()
	getDescription ()
	hasAutoActivation ()
	Is to be activated on "installation", does only work for ILIAS core cron jobs. More...
	hasFlexibleSchedule ()
	getDefaultScheduleType ()
	getDefaultScheduleValue ()
	run ()

Protected Member Functions
	getRefIdsByObjId (int $a_obj_id)
	getFirstAccessibleRefIdBUserAndObjId (int $a_user_id, int $a_obj_id)

Private Member Functions
	addProviderObject (int $provider_id, array $row, int $notification_type)
	resetProviderCache ()
	sendNotificationForNewPosts (string $threshold_date)
	sendNotificationForUpdatedPosts (string $threshold_date)
	sendNotificationForCensoredPosts (string $threshold_date)
	sendNotificationForUncensoredPosts (string $threshold_date)
	sendNotificationForDeletedThreads ()
	sendNotificationForDeletedPosts ()
	sendNotification (ilDBStatement $res, string $actionName, int $notificationType)
	sendDeleteNotifications (ilDBStatement $res, string $action, string $actionDescription, int $notificationType)
	createForumPostSql (string $condition)
	createSelectOfDeletionNotificationsSql ()

Private Attributes
const	KEEP_ALIVE_CHUNK_SIZE = 25
const	DEFAULT_MAX_NOTIFICATION_AGE_IN_DAYS = 30
ilLanguage	$lng
ilSetting	$settings
ilLogger	$logger
ilTree	$tree
int	$num_sent_messages = 0
ilDBInterface	$ilDB
ilForumNotificationCache	$notificationCache
ILIAS Refinery Factory	$refinery
ilCronManager	$cronManager

Static Private Attributes
static array	$providerObject = []
static array	$deleted_ids_cache = []
static array	$ref_ids_by_obj_id = []
static array	$accessible_ref_ids_by_user = []
static array	$container_by_frm_ref_id = []

Additional Inherited Members
Data Fields inherited from ilCronJob
const	SCHEDULE_TYPE_DAILY = 1
	This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_IN_MINUTES = 2
	This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_IN_HOURS = 3
	This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_IN_DAYS = 4
	This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_WEEKLY = 5
	This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_MONTHLY = 6
	This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_QUARTERLY = 7
	This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_YEARLY = 8
	This will be replaced with an ENUM in ILIAS 9 More...
Protected Attributes inherited from ilCronJob
int	$schedule_type = null
int	$schedule_value = null
Closure	$date_time_provider = null

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 26 of file class.ilForumCronNotification.php.

Constructor & Destructor Documentation

__construct()

ilForumCronNotification::__construct	(	ilDBInterface	$database = null,
		ilForumNotificationCache	$notificationCache = null,
		ilLanguage	$lng = null,
		ilSetting	$settings = null,
		\ILIAS\Refinery\Factory	$refinery = null,
		ilCronManager	$cronManager = null
	)

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

References $DIC, ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\Repository\settings().

      {
        global $DIC;

        $this->settings = $settings ?? new ilSetting('frma');
        $this->lng = $lng ?? $DIC->language();
        $this->ilDB = $database ?? $DIC->database();
        $this->notificationCache = $notificationCache ?? new ilForumNotificationCache();
        $this->refinery = $refinery ?? $DIC->refinery();
        $this->cronManager = $cronManager ?? $DIC->cron()->manager();
    }

Here is the call graph for this function:

Member Function Documentation

activationWasToggled()

ilForumCronNotification::activationWasToggled	(	ilDBInterface	$db,
		ilSetting	$setting,
		bool	$a_currently_active
	)

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

References ilSetting\set().

                                                                                                         : void
    {
        $value = 1;
        // propagate cron-job setting to object setting
        if ($a_currently_active) {
            $value = 2;
        }

        $setting->set('forum_notification', (string) $value);
    }

Here is the call graph for this function:

addCustomSettingsToForm()

ilForumCronNotification::addCustomSettingsToForm

(

ilPropertyFormGUI

$a_form

)

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

References ilPropertyFormGUI\addItem(), ILIAS\Repository\lng(), ilNumberInputGUI\setSize(), and ILIAS\Repository\settings().

                                                                      : void
    {
        $this->lng->loadLanguageModule('forum');

        $max_notification_age = new ilNumberInputGUI(
            $this->lng->txt('frm_max_notification_age'),
            'max_notification_age'
        );
        $max_notification_age->setSize(5);
        $max_notification_age->setSuffix($this->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($this->lng->txt('frm_max_notification_age_info'));
        $max_notification_age->setValue(
            $this->settings->get(
                'max_notification_age',
                (string) self::DEFAULT_MAX_NOTIFICATION_AGE_IN_DAYS
            )
        );

        $a_form->addItem($max_notification_age);
    }

Here is the call graph for this function:

addProviderObject()

ilForumCronNotification::addProviderObject ( int  $provider_id, array  $row, int  $notification_type  )

private

Parameters

array<string,string|int|float|null>

$row

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

Referenced by sendCronForumNotification().

                                                                                            : void
    {
        $tmp_provider = new ilForumCronNotificationDataProvider($row, $notification_type, $this->notificationCache);
        self::$providerObject[$provider_id . '_' . $notification_type] = $tmp_provider;
        self::$providerObject[$provider_id . '_' . $notification_type]->addRecipient((int) $row['user_id']);
    }

Here is the caller graph for this function:

addToExternalSettingsForm()

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

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

References ilAdministrationSettingsFormHandler\FORM_FORUM, and ILIAS\Repository\lng().

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

Here is the call graph for this function:

createForumPostSql()

ilForumCronNotification::createForumPostSql ( string  $condition )

private

Definition at line 605 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_author_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

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

Referenced by sendNotificationForDeletedPosts(), 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
                        AND     frm_notification.interested_events & %s
                        ORDER BY frm_posts_deleted.post_date ASC';
    }

Here is the caller graph for this function:

existsProviderObject()

ilForumCronNotification::existsProviderObject	(	int	$provider_id,
		int	$notification_type
	)

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

Referenced by sendCronForumNotification().

                                                                                  : bool
    {
        return isset(self::$providerObject[$provider_id . '_' . $notification_type]);
    }

Here is the caller graph for this function:

getDefaultScheduleType()

ilForumCronNotification::getDefaultScheduleType

(

)

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

                                            : int
    {
        return self::SCHEDULE_TYPE_IN_HOURS;
    }

getDefaultScheduleValue()

ilForumCronNotification::getDefaultScheduleValue

(

)

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

                                             : ?int
    {
        return 1;
    }

getDescription()

ilForumCronNotification::getDescription

(

)

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

References ILIAS\Repository\lng().

                                    : string
    {
        return $this->lng->txt('cron_forum_notification_crob_desc');
    }

Here is the call graph for this function:

getFirstAccessibleRefIdBUserAndObjId()

ilForumCronNotification::getFirstAccessibleRefIdBUserAndObjId ( int  $a_user_id, int  $a_obj_id  )

protected

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

References $DIC, $ref_id, and getRefIdsByObjId().

Referenced by sendCronForumNotification().

                                                                                          : int
    {
        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] = [];
        }

        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 70 of file class.ilForumCronNotification.php.

Referenced by keepAlive().

                           : string
    {
        return 'frm_notification';
    }

Here is the caller graph for this function:

getRefIdsByObjId()

ilForumCronNotification::getRefIdsByObjId ( int  $a_obj_id )

protected

Returns

list<int>

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

References ilObject\_getAllReferences().

Referenced by getFirstAccessibleRefIdBUserAndObjId().

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

        return 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 75 of file class.ilForumCronNotification.php.

References ILIAS\Repository\lng().

                              : string
    {
        return $this->lng->txt('cron_forum_notification');
    }

Here is the call graph for this function:

hasAutoActivation()

ilForumCronNotification::hasAutoActivation

(

)

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

                                       : bool
    {
        return false;
    }

hasCustomSettings()

ilForumCronNotification::hasCustomSettings

(

)

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

                                       : bool
    {
        return true;
    }

hasFlexibleSchedule()

ilForumCronNotification::hasFlexibleSchedule

(

)

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

                                         : bool
    {
        return true;
    }

keepAlive()

ilForumCronNotification::keepAlive

(

)

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

References getId(), and ILIAS\Repository\logger().

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

                               : void
    {
        $this->logger->debug('Sending ping to cron manager ...');
        $this->cronManager->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 360 of file class.ilForumCronNotification.php.

Referenced by sendCronForumNotification().

                                         : void
    {
        self::$providerObject = [];
    }

Here is the caller graph for this function:

run()

ilForumCronNotification::run

(

)

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

References $DIC, ILIAS\Repository\lng(), ILIAS\Repository\logger(), sendNotificationForCensoredPosts(), sendNotificationForDeletedPosts(), sendNotificationForDeletedThreads(), sendNotificationForNewPosts(), sendNotificationForUncensoredPosts(), sendNotificationForUpdatedPosts(), ILIAS\Repository\settings(), ilCronJobResult\STATUS_NO_ACTION, and ilCronJobResult\STATUS_OK.

                         : ilCronJobResult
    {
        global $DIC;

        $this->logger = $DIC->logger()->frm();
        $this->tree = $DIC->repositoryTree();

        $status = ilCronJobResult::STATUS_NO_ACTION;

        $this->lng->loadLanguageModule('forum');

        $this->logger->info('Started forum notification job ...');

        if (!($last_run_datetime = $this->settings->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 ((string) $this->settings->get('max_notification_age', '') === '') {
            $this->logger->info(sprintf(
                'No maximum notification age set, %s days will be used to determine the ' .
                'left interval when querying the relevant forum events.',
                self::DEFAULT_MAX_NOTIFICATION_AGE_IN_DAYS
            ));
        }

        if ($last_run_datetime !== null &&
            checkdate(
                (int) date('m', strtotime($last_run_datetime)),
                (int) date('d', strtotime($last_run_datetime)),
                (int) date('Y', strtotime($last_run_datetime))
            )) {
            $threshold = max(
                strtotime($last_run_datetime),
                strtotime('-' . (int) $this->settings->get('max_notification_age', (string) self::DEFAULT_MAX_NOTIFICATION_AGE_IN_DAYS) . ' days')
            );
        } else {
            $threshold = strtotime('-' . (int) $this->settings->get('max_notification_age', (string) self::DEFAULT_MAX_NOTIFICATION_AGE_IN_DAYS) . ' days');
        }

        $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->sendNotificationForDeletedPosts();

        $this->settings->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

)

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

References ilPropertyFormGUI\getInput(), ILIAS\Repository\refinery(), and ILIAS\Repository\settings().

                                                                 : bool
    {
        $this->settings->set(
            'max_notification_age',
            $this->refinery->in()->series([
                $this->refinery->byTrying([
                    $this->refinery->kindlyTo()->int(),
                    $this->refinery->in()->series([
                        $this->refinery->kindlyTo()->float(),
                        $this->refinery->kindlyTo()->int()
                    ])
                ]),
                $this->refinery->kindlyTo()->string()
            ])->transform($a_form->getInput('max_notification_age'))
        );
        return true;
    }

Here is the call graph for this function:

sendCronForumNotification()

ilForumCronNotification::sendCronForumNotification	(	ilDBStatement	$res,
		int	$notification_type
	)

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

References $container, $DIC, $i, $provider, $ref_id, addProviderObject(), ANONYMOUS_USER_ID, existsProviderObject(), ilDBInterface\fetchAssoc(), getFirstAccessibleRefIdBUserAndObjId(), ilObjectFactory\getInstanceByRefId(), ILIAS\Repository\int(), keepAlive(), ILIAS\Repository\logger(), ilForumAuthorInformationCache\preloadUserObjects(), resetProviderCache(), ilForumMailNotification\TYPE_POST_DELETED, and ilForumMailNotification\TYPE_THREAD_DELETED.

Referenced by sendDeleteNotifications(), and sendNotification().

                                                                                         : void
    {
        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'];
            }

            if (defined('ANONYMOUS_USER_ID') && (int) $row['user_id'] === ANONYMOUS_USER_ID) {
                continue;
            }

            $ref_id = $this->getFirstAccessibleRefIdBUserAndObjId((int) $row['user_id'], (int) $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);
            $row['closest_container'] = null;
            if ($container instanceof ilObjCourse || $container instanceof ilObjGroup) {
                $row['closest_container'] = $container;
            }

            $provider_id = isset($row['deleted_id']) ? -((int) $row['deleted_id']) : (int) $row['pos_pk'];
            if ($this->existsProviderObject($provider_id, $notification_type)) {
                self::$providerObject[$provider_id . '_' . $notification_type]->addRecipient((int) $row['user_id']);
            } else {
                $this->addProviderObject($provider_id, $row, $notification_type);
            }
        }

        $usrIdsToPreload = [];
        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('Sent notifications ... ');

            ++$i;
        }

        $this->resetProviderCache();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

sendDeleteNotifications()

ilForumCronNotification::sendDeleteNotifications ( ilDBStatement  $res, string  $action, string  $actionDescription, int  $notificationType  )

private

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

References keepAlive(), ILIAS\Repository\logger(), sendCronForumNotification(), and ilDBConstants\T_INTEGER.

Referenced by sendNotificationForDeletedPosts(), and sendNotificationForDeletedThreads().

     : void {
        $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,
                        ilDBConstants::T_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:

sendNotification()

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

private

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

References keepAlive(), ILIAS\Repository\logger(), and sendCronForumNotification().

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

                                                                                                    : void
    {
        $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

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

References $res, ilForumNotificationEvents\CENSORED, createForumPostSql(), sendNotification(), ilDBConstants\T_INTEGER, ilDBConstants\T_TIMESTAMP, and ilForumMailNotification\TYPE_POST_CENSORED.

Referenced by run().

                                                                             : void
    {
        $condition = '
            frm_notification.interested_events & %s AND
                        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 = [
            ilDBConstants::T_INTEGER,
            ilDBConstants::T_INTEGER,
            ilDBConstants::T_INTEGER,
            ilDBConstants::T_TIMESTAMP
        ];
        $values = [ilForumNotificationEvents::CENSORED, 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:

sendNotificationForDeletedPosts()

ilForumCronNotification::sendNotificationForDeletedPosts ( )

private

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

References $res, createSelectOfDeletionNotificationsSql(), ilForumNotificationEvents\POST_DELETED, sendDeleteNotifications(), ilDBConstants\T_INTEGER, and ilForumMailNotification\TYPE_POST_DELETED.

Referenced by run().

                                                      : void
    {
        $res = $this->ilDB->queryF(
            $this->createSelectOfDeletionNotificationsSql(),
            [ilDBConstants::T_INTEGER, ilDBConstants::T_INTEGER],
            [0, ilForumNotificationEvents::POST_DELETED]
        );

        $this->sendDeleteNotifications(
            $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:

sendNotificationForDeletedThreads()

ilForumCronNotification::sendNotificationForDeletedThreads ( )

private

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

References $res, createSelectOfDeletionNotificationsSql(), sendDeleteNotifications(), ilDBConstants\T_INTEGER, ilForumNotificationEvents\THREAD_DELETED, and ilForumMailNotification\TYPE_THREAD_DELETED.

Referenced by run().

                                                        : void
    {
        $res = $this->ilDB->queryF(
            $this->createSelectOfDeletionNotificationsSql(),
            [ilDBConstants::T_INTEGER, ilDBConstants::T_INTEGER],
            [1, ilForumNotificationEvents::THREAD_DELETED]
        );

        $this->sendDeleteNotifications(
            $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

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

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

Referenced by run().

                                                                        : void
    {
        $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 = [ilDBConstants::T_INTEGER, ilDBConstants::T_TIMESTAMP, ilDBConstants::T_TIMESTAMP];
        $values = [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

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

References $res, createForumPostSql(), sendNotification(), ilDBConstants\T_INTEGER, ilDBConstants\T_TIMESTAMP, ilForumMailNotification\TYPE_POST_UNCENSORED, and ilForumNotificationEvents\UNCENSORED.

Referenced by run().

                                                                               : void
    {
        $condition = '
            frm_notification.interested_events & %s AND
                        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 = [
            ilDBConstants::T_INTEGER,
            ilDBConstants::T_INTEGER,
            ilDBConstants::T_INTEGER,
            ilDBConstants::T_TIMESTAMP
        ];
        $values = [ilForumNotificationEvents::UNCENSORED, 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

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

References $res, createForumPostSql(), sendNotification(), ilDBConstants\T_INTEGER, ilDBConstants\T_TIMESTAMP, ilForumMailNotification\TYPE_POST_UPDATED, and ilForumNotificationEvents\UPDATED.

Referenced by run().

                                                                            : void
    {
        $condition = '
            frm_notification.interested_events & %s AND
                        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 = [
            ilDBConstants::T_INTEGER,
            ilDBConstants::T_INTEGER,
            ilDBConstants::T_INTEGER,
            ilDBConstants::T_TIMESTAMP
        ];
        $values = [ilForumNotificationEvents::UPDATED, 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

array ilForumCronNotification::$accessible_ref_ids_by_user = []

staticprivate

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

$container_by_frm_ref_id

array ilForumCronNotification::$container_by_frm_ref_id = []

staticprivate

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

$cronManager

ilCronManager ilForumCronNotification::$cronManager

private

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

$deleted_ids_cache

array ilForumCronNotification::$deleted_ids_cache = []

staticprivate

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

$ilDB

ilDBInterface ilForumCronNotification::$ilDB

private

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

$lng

ilLanguage ilForumCronNotification::$lng

private

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

$logger

ilLogger ilForumCronNotification::$logger

private

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

$notificationCache

ilForumNotificationCache ilForumCronNotification::$notificationCache

private

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

$num_sent_messages

int ilForumCronNotification::$num_sent_messages = 0

private

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

$providerObject

array ilForumCronNotification::$providerObject = []

staticprivate

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

$ref_ids_by_obj_id

array ilForumCronNotification::$ref_ids_by_obj_id = []

staticprivate

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

$refinery

ILIAS Refinery Factory ilForumCronNotification::$refinery

private

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

$settings

ilSetting ilForumCronNotification::$settings

private

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

$tree

ilTree ilForumCronNotification::$tree

private

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

DEFAULT_MAX_NOTIFICATION_AGE_IN_DAYS

const ilForumCronNotification::DEFAULT_MAX_NOTIFICATION_AGE_IN_DAYS = 30

private

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

KEEP_ALIVE_CHUNK_SIZE

const ilForumCronNotification::KEEP_ALIVE_CHUNK_SIZE = 25

private

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

---

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

• Modules/Forum/classes/class.ilForumCronNotification.php