The IntlDateFormatter class

    (PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0)

    Introduction

    Date Formatter is a concrete class that enables locale-dependent formatting/parsing of dates using pattern strings and/or canned patterns.

    This class represents the ICU date formatting functionality. It allows users to display dates in a localized format or to parse strings into PHP date values using pattern strings and/or canned patterns.

    Class synopsis

    classIntlDateFormatter {
    publicconstintFULL;
    publicconstintLONG;
    publicconstintMEDIUM;
    publicconstintSHORT;
    publicconstintNONE;
    publicconstintRELATIVE_FULL;
    publicconstintRELATIVE_LONG;
    publicconstintRELATIVE_MEDIUM;
    publicconstintRELATIVE_SHORT;
    publicconstintGREGORIAN;
    publicconstintTRADITIONAL;
    public__construct(
        ?string$locale,
        int$dateType = IntlDateFormatter::FULL,
        int$timeType = IntlDateFormatter::FULL,
        IntlTimeZone|DateTimeZone|string|null$timezone = null,
        IntlCalendar|int|null$calendar = null,
        ?string$pattern = null
    )
    publicstaticcreate(
        ?string$locale,
        int$dateType = IntlDateFormatter::FULL,
        int$timeType = IntlDateFormatter::FULL,
        IntlTimeZone|DateTimeZone|string|null$timezone = null,
        IntlCalendar|int|null$calendar = null,
        ?string$pattern = null
    ): ?IntlDateFormatter
    publicformat(IntlCalendar|DateTimeInterface|array|string|int|float$datetime): string|false
    publicstaticformatObject(IntlCalendar|DateTimeInterface$datetime, array|int|string|null$format = null, ?string$locale = null): string|false
    publicgetCalendar(): int|false
    publicgetDateType(): int|false
    publicgetErrorCode(): int
    publicgetErrorMessage(): string
    publicgetLocale(int$type = ULOC_ACTUAL_LOCALE): string|false
    publicgetPattern(): string|false
    publicgetTimeType(): int|false
    publicgetTimeZoneId(): string|false
    publicgetCalendarObject(): IntlCalendar|false|null
    publicgetTimeZone(): IntlTimeZone|false
    publicisLenient(): bool
    publiclocaltime(string$string, int&$offset = null): array|false
    publicparse(string$string, int&$offset = null): int|float|false
    publicsetCalendar(IntlCalendar|int|null$calendar): bool
    publicsetLenient(bool$lenient): void
    publicsetPattern(string$pattern): bool
    publicsetTimeZone(IntlTimeZone|DateTimeZone|string|null$timezone): bool
    }

    Predefined Constants

    These constants are used to specify different formats in the constructor for DateType and TimeType.

    IntlDateFormatter::NONE
    Do not include this element
    IntlDateFormatter::FULL
    Completely specified style (Tuesday, April 12, 1952 AD or 3:30:42pm PST)
    IntlDateFormatter::LONG
    Long style (January 12, 1952 or 3:30:32pm)
    IntlDateFormatter::MEDIUM
    Medium style (Jan 12, 1952)
    IntlDateFormatter::SHORT
    Most abbreviated style, only essential data (12/13/52 or 3:30pm)
    IntlDateFormatter::RELATIVE_FULL
    The same as IntlDateFormatter::FULL, but yesterday, today, and tomorrow show as yesterday, today, and tomorrow, respectively. Available as of PHP 8.0.0, for dateType only.
    IntlDateFormatter::RELATIVE_LONG
    The same as IntlDateFormatter::LONG, but yesterday, today, and tomorrow show as yesterday, today, and tomorrow, respectively. Available as of PHP 8.0.0, for dateType only.
    IntlDateFormatter::RELATIVE_MEDIUM
    The same as IntlDateFormatter::MEDIUM, but yesterday, today, and tomorrow show as yesterday, today, and tomorrow, respectively. Available as of PHP 8.0.0, for dateType only.
    IntlDateFormatter::RELATIVE_SHORT
    The same as IntlDateFormatter::SHORT, but yesterday, today, and tomorrow show as yesterday, today, and tomorrow, respectively. Available as of PHP 8.0.0, for dateType only.

    The following int constants are used to specify the calendar. These calendars are all based directly on the Gregorian calendar. Non-Gregorian calendars need to be specified in locale. Examples might include locale="hi@calendar=BUDDHIST".

    IntlDateFormatter::TRADITIONAL
    Non-Gregorian Calendar
    IntlDateFormatter::GREGORIAN
    Gregorian Calendar

    Table of Contents

    To Top