widgetName = JText::translate('VBO_W_REMINDERS_TITLE');
$this->widgetDescr = JText::translate('VBO_W_REMINDERS_DESCR');
$this->widgetId = basename(__FILE__, '.php');
// define widget and icon and style name
$this->widgetIcon = '';
$this->widgetStyleName = 'green';
// load widget's settings
$this->widgetSettings = $this->loadSettings();
if (!is_object($this->widgetSettings)) {
$this->widgetSettings = new stdClass;
}
// check if VCM is available
if (is_file(VCM_SITE_PATH . DIRECTORY_SEPARATOR . 'helpers' . DIRECTORY_SEPARATOR . 'lib.vikchannelmanager.php')) {
$this->vcm_exists = true;
}
}
/**
* This widget does not actually need to preload data to be watched for
* dispatching notifications, and the reminders due are automatically
* scheduled for being dispatched as a browser notification. However,
* we make use of this method to periodically check if some reminders
* should be automatically created for specific reasons, such as the
* Airbnb host-to-guest reviews to remind the host to review the guest.
* We also preload the necessary CSS/JS assets and schedule the imminent
* reminders for notifications, if any.
*
* @return void
*/
public function preload()
{
// declare JS lang vars
JText::script('VBO_PLEASE_FILL_FIELDS');
JText::script('VBDELCONFIRM');
JText::script('VBCONFIGCLOSINGDATEADD');
JText::script('VBADMINNOTESUPD');
// load assets
$this->vbo_app->loadDatePicker();
// check if VCM is available
if ($this->vcm_exists) {
$today_dt = date('Y-m-d');
$yesterday_dt = date('Y-m-d', strtotime('yesterday'));
// check the last time this check was made
$last_check_dt = isset($this->widgetSettings->last_check_dt) ? $this->widgetSettings->last_check_dt : $yesterday_dt;
if ($last_check_dt != $today_dt) {
// update last check date
$this->widgetSettings->last_check_dt = $today_dt;
$this->updateSettings(json_encode($this->widgetSettings));
// check for any Channel Manager reservation that requires an auto-reminder
$this->scheduleChannelManagerReminders();
}
}
// load the 10 next (imminent) reminders
$overdue = VBORemindersHelper::getInstance()->getImminents(10);
if ($overdue) {
// schedule browser notifications for the next reminders
VBONotificationScheduler::getInstance()->enqueueReminders($overdue);
}
// nothing should be actually watched, ever
return null;
}
/**
* Custom method for this widget only to load the reminder records.
* The method is called by the admin controller through an AJAX request.
* The visibility should be public, it should not exit the process, and
* any content sent to output will be returned to the AJAX response.
* In this case we return an array because this method requires "return":1.
*
* It's the actual rendering of the widget which also allows navigation.
*
* @return array
*/
public function loadReminders()
{
$offset = VikRequest::getInt('offset', 0, 'request');
$length = VikRequest::getInt('length', $this->reminders_per_page, 'request');
$completed = VikRequest::getInt('completed', 0, 'request');
$expired = VikRequest::getInt('expired', 0, 'request');
$bid = VikRequest::getInt('bid', 0, 'request');
$reminder_id = VikRequest::getInt('reminder_id', 0, 'request');
$wrapper = VikRequest::getString('wrapper', '', 'request');
// load reminders starting from today at 00:00:00
$now_info = getdate();
$lim_min_date = date('Y-m-d H:i:s', mktime(0, 0, 0, $now_info['mon'], $now_info['mday'], $now_info['year']));
// prepare fetch options
$fetch = [
'after' => $lim_min_date,
'completed' => $completed,
'expired' => $expired,
'idorder' => $bid,
];
// load reminders
$helper = VBORemindersHelper::getInstance();
$reminders = $helper->loadReminders($fetch, $offset, $length);
// check if a next page can be available
$has_next_page = (count($reminders) >= $length);
// compose bookings base URI
$bookings_base_uri = VBOFactory::getPlatform()->getUri()->admin('index.php?option=com_vikbooking&task=editorder&cid[]=%d', $xhtml = false);
// check if a specific reminder ID was requested
if ($reminder_id) {
// check if the requested ID was found among the most recent ones
$reminder_found = false;
foreach ($reminders as $reminder) {
if ($reminder->id == $reminder_id) {
$reminder_found = true;
break;
}
}
if (!$reminder_found) {
// fetch the record by ID
$reminder_record = $helper->getReminder($reminder_id);
if ($reminder_record) {
// prepend element to the list
array_unshift($reminders, $reminder_record);
}
}
}
// start output buffering
ob_start();
if (!$reminders) {
?>
widgetSettings->show_completed = $completed;
$this->widgetSettings->show_expired = $expired;
$this->updateSettings(json_encode($this->widgetSettings));
}
foreach ($reminders as $reminder) {
$use_icn_status = $reminder->completed ? 'dot-circle' : 'far fa-circle';
$hidden_date = '';
$hidden_hours = '';
$hidden_minutes = '';
if (!empty($reminder->duedate)) {
$date_parts = explode(' ', $reminder->duedate);
$hidden_date = date($this->df, strtotime($date_parts[0]));
if ($reminder->usetime) {
$time_parts = explode(':', $date_parts[1]);
$hidden_hours = (int)$time_parts[0];
$hidden_minutes = (int)$time_parts[1];
}
}
$is_past_reminder = false;
if (!empty($reminder->duedate)) {
// calculate distance to expiration date from today
$diff_data = $helper->relativeDatesDiff($reminder->duedate);
$is_past_reminder = $diff_data['past'];
}
// list of extra classes for the reminder
$extra_classes = [];
if ($is_past_reminder) {
$extra_classes[] = 'vbo-reminder-past';
} else {
$extra_classes[] = 'vbo-reminder-future';
}
if ($reminder->completed) {
$extra_classes[] = 'vbo-reminder-ok';
} else {
$extra_classes[] = 'vbo-reminder-nok';
}
?>