INTLCALENDAR(3) 1 INTLCALENDAR(3)
The IntlCalendar class
INTRODUCTION
CLASS SYNOPSIS
IntlCalendar
IntlCalendar
Constants
o const integer$IntlCalendar::FIELD_ERA0
o const integer$IntlCalendar::FIELD_YEAR1
o const integer$IntlCalendar::FIELD_MONTH2
o const integer$IntlCalendar::FIELD_WEEK_OF_YEAR3
o const integer$IntlCalendar::FIELD_WEEK_OF_MONTH4
o const integer$IntlCalendar::FIELD_DATE5
o const integer$IntlCalendar::FIELD_DAY_OF_YEAR6
o const integer$IntlCalendar::FIELD_DAY_OF_WEEK7
o const integer$IntlCalendar::FIELD_DAY_OF_WEEK_IN_MONTH8
o const integer$IntlCalendar::FIELD_AM_PM9
o const integer$IntlCalendar::FIELD_HOUR10
o const integer$IntlCalendar::FIELD_HOUR_OF_DAY11
o const integer$IntlCalendar::FIELD_MINUTE12
o const integer$IntlCalendar::FIELD_SECOND13
o const integer$IntlCalendar::FIELD_MILLISECOND14
o const integer$IntlCalendar::FIELD_ZONE_OFFSET15
o const integer$IntlCalendar::FIELD_DST_OFFSET16
o const integer$IntlCalendar::FIELD_YEAR_WOY17
o const integer$IntlCalendar::FIELD_DOW_LOCAL18
o const integer$IntlCalendar::FIELD_EXTENDED_YEAR19
o const integer$IntlCalendar::FIELD_JULIAN_DAY20
o const integer$IntlCalendar::FIELD_MILLISECONDS_IN_DAY21
o const integer$IntlCalendar::FIELD_IS_LEAP_MONTH22
o const integer$IntlCalendar::FIELD_FIELD_COUNT 23
o const integer$IntlCalendar::FIELD_DAY_OF_MONTH5
o const integer$IntlCalendar::DOW_SUNDAY1
o const integer$IntlCalendar::DOW_MONDAY2
o const integer$IntlCalendar::DOW_TUESDAY3
o const integer$IntlCalendar::DOW_WEDNESDAY4
o const integer$IntlCalendar::DOW_THURSDAY5
o const integer$IntlCalendar::DOW_FRIDAY6
o const integer$IntlCalendar::DOW_SATURDAY7
o const integer$IntlCalendar::DOW_TYPE_WEEKDAY0
o const integer$IntlCalendar::DOW_TYPE_WEEKEND1
o const integer$IntlCalendar::DOW_TYPE_WEEKEND_OFFSET2
o const integer$IntlCalendar::DOW_TYPE_WEEKEND_CEASE3
o const integer$IntlCalendar::WALLTIME_FIRST1
o const integer$IntlCalendar::WALLTIME_LAST0
o const integer$IntlCalendar::WALLTIME_NEXT_VALID2
Methods
o public bool IntlCalendar::add (int $field, int $amount)
o
bool intlcal_add (IntlCalendar $cal, int $field, int $amount)
o public bool IntlCalendar::after (IntlCalendar $other)
o
bool intlcal_after (IntlCalendar $cal, IntlCalendar $other)
o public bool IntlCalendar::before (IntlCalendar $other)
o
bool intlcal_before (IntlCalendar $cal, IntlCalendar $other)
o public bool IntlCalendar::clear ([int $field = NULL])
o
bool intlcal_clear (IntlCalendar $cal, [int $field = NULL])
o private IntlCalendar::__construct (void )
o publicstatic IntlCalendar IntlCalendar::createInstance ([mixed $timeZone = NULL], [string $locale = ""])
o
IntlCalendar intlcal_create_instance ([mixed $timeZone = NULL], [string $locale = ""])
o public bool IntlCalendar::equals (IntlCalendar $other)
o
bool intlcal_equals (IntlCalendar $cal, IntlCalendar $other)
o public int IntlCalendar::fieldDifference (float $when, int $field)
o
int intlcal_field_difference (IntlCalendar $cal, float $when, int $field)
o publicstatic IntlCalendar IntlCalendar::fromDateTime (mixed $dateTime)
o
IntlCalendar intlcal_from_date_time (mixed $dateTime)
o public int IntlCalendar::get (int $field)
o
int intlcal_get (IntlCalendar> $cal, int $field)
o public int IntlCalendar::getActualMaximum (int $field)
o
int intlcal_get_actual_maximum (IntlCalendar $cal, int $field)
o public int IntlCalendar::getActualMinimum (int $field)
o
int intlcal_get_actual_minimum (IntlCalendar $cal, int $field)
o publicstatic array IntlCalendar::getAvailableLocales (void )
o
array intlcal_get_available_locales (void )
o public int IntlCalendar::getDayOfWeekType (int $dayOfWeek)
o
int intlcal_get_day_of_week_type (IntlCalendar $cal, int $dayOfWeek)
o public int IntlCalendar::getErrorCode (void )
o public string IntlCalendar::getErrorMessage (void )
o public int IntlCalendar::getFirstDayOfWeek (void )
o
int intlcal_get_first_day_of_week (IntlCalendar $cal)
o public int IntlCalendar::getGreatestMinimum (int $field)
o
int intlcal_get_greatest_minimum (IntlCalendar $cal, int $field)
o publicstatic Iterator IntlCalendar::getKeywordValuesForLocale (string $key, string $locale, boolean $commonlyUsed)
o
Iterator intlcal_get_keyword_values_for_locale (string $key, string $locale, boolean $commonlyUsed)
o public int IntlCalendar::getLeastMaximum (int $field)
o
int intlcal_get_least_maximum (IntlCalendar $cal, int $field)
o public string IntlCalendar::getLocale (int $localeType)
o
string intlcal_get_locale (IntlCalendar $cal, int $localeType)
o public int IntlCalendar::getMaximum (int $field)
o
int intlcal_get_maximum (IntlCalendar $cal, int $field)
o public int IntlCalendar::getMinimalDaysInFirstWeek (void )
o
int intlcal_get_minimal_days_in_first_week (IntlCalendar $cal)
o public int IntlCalendar::getMinimum (int $field)
o
int intlcal_get_minimum (IntlCalendar $cal, int $field)
o publicstatic float IntlCalendar::getNow (void )
o
float intlcal_get_now (void )
o public int IntlCalendar::getRepeatedWallTimeOption (void )
o
int intlcal_get_repeated_wall_time_option (IntlCalendar $cal)
o public int IntlCalendar::getSkippedWallTimeOption (void )
o
int intlcal_get_skipped_wall_time_option (IntlCalendar $cal)
o public float IntlCalendar::getTime (void )
o
float intlcal_get_time (IntlCalendar $cal)
o public IntlTimeZone IntlCalendar::getTimeZone (void )
o
IntlTimeZone intlcal_get_time_zone (IntlCalendar $cal)
o public string IntlCalendar::getType (void )
o
string intlcal_get_type (IntlCalendar $cal)
o public int IntlCalendar::getWeekendTransition (string $dayOfWeek)
o
int intlcal_get_weekend_transition (IntlCalendar $cal, string $dayOfWeek)
o public bool IntlCalendar::inDaylightTime (void )
o
bool intlcal_in_daylight_time (IntlCalendar $cal)
o public bool IntlCalendar::isEquivalentTo (IntlCalendar $other)
o
bool intlcal_is_equivalent_to (IntlCalendar $cal, IntlCalendar $other)
o public bool IntlCalendar::isLenient (void )
o
bool intlcal_is_lenient (IntlCalendar $cal)
o public bool IntlCalendar::isSet (int $field)
o
bool intlcal_is_set (IntlCalendar $cal, int $field)
o public bool IntlCalendar::isWeekend ([float $date = NULL])
o
bool intlcal_is_weekend (IntlCalendar $cal, [float $date = NULL])
o public bool IntlCalendar::roll (int $field, mixed $amountOrUpOrDown)
o
bool intlcal_roll (IntlCalendar $cal, int $field, mixed $amountOrUpOrDown)
o public bool IntlCalendar::set (int $field, int $value)
o public bool IntlCalendar::set (int $year, int $month, [int $dayOfMonth = NULL], [int $hour = NULL], [int $minute = NULL], [int
$second = NULL])
o
bool intlcal_set (IntlCalendar $cal, int $field, int $value)
o
bool intlcal_set (IntlCalendar $cal, int $year, int $month, [int $dayOfMonth = NULL], [int $hour = NULL], [int $minute = NULL],
[int $second = NULL])
o public bool IntlCalendar::setFirstDayOfWeek (int $dayOfWeek)
o
bool intlcal_set_first_day_of_week (IntlCalendar $cal, int $dayOfWeek)
o public ReturnType IntlCalendar::setLenient (string $isLenient)
o
ReturnType intlcal_set_lenient (IntlCalendar $cal, string $isLenient)
o public bool IntlCalendar::setMinimalDaysInFirstWeek (int $minimalDays)
o
bool intlcal_get_minimal_days_in_first_week (IntlCalendar $cal, int $minimalDays)
o public bool IntlCalendar::setRepeatedWallTimeOption (int $wallTimeOption)
o
bool intlcal_set_repeated_wall_time_option (IntlCalendar $cal, int $wallTimeOption)
o public bool IntlCalendar::setSkippedWallTimeOption (int $wallTimeOption)
o
bool intlcal_set_skipped_wall_time_option (IntlCalendar $cal, int $wallTimeOption)
o public bool IntlCalendar::setTime (float $date)
o
bool intlcal_set_time (IntlCalendar $cal, float $date)
o public bool IntlCalendar::setTimeZone (mixed $timeZone)
o
bool intlcal_set_time_zone (IntlCalendar $cal, mixed $timeZone)
o public DateTime IntlCalendar::toDateTime (void )
o
DateTime intlcal_to_date_time (IntlCalendar $cal)
PREDEFINED CONSTANTS
o IntlCalendar::FIELD_ERA - Calendar field numerically representing an era, for instance 1 for AD and 0 for BC in the Grego-
rian/Julian calendars and 235 for the Heisei () era in the Japanese calendar. Not all calendars have more than one era.
o 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.
o IntlCalendar::FIELD_MONTH - Calendar field for the month. The month sequence is zero-based, so Janurary (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, Feb-
ruary by 1, , December by 11 and, for calendars that have it, the 13th or leap month by 12.
o 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.
o 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.
o IntlCalendar::FIELD_DATE - Calendar field for the day of the month. The same as IntlCalendar::FIELD_DAY_OF_MONTH, which has a
clearer name.
o 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.
o IntlCalendar::FIELD_DAY_OF_WEEK - Calendar field for the day of the week. Its values start with 1 (Sunday, see IntlCalen-
dar::DOW_SUNDAY and subsequent constants) and the last valid value is 7 (Saturday).
o 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 (Mon-
day), then the set day of the month is the 1st Monday of the month; the maximum value is 5. Additionally, the value 0 and nega-
tive 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 IntlCalen-
dar::FIELD_WEEK_OF_MONTH and IntlCalendar::FIELD_WEEK_OF_YEAR, this value does not depend on IntlCalendar.getFirstDayOfWeek(3) or
on IntlCalendar.getMinimalDaysInFirstWeek(3). The first Monday is the first Monday, even if it occurs in a week that belongs to
the previous month.
o 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.
o IntlCalendar::FIELD_HOUR - Calendar field for the hour, without specifying whether its in the morning or in the afternoon. Valid
values are 0 to 11.
o IntlCalendar::FIELD_HOUR_OF_DAY - Calendar field for the full (24h) hour of the day. Valid values are 0 to 23.
o IntlCalendar::FIELD_MINUTE - Calendar field for the minutes component of the time.
o IntlCalendar::FIELD_SECOND - Calendar field for the seconds component of the time.
o IntlCalendar::FIELD_MILLISECOND - Calendar field the milliseconds component of the time.
o 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.
o IntlCalendar::FIELD_DST_OFFSET - Calendar field for the daylight saving time offset of the calendars timezone, in milliseconds, if
active for calendars time.
o IntlCalendar::FIELD_YEAR_WOY - Calendar field representing the year for week of year purposes.
o IntlCalendar::FIELD_DOW_LOCAL - Calendar field for the localized day of the week. This is a value betwen 1 and 7, 1 being used for
the day of the week that matches the value returned by IntlCalendar.getFirstDayOfWeek(3).
o IntlCalendar::FIELD_EXTENDED_YEAR - Calendar field for a year number representation that is continuous across eras. For the Grego-
rian calendar, the value of this field matches that of IntlCalendar::FIELD_YEAR for AD years; a BC year y is represented by -y +
1.
o 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.
o IntlCalendar::FIELD_MILLISECONDS_IN_DAY - Calendar field encompassing the information in IntlCalendar::FIELD_HOUR_OF_DAY, IntlCal-
endar::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 ellapsed in the day since on DST transitions it will have discontinuities analog to those of
the wall time.
o IntlCalendar::FIELD_IS_LEAP_MONTH - Calendar field whose value is 1 for indicating a leap month and 0 otherwise.
o IntlCalendar::FIELD_FIELD_COUNT - The total number of fields.
o IntlCalendar::FIELD_DAY_OF_MONTH - Alias for IntlCalendar::FIELD_DATE.
o IntlCalendar::DOW_SUNDAY -Sunday.
o IntlCalendar::DOW_MONDAY -Monday.
o IntlCalendar::DOW_TUESDAY -Tuesday.
o IntlCalendar::DOW_WEDNESDAY -Wednesday.
o IntlCalendar::DOW_THURSDAY -Thursday.
o IntlCalendar::DOW_FRIDAY -Friday.
o IntlCalendar::DOW_SATURDAY -Saturday.
o IntlCalendar::DOW_TYPE_WEEKDAY - Output of IntlCalendar.getDayOfWeekType(3) indicating a day of week is a weekday.
o IntlCalendar::DOW_TYPE_WEEKEND - Output of IntlCalendar.getDayOfWeekType(3) indicating a day of week belongs to the weekend.
o IntlCalendar::DOW_TYPE_WEEKEND_OFFSET - Output of IntlCalendar.getDayOfWeekType(3) indicating the weekend begins during the given
day of week.
o IntlCalendar::DOW_TYPE_WEEKEND_CEASE - Output of IntlCalendar.getDayOfWeekType(3) indicating the weekend ends during the given day
of week.
o IntlCalendar::WALLTIME_FIRST - Output of IntlCalendar.getSkippedWallTimeOption(3) 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(3) indicating the
wall times in the repeated range should refer to the instant of the first occurrence of such wall time.
o IntlCalendar::WALLTIME_LAST - Output of IntlCalendar.getSkippedWallTimeOption(3) 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(3) indicating the
wall times in the repeated range should refer to the instant of the second occurrence of such wall time.
o IntlCalendar::WALLTIME_NEXT_VALID - Output of IntlCalendar.getSkippedWallTimeOption(3) indicating that wall times in the skipped
range should refer to the instant when the daylight saving time transition occurs (begins).
PHP Documentation Group INTLCALENDAR(3)