Class for date presentation. More...

Collaboration diagram for ilDatePresentation:

Static Public Member Functions
static	setUseRelativeDates ($a_status)
	set use relative dates More...

static	useRelativeDates ()
	check if relative dates are used More...

static	setLanguage ($a_lng)
	set language More...

static	getLanguage ()
	set language More...

static	resetToDefaults ()
	reset to defaults More...

static	formatDate (ilDateTime $date, $a_skip_day=false, $a_include_wd=false, $include_seconds=false)
	Format a date public. More...

static	formatPeriod (ilDateTime $start, ilDateTime $end, $a_skip_starting_day=false)
	Format a period of two date Shows: 14. More...

static	isToday (ilDateTime $date)
	Check if date is "today". More...

static	isYesterday (ilDateTime $date)
	Check if date is yesterday. More...

static	isTomorrow (ilDateTime $date)
	Check if date is tomorrow. More...

static	secondsToString ($seconds, $force_with_seconds=false, $a_lng=null)
	converts seconds to string: Long: 7 days 4 hour(s) ... More...

Static Public Attributes
static	$use_relative_dates = true

static	$today = null

static	$tomorrow = null

static	$yesterday = null

Static Protected Attributes
static	$weekdays

Static Private Attributes
static	$lang = null

Detailed Description

Class for date presentation.

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

Definition at line 35 of file class.ilDatePresentation.php.

Member Function Documentation

◆ formatDate()

static ilDatePresentation::formatDate	(	ilDateTime	$date,
			$a_skip_day = `false`,
			$a_include_wd = `false`,
			$include_seconds = `false`
	)

static

Format a date public.

Parameters

object $date ilDate or ilDateTime

Returns: string date presentation in user specific timezone and language

Definition at line 127 of file class.ilDatePresentation.php.

References $DIC, $ilUser, $lng, ilCalendarUtil\_numericMonthToString(), ilDateTime\get(), IL_CAL_FKT_DATE, IL_CAL_FKT_GETDATE, ilDateTime\isNull(), ilCalendarSettings\TIME_FORMAT_12, and ilCalendarSettings\TIME_FORMAT_24.

     {
         global $DIC;
 
         $lng = $DIC['lng'];
         $ilUser = $DIC['ilUser'];
         
         if ($date->isNull()) {
             return self::getLanguage()->txt('no_date');
         }
         
         $has_time = !is_a($date, 'ilDate');
         
         // Converting pure dates to user timezone might return wrong dates
         if ($has_time) {
             $date_info = $date->get(IL_CAL_FKT_GETDATE, '', $ilUser->getTimeZone());
         } else {
             $date_info = $date->get(IL_CAL_FKT_GETDATE, '', 'UTC');
         }
         
         if (!$a_skip_day) {
             $sep = ", ";
             if (self::isToday($date) and self::useRelativeDates()) {
                 $date_str = self::getLanguage()->txt('today');
             } elseif (self::isTomorrow($date) and self::useRelativeDates()) {
                 $date_str = self::getLanguage()->txt('tomorrow');
             } elseif (self::isYesterday($date) and self::useRelativeDates()) {
                 $date_str = self::getLanguage()->txt('yesterday');
             } else {
                 include_once('./Services/Calendar/classes/class.ilCalendarUtil.php');
                 $date_str = "";
                 if ($a_include_wd) {
                     $date_str = $lng->txt(self::$weekdays[$date->get(IL_CAL_FKT_DATE, 'w')]) . ",       ";
                 }
                 $date_str .= $date->get(IL_CAL_FKT_DATE, 'd') . '. ' .
                     ilCalendarUtil::_numericMonthToString($date_info['mon'], false) . ' ' .
                     $date_info['year'];
             }
         } else {
             $sep = "";
         }
         
         if (!$has_time) {
             return $date_str;
         }
 
         $sec = ($include_seconds)
             ? ":s"
             : "";
 
         switch ($ilUser->getTimeFormat()) {
             case ilCalendarSettings::TIME_FORMAT_24:
                 return $date_str . $sep . $date->get(IL_CAL_FKT_DATE, 'H:i'.$sec, $ilUser->getTimeZone());
                 
             case ilCalendarSettings::TIME_FORMAT_12:
                 return $date_str . $sep . $date->get(IL_CAL_FKT_DATE, 'g:ia'.$sec, $ilUser->getTimeZone());
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ formatPeriod()

static ilDatePresentation::formatPeriod	(	ilDateTime	$start,
		ilDateTime	$end,
			$a_skip_starting_day = `false`
	)

static

Format a period of two date Shows: 14.

Jul 2008 18:00 - 20:00 or: Today 18:00 - 20:00 or: 14. Jul 2008 - 16. Jul 2008 or: 14. Jul 2008, 12:00 - 16. Jul 2008, 14:00

public

Parameters

Definition at line 199 of file class.ilDatePresentation.php.

References $DIC, $ilUser, ilDateTime\_equals(), ilDateTime\get(), IL_CAL_DATE, IL_CAL_DAY, IL_CAL_FKT_DATE, ilCalendarSettings\TIME_FORMAT_12, and ilCalendarSettings\TIME_FORMAT_24.

Referenced by ilSessionAppointment\_appointmentToString(), ilAccountMail\addAttachments(), ilObjectActivation\addListGUIActivationProperty(), ilCalendarEntry\appointmentToMailString(), ilObjRemoteTestGUI\availabilityToString(), ilObjRemoteCourseGUI\availabilityToString(), ilObjRemoteGroupGUI\availabilityToString(), ilCalendarAppointmentGUI\book(), ilSessionStatisticsGUI\buildData(), ilCalendarAppointmentGUI\cancelBooking(), ilECSCategoryMappingRule\conditionToString(), ilObjUser\deleteUserDefinedFieldEntries(), ilBookingObjectGUI\displayPostInfo(), ilWikiStatGUI\export(), ilCalendarChangedAppointmentsTableGUI\fillRow(), ilGroupParticipantsTableGUI\fillRow(), ilCourseParticipantsTableGUI\fillRow(), ilCalendarBlockGUI\getData(), ilCalendarAppointmentPanelGUI\getHTML(), ilCalendarAgendaListGUI\getHTML(), ilCalendarViewGUI\getModalForApp(), ilCalendarBlockGUI\getModalForApp(), ilObjSession\getPresentationTitleAppointmentPeriod(), ilTrQuery\getSessionData(), ilChatroomFormFactory\getSessionForm(), ilObjCourseGUI\infoScreen(), ilObjGroupGUI\infoScreen(), ilObjSessionGUI\initAttendanceList(), ilObjBookingPoolGUI\initBookingNumbersForm(), ilObjGroupAccess\lookupPeriodInfo(), ilObjCourseAccess\lookupPeriodInfo(), ilConsultationHoursTableGUI\parse(), ilAccountMail\replacePlaceholders(), ilObjBookingPoolGUI\rsvConfirmCancelAggregationForm(), ilObjBookingPoolGUI\rsvConfirmCancelObject(), ilObjBookingPoolGUI\rsvConfirmDeleteObject(), ilCalendarAppointmentsTableGUI\setAppointments(), ilCalendarAppointmentGUI\showInfoScreen(), ilChatroomHistoryGUI\showMessages(), and ilMemberExport\write().

     {
         global $DIC;
 
         $ilUser = $DIC['ilUser'];
 
         $has_time = !is_a($start, 'ilDate');
         
         // Same day
         if (ilDateTime::_equals($start, $end, IL_CAL_DAY, $ilUser->getTimeZone())) {
             if (!$has_time) {
                 return self::formatDate($start);
             } else {
                 $date_str = "";
                 $sep = "";
                 if (!$a_skip_starting_day) {
                     $date_str = self::formatDate(
                         new ilDate($start->get(IL_CAL_DATE, '', $ilUser->getTimeZone()), IL_CAL_DATE)
                     );
                     $sep = ", ";
                 }
                 
                 // $start == $end
                 if (ilDateTime::_equals($start, $end)) {
                     switch ($ilUser->getTimeFormat()) {
                         case ilCalendarSettings::TIME_FORMAT_24:
                             return $date_str . $sep . $start->get(IL_CAL_FKT_DATE, 'H:i', $ilUser->getTimeZone());
                             
                         case ilCalendarSettings::TIME_FORMAT_12:
                             return $date_str . $sep . $start->get(IL_CAL_FKT_DATE, 'h:i a', $ilUser->getTimeZone());
                     }
                 } else {
                     switch ($ilUser->getTimeFormat()) {
                         case ilCalendarSettings::TIME_FORMAT_24:
                             return $date_str . $sep . $start->get(IL_CAL_FKT_DATE, 'H:i', $ilUser->getTimeZone()) . ' - ' .
                                 $end->get(IL_CAL_FKT_DATE, 'H:i', $ilUser->getTimeZone());
                             
                         case ilCalendarSettings::TIME_FORMAT_12:
                             return $date_str . $sep . $start->get(IL_CAL_FKT_DATE, 'g:ia', $ilUser->getTimeZone()) . ' - ' .
                                 $end->get(IL_CAL_FKT_DATE, 'g:ia', $ilUser->getTimeZone());
                     }
                 }
             }
         }
         // Different days
         return self::formatDate($start, $a_skip_starting_day) . ' - ' . self::formatDate($end);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLanguage()

static ilDatePresentation::getLanguage ( )

static

set language

Returns

Definition at line 93 of file class.ilDatePresentation.php.

References $DIC, $lang, and $lng.

Referenced by ilMailTemplateContext\resolvePlaceholder().

     {
         global $DIC;
 
         $lng = $DIC['lng'];
         
         return self::$lang ? self::$lang : $lng;
     }

Here is the caller graph for this function:

◆ isToday()

static ilDatePresentation::isToday ( ilDateTime $date )

static

Check if date is "today".

public

Parameters

object ilDateTime DateTime object to check

Returns: bool

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

References $DIC, $ilUser, ilDateTime\_equals(), IL_CAL_DAY, and IL_CAL_UNIX.

     {
         global $DIC;
 
         $ilUser = $DIC['ilUser'];
         
         if (!is_object(self::$today)) {
             self::$today = new ilDateTime(time(), IL_CAL_UNIX, $ilUser->getTimeZone());
         }
         return ilDateTime::_equals(self::$today, $date, IL_CAL_DAY, $ilUser->getTimeZone());
     }

Here is the call graph for this function:

◆ isTomorrow()

static ilDatePresentation::isTomorrow ( ilDateTime $date )

static

Check if date is tomorrow.

public

Parameters

object ilDateTime DateTime object to check

Returns: bool

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

References $DIC, $ilUser, ilDateTime\_equals(), IL_CAL_DAY, IL_CAL_UNIX, and ilDateTime\increment().

     {
         global $DIC;
 
         $ilUser = $DIC['ilUser'];
         
         if (!is_object(self::$tomorrow)) {
             self::$tomorrow = new ilDateTime(time(), IL_CAL_UNIX, $ilUser->getTimeZone());
             self::$tomorrow->increment(IL_CAL_DAY, 1);
         }
         
         return ilDateTime::_equals(self::$tomorrow, $date, IL_CAL_DAY, $ilUser->getTimeZone());
     }

Here is the call graph for this function:

◆ isYesterday()

static ilDatePresentation::isYesterday ( ilDateTime $date )

static

Check if date is yesterday.

public

Parameters

object ilDateTime DateTime object to check

Returns: bool

Definition at line 277 of file class.ilDatePresentation.php.

References $DIC, $ilUser, ilDateTime\_equals(), IL_CAL_DAY, IL_CAL_UNIX, and ilDateTime\increment().

     {
         global $DIC;
 
         $ilUser = $DIC['ilUser'];
         
         if (!is_object(self::$yesterday)) {
             self::$yesterday = new ilDateTime(time(), IL_CAL_UNIX, $ilUser->getTimeZone());
             self::$yesterday->increment(IL_CAL_DAY, -1);
         }
         
         return ilDateTime::_equals(self::$yesterday, $date, IL_CAL_DAY, $ilUser->getTimeZone());
     }

Here is the call graph for this function:

◆ resetToDefaults()

static ilDatePresentation::resetToDefaults ( )

static

reset to defaults

Returns

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

References $DIC, and $lng.

Referenced by ilObjUser\deleteUserDefinedFieldEntries(), and ilLPProgressTableGUI\fillRowCSV().

     {
         global $DIC;
 
         $lng = $DIC['lng'];
         
         self::setLanguage($lng);
         self::setUseRelativeDates(true);
     }

Here is the caller graph for this function:

◆ secondsToString()

static ilDatePresentation::secondsToString	(	$seconds,
		$force_with_seconds = `false`,
		$a_lng = `null`
	)

static

converts seconds to string: Long: 7 days 4 hour(s) ...

Parameters

int	$seconds	seconds
bool	$force_with_seconds
ilLanguage	$a_lng

Returns: string

Definition at line 322 of file class.ilDatePresentation.php.

References $DIC, $lng, $message, and $rest.

Referenced by ilLearningProgressBaseGUI\__appendLPDetails(), ilLearningProgressBaseGUI\__appendUserInfo(), ilRegistrationMimeMailNotification\__construct(), ilCourseContentGUI\__renderItem(), ilCourseContentGUI\__renderUserItem(), ilLearningProgressBaseGUI\__showObjectDetails(), ilInfoScreenGUI\addMetaDataSections(), ilCourseContentGUI\editTimings(), ilTimingOverviewTableGUI\fillRow(), ilCalendarAppointmentsTableGUI\fillRow(), ilTrUserObjectsPropsTableGUI\fillRow(), ilScormMailTemplateLPContext\getDescription(), ilCourseMailTemplateTutorContext\getDescription(), ilObjSCORM2004LearningModule\getTrackingDataAgg(), ilObjUserFolderGUI\initFormGeneralSettings(), ilPersonalSettingsGUI\initGeneralSettingsForm(), ilLPTableBaseGUI\parseValue(), ilTrSummaryTableGUI\parseValue(), ilInfoScreenGUI\showLearningProgress(), and ilLearningProgressGUI\showtlt().

     {
         global $DIC;
 
         $lng = $DIC['lng'];
 
         if ($a_lng) {
             $lng = $a_lng;
         }
 
         $seconds = $seconds ? $seconds : 0;
         
         // #13625
         if ($seconds > 0) {
             $days = floor($seconds / 86400);
             $rest = $seconds % 86400;
 
             $hours = floor($rest / 3600);
             $rest = $rest % 3600;
 
             $minutes = floor($rest / 60);
             $seconds = $rest % 60;
         } else {
             $days = ceil($seconds / 86400);
             $rest = $seconds % 86400;
 
             $hours = ceil($rest / 3600);
             $rest = $rest % 3600;
 
             $minutes = ceil($rest / 60);
             $seconds = $rest % 60;
         }
 
         if ($days) {
             $message = $days . ' ' . ($days == 1 ? $lng->txt('day') : $lng->txt('days'));
         }
         if ($hours) {
             if ($message) {
                 $message .= ' ';
             }
             $message .= ($hours . ' ' . ($hours == 1 ? $lng->txt('hour') : $lng->txt('hours')));
         }
         if ($minutes) {
             if ($message) {
                 $message .= ' ';
             }
             $message .= ($minutes . ' ' . ($minutes == 1 ? $lng->txt('minute') : $lng->txt('minutes')));
         }
         if ($force_with_seconds && $seconds) {
             if ($message) {
                 $message .= ' ';
             }
             $message .= ($seconds . ' ' . ($seconds == 1 ? $lng->txt('second') : $lng->txt('seconds')));
         }
         if (!$days and !$hours and !$minutes) {
             return $seconds . ' ' . ($seconds == 1 ? $lng->txt('second') : $lng->txt('seconds'));
         } else {
             return $message;
         }
     }

Here is the caller graph for this function:

◆ setLanguage()

static ilDatePresentation::setLanguage ( $a_lng )

static

set language

Returns

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

References $lang.

Referenced by ilForumMailNotification\createMailDate(), ilObjUser\deleteUserDefinedFieldEntries(), ilMailTemplateContext\resolvePlaceholder(), ilCronDeleteInactiveUserReminderMailNotification\send(), and ilForumMailNotification\send().

     {
         self::$lang = $a_lng;
     }

Here is the caller graph for this function:

◆ setUseRelativeDates()

static ilDatePresentation::setUseRelativeDates ( $a_status )

static

set use relative dates

Parameters

bool

Returns

Definition at line 60 of file class.ilDatePresentation.php.

Referenced by ilBookingReservationsTableGUI\__construct(), ilCalendarEntry\appointmentToMailString(), ilSessionStatisticsGUI\buildData(), ilPersonalSettingsGUI\deleteOwnAccount4(), ilObjUser\deleteUserDefinedFieldEntries(), ilBookingObjectGUI\displayPostInfo(), ilSurveyEvaluationGUI\evaluation(), ilSessionStatisticsGUI\exportCSV(), ilSurveyEvaluationGUI\exportEvaluationUser(), ilForumExportGUI\exportHTML(), ilObjectMetaDataBlockGUI\fillDataSection(), ilLMDownloadTableGUI\fillRow(), ilPollBlockGUI\fillRow(), assFileUploadFileTableGUI\fillRow(), ilQuestionPoolPrintViewTableGUI\fillRow(), ilLPProgressTableGUI\fillRowCSV(), ilCertificateDateHelper\formatDate(), ilTestPassOverviewTableGUI\formatDate(), ilCertificateDateHelper\formatDateTime(), ilCertificateAdapter\getBaseVariablesForPresentation(), ilCertificateAdapter\getBaseVariablesForPreview(), ilSkillCertificateAdapter\getCertificateVariablesForPresentation(), ilSkillCertificateAdapter\getCertificateVariablesForPreview(), ilPersonalSkillsGUI\getEvalItem(), ilBlogExerciseGUI\getExerciseInfo(), ilPortfolioExerciseGUI\getExerciseInfo(), ilLPTableBaseGUI\getExportMeta(), ilCalendarHeaderNavigationGUI\getHTML(), ilAttendanceList\getHTML(), ilTable2GUI\getHTML(), ilObjectMetaDataGUI\getKeyValueList(), ilNoteGUI\getNoteListHTML(), ilCourseMembershipGUI\getPrintMemberData(), ilTermsOfServiceDocumentGUI\getResetMessageBoxHtml(), ilTestServiceGUI\getResultsSignature(), ilObjSurveyGUI\infoScreen(), ilObjSessionGUI\initAttendanceList(), ilPCSection\insertTimings(), ilBadgeProfileGUI\listBackpackGroups(), ilBadgeProfileGUI\listBadges(), ilUserCertificateGUI\listCertificates(), ilTestServiceGUI\populatePassFinishDate(), ilBlogPostingGUI\postOutputProcessing(), ilWikiPageGUI\preview(), ilForumExportGUI\printPost(), ilForumExportGUI\printThread(), ilObjPortfolioGUI\printView(), ilObjTestGUI\reviewobject(), ilObjBookingPoolGUI\rsvConfirmCancelAggregationForm(), ilMembershipCronNotifications\run(), ilSkillNotifications\run(), ilCronManager\runActiveJobs(), ilCronDeleteInactiveUserReminderMailNotification\send(), ilForumMailNotification\send(), ilTestMailNotification\sendAdvancedNotification(), ilTestMailNotification\sendSimpleNotification(), ilSkillSelfEvaluationGUI\setSelfEvaluationPresentationForm(), ilChatroomHistoryGUI\showMessages(), and ilMemberExport\write().

     {
         self::$use_relative_dates = $a_status;
     }

Here is the caller graph for this function:

◆ useRelativeDates()

static ilDatePresentation::useRelativeDates ( )

static

check if relative dates are used

Returns

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

Referenced by ilBookingObjectGUI\displayPostInfo(), ilObjectMetaDataBlockGUI\fillDataSection(), ilPollBlockGUI\fillRow(), ilCertificateDateHelper\formatDate(), ilTestPassOverviewTableGUI\formatDate(), ilCertificateDateHelper\formatDateTime(), ilCertificateAdapter\getBaseVariablesForPresentation(), ilCertificateAdapter\getBaseVariablesForPreview(), ilSkillCertificateAdapter\getCertificateVariablesForPresentation(), ilSkillCertificateAdapter\getCertificateVariablesForPreview(), ilBlogExerciseGUI\getExerciseInfo(), ilPortfolioExerciseGUI\getExerciseInfo(), ilObjectMetaDataGUI\getKeyValueList(), ilNoteGUI\getNoteListHTML(), ilTermsOfServiceDocumentGUI\getResetMessageBoxHtml(), ilTestServiceGUI\getResultsSignature(), ilUserCertificateGUI\listCertificates(), ilTestServiceGUI\populatePassFinishDate(), ilBlogPostingGUI\postOutputProcessing(), ilWikiPageGUI\preview(), ilObjTestGUI\reviewobject(), ilMembershipCronNotifications\run(), ilSkillNotifications\run(), ilCronManager\runActiveJobs(), ilCronDeleteInactiveUserReminderMailNotification\send(), ilForumMailNotification\send(), and ilChatroomHistoryGUI\showMessages().

     {
         return self::$use_relative_dates;
     }

Here is the caller graph for this function:

Field Documentation

◆ $lang

ilDatePresentation::$lang = null

staticprivate

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

◆ $today

ilDatePresentation::$today = null

static

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

◆ $tomorrow

ilDatePresentation::$tomorrow = null

static

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

◆ $use_relative_dates

ilDatePresentation::$use_relative_dates = true

static

Definition at line 37 of file class.ilDatePresentation.php.

◆ $weekdays

ilDatePresentation::$weekdays

staticprotected

Initial value:

= array(
        0 => "Su_short",
        1 => "Mo_short",
        2 => "Tu_short",
        3 => "We_short",
        4 => "Th_short",
        5 => "Fr_short",
        6 => "Sa_short"
    )

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

◆ $yesterday

ilDatePresentation::$yesterday = null

static

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

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

Services/Calendar/classes/class.ilDatePresentation.php

Static Public Member Functions

Static Public Attributes

Static Protected Attributes

Static Private Attributes

Detailed Description

Member Function Documentation

◆ formatDate()

◆ formatPeriod()

◆ getLanguage()

◆ isToday()

◆ isTomorrow()

◆ isYesterday()

◆ resetToDefaults()

◆ secondsToString()

◆ setLanguage()

◆ setUseRelativeDates()

◆ useRelativeDates()

Field Documentation

◆ $lang

◆ $today

◆ $tomorrow

◆ $use_relative_dates

◆ $weekdays

◆ $yesterday