Cron for booking manager notification. More...

Inheritance diagram for ilBookCronNotification:

Collaboration diagram for ilBookCronNotification:

Public Member Functions
	__construct ()

	getId ()

	getTitle ()

	getDescription ()

	getDefaultScheduleType ()

	getDefaultScheduleValue ()

	hasAutoActivation ()
	Is to be activated on "installation", does only work for ILIAS core cron jobs. More...

	hasFlexibleSchedule ()

	run ()

Public Member Functions inherited from ILIAS\Cron\CronJob
	setDateTimeProvider (?\Closure $date_time_provider)

	isDue (?\DateTimeImmutable $last_run, ?JobScheduleType $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 (?JobScheduleType $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 ()

	usesLegacyForms ()

	getCustomConfigurationInput (\ILIAS\UI\Factory $ui_factory, \ILIAS\Refinery\Factory $factory, \ilLanguage $lng)

	addCustomSettingsToForm (\ilPropertyFormGUI $a_form)

	saveCustomConfiguration (mixed $form_data)

	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
	sendNotifications ()

	sendMails (array $notifications)

Protected Attributes
ILIAS BookingManager InternalRepoService	$repo

ilLanguage	$lng

ilLogger	$book_log

Protected Attributes inherited from ILIAS\Cron\CronJob
JobScheduleType	$schedule_type = null

int	$schedule_value = null

Closure	$date_time_provider = null

Detailed Description

Cron for booking manager notification.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

◆ __construct()

ilBookCronNotification::__construct ( )

Definition at line 33 of file class.ilBookCronNotification.php.

    {
        global $DIC;
 
        $this->lng = $DIC->language();
 
        $this->book_log = ilLoggerFactory::getLogger("book");
        $this->repo = $DIC->bookingManager()
            ->internal()
            ->repo();
    }

References $DIC, ilLoggerFactory\getLogger(), and ILIAS\Repository\lng().

Here is the call graph for this function:

Member Function Documentation

◆ getDefaultScheduleType()

ilBookCronNotification::getDefaultScheduleType ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 66 of file class.ilBookCronNotification.php.

                                            : JobScheduleType
    {
        return JobScheduleType::DAILY;
    }

◆ getDefaultScheduleValue()

ilBookCronNotification::getDefaultScheduleValue ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 71 of file class.ilBookCronNotification.php.

                                             : ?int
    {
        return null;
    }

◆ getDescription()

ilBookCronNotification::getDescription ( )

Reimplemented from ILIAS\Cron\CronJob.

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

                                    : string
    {
        $lng = $this->lng;
 
        $lng->loadLanguageModule("book");
        return $lng->txt("book_notification_info");
    }

References $lng, ilLanguage\loadLanguageModule(), and ilLanguage\txt().

Here is the call graph for this function:

◆ getId()

ilBookCronNotification::getId ( )

Reimplemented from ILIAS\Cron\CronJob.

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

                           : string
    {
        return "book_notification";
    }

◆ getTitle()

ilBookCronNotification::getTitle ( )

Reimplemented from ILIAS\Cron\CronJob.

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

                              : string
    {
        $lng = $this->lng;
 
        $lng->loadLanguageModule("book");
        return $lng->txt("book_notification");
    }

References $lng, ilLanguage\loadLanguageModule(), and ilLanguage\txt().

Here is the call graph for this function:

◆ hasAutoActivation()

ilBookCronNotification::hasAutoActivation ( )

Is to be activated on "installation", does only work for ILIAS core cron jobs.

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 76 of file class.ilBookCronNotification.php.

                                       : bool
    {
        return false;
    }

◆ hasFlexibleSchedule()

ilBookCronNotification::hasFlexibleSchedule ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 81 of file class.ilBookCronNotification.php.

                                         : bool
    {
        return false;
    }

◆ run()

ilBookCronNotification::run ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 86 of file class.ilBookCronNotification.php.

                         : JobResult
    {
        $status = JobResult::STATUS_NO_ACTION;
 
        $count = $this->sendNotifications();
 
        if ($count > 0) {
            $status = JobResult::STATUS_OK;
        }
 
        $result = new JobResult();
        $result->setStatus($status);
 
        return $result;
    }

References sendNotifications().

Here is the call graph for this function:

◆ sendMails()

ilBookCronNotification::sendMails ( array $notifications )

protected

Definition at line 198 of file class.ilBookCronNotification.php.

     : void {
        foreach ($notifications as $uid => $n) {
            $ntf = new ilSystemNotification();
            $lng = $ntf->getUserLanguage($uid);
            $lng->loadLanguageModule("book");
 
            $txt = "";
            if (is_array($n["personal"] ?? null)) {
                $txt .= "\n" . $lng->txt("book_your_reservations") . "\n";
                $txt .= "-----------------------------------------\n";
                foreach ($n["personal"] as $obj_id => $reservs) {
                    $txt .= ilObject::_lookupTitle($obj_id) . ":\n";
                    foreach ($reservs as $r) {
                        $txt .= "- " . $r["title"] . " (" . $r["counter"] . "), " .
                            ilDatePresentation::formatDate(new ilDate($r["date"], IL_CAL_DATE)) . ", " .
                            $r["slot"] . "\n";
                    }
                }
            }
 
            if (is_array($n["admin"] ?? null)) {
                $txt .= "\n" . $lng->txt("book_reservation_overview") . "\n";
                $txt .= "-----------------------------------------\n";
                foreach ($n["admin"] as $obj_id => $reservs) {
                    $txt .= ilObject::_lookupTitle($obj_id) . ":\n";
                    foreach ($reservs as $r) {
                        $txt .= "- " . $r["title"] . " (" . $r["counter"] . "), " . $r["user_name"] . ", " .
                            ilDatePresentation::formatDate(new ilDate($r["date"], IL_CAL_DATE)) . ", " .
                            $r["slot"] . "\n";
                        if ($r["message"] != "") {
                            $txt .= "  " . $lng->txt("book_message") .
                                ": " . $r["message"];
                        }
                    }
                }
            }
            $ntf->setLangModules(array("book"));
            $ntf->setSubjectLangId("book_booking_reminders");
            $ntf->setIntroductionLangId("book_rem_intro");
            $ntf->addAdditionalInfo("", $txt);
            $ntf->setReasonLangId("book_rem_reason");
            $this->book_log->debug("send Mail: " . $uid);
            $ntf->sendMailAndReturnRecipients([$uid]);
        }
    }

References $lng, $txt, ilObject\_lookupTitle(), ilDatePresentation\formatDate(), ilLanguage\getUserLanguage(), IL_CAL_DATE, ilLanguage\loadLanguageModule(), and ilLanguage\txt().

Referenced by sendNotifications().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendNotifications()

ilBookCronNotification::sendNotifications ( )

protected

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

                                          : int
    {
        global $DIC;
 
        $access = $DIC->bookingManager()->internal()->domain()->access();
 
        $log = $this->book_log;
 
        $log->debug("start");
 
 
        $notifications = [];
 
        /*
         * pool id 123 > 2 days, ...
         */
        foreach (ilObjBookingPool::getPoolsWithReminders() as $p) {
            // determine reservations from max(next day $last_to_ts) up to "rmd_day" days + 1
            // per pool id
            $next_day_ts = mktime(0, 0, 0, date('n'), (int) date('j') + 1);
            $log->debug("next day ts: " . $next_day_ts);
            $last_reminder_to_ts = $p["last_remind_ts"];
            // for debug purposes
            // $last_reminder_to_ts-= 24*60*60;
            $log->debug("last_reminder ts: " . $last_reminder_to_ts);
            $from_ts = max($next_day_ts, $last_reminder_to_ts);
            $log->debug("from ts: " . $from_ts);
            $to_ts = mktime(0, 0, 0, date('n'), (int) date('j') + $p["reminder_day"] + 1);
            $res = [];
 
            // overwrite from to current time, see #26216, this ensures
            // that all reservations are sent, some multiple times (each day)
            // we include all reservations from now to the period set in the pool settings
            $from_ts = time();
 
            // additional logging info, see #26216
            $log->debug("pool id: "
                . $p["booking_pool_id"]
                . "(" . ilObject::_lookupTitle($p["booking_pool_id"]) . ") "
                . ", "
                . date("Y-m-d, H:i:s", $from_ts)
                . " to " . date("Y-m-d, H:i:s", $to_ts));
 
 
            if ($to_ts > $from_ts) {
                $repo = $this->repo->reservation();
                $res = $repo->getListByDate(true, null, [
                    "from" => $from_ts,
                    "to" => $to_ts
                ], [$p["booking_pool_id"]]);
            }
 
            $log->debug("reservations: " . count($res));
 
            //var_dump($res); exit;
 
            // get subscriber of pool id
            $user_ids = ilNotification::getNotificationsForObject(ilNotification::TYPE_BOOK, $p["booking_pool_id"]);
            $log->debug("users: " . count($user_ids));
 
            // group by user, type, pool
            foreach ($res as $r) {
                // users
                $log->debug("check notification of user id: " . $r["user_id"]);
                if (in_array($r["user_id"], $user_ids)) {
                    if ($access->canRetrieveNotificationsForOwnReservationsByObjId(
                        (int) $p["booking_pool_id"],
                        (int) $r["user_id"]
                    )) {
                        $log->debug("got read");
                        $notifications[$r["user_id"]]["personal"][$r["pool_id"]][] = $r;
                    }
                }
 
                // admins
                foreach ($user_ids as $uid) {
                    $log->debug("check write for user id: " . $uid . ", pool: " . $p["booking_pool_id"]);
 
                    if ($access->canRetrieveNotificationsForAllReservationsByObjId(
                        (int) $p["booking_pool_id"],
                        (int) $r["user_id"]
                    )) {
                        $log->debug("got write");
                        $notifications[$uid]["admin"][$r["pool_id"]][] = $r;
                    }
                }
            }
            ilObjBookingPool::writeLastReminderTimestamp($p["booking_pool_id"], $to_ts);
        }
 
        // send mails
        $this->sendMails($notifications);
 
        return count($notifications);
    }