The IntlCalendar class
(PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a1)
简介
类摘要
$timezone
= null
, ?string $locale
= null
): ?IntlCalendar$keyword
, string $locale
, bool $onlyCommon
): IntlIterator|falseint
$year
,int
$month
,int
$dayOfMonth
= NULL,int
$hour
= NULL,int
$minute
= NULL,int
$second
= NULL): true
预定义常量
-
IntlCalendar::FIELD_ERA
int -
Calendar field numerically representing an era, for instance
1
for AD and0
for BC in the Gregorian/Julian calendars and235
for the Heisei (平成) era in the Japanese calendar. Not all calendars have more than one era. -
IntlCalendar::FIELD_YEAR
int -
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
int -
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 by1
, …, December by11
and, for calendars that have it, the 13th or leap month by12
. -
IntlCalendar::FIELD_WEEK_OF_YEAR
int -
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
int -
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
int -
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
int -
Calendar field for the day of the year. For the Gregorian calendar, starts with
1
and ends with365
or366
. -
IntlCalendar::FIELD_DAY_OF_WEEK
int -
Calendar field for the day of the week. Its values start with
1
(Sunday, seeIntlCalendar::DOW_SUNDAY
and subsequent constants) and the last valid value is 7 (Saturday). -
IntlCalendar::FIELD_DAY_OF_WEEK_IN_MONTH
int -
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 is2
(Monday), then the set day of the month is the 1st Monday of the month; the maximum value is5
.Additionally, the value
0
and negative values are also allowed. The value0
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 value1
). 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
andIntlCalendar::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
int -
Calendar field indicating whether a time is before noon (value
0
, AM) or after (1
). Midnight is AM, noon is PM. -
IntlCalendar::FIELD_HOUR
int -
Calendar field for the hour, without specifying whether itʼs in the morning or in the afternoon. Valid values are
0
to11
. -
IntlCalendar::FIELD_HOUR_OF_DAY
int -
Calendar field for the full (24h) hour of the day. Valid values are
0
to23
. -
IntlCalendar::FIELD_MINUTE
int -
Calendar field for the minutes component of the time.
-
IntlCalendar::FIELD_SECOND
int -
Calendar field for the seconds component of the time.
-
IntlCalendar::FIELD_MILLISECOND
int -
Calendar field the milliseconds component of the time.
-
IntlCalendar::FIELD_ZONE_OFFSET
int -
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
int -
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
int -
Calendar field representing the year for week of year purposes.
-
IntlCalendar::FIELD_DOW_LOCAL
int -
Calendar field for the localized day of the week. This is a value between
1
and7
,1
being used for the day of the week that matches the value returned by IntlCalendar::getFirstDayOfWeek(). -
IntlCalendar::FIELD_EXTENDED_YEAR
int -
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 yeary
is represented by-y + 1
. -
IntlCalendar::FIELD_JULIAN_DAY
int -
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
int -
Calendar field encompassing the information in
IntlCalendar::FIELD_HOUR_OF_DAY
,IntlCalendar::FIELD_MINUTE
,IntlCalendar::FIELD_SECOND
andIntlCalendar::FIELD_MILLISECOND
. Range is from the0
to24 * 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
int -
Calendar field whose value is
1
for indicating a leap month and0
otherwise. -
IntlCalendar::FIELD_FIELD_COUNT
int -
The total number of fields.
-
IntlCalendar::FIELD_DAY_OF_MONTH
int -
IntlCalendar::DOW_SUNDAY
int -
Sunday.
-
IntlCalendar::DOW_MONDAY
int -
Monday.
-
IntlCalendar::DOW_TUESDAY
int -
Tuesday.
-
IntlCalendar::DOW_WEDNESDAY
int -
Wednesday.
-
IntlCalendar::DOW_THURSDAY
int -
Thursday.
-
IntlCalendar::DOW_FRIDAY
int -
Friday.
-
IntlCalendar::DOW_SATURDAY
int -
Saturday.
-
IntlCalendar::DOW_TYPE_WEEKDAY
int -
Output of IntlCalendar::getDayOfWeekType() indicating a day of week is a weekday.
-
IntlCalendar::DOW_TYPE_WEEKEND
int -
Output of IntlCalendar::getDayOfWeekType() indicating a day of week belongs to the weekend.
-
IntlCalendar::DOW_TYPE_WEEKEND_OFFSET
int -
Output of IntlCalendar::getDayOfWeekType() indicating the weekend begins during the given day of week.
-
IntlCalendar::DOW_TYPE_WEEKEND_CEASE
int -
Output of IntlCalendar::getDayOfWeekType() indicating the weekend ends during the given day of week.
-
IntlCalendar::WALLTIME_FIRST
int -
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
int -
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
int -
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).
更新日志
版本 | 说明 |
---|---|
8.4.0 | The class constants are now typed. |
目录
- IntlCalendar::add — Add a (signed) amount of time to a field
- IntlCalendar::after — Whether this objectʼs time is after that of the passed object
- IntlCalendar::before — Whether this objectʼs time is before that of the passed object
- IntlCalendar::clear — Clear a field or all fields
- IntlCalendar::__construct — Private constructor for disallowing instantiation
- IntlCalendar::createInstance — Create a new IntlCalendar
- IntlCalendar::equals — Compare time of two IntlCalendar objects for equality
- IntlCalendar::fieldDifference — Calculate difference between given time and this objectʼs time
- IntlCalendar::fromDateTime — Create an IntlCalendar from a DateTime object or string
- IntlCalendar::get — Get the value for a field
- 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 — Get number representing the current time
- 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 — Get the objectʼs timezone
- IntlCalendar::getType — Get the calendar type
- 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::setDate — Set a date fields
- IntlCalendar::setDateTime — Set a date and time fields
- IntlCalendar::setFirstDayOfWeek — Set the day on which the week is deemed to start
- 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 — Set the calendar time in milliseconds since the epoch
- IntlCalendar::setTimeZone — Set the timezone used by this calendar
- IntlCalendar::toDateTime — Convert an IntlCalendar into a DateTime object
用户贡献的备注 1 note
Example obtaining a week and its boundaries (for building a calendar view):
<?php
$date = new DateTime('now');
$locale = 'en_US';
$thisWeek = IntlCalendar::fromDateTime($date, $locale);
$thisWeek->set(IntlCalendar::FIELD_DAY_OF_WEEK, $thisWeek->getFirstDayOfWeek());
// $thisWeek now points to the first day of the week
$weekStart = $thisWeek->toDateTime();
$daysToAdvance = $thisWeek->getMaximum(IntlCalendar::FIELD_DAY_OF_WEEK) - 1;
// Maximum number of days in a week minus 1 gets you to the last day
$weekEnd = $weekStart->modify("+{$daysToAdvance} days");
$previousWeek = IntlCalendar::fromDateTime($date, $locale);
$previousWeek->add(IntlCalendar::FIELD_WEEK_OF_YEAR, -1);
$previousWeek = $previousWeek->toDateTime();
$nextWeek = IntlCalendar::fromDateTime($date, $locale);
$nextWeek->add(IntlCalendar::FIELD_WEEK_OF_YEAR, 1);
$nextWeek = $nextWeek->toDateTime();
?>