Class for date presentation. More...

Collaboration diagram for ilDatePresentation:

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

static	useRelativeDates ()

static	setLanguage (ilLanguage $a_lng)

static	getLanguage ()

static	resetToDefaults ()
	reset to defaults More...

static	formatDate (ilDateTime $date, bool $a_skip_day=false, bool $a_include_wd=false, bool $include_seconds=false, ?ilObjUser $user=null,)

static	formatPeriod (ilDateTime $start, ilDateTime $end, bool $a_skip_starting_day=false, ?ilObjUser $user=null)
	Format a period of two dates 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 (int $seconds, bool $force_with_seconds=false, ?ilLanguage $a_lng=null)
	converts seconds to string: Long: 7 days 4 hour(s) ... More...

Static Public Attributes
static bool	$use_relative_dates = true

static ilDateTime	$today = null

static ilDateTime	$tomorrow = null

static ilDateTime	$yesterday = null

Static Protected Attributes
static array	$weekdays

Static Private Attributes
static ilLanguage	$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

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

Member Function Documentation

◆ formatDate()

static ilDatePresentation::formatDate	(	ilDateTime	$date,
		bool	$a_skip_day = `false`,
		bool	$a_include_wd = `false`,
		bool	$include_seconds = `false`,
		?ilObjUser	$user = `null`
	)

static

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

     : string {
        global $DIC;
        if ($user) {
            $lng = new ilLanguage($user->getLanguage());
        } else {
            $user = $DIC->user();
            $lng = self::getLanguage();
        }
 
        $lng->loadLanguageModule('dateplaner');
 
        if ($date->isNull()) {
            return $lng->txt('no_date');
        }
 
        $has_time = !$date instanceof ilDate;
 
        // Converting pure dates to user timezone might return wrong dates
        $date_info = [];
        if ($has_time) {
            $date_info = $date->get(IL_CAL_FKT_GETDATE, '', $user->getTimeZone());
        } else {
            $date_info = $date->get(IL_CAL_FKT_GETDATE, '', 'UTC');
        }
 
        $date_str = '';
        if (!$a_skip_day) {
            $sep = ', ';
            if (self::isToday($date) && self::useRelativeDates()) {
                $date_str = $lng->txt('today');
            } elseif (self::isTomorrow($date) && self::useRelativeDates()) {
                $date_str = $lng->txt('tomorrow');
            } elseif (self::isYesterday($date) && self::useRelativeDates()) {
                $date_str = $lng->txt('yesterday');
            } else {
                $date_str = '';
                if ($a_include_wd) {
                    $date_str = $lng->txt(self::$weekdays[$date_info['wday']]) . ',     ';
                }
                $date_str .= $date_info['mday'] . '. ' .
                    ilCalendarUtil::_numericMonthToString(
                        $date_info['mon'],
                        false,
                        $lng
                    ) . ' ' .
                    $date_info['year'];
            }
        } else {
            $sep = '';
        }
 
        if (!$has_time) {
            return $date_str;
        }
 
        $sec = ($include_seconds)
            ? ':s'
            : '';
 
        switch ($user->getTimeFormat()) {
            case ilCalendarSettings::TIME_FORMAT_24:
                return $date_str . $sep .
                    $date->get(
                        IL_CAL_FKT_DATE,
                        'H:i' . $sec,
                        $user->getTimeZone()
                    );
            case ilCalendarSettings::TIME_FORMAT_12:
                return $date_str . $sep .
                    $date->get(
                        IL_CAL_FKT_DATE,
                        'g:ia' . $sec,
                        $user->getTimeZone()
                    );
        }
 
        return '';
    }

References $lng.

Here is the caller graph for this function:

◆ formatPeriod()

static ilDatePresentation::formatPeriod	(	ilDateTime	$start,
		ilDateTime	$end,
		bool	$a_skip_starting_day = `false`,
		?ilObjUser	$user = `null`
	)

static

Format a period of two dates 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

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

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

References $DIC.

Referenced by ilSessionAppointment\_appointmentToString(), ilInfoScreenGUI\addAccessPeriodProperty(), ilObjectActivation\addListGUIActivationProperty(), ilCalendarEntry\appointmentToMailString(), ilObjRemoteCourseGUI\availabilityToString(), ilObjRemoteGroupGUI\availabilityToString(), ilObjRemoteTestGUI\availabilityToString(), ilCalendarAppointmentGUI\book(), ilSessionStatisticsGUI\buildData(), ilCalendarAppointmentGUI\cancelBooking(), ilAppointmentPresentationBookingPoolGUI\collectPropertiesAndActions(), ilECSCategoryMappingRule\conditionToString(), ilCalendarAppointmentGUI\confirmRegister(), ilCalendarAppointmentGUI\confirmUnregister(), ilWikiStatGUI\export(), ilCalendarChangedAppointmentsTableGUI\fillRow(), ilCourseParticipantsTableGUI\fillRow(), ilGroupParticipantsTableGUI\fillRow(), ilCalendarBlockGUI\getData(), ilCalendarAppointmentPanelGUI\getHTML(), ilCalendarAgendaListGUI\getHTML(), ilCalendarBlockGUI\getModalForApp(), ilCalendarViewGUI\getModalForApp(), ilObjSession\getPresentationTitleAppointmentPeriod(), ilObjUser\getProfileAsString(), ilObjCourseGUI\infoScreen(), ilObjGroupGUI\infoScreen(), ilObjSessionGUI\initAttendanceList(), ilObjCourseAccess\lookupPeriodInfo(), ilObjGroupAccess\lookupPeriodInfo(), ilConsultationHoursTableGUI\parse(), ilAccountMail\replacePlaceholders(), ilBookingReservationsGUI\rsvConfirmCancel(), ilBookingReservationsGUI\rsvConfirmDelete(), ilAccountMail\send(), ilCalendarAppointmentsTableGUI\setAppointments(), ilCalendarAppointmentGUI\showInfoScreen(), and ilMemberExport\write().

Here is the caller graph for this function:

◆ getLanguage()

static ilDatePresentation::getLanguage ( )

static

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

                                        : ilLanguage
    {
        global $DIC;
 
        $lng = $DIC->language();
 
        return self::$lang ?: $lng;
    }

References $DIC, $lang, and $lng.

Referenced by ILIAS\Mail\Autoresponder\AutoresponderNotification\send().

Here is the caller graph for this function:

◆ isToday()

static ilDatePresentation::isToday ( ilDateTime $date )

static

Check if date is "today".

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

                                                    : bool
    {
        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());
    }

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

Here is the call graph for this function:

◆ isTomorrow()

static ilDatePresentation::isTomorrow ( ilDateTime $date )

static

Check if date is tomorrow.

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

                                                       : bool
    {
        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());
    }

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

Here is the call graph for this function:

◆ isYesterday()

static ilDatePresentation::isYesterday ( ilDateTime $date )

static

Check if date is yesterday.

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

                                                        : bool
    {
        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());
    }

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

Here is the call graph for this function:

◆ resetToDefaults()

static ilDatePresentation::resetToDefaults ( )

static

reset to defaults

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

                                            : void
    {
        global $DIC;
 
        $lng = $DIC->language();
        self::setLanguage($lng);
        self::setUseRelativeDates(true);
    }

References $DIC, $lng, setLanguage(), and setUseRelativeDates().

Referenced by ilLPProgressTableGUI\fillRowCSV(), ilObjUser\getProfileAsString(), and ilRoleAssignmentTableGUI\getTitleForReference().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ secondsToString()

static ilDatePresentation::secondsToString	(	int	$seconds,
		bool	$force_with_seconds = `false`,
		?ilLanguage	$a_lng = `null`
	)

static

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

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

     : string {
        global $DIC;
 
        $lng = $DIC['lng'];
        $message = null;
 
        if ($a_lng) {
            $lng = $a_lng;
        }
 
        $seconds = $seconds ?: 0;
 
        // #13625
        if ($seconds > 0) {
            $days = floor($seconds / 86400);
            $rest = $seconds % 86400;
 
            $hours = floor($rest / 3600);
            $rest %= 3600;
 
            $minutes = floor($rest / 60);
            $seconds = $rest % 60;
        } else {
            $days = ceil($seconds / 86400);
            $rest = $seconds % 86400;
 
            $hours = ceil($rest / 3600);
            $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 && !$hours && !$minutes) {
            return $seconds . ' ' . ($seconds == 1 ? $lng->txt('second') : $lng->txt('seconds'));
        }
 
        return $message;
    }

References $lng.

Referenced by ilCourseContentGUI\__renderUserItem(), ilCalendarAppointmentsTableGUI\fillRow(), ilTrUserObjectsPropsTableGUI\fillRow(), ilObjSCORM2004LearningModule\getTrackingDataAgg(), and ilLearningProgressGUI\showtlt().

Here is the caller graph for this function:

◆ setLanguage()

static ilDatePresentation::setLanguage ( ilLanguage $a_lng )

static

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

                                                         : void
    {
        self::$lang = $a_lng;
    }

References $lang.

Referenced by ilForumMailNotification\createMailDate(), ilForumMailEventNotificationSender\createMailDate(), ilObjUser\getProfileAsString(), resetToDefaults(), ilForumMailNotification\send(), ilForumMailEventNotificationSender\send(), and ILIAS\Mail\Autoresponder\AutoresponderNotification\send().

Here is the caller graph for this function:

◆ setUseRelativeDates()

static ilDatePresentation::setUseRelativeDates ( bool $a_status )

static

set use relative dates

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

                                                              : void
    {
        self::$use_relative_dates = $a_status;
    }

Referenced by ilBookingReservationsTableGUI\__construct(), ilCalendarEntry\appointmentToMailString(), ilSessionStatisticsGUI\buildData(), ilNoteGUI\deleteNote(), ILIAS\User\Account\DeleteAccountGUI\deleteOwnAccountStep3(), ILIAS\Survey\Execution\LaunchGUI\determineAppraiseeInfo(), ilSessionStatisticsGUI\exportCSV(), ilSurveyEvaluationGUI\exportEvaluationUser(), assFileUploadFileTableGUI\fillRow(), ilQuestionPoolPrintViewTableGUI\fillRow(), ilLPProgressTableGUI\fillRowCSV(), ilCertificateDateHelper\format(), ilTestPassOverviewTableGUI\formatDate(), ilGroupMembershipGUI\getAttendanceListUserData(), ilPersonalSkillsGUI\getEvalItem(), ilPortfolioExerciseGUI\getExerciseInfo(), ilLPTableBaseGUI\getExportMeta(), ilCalendarHeaderNavigationGUI\getHTML(), ilDclCreateViewTableGUI\getHTML(), ilDclEditViewTableGUI\getHTML(), ilDclFieldListTableGUI\getHTML(), ilDclTableViewEditFieldsTableGUI\getHTML(), ilAttendanceList\getHTML(), ilTable2GUI\getHTML(), ilObjectMetaDataGUI\getKeyValueList(), ilObjectMetaDataBlockGUI\getLegacyContent(), ilBlogPostingGUI\getPageHeading(), ILIAS\Portfolio\PortfolioPrintViewProviderGUI\getPages(), ilEmployeeTalkAppointmentGUI\getPendingTalkDates(), ILIAS\Survey\PrintView\ResultsDetailsPrintViewProviderGUI\getPrintHeader(), ILIAS\Survey\PrintView\ResultsPerUserPrintViewProviderGUI\getPrintHeader(), ilCourseMembershipGUI\getPrintMemberData(), ilObjUser\getProfileAsString(), ilTestServiceGUI\getResultsSignature(), ilRoleAssignmentTableGUI\getTitleForReference(), ilObjSessionGUI\initAttendanceList(), ilBadgeProfileGUI\listBackpackGroups(), ilUserCertificateGUI\listCertificates(), ilTestServiceGUI\populatePassFinishDate(), ilForumExportGUI\printPost(), ilForumExportGUI\printThread(), resetToDefaults(), ilMembershipCronNotifications\run(), ilSkillNotifications\run(), ILIAS\Cron\Job\Manager\JobManagerImpl\runActiveJobs(), ilForumMailNotification\send(), ilForumMailEventNotificationSender\send(), ILIAS\Mail\Autoresponder\AutoresponderNotification\send(), ilTestMailNotification\sendAdvancedNotification(), ilTestMailNotification\sendSimpleNotification(), ilCertificateDateHelperTest\testHelperDoesNotChangeUseRelativeDates(), and ilMemberExport\write().

Here is the caller graph for this function:

◆ useRelativeDates()

static ilDatePresentation::useRelativeDates ( )

static

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

                                             : bool
    {
        return self::$use_relative_dates;
    }

References $use_relative_dates.

Referenced by ilNoteGUI\deleteNote(), ilCertificateDateHelper\format(), ilTestPassOverviewTableGUI\formatDate(), ilPortfolioExerciseGUI\getExerciseInfo(), ilObjectMetaDataGUI\getKeyValueList(), ilObjectMetaDataBlockGUI\getLegacyContent(), ilBlogPostingGUI\getPageHeading(), ilEmployeeTalkAppointmentGUI\getPendingTalkDates(), ilTestServiceGUI\getResultsSignature(), ilUserCertificateGUI\listCertificates(), ilTestServiceGUI\populatePassFinishDate(), ilMembershipCronNotifications\run(), ilSkillNotifications\run(), ILIAS\Cron\Job\Manager\JobManagerImpl\runActiveJobs(), ilForumMailNotification\send(), ilForumMailEventNotificationSender\send(), ILIAS\Mail\Autoresponder\AutoresponderNotification\send(), and ilCertificateDateHelperTest\testHelperDoesNotChangeUseRelativeDates().

Here is the caller graph for this function:

Field Documentation

◆ $lang

ilLanguage ilDatePresentation::$lang = null

staticprivate

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

◆ $today

ilDateTime ilDatePresentation::$today = null

static

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

◆ $tomorrow

ilDateTime ilDatePresentation::$tomorrow = null

static

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

◆ $use_relative_dates

bool ilDatePresentation::$use_relative_dates = true

static

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

Referenced by useRelativeDates().

◆ $weekdays

array ilDatePresentation::$weekdays

staticprotected

Initial value:

= [
        0 => 'Su_short',
        1 => 'Mo_short',
        2 => 'Tu_short',
        3 => 'We_short',
        4 => 'Th_short',
        5 => 'Fr_short',
        6 => 'Sa_short'
    ]

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

◆ $yesterday

ilDateTime ilDatePresentation::$yesterday = null

static

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

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

components/ILIAS/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