IntlCalendar

(PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a1)

Introduction

Synopsis de la classe

class IntlCalendar { /* Constantes */ public const int FIELD_ERA; public const int FIELD_YEAR; public const int FIELD_MONTH; public const int FIELD_WEEK_OF_YEAR; public const int FIELD_WEEK_OF_MONTH; public const int FIELD_DATE; public const int FIELD_DAY_OF_YEAR; public const int FIELD_DAY_OF_WEEK; public const int FIELD_DAY_OF_WEEK_IN_MONTH; public const int FIELD_AM_PM; public const int FIELD_HOUR; public const int FIELD_HOUR_OF_DAY; public const int FIELD_MINUTE; public const int FIELD_SECOND; public const int FIELD_MILLISECOND; public const int FIELD_ZONE_OFFSET; public const int FIELD_DST_OFFSET; public const int FIELD_YEAR_WOY; public const int FIELD_DOW_LOCAL; public const int FIELD_EXTENDED_YEAR; public const int FIELD_JULIAN_DAY; public const int FIELD_MILLISECONDS_IN_DAY; public const int FIELD_IS_LEAP_MONTH; public const int FIELD_FIELD_COUNT; public const int FIELD_DAY_OF_MONTH; public const int DOW_SUNDAY; public const int DOW_MONDAY; public const int DOW_TUESDAY; public const int DOW_WEDNESDAY; public const int DOW_THURSDAY; public const int DOW_FRIDAY; public const int DOW_SATURDAY; public const int DOW_TYPE_WEEKDAY; public const int DOW_TYPE_WEEKEND; public const int DOW_TYPE_WEEKEND_OFFSET; public const int DOW_TYPE_WEEKEND_CEASE; public const int WALLTIME_FIRST; public const int WALLTIME_LAST; public const int WALLTIME_NEXT_VALID; /* Méthodes */ private __construct() public add(int $field, int $value): bool public after(IntlCalendar $other): bool public before(IntlCalendar $other): bool public clear(?int $field = null): true public static createInstance(IntlTimeZone|DateTimeZone|string|null $timezone = null, ?string $locale = null): ?IntlCalendar public equals(IntlCalendar $other): bool public fieldDifference(float $timestamp, int $field): int|false public static fromDateTime(DateTime|string $datetime, ?string $locale = null): ?IntlCalendar public get(int $field): int|false public getActualMaximum(int $field): int|false public getActualMinimum(int $field): int|false public static getAvailableLocales(): array public getDayOfWeekType(int $dayOfWeek): int|false public getErrorCode(): int|false public getErrorMessage(): string|false public getFirstDayOfWeek(): int|false public getGreatestMinimum(int $field): int|false public static getKeywordValuesForLocale(string $keyword, string $locale, bool $onlyCommon): IntlIterator|false public getLeastMaximum(int $field): int|false public getLocale(int $type): string|false public getMaximum(int $field): int|false public getMinimalDaysInFirstWeek(): int|false public getMinimum(int $field): int|false public static getNow(): float public getRepeatedWallTimeOption(): int public getSkippedWallTimeOption(): int public getTime(): float|false public getTimeZone(): IntlTimeZone|false public gettype(): string public getWeekendTransition(int $dayOfWeek): int|false public inDaylightTime(): bool public isEquivalentTo(IntlCalendar $other): bool public isLenient(): bool public isSet(int $field): bool public isWeekend(?float $timestamp = null): bool public roll(int $field, int|bool $value): bool public set(int $field, int $value): true public set(
    int $year,
    int $month,
    int $dayOfMonth = NULL,
    int $hour = NULL,
    int $minute = NULL,
    int $second = NULL
): true public setFirstDayOfWeek(int $dayOfWeek): true public setLenient(bool $lenient): true public setMinimalDaysInFirstWeek(int $days): true public setRepeatedWallTimeOption(int $option): true public setSkippedWallTimeOption(int $option): true public setTime(float $timestamp): bool public setTimeZone(IntlTimeZone|DateTimeZone|string|null $timezone): bool public toDateTime(): DateTime|false }

Constantes pré-définies

IntlCalendar::FIELD_ERA

Calendar field numerically representing an era, for instance 1 for AD and 0 for BC in the Gregorian/Julian calendars and 235 for the Heisei (平成) era in the Japanese calendar. Not all calendars have more than one era.

IntlCalendar::FIELD_YEAR

Calendar field for the year. This is not unique across eras. If the calendar type has more than one era, generally the minimum value for this field will be 1.

IntlCalendar::FIELD_MONTH

Calendar field for the month. The month sequence is zero-based, so January (here used to signify the first month of the calendar; this may be called another name, such as Muharram in the Islamic calendar) is represented by 0, February by 1, …, December by 11 and, for calendars that have it, the 13th or leap month by 12.

IntlCalendar::FIELD_WEEK_OF_YEAR

Calendar field for the number of the week of the year. This depends on which day of the week is deemed to start the week and the minimal number of days in a week.

IntlCalendar::FIELD_WEEK_OF_MONTH

Calendar field for the number of the week of the month. This depends on which day of the week is deemed to start the week and the minimal number of days in a week.

IntlCalendar::FIELD_DATE

Calendar field for the day of the month. The same as IntlCalendar::FIELD_DAY_OF_MONTH, which has a clearer name.

IntlCalendar::FIELD_DAY_OF_YEAR

Calendar field for the day of the year. For the Gregorian calendar, starts with 1 and ends with 365 or 366.

IntlCalendar::FIELD_DAY_OF_WEEK

Calendar field for the day of the week. Its values start with 1 (Sunday, see IntlCalendar::DOW_SUNDAY and subsequent constants) and the last valid value is 7 (Saturday).

IntlCalendar::FIELD_DAY_OF_WEEK_IN_MONTH

Given a day of the week (Sunday, Monday, …), this calendar field assigns an ordinal to such a day of the week in a specific month. Thus, if the value of this field is 1 and the value of the day of the week is 2 (Monday), then the set day of the month is the 1st Monday of the month; the maximum value is 5.

Additionally, the value 0 and negative values are also allowed. The value 0 encompasses the seven days that occur immediately before the first seven days of a month (which therefore have a ‘day of week in month’ with value 1). Negative values starts counting from the end of the month – -1 points to the last occurrence of a day of the week in a month, -2 to the second last, and so on.

Unlike IntlCalendar::FIELD_WEEK_OF_MONTH and IntlCalendar::FIELD_WEEK_OF_YEAR, this value does not depend on IntlCalendar::getFirstDayOfWeek() or on IntlCalendar::getMinimalDaysInFirstWeek(). The first Monday is the first Monday, even if it occurs in a week that belongs to the previous month.

IntlCalendar::FIELD_AM_PM

Calendar field indicating whether a time is before noon (value 0, AM) or after (1). Midnight is AM, noon is PM.

IntlCalendar::FIELD_HOUR

Calendar field for the hour, without specifying whether itʼs in the morning or in the afternoon. Valid values are 0 to 11.

IntlCalendar::FIELD_HOUR_OF_DAY

Calendar field for the full (24h) hour of the day. Valid values are 0 to 23.

IntlCalendar::FIELD_MINUTE

Calendar field for the minutes component of the time.

IntlCalendar::FIELD_SECOND

Calendar field for the seconds component of the time.

IntlCalendar::FIELD_MILLISECOND

Calendar field the milliseconds component of the time.

IntlCalendar::FIELD_ZONE_OFFSET

Calendar field indicating the raw offset of the timezone, in milliseconds. The raw offset is the timezone offset, excluding any offset due to daylight saving time.

IntlCalendar::FIELD_DST_OFFSET

Calendar field for the daylight saving time offset of the calendarʼs timezone, in milliseconds, if active for calendarʼs time.

IntlCalendar::FIELD_YEAR_WOY

Calendar field representing the year for week of year purposes.

IntlCalendar::FIELD_DOW_LOCAL

Calendar field for the localized day of the week. This is a value between 1 and 7, 1 being used for the day of the week that matches the value returned by IntlCalendar::getFirstDayOfWeek().

IntlCalendar::FIELD_EXTENDED_YEAR

Calendar field for a year number representation that is continuous across eras. For the Gregorian calendar, the value of this field matches that of IntlCalendar::FIELD_YEAR for AD years; a BC year y is represented by -y + 1.

IntlCalendar::FIELD_JULIAN_DAY

Calendar field for a modified Julian day number. It is different from a conventional Julian day number in that its transitions occur at local zone midnight rather than at noon UTC. It uniquely identifies a date.

IntlCalendar::FIELD_MILLISECONDS_IN_DAY

Calendar field encompassing the information in IntlCalendar::FIELD_HOUR_OF_DAY, IntlCalendar::FIELD_MINUTE, IntlCalendar::FIELD_SECOND and IntlCalendar::FIELD_MILLISECOND. Range is from the 0 to 24 * 3600 * 1000 - 1. It is not the amount of milliseconds elapsed in the day since on DST transitions it will have discontinuities analog to those of the wall time.

IntlCalendar::FIELD_IS_LEAP_MONTH

Calendar field whose value is 1 for indicating a leap month and 0 otherwise.

IntlCalendar::FIELD_FIELD_COUNT

The total number of fields.

IntlCalendar::FIELD_DAY_OF_MONTH

Alias for IntlCalendar::FIELD_DATE.

IntlCalendar::DOW_SUNDAY

Sunday.

IntlCalendar::DOW_MONDAY

Monday.

IntlCalendar::DOW_TUESDAY

Tuesday.

IntlCalendar::DOW_WEDNESDAY

Wednesday.

IntlCalendar::DOW_THURSDAY

Thursday.

IntlCalendar::DOW_FRIDAY

Friday.

IntlCalendar::DOW_SATURDAY

Saturday.

IntlCalendar::DOW_TYPE_WEEKDAY

Output of IntlCalendar::getDayOfWeekType() indicating a day of week is a weekday.

IntlCalendar::DOW_TYPE_WEEKEND

Output of IntlCalendar::getDayOfWeekType() indicating a day of week belongs to the weekend.

IntlCalendar::DOW_TYPE_WEEKEND_OFFSET

Output of IntlCalendar::getDayOfWeekType() indicating the weekend begins during the given day of week.

IntlCalendar::DOW_TYPE_WEEKEND_CEASE

Output of IntlCalendar::getDayOfWeekType() indicating the weekend ends during the given day of week.

IntlCalendar::WALLTIME_FIRST

Output of IntlCalendar::getSkippedWallTimeOption() indicating that wall times in the skipped range should refer to the same instant as wall times with one hour less and of IntlCalendar::getRepeatedWallTimeOption() indicating the wall times in the repeated range should refer to the instant of the first occurrence of such wall time.

IntlCalendar::WALLTIME_LAST

Output of IntlCalendar::getSkippedWallTimeOption() indicating that wall times in the skipped range should refer to the same instant as wall times with one hour after and of IntlCalendar::getRepeatedWallTimeOption() indicating the wall times in the repeated range should refer to the instant of the second occurrence of such wall time.

IntlCalendar::WALLTIME_NEXT_VALID

Output of IntlCalendar::getSkippedWallTimeOption() indicating that wall times in the skipped range should refer to the instant when the daylight saving time transition occurs (begins).

Sommaire

• IntlCalendar::add — Ajoute une durée (signée) à un champ
• IntlCalendar::after — Vérifie si l'objet temps courant est dans le futur par rapport à l'objet temps passé
• IntlCalendar::before — Vérifie si l'objet temps est dans le passé par rapport à l'objet fourni
• IntlCalendar::clear — Vide un ou tous les champs
• IntlCalendar::__construct — Constructeur privé pour la désactivation de l'instanciation
• IntlCalendar::createInstance — Crée un nouvel objet IntlCalendar
• IntlCalendar::equals — Vérifie si deux objets IntlCalendar sont égaux
• IntlCalendar::fieldDifference — Calcule la différence entre le temps donné et le temps de l'objet
• IntlCalendar::fromDateTime — Create an IntlCalendar from a DateTime object or string
• IntlCalendar::get — Récupère la valeur d'une propriété
• IntlCalendar::getActualMaximum — The maximum value for a field, considering the objectʼs current time
• IntlCalendar::getActualMinimum — The minimum value for a field, considering the objectʼs current time
• IntlCalendar::getAvailableLocales — Get array of locales for which there is data
• IntlCalendar::getDayOfWeekType — Tell whether a day is a weekday, weekend or a day that has a transition between the two
• IntlCalendar::getErrorCode — Get last error code on the object
• IntlCalendar::getErrorMessage — Get last error message on the object
• IntlCalendar::getFirstDayOfWeek — Get the first day of the week for the calendarʼs locale
• IntlCalendar::getGreatestMinimum — Get the largest local minimum value for a field
• IntlCalendar::getKeywordValuesForLocale — Get set of locale keyword values
• IntlCalendar::getLeastMaximum — Get the smallest local maximum for a field
• IntlCalendar::getLocale — Get the locale associated with the object
• IntlCalendar::getMaximum — Get the global maximum value for a field
• IntlCalendar::getMinimalDaysInFirstWeek — Get minimal number of days the first week in a year or month can have
• IntlCalendar::getMinimum — Get the global minimum value for a field
• IntlCalendar::getNow — Récupère le nombre représentant la date courante
• IntlCalendar::getRepeatedWallTimeOption — Get behavior for handling repeating wall time
• IntlCalendar::getSkippedWallTimeOption — Get behavior for handling skipped wall time
• IntlCalendar::getTime — Get time currently represented by the object
• IntlCalendar::getTimeZone — Récupère le fuseau horaire de l'objet
• IntlCalendar::getType — Récupère le type de calendrier
• IntlCalendar::getWeekendTransition — Get time of the day at which weekend begins or ends
• IntlCalendar::inDaylightTime — Whether the objectʼs time is in Daylight Savings Time
• IntlCalendar::isEquivalentTo — Whether another calendar is equal but for a different time
• IntlCalendar::isLenient — Whether date/time interpretation is in lenient mode
• IntlCalendar::isSet — Whether a field is set
• IntlCalendar::isWeekend — Whether a certain date/time is in the weekend
• IntlCalendar::roll — Add value to field without carrying into more significant fields
• IntlCalendar::set — Set a time field or several common fields at once
• IntlCalendar::setFirstDayOfWeek — Défini le jour de début de la semaine
• IntlCalendar::setLenient — Set whether date/time interpretation is to be lenient
• IntlCalendar::setMinimalDaysInFirstWeek — Set minimal number of days the first week in a year or month can have
• IntlCalendar::setRepeatedWallTimeOption — Set behavior for handling repeating wall times at negative timezone offset transitions
• IntlCalendar::setSkippedWallTimeOption — Set behavior for handling skipped wall times at positive timezone offset transitions
• IntlCalendar::setTime — Défini le temps du calendrier en milliseconde depuis l'époque
• IntlCalendar::setTimeZone — Défini le fuseau horaire utilisé par ce calendrier
• IntlCalendar::toDateTime — Converti un objet IntlCalendar en un objet DateTime