ilDateTime Class Reference

Date and time handling More...

Inheritance diagram for ilDateTime:

Collaboration diagram for ilDateTime:

Public Member Functions
	__construct ($a_date=null, int $a_format=0, string $a_tz='')
	Create new date object. More...
	__clone ()
	__sleep ()
	__wakeup ()
	isNull ()
	Check if a date is null (Datetime == '0000-00-00 00:00:00', unixtime == 0,...) More...
	switchTimeZone (string $a_timezone_identifier='')
	Switch timezone. More...
	getTimeZoneIdentifier ()
	increment (string $a_type, int $a_count=1)
	getUnixTime ()
	setDate ($a_date, int $a_format)
	Set date. More...
	get (int $a_format, string $a_format_str='', string $a_tz='')
	get formatted date More...
	__toString ()
	to string for date time objects Output is user time zone public More...

Static Public Member Functions
static	_before (ilDateTime $start, ilDateTime $end, string $a_compare_field='', string $a_tz='')
	compare two dates and check start is before end This method does not consider tz offsets. More...
static	_equals (ilDateTime $start, ilDateTime $end, string $a_compare_field='', string $a_tz='')
	Check if two date are equal. More...
static	_after (ilDateTime $start, ilDateTime $end, string $a_compare_field='', string $a_tz='')
	compare two dates and check start is after end This method does not consider tz offsets. More...
static	_within (ilDateTime $dt, ilDateTime $start, ilDateTime $end, string $a_compare_field='', string $a_tz='')
	Check whether an date is within a date duration given by start and end. More...

Data Fields
const	YEAR = 'year'
const	MONTH = 'month'
const	WEEK = 'week'
const	DAY = 'day'
const	HOUR = 'hour'
const	MINUTE = 'minute'
const	SECOND = 'second'

Protected Member Functions
	parsePartsToDate (int $a_year, int $a_month, int $a_day, ?int $a_hour=null, ?int $a_min=null, ?int $a_sec=null, ?string $a_timezone=null)

Protected Attributes
ilLogger	$log
ilTimeZone	$timezone = null
ilTimeZone	$default_timezone = null
DateTime	$dt_obj = null

Detailed Description

Date and time handling

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilDateTime::__construct	(		$a_date = null,
		int	$a_format = 0,
		string	$a_tz = ''
	)

Create new date object.

Parameters

int|string	following the format given as the second parameter
int	format
string

Exceptions

ilDateTimeException

Definition at line 64 of file class.ilDateTime.php.

References $DIC, ilTimeZone\_getInstance(), and setDate().

    {
        global $DIC;

        $this->log = $DIC->logger()->cal();

        try {
            $this->timezone = ilTimeZone::_getInstance($a_tz);
            $this->default_timezone = ilTimeZone::_getInstance('');
            $this->setDate($a_date, $a_format);
        } catch (ilTimeZoneException $exc) {
            $this->log->warning($exc->getMessage());
            throw new ilDateTimeException('Unsupported timezone given. Timezone: ' . $a_tz);
        }
    }

Here is the call graph for this function:

Member Function Documentation

__clone()

ilDateTime::__clone

(

)

Definition at line 80 of file class.ilDateTime.php.

References $dt_obj.

    {
        if ($this->dt_obj) {
            $this->dt_obj = clone $this->dt_obj;
        }
    }

__sleep()

ilDateTime::__sleep

(

)

Definition at line 87 of file class.ilDateTime.php.

    {
        return array('timezone', 'default_timezone', 'dt_obj');
    }

__toString()

ilDateTime::__toString

(

)

to string for date time objects Output is user time zone public

Parameters

Definition at line 557 of file class.ilDateTime.php.

References IL_CAL_DATETIME.

                                : string
    {
        return $this->get(IL_CAL_DATETIME) . '<br>';
    }

__wakeup()

ilDateTime::__wakeup

(

)

Definition at line 92 of file class.ilDateTime.php.

References $DIC.

    {
        global $DIC;
        $this->log = $DIC->logger()->cal();
    }

_after()

static ilDateTime::_after ( ilDateTime  $start, ilDateTime  $end, string  $a_compare_field = '', string  $a_tz = ''  )

static

compare two dates and check start is after end This method does not consider tz offsets.

So you have to take care that both dates are defined in the the same timezone public

Parameters

ilDateTime
ilDateTime
string	field used for comparison. E.g IL_CAL_YEAR checks if start is one or more years after than end
string	timezone

Returns

bool

Definition at line 209 of file class.ilDateTime.php.

References get(), IL_CAL_DAY, IL_CAL_FKT_DATE, IL_CAL_MONTH, IL_CAL_YEAR, and isNull().

Referenced by ilObjGroupAccess\_registrationEnabled(), _within(), ilCalendarRecurrenceCalculator\applyDurationPeriod(), ilCalendarRecurrenceCalculator\applyLimits(), ilCalendarRecurrenceCalculator\calculateDateList(), ilDateDurationInputGUI\checkInput(), ilAppointmentPresentationConsultationHoursGUI\collectPropertiesAndActions(), ilGroupRegistrationGUI\fillRegistrationPeriod(), ilCourseRegistrationGUI\fillRegistrationPeriod(), ilConsultationHourBookingTableGUI\fillRow(), ilSearchResult\filter(), ilSessionClassificationPathGUI\findSessionContainerForItem(), ilPageObject\getActive(), ilCalendarAppointmentPanelGUI\getHTML(), ilCalendarAgendaListGUI\getHTML(), ilContainerSessionsContentGUI\initSessionPresentationLimitation(), ilBookingEntry\isAppointmentBookableForUser(), ILIAS\Calendar\ConsultationHours\BookingDataProvider\isFiltered(), ilLPPersonalGUI\isPresentable(), ilECSCategoryMappingRule\matchesValue(), ilObjGroup\register(), ilCourseContentGUI\updateManagedTimings(), ilCourseContentGUI\updatePersonalTimings(), and ilECSCategoryMappingRule\validate().

     : bool {
        if ($start->isNull() || $end->isNull()) {
            return false;
        }

        switch ($a_compare_field) {
            case IL_CAL_YEAR:
                return $start->get(IL_CAL_FKT_DATE, 'Y', $a_tz) > $end->get(IL_CAL_FKT_DATE, 'Y', $a_tz);

            case IL_CAL_MONTH:
                return (int) $start->get(IL_CAL_FKT_DATE, 'Ym', $a_tz) > $end->get(IL_CAL_FKT_DATE, 'Ym', $a_tz);

            case IL_CAL_DAY:
                return (int) $start->get(IL_CAL_FKT_DATE, 'Ymd', $a_tz) > $end->get(IL_CAL_FKT_DATE, 'Ymd', $a_tz);

            case '':
            default:
                return $start->dt_obj > $end->dt_obj;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_before()

static ilDateTime::_before ( ilDateTime  $start, ilDateTime  $end, string  $a_compare_field = '', string  $a_tz = ''  )

static

compare two dates and check start is before end This method does not consider tz offsets.

So you have to take care that both dates are defined in the the same timezone

Parameters

ilDateTime
ilDateTime
string	field used for comparison. E.g IL_CAL_YEAR checks if start is one or more years earlier than end
string	timezone

Returns

bool

Definition at line 138 of file class.ilDateTime.php.

References get(), IL_CAL_DAY, IL_CAL_FKT_DATE, IL_CAL_MONTH, IL_CAL_YEAR, and isNull().

Referenced by ilObjGroupAccess\_registrationEnabled(), _within(), ilMiniCalendarGUI\addMiniMonth(), ilCalendarBlockGUI\addMiniMonth(), ilCalendarRecurrenceCalculator\applyDurationPeriod(), ilCalendarRecurrenceCalculator\applyLimits(), ilCalendarRecurrenceCalculator\calculateDateList(), ilBookingEntry\cancelBooking(), ilGroupRegistrationGUI\fillRegistrationPeriod(), ilCourseRegistrationGUI\fillRegistrationPeriod(), ilECSServerTableGUI\fillRow(), ilSearchResult\filter(), ilPageObject\getActive(), ilConsultationHourUtils\getConsultationHourLinksForRepositoryObject(), ilCalendarAgendaListGUI\getHTML(), ilCalendarBlockGUI\getHTML(), ilExerciseManagementGUI\handleIndividualDeadlineCallsObject(), ilContainerSessionsContentGUI\initSessionPresentationLimitation(), ILIAS\Calendar\ConsultationHours\BookingDataProvider\isFiltered(), ilLPPersonalGUI\isPresentable(), ilECSTimePlace\loadFromJson(), ilObjGroupAccess\lookupRegistrationInfo(), ilObjCourseAccess\lookupRegistrationInfo(), ilECSCategoryMappingRule\matchesValue(), ilCalendarRecurrenceCalculator\optimizeEndingTime(), ilCalendarRecurrenceCalculator\optimizeStartingTime(), ilUserQuery\query(), ilObjGroup\register(), ilCalendarMonthGUI\show(), and ilCalendarEntry\validate().

     : bool {
        if ($start->isNull() || $end->isNull()) {
            return false;
        }

        switch ($a_compare_field) {
            case IL_CAL_YEAR:
                return $start->get(IL_CAL_FKT_DATE, 'Y', $a_tz) < $end->get(IL_CAL_FKT_DATE, 'Y', $a_tz);

            case IL_CAL_MONTH:
                return (int) $start->get(IL_CAL_FKT_DATE, 'Ym', $a_tz) < $end->get(IL_CAL_FKT_DATE, 'Ym', $a_tz);

            case IL_CAL_DAY:
                return (int) $start->get(IL_CAL_FKT_DATE, 'Ymd', $a_tz) < $end->get(IL_CAL_FKT_DATE, 'Ymd', $a_tz);

            case '':
            default:
                return $start->dt_obj < $end->dt_obj;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_equals()

static ilDateTime::_equals ( ilDateTime  $start, ilDateTime  $end, string  $a_compare_field = '', string  $a_tz = ''  )

static

Check if two date are equal.

Parameters

ilDateTime
ilDateTime
string	field used for comparison. E.g IL_CAL_YEAR checks if start is the same years than end
string	timzone

Returns

bool

Definition at line 172 of file class.ilDateTime.php.

References get(), IL_CAL_DAY, IL_CAL_FKT_DATE, IL_CAL_MONTH, IL_CAL_YEAR, and isNull().

Referenced by ilCalendarUtil\_isToday(), _within(), ilMiniCalendarGUI\addMiniMonth(), ilCalendarBlockGUI\addMiniMonth(), ilCalendarRecurrenceCalculator\calculateDateList(), ilCalendarAppointmentGUI\edit(), ilSubItemSelectionTableGUI\fillRow(), ilSessionClassificationPathGUI\findSessionContainerForItem(), ilDatePresentation\formatPeriod(), ilCalendarAgendaListGUI\getHTML(), ilDatePresentation\isToday(), ilDatePresentation\isTomorrow(), ilDatePresentation\isYesterday(), ilDateList\removeByDAY(), ilEmployeeTalkTableGUI\setTalkData(), and ilCalendarMonthGUI\show().

     : bool {
        if ($start->isNull() || $end->isNull()) {
            return false;
        }

        switch ($a_compare_field) {
            case IL_CAL_YEAR:
                return $start->get(IL_CAL_FKT_DATE, 'Y', $a_tz) == $end->get(IL_CAL_FKT_DATE, 'Y', $a_tz);

            case IL_CAL_MONTH:
                return (int) $start->get(IL_CAL_FKT_DATE, 'Ym', $a_tz) == $end->get(IL_CAL_FKT_DATE, 'Ym', $a_tz);

            case IL_CAL_DAY:
                return (int) $start->get(IL_CAL_FKT_DATE, 'Ymd', $a_tz) == $end->get(IL_CAL_FKT_DATE, 'Ymd', $a_tz);

            case '':
            default:
                return $start->dt_obj == $end->dt_obj;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_within()

static ilDateTime::_within ( ilDateTime  $dt, ilDateTime  $start, ilDateTime  $end, string  $a_compare_field = '', string  $a_tz = ''  )

static

Check whether an date is within a date duration given by start and end.

Definition at line 238 of file class.ilDateTime.php.

References _after(), _before(), and _equals().

Referenced by ilCalendarScheduleFilterExercise\addCustomEvents(), ilCalendarScheduleFilterTimings\addCustomEvents(), ilSearchResult\filter(), ilCalendarHeaderNavigationGUI\getHTML(), ilContainerSessionsContentGUI\initSessionPresentationLimitation(), and ilLPPersonalGUI\isPresentable().

     : bool {
        return
            (ilDateTime::_after($dt, $start, $a_compare_field, $a_tz) or ilDateTime::_equals(
                $dt,
                $start,
                $a_compare_field,
                $a_tz
            )) &&
            (ilDateTime::_before($dt, $end, $a_compare_field, $a_tz) or ilDateTime::_equals(
                $dt,
                $end,
                $a_compare_field,
                $a_tz
            ));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

get()

ilDateTime::get	(	int	$a_format,
		string	$a_format_str = '',
		string	$a_tz = ''
	)

get formatted date

Returns

string|int|array|null

Definition at line 477 of file class.ilDateTime.php.

References $default_timezone, ilTimeZone\_getInstance(), ilTimeZone\getIdentifier(), getUnixTime(), IL_CAL_DATE, IL_CAL_DATETIME, IL_CAL_FKT_DATE, IL_CAL_FKT_GETDATE, IL_CAL_ISO_8601, IL_CAL_TIMESTAMP, IL_CAL_UNIX, ILIAS\Repository\int(), isNull(), and null.

Referenced by _after(), _before(), _equals(), ilDateList\add(), ILIAS\BookingManager\BookingProcess\BookingProcessManager\bookAvailableObjects(), ilConsultationHourUtils\findCalendarAppointmentsForBooking(), ilDatePresentation\formatDate(), ilDatePresentation\formatPeriod(), ilCmiXapiDateTime\fromIliasDateTime(), ilCalendarSchedule\getByDay(), ilCalendarHeaderNavigationGUI\getHTML(), ilCalendarRegistration\getRegisteredUsers(), ilCalendarRecurrenceCalculator\getYearWeekDays(), ilCalendarRegistration\isRegistered(), ilLTIDataConnector\lookupResourcesForAllUsersSinceDate(), ilCalendarWeekGUI\parseHourInfo(), ilLegacyFormElementsUtil\period2String(), ilExcel\prepareDateValue(), ilChatroomHistoryGUI\renderDateTimeInformation(), ilExAssignment\setIndividualDeadline(), ilCalendarRegistration\unregister(), and ilCmiXapiUser\updateFetchedUntilForObjects().

    {
        if ($this->isNull()) {
            return null;
        }

        $timezone = $this->default_timezone;
        if ($a_tz) {
            try {
                $timezone = ilTimeZone::_getInstance($a_tz);
            } catch (ilTimeZoneException $exc) {
                $this->log->warning('Invalid timezone given. Timezone: ' . $a_tz);
            }
        }
        $out_date = clone($this->dt_obj);
        $out_date->setTimezone(new DateTimeZone($timezone->getIdentifier()));

        $date = null;
        switch ($a_format) {
            case IL_CAL_UNIX:
                // timezone unrelated
                $date = $this->getUnixTime();
                break;

            case IL_CAL_DATE:
                $date = $out_date->format('Y-m-d');
                break;

            case IL_CAL_DATETIME:
                $date = $out_date->format('Y-m-d H:i:s');
                break;

            case IL_CAL_FKT_DATE:
                $date = $out_date->format($a_format_str);
                break;

            case IL_CAL_FKT_GETDATE:
                $date = array(
                    'seconds' => (int) $out_date->format('s')
                    ,
                    'minutes' => (int) $out_date->format('i')
                    ,
                    'hours' => (int) $out_date->format('G')
                    ,
                    'mday' => (int) $out_date->format('j')
                    ,
                    'wday' => (int) $out_date->format('w')
                    ,
                    'mon' => (int) $out_date->format('n')
                    ,
                    'year' => (int) $out_date->format('Y')
                    ,
                    'yday' => (int) $out_date->format('z')
                    ,
                    'weekday' => $out_date->format('l')
                    ,
                    'month' => $out_date->format('F')
                    ,
                    'isoday' => (int) $out_date->format('N')
                );
                break;

            case IL_CAL_ISO_8601:
                $date = $out_date->format('c');
                break;

            case IL_CAL_TIMESTAMP:
                $date = $out_date->format('YmdHis');
                break;
        }
        return $date;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTimeZoneIdentifier()

ilDateTime::getTimeZoneIdentifier

(

)

Definition at line 123 of file class.ilDateTime.php.

Referenced by parsePartsToDate(), and setDate().

                                           : string
    {
        return $this->timezone->getIdentifier();
    }

Here is the caller graph for this function:

getUnixTime()

ilDateTime::getUnixTime

(

)

Definition at line 314 of file class.ilDateTime.php.

References isNull(), and null.

Referenced by ILIAS\EmployeeTalk\Notification\NotificationHandler\extractFormattedDates(), get(), and increment().

                                 : ?int
    {
        if (!$this->isNull()) {
            return $this->dt_obj->getTimestamp();
        }
        return null;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

increment()

ilDateTime::increment	(	string	$a_type,
		int	$a_count = 1
	)

Parameters

string	$a_type
int	$a_count

Returns

int|null

Todo:

refactor return type

Definition at line 266 of file class.ilDateTime.php.

References getUnixTime(), isNull(), and null.

Referenced by ilCalendarRecurrenceCalculator\applyBYDAYRules(), ilCalendarSchedule\getByDay(), ilCalendarSchedule\getChangedEvents(), ilTimingsUser\handleNewMembership(), ilCalendarRecurrenceCalculator\incrementByFrequency(), ilCalendarAppointmentGUI\initAppointment(), ilCalendarAgendaListGUI\initEndPeriod(), and ilCalendarSchedule\initPeriod().

                                                               : ?int
    {
        if ($this->isNull()) {
            return null;
        }

        $sub = ($a_count < 0);
        $count_str = abs($a_count);

        switch ($a_type) {
            case self::YEAR:
                $count_str .= 'year';
                break;

            case self::MONTH:
                $count_str .= 'month';
                break;

            case self::WEEK:
                $count_str .= 'week';
                break;

            case self::DAY:
                $count_str .= 'day';
                break;

            case self::HOUR:
                $count_str .= 'hour';
                break;

            case self::MINUTE:
                $count_str .= 'minute';
                break;

            case self::SECOND:
                $count_str .= 'second';
                break;
        }

        $interval = date_interval_create_from_date_string($count_str);
        if (!$sub) {
            $this->dt_obj->add($interval);
        } else {
            $this->dt_obj->sub($interval);
        }
        return $this->getUnixTime();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isNull()

ilDateTime::isNull

(

)

Check if a date is null (Datetime == '0000-00-00 00:00:00', unixtime == 0,...)

Returns

bool

Definition at line 102 of file class.ilDateTime.php.

Referenced by _after(), _before(), _equals(), ilDatePresentation\formatDate(), get(), getUnixTime(), and increment().

                            : bool
    {
        return !($this->dt_obj instanceof DateTime);
    }

Here is the caller graph for this function:

parsePartsToDate()

ilDateTime::parsePartsToDate ( int  $a_year, int  $a_month, int  $a_day, ?int  $a_hour = null, ?int  $a_min = null, ?int  $a_sec = null, ?string  $a_timezone = null  )

protected

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

References getTimeZoneIdentifier(), ILIAS\Repository\int(), and null.

Referenced by setDate().

     : ?DateTime {
        $a_year = $a_year;
        $a_month = $a_month;
        $a_day = $a_day;

        if (!$a_year) {
            return null;
        }
        $date = null;
        try {
            $a_hour = (int) $a_hour;
            $a_min = (int) $a_min;
            $a_sec = (int) $a_sec;

            $format = $a_year . '-' . $a_month . '-' . $a_day;

            if ($a_hour !== null) {
                $format .= ' ' . $a_hour . ':' . $a_min . ':' . $a_sec;

                // use current timezone if no other given
                if (!$a_timezone) {
                    $a_timezone = $this->getTimeZoneIdentifier();
                }

                $date = new DateTime($format, new DateTimeZone($a_timezone));
            } else {
                $date = new DateTime($format);
            }
        } catch (Exception $ex) {
            // :TODO: do anything?
        }
        return ($date instanceof DateTime)
            ? $date
            : null;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setDate()

ilDateTime::setDate	(		$a_date,
		int	$a_format
	)

Set date.

Exceptions

ilDateTimeException

Todo:

fix ISO_8601 support

False "DateTime::ATOM was removed 7.2 warning" is a false positve

PhpElementIsNotAvailableInCurrentPhpVersionInspection

Definition at line 371 of file class.ilDateTime.php.

References $message, getTimeZoneIdentifier(), IL_CAL_DATE, IL_CAL_DATETIME, IL_CAL_FKT_GETDATE, IL_CAL_ISO_8601, IL_CAL_TIMESTAMP, IL_CAL_UNIX, null, parsePartsToDate(), and ilLogLevel\WARNING.

Referenced by __construct(), and ilExAssignmentEditorGUI\setDisabledFieldValues().

                                                   : void
    {
        $this->dt_obj = null;

        if (!$a_date) {
            return;
        }

        switch ($a_format) {
            case IL_CAL_UNIX:
                try {
                    $this->dt_obj = new DateTime('@' . $a_date);
                    $this->dt_obj->setTimezone(new DateTimeZone($this->getTimeZoneIdentifier()));
                } catch (Exception $ex) {
                    $message = 'Cannot parse date: ' . $a_date . ' with format ' . $a_format;
                    $this->log->warning($message);
                    throw new ilDateTimeException($message);
                }
                break;

            case IL_CAL_DATETIME:
                $matches = preg_match(
                    '/^(\d{4})-?(\d{2})-?(\d{2})([T\s]?(\d{2}):?(\d{2}):?(\d{2})(\.\d+)?(Z|[\+\-]\d{2}:?\d{2})?)$/i',
                    $a_date,
                    $d_parts
                );
                if ($matches < 1) {
                    $this->log->warning('Cannot parse date: ' . $a_date);
                    $this->log->warning(print_r($matches, true));
                    $this->log->logStack(ilLogLevel::WARNING);
                    throw new ilDateTimeException('Cannot parse date: ' . $a_date);
                }

                $tz_id = (isset($d_parts[9]) && $d_parts[9] === 'Z')
                    ? 'UTC'
                    : $this->getTimeZoneIdentifier();
                $this->dt_obj = $this->parsePartsToDate(
                    (int) $d_parts[1],
                    (int) $d_parts[2],
                    (int) $d_parts[3],
                    (int) $d_parts[5],
                    (int) $d_parts[6],
                    (int) $d_parts[7],
                    $tz_id
                );
                break;

            case IL_CAL_DATE:
                try {
                    // Pure dates are not timezone sensible.
                    $this->dt_obj = new DateTime($a_date, new DateTimeZone('UTC'));
                } catch (Exception $ex) {
                    $this->log->warning('Cannot parse date : ' . $a_date);
                    throw new ilDateTimeException('Cannot parse date: ' . $a_date);
                }
                break;

            case IL_CAL_FKT_GETDATE:
                // Format like getdate parameters
                $this->dt_obj = $this->parsePartsToDate(
                    (int) $a_date['year'],
                    (int) $a_date['mon'],
                    (int) $a_date['mday'],
                    (int) $a_date['hours'],
                    (int) $a_date['minutes'],
                    (int) ($a_date['seconds'] ?? 0),
                    $this->getTimeZoneIdentifier()
                );
                break;

            case IL_CAL_TIMESTAMP:
                if (!preg_match("/(\d{4})(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})/", $a_date, $d_parts)) {
                    $this->log->warning('Cannot parse date: ' . $a_date);
                    throw new ilDateTimeException('Cannot parse date.');
                }
                $this->dt_obj = $this->parsePartsToDate(
                    (int) $d_parts[1],
                    (int) $d_parts[2],
                    (int) $d_parts[3],
                    (int) $d_parts[4],
                    (int) $d_parts[5],
                    (int) $d_parts[6],
                    $this->getTimeZoneIdentifier()
                );
                break;

            case IL_CAL_ISO_8601:
                $this->dt_obj = DateTime::createFromFormat(
                    DateTime::ATOM,
                    $a_date,
                    new DateTimeZone($this->getTimeZoneIdentifier())
                );
                break;
        }
        // remove set timezone since it does not influence the internal date.
        // the tz must be passed in the moment of the creation of the date object.
    }

Here is the call graph for this function:

Here is the caller graph for this function:

switchTimeZone()

ilDateTime::switchTimeZone

(

string

$a_timezone_identifier = ''

)

Switch timezone.

Parameters

string

PHP timezone identifier

Exceptions

ilDateTimeException

Definition at line 112 of file class.ilDateTime.php.

References Vendor\Package\$e, and ilTimeZone\_getInstance().

Referenced by ilCalendarRecurrenceCalculator\adjustTimeZones().

                                                                      : void
    {
        try {
            $this->timezone = ilTimeZone::_getInstance($a_timezone_identifier);
            return;
        } catch (ilTimeZoneException $e) {
            $this->log->warning('Unsupported timezone given: ' . $a_timezone_identifier);
            throw new ilDateTimeException('Unsupported timezone given. Timezone: ' . $a_timezone_identifier);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$default_timezone

ilTimeZone ilDateTime::$default_timezone = null

protected

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

Referenced by get().

$dt_obj

DateTime ilDateTime::$dt_obj = null

protected

Definition at line 55 of file class.ilDateTime.php.

Referenced by __clone().

$log

ilLogger ilDateTime::$log

protected

Definition at line 52 of file class.ilDateTime.php.

$timezone

ilTimeZone ilDateTime::$timezone = null

protected

Definition at line 53 of file class.ilDateTime.php.

DAY

const ilDateTime::DAY = 'day'

Definition at line 47 of file class.ilDateTime.php.

Referenced by ilCalendarRecurrenceCalculator\applyBYMONTHDAYRules(), ilCalendarRecurrenceCalculator\applyBYYEARDAYRules(), ilCalendarSchedule\getByDay(), ilCalendarHeaderNavigationGUI\getHTML(), ilCalendarAgendaListGUI\getHTML(), ILIAS\LegalDocuments\Provide\History\HistoryDBRepository\getMaxHistEntryPerPageOlderThanX(), ilCalendarRecurrenceCalculator\incrementByFrequency(), ilBookingReservationsTableGUI\initFilter(), ilCalendarRecurrenceCalculator\optimizeEndingTime(), ilLoggerCronCleanErrorFiles\run(), and ilCalendarDayGUI\show().

HOUR

const ilDateTime::HOUR = 'hour'

Definition at line 48 of file class.ilDateTime.php.

Referenced by ilConsultationHoursGUI\createAppointments().

MINUTE

const ilDateTime::MINUTE = 'minute'

Definition at line 49 of file class.ilDateTime.php.

Referenced by ilCalendarRecurrenceCalculator\applyDurationPeriod(), and ilConsultationHoursGUI\createAppointments().

MONTH

const ilDateTime::MONTH = 'month'

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

Referenced by ilMiniCalendarGUI\addMiniMonth(), ilCalendarRecurrenceCalculator\applyBYMONTHRules(), ilCalendarHeaderNavigationGUI\getHTML(), ilCalendarBlockGUI\getViewControl(), ilCalendarRecurrenceCalculator\incrementByFrequency(), ilCalendarHeaderNavigationGUI\incrementDate(), and ilCalendarMonthGUI\show().

SECOND

const ilDateTime::SECOND = 'second'

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

WEEK

const ilDateTime::WEEK = 'week'

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

Referenced by ilCalendarRecurrenceCalculator\applyBYWEEKNORules(), ilCalendarHeaderNavigationGUI\getHTML(), ILIAS\BookingManager\BookingProcess\WeekGUI\getHTML(), ilCalendarRecurrenceCalculator\incrementByFrequency(), and ilCalendarWeekGUI\show().

YEAR

const ilDateTime::YEAR = 'year'

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

Referenced by ilConsultationHoursGUI\createAppointments(), and ilCalendarRecurrenceCalculator\incrementByFrequency().

---

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

• components/ILIAS/Calendar/classes/class.ilDateTime.php