ilBookCronNotification Class Reference

Cron for booking manager notification. More...

Inheritance diagram for ilBookCronNotification:

Collaboration diagram for ilBookCronNotification:

Public Member Functions
	__construct ()
	Constructor. More...
	getId ()
	Get id. More...
	getTitle ()
	Get title. More...
	getDescription ()
	Get description. More...
	getDefaultScheduleType ()
	Get schedule type. More...
	getDefaultScheduleValue ()
	Get schedule value. More...
	hasAutoActivation ()
	Is to be activated on "installation". More...
	hasFlexibleSchedule ()
	Can the schedule be configured? More...
	run ()
	Run job. More...
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...

Protected Member Functions
	sendNotifications ()
	Send notifications. More...
	sendMails ($notifications)
	Send mails. More...
	checkAccess ($perm, $uid, $obj_id)
	check access on obj id More...
	sendUserNotifications ($res)
	Send user notifications. More...
	sendAdminNotifications ($res)
	Send admin notifications. More...
Protected Member Functions inherited from ilCronJob
	checkSchedule ($a_ts_last_run, $a_schedule_type, $a_schedule_value)

Protected Attributes
	$lng
	$access
	$book_log

Additional Inherited Members
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

Detailed Description

Cron for booking manager notification.

Author

Alex Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..com

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

Constructor & Destructor Documentation

__construct()

ilBookCronNotification::__construct

(

)

Constructor.

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

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

References $DIC, and ilLoggerFactory\getLogger().

Here is the call graph for this function:

Member Function Documentation

checkAccess()

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

protected

check access on obj id

Parameters

return

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

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

References $access, and ilObject\_getAllReferences().

Referenced by sendNotifications().

Here is the call graph for this function:

Here is the caller graph for this function:

getDefaultScheduleType()

ilBookCronNotification::getDefaultScheduleType

(

)

Get schedule type.

Returns

int

Reimplemented from ilCronJob.

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

    {
        return self::SCHEDULE_TYPE_DAILY;
    }

References ilCronJob\SCHEDULE_TYPE_DAILY.

getDefaultScheduleValue()

ilBookCronNotification::getDefaultScheduleValue

(

)

Get schedule value.

Returns

int|array

Reimplemented from ilCronJob.

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

    {
        return;
    }

getDescription()

ilBookCronNotification::getDescription

(

)

Get description.

Returns

string

Reimplemented from ilCronJob.

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

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

References $lng.

getId()

ilBookCronNotification::getId

(

)

Get id.

Returns

string

Reimplemented from ilCronJob.

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

    {
        return "book_notification";
    }

getTitle()

ilBookCronNotification::getTitle

(

)

Get title.

Returns

string

Reimplemented from ilCronJob.

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

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

References $lng.

hasAutoActivation()

ilBookCronNotification::hasAutoActivation

(

)

Is to be activated on "installation".

Returns

boolean

Reimplemented from ilCronJob.

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

    {
        return false;
    }

hasFlexibleSchedule()

ilBookCronNotification::hasFlexibleSchedule

(

)

Can the schedule be configured?

Returns

boolean

Reimplemented from ilCronJob.

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

    {
        return false;
    }

run()

ilBookCronNotification::run

(

)

Run job.

Returns

ilCronJobResult

Reimplemented from ilCronJob.

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

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

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

Here is the call graph for this function:

sendAdminNotifications()

ilBookCronNotification::sendAdminNotifications (   $res )

protected

Send admin notifications.

Returns

int

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

    {
    }

sendMails()

ilBookCronNotification::sendMails (   $notifications )

protected

Send mails.

Parameters

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

    {
        foreach ($notifications as $uid => $n) {
            include_once "./Services/Notification/classes/class.ilSystemNotification.php";
            $ntf = new ilSystemNotification();
            $lng = $ntf->getUserLanguage($uid);
            $lng->loadLanguageModule("book");
 
            $txt = "";
            if (is_array($n["personal"])) {
                $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"])) {
                $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");
            $ntf->sendMail(array($uid));
        }
    }

References $lng, $n, $r, $txt, ilObject\_lookupTitle(), ilDatePresentation\formatDate(), and IL_CAL_DATE.

Referenced by sendNotifications().

Here is the call graph for this function:

Here is the caller graph for this function:

sendNotifications()

ilBookCronNotification::sendNotifications ( )

protected

Send notifications.

Parameters

return int

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

    {
        $log = $this->book_log;
 
        // get all booking pools with notification setting
 
 
 
        $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'), 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'), 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) {
                $res = ilBookingReservation::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);
        }
 
        $log->debug("notifications to users: " . count($notifications));
 
        // send mails
        $this->sendMails($notifications);
 
        return count($notifications);
    }

References $book_log, $log, $r, $res, ilObject\_lookupTitle(), checkAccess(), ilBookingReservation\getListByDate(), ilNotification\getNotificationsForObject(), ilObjBookingPool\getPoolsWithReminders(), sendMails(), ilNotification\TYPE_BOOK, and ilObjBookingPool\writeLastReminderTimestamp().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

sendUserNotifications()

ilBookCronNotification::sendUserNotifications (   $res )

protected

Send user notifications.

Returns

int

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

    {
        /*
         * Your reservations for tomorrow
         *
         * Pool Title
         * Pool Link
         * - Object (cnt), From - To
         * - ...
         *
         * Reservations for tomorrow
         *
         * Pool Title
         * Pool Link
         * - Object (cnt), From - To
         * - ...
         *
         */
    }

Field Documentation

$access

ilBookCronNotification::$access

protected

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

Referenced by checkAccess().

$book_log

ilBookCronNotification::$book_log

protected

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

Referenced by sendNotifications().

$lng

ilBookCronNotification::$lng

protected

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

Referenced by getDescription(), getTitle(), and sendMails().

---

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

• Modules/BookingManager/classes/class.ilBookCronNotification.php