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

Inheritance diagram for ilBookCronNotification:

Collaboration diagram for ilBookCronNotification:

Public Member Functions
	__construct ()

	getId ()

	getTitle ()

	getDescription ()

	getDefaultScheduleType ()

	getDefaultScheduleValue ()

	hasAutoActivation ()

	hasFlexibleSchedule ()

	run ()

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

	sendMails (array $notifications)

	checkAccess (string $perm, int $uid, int $obj_id)

Protected Attributes
ilLanguage	$lng

ilAccessHandler	$access

ilLogger	$book_log

Protected Attributes inherited from ilCronJob
int	$schedule_type = null

int	$schedule_value = null

Closure	$date_time_provider = null

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

Detailed Description

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

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

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

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

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

Constructor & Destructor Documentation

◆ __construct()

ilBookCronNotification::__construct ( )

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

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

     {
         global $DIC;
 
         $this->lng = $DIC->language();
         if (isset($DIC["ilAccess"])) {
             $this->access = $DIC->access();
         }
 
         $this->book_log = ilLoggerFactory::getLogger("book");
     }

Here is the call graph for this function:

Member Function Documentation

◆ checkAccess()

ilBookCronNotification::checkAccess	(	string	$perm,
		int	$uid,
		int	$obj_id
	)

protected

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

References $access, $ref_id, ilObject\_getAllReferences(), and ilRBACAccessHandler\checkAccessOfUser().

Referenced by sendNotifications().

      : bool {
         $access = $this->access;
         foreach (ilObject::_getAllReferences($obj_id) as $ref_id) {
             if ($access->checkAccessOfUser($uid, $perm, "", $ref_id)) {
                 return true;
             }
         }
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefaultScheduleType()

ilBookCronNotification::getDefaultScheduleType ( )

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

                                             : int
     {
         return self::SCHEDULE_TYPE_DAILY;
     }

◆ getDefaultScheduleValue()

ilBookCronNotification::getDefaultScheduleValue ( )

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

                                              : ?int
     {
         return null;
     }

◆ getDescription()

ilBookCronNotification::getDescription ( )

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

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

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

Here is the call graph for this function:

◆ getId()

ilBookCronNotification::getId ( )

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

                            : string
     {
         return "book_notification";
     }

◆ getTitle()

ilBookCronNotification::getTitle ( )

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

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

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

Here is the call graph for this function:

◆ hasAutoActivation()

ilBookCronNotification::hasAutoActivation ( )

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

                                        : bool
     {
         return false;
     }

◆ hasFlexibleSchedule()

ilBookCronNotification::hasFlexibleSchedule ( )

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

                                          : bool
     {
         return false;
     }

◆ run()

ilBookCronNotification::run ( )

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

References sendNotifications(), ilCronJobResult\STATUS_NO_ACTION, and ilCronJobResult\STATUS_OK.

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

Here is the call graph for this function:

◆ sendMails()

ilBookCronNotification::sendMails ( array $notifications )

protected

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

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

Referenced by sendNotifications().

      : 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";
                     }
                 }
             }
 
             $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]);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendNotifications()

ilBookCronNotification::sendNotifications ( )

protected

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

References $book_log, Vendor\Package\$f, $log, $res, ilObject\_lookupTitle(), checkAccess(), ilNotification\getNotificationsForObject(), ilObjBookingPool\getPoolsWithReminders(), sendMails(), ilNotification\TYPE_BOOK, and ilObjBookingPool\writeLastReminderTimestamp().

Referenced by run().

                                           : int
     {
         $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) {
                 $f = new ilBookingReservationDBRepositoryFactory();
                 $repo = $f->getRepo();
                 $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 ($this->checkAccess("read", $r["user_id"], $p["booking_pool_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 ($this->checkAccess("write", $uid, $p["booking_pool_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);
     }