The IntlGregorianCalendar class

(PHP 5 >= 5.5.0, PHP 7, PHP 8)

Introduction

Class synopsis

class IntlGregorianCalendar extends IntlCalendar {

/* Inherited constants */

public const int IntlCalendar::FIELD_ERA;

public const int IntlCalendar::FIELD_YEAR;

public const int IntlCalendar::FIELD_MONTH;

public const int IntlCalendar::FIELD_WEEK_OF_YEAR;

public const int IntlCalendar::FIELD_WEEK_OF_MONTH;

public const int IntlCalendar::FIELD_DATE;

public const int IntlCalendar::FIELD_DAY_OF_YEAR;

public const int IntlCalendar::FIELD_DAY_OF_WEEK;

public const int IntlCalendar::FIELD_DAY_OF_WEEK_IN_MONTH;

public const int IntlCalendar::FIELD_AM_PM;

public const int IntlCalendar::FIELD_HOUR;

public const int IntlCalendar::FIELD_HOUR_OF_DAY;

public const int IntlCalendar::FIELD_MINUTE;

public const int IntlCalendar::FIELD_SECOND;

public const int IntlCalendar::FIELD_MILLISECOND;

public const int IntlCalendar::FIELD_ZONE_OFFSET;

public const int IntlCalendar::FIELD_DST_OFFSET;

public const int IntlCalendar::FIELD_YEAR_WOY;

public const int IntlCalendar::FIELD_DOW_LOCAL;

public const int IntlCalendar::FIELD_EXTENDED_YEAR;

public const int IntlCalendar::FIELD_JULIAN_DAY;

public const int IntlCalendar::FIELD_MILLISECONDS_IN_DAY;

public const int IntlCalendar::FIELD_IS_LEAP_MONTH;

public const int IntlCalendar::FIELD_FIELD_COUNT;

public const int IntlCalendar::FIELD_DAY_OF_MONTH;

public const int IntlCalendar::DOW_SUNDAY;

public const int IntlCalendar::DOW_MONDAY;

public const int IntlCalendar::DOW_TUESDAY;

public const int IntlCalendar::DOW_WEDNESDAY;

public const int IntlCalendar::DOW_THURSDAY;

public const int IntlCalendar::DOW_FRIDAY;

public const int IntlCalendar::DOW_SATURDAY;

public const int IntlCalendar::DOW_TYPE_WEEKDAY;

public const int IntlCalendar::DOW_TYPE_WEEKEND;

public const int IntlCalendar::DOW_TYPE_WEEKEND_OFFSET;

public const int IntlCalendar::DOW_TYPE_WEEKEND_CEASE;

public const int IntlCalendar::WALLTIME_FIRST;

public const int IntlCalendar::WALLTIME_LAST;

public const int IntlCalendar::WALLTIME_NEXT_VALID;

/* Methods */

public __construct(IntlTimeZone $tz = ?, string $locale = ?)

public __construct(int $timeZoneOrYear, int $localeOrMonth, int $dayOfMonth)

public __construct(
    int $timeZoneOrYear,
    int $localeOrMonth,
    int $dayOfMonth,
    int $hour,
    int $minute,
    int $second = ?
)

public static createFromDate(int $year, int $month, int $dayOfMonth): static

public static createFromDateTime(
    int $year,
    int $month,
    int $dayOfMonth,
    int $hour,
    int $minute,
    ?int $second = null
): static

public getGregorianChange(): float

public isLeapYear(int $year): bool

public setGregorianChange(float $timestamp): bool

/* Inherited methods */

public IntlCalendar::add(int $field, int $value): bool

public IntlCalendar::after(IntlCalendar $other): bool

public IntlCalendar::before(IntlCalendar $other): bool

public IntlCalendar::clear(?int $field = null): true

public static IntlCalendar::createInstance(IntlTimeZone|DateTimeZone|string|null $timezone = null, ?string $locale = null): ?IntlCalendar

public IntlCalendar::equals(IntlCalendar $other): bool

public IntlCalendar::fieldDifference(float $timestamp, int $field): int|false

public static IntlCalendar::fromDateTime(DateTime|string $datetime, ?string $locale = null): ?IntlCalendar

public IntlCalendar::get(int $field): int|false

public IntlCalendar::getActualMaximum(int $field): int|false

public IntlCalendar::getActualMinimum(int $field): int|false

public static IntlCalendar::getAvailableLocales(): array

public IntlCalendar::getDayOfWeekType(int $dayOfWeek): int|false

public IntlCalendar::getErrorCode(): int|false

public IntlCalendar::getErrorMessage(): string|false

public IntlCalendar::getFirstDayOfWeek(): int|false

public IntlCalendar::getGreatestMinimum(int $field): int|false

public static IntlCalendar::getKeywordValuesForLocale(string $keyword, string $locale, bool $onlyCommon): IntlIterator|false

public IntlCalendar::getLeastMaximum(int $field): int|false

public IntlCalendar::getLocale(int $type): string|false

public IntlCalendar::getMaximum(int $field): int|false

public IntlCalendar::getMinimalDaysInFirstWeek(): int|false

public IntlCalendar::getMinimum(int $field): int|false

public static IntlCalendar::getNow(): float

public IntlCalendar::getRepeatedWallTimeOption(): int

public IntlCalendar::getSkippedWallTimeOption(): int

public IntlCalendar::getTime(): float|false

public IntlCalendar::getTimeZone(): IntlTimeZone|false

public IntlCalendar::getType(): string

public IntlCalendar::getWeekendTransition(int $dayOfWeek): int|false

public IntlCalendar::inDaylightTime(): bool

public IntlCalendar::isEquivalentTo(IntlCalendar $other): bool

public IntlCalendar::isLenient(): bool

public IntlCalendar::isSet(int $field): bool

public IntlCalendar::isWeekend(?float $timestamp = null): bool

public IntlCalendar::roll(int $field, int|bool $value): bool

public IntlCalendar::set(int $field, int $value): true

public IntlCalendar::set(
    int $year,
    int $month,
    int $dayOfMonth = NULL,
    int $hour = NULL,
    int $minute = NULL,
    int $second = NULL
): true

public IntlCalendar::setDate(int $year, int $month, int $dayOfMonth): void

public IntlCalendar::setDateTime(
    int $year,
    int $month,
    int $dayOfMonth,
    int $hour,
    int $minute,
    ?int $second = null
): void

public IntlCalendar::setFirstDayOfWeek(int $dayOfWeek): true

public IntlCalendar::setLenient(bool $lenient): true

public IntlCalendar::setMinimalDaysInFirstWeek(int $days): true

public IntlCalendar::setRepeatedWallTimeOption(int $option): true

public IntlCalendar::setSkippedWallTimeOption(int $option): true

public IntlCalendar::setTime(float $timestamp): bool

public IntlCalendar::setTimeZone(IntlTimeZone|DateTimeZone|string|null $timezone): bool

public IntlCalendar::toDateTime(): DateTime|false

}

IntlGregorianCalendar::__construct — Create the Gregorian Calendar class
IntlGregorianCalendar::createFromDate — Create a new IntlGregorianCalendar instance from date
IntlGregorianCalendar::createFromDateTime — Create a new IntlGregorianCalendar instance from date and time
IntlGregorianCalendar::getGregorianChange — Get the Gregorian Calendar change date
IntlGregorianCalendar::isLeapYear — Determine if the given year is a leap year
IntlGregorianCalendar::setGregorianChange — Set the Gregorian Calendar the change date

Improve This Page

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 1 note

down

Julian Sawicki ¶

3 years ago

I was using `IntlGregorianCalendar` because it offered a nice way to get the week number of the year as an integer. This differs from `DateTime`; `DateTime` gives you the week number of the year as an string.

<?php 

$dateTime = new DateTime('21-09-2020 09:00:00');
echo $dateTime->format("W"); // string '39'

$intlCalendar = IntlCalendar::fromDateTime ('21-09-2020 09:00:00');
echo $intlCalendar->get(IntlCalendar::FIELD_WEEK_OF_YEAR); // integer 39