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 function __construct (IntlTimeZone $tz = ?, string $locale = ?)

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

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

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

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

public function getGregorianChange (): float

public function isLeapYear (int $year): bool

public function setGregorianChange (float $timestamp): bool

/* Inherited methods */

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

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

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

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

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

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

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

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

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

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

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

public static function IntlCalendar::getAvailableLocales (): array

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

public function IntlCalendar::getErrorCode (): int |false

public function IntlCalendar::getErrorMessage (): string |false

public function IntlCalendar::getFirstDayOfWeek (): int |false

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

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

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

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

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

public function IntlCalendar::getMinimalDaysInFirstWeek (): int |false

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

public static function IntlCalendar::getNow (): float

public function IntlCalendar::getRepeatedWallTimeOption (): int

public function IntlCalendar::getSkippedWallTimeOption (): int

public function IntlCalendar::getTime (): float |false

public function IntlCalendar::getTimeZone (): IntlTimeZone |false

public function IntlCalendar::getType (): string

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

public function IntlCalendar::inDaylightTime (): bool

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

public function IntlCalendar::isLenient (): bool

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

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

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

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

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

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

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

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

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

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

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

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

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

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

public function 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

Found A Problem?

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

+add a note

User Contributed Notes 1 note

down

Julian Sawicki ¶

5 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