diff --git a/reference/intl/book.xml b/reference/intl/book.xml index 3995c1ed54..c886be0437 100644 --- a/reference/intl/book.xml +++ b/reference/intl/book.xml @@ -95,6 +95,7 @@ &reference.intl.locale; &reference.intl.normalizer; &reference.intl.messageformatter; + &reference.intl.intlcalendar; &reference.intl.dateformatter; &reference.intl.resourcebundle; &reference.intl.spoofchecker; diff --git a/reference/intl/intlcalendar.xml b/reference/intl/intlcalendar.xml new file mode 100644 index 0000000000..93cd48d507 --- /dev/null +++ b/reference/intl/intlcalendar.xml @@ -0,0 +1,585 @@ + + + + + + The IntlCalendar class + IntlCalendar + + + + +
+ &reftitle.intro; + + + +
+ + +
+ &reftitle.classsynopsis; + + + + IntlCalendar + + + + + IntlCalendar + + + + Constants + + const + integer + IntlCalendar::FIELD_ERA + 0 + + + const + integer + IntlCalendar::FIELD_YEAR + 1 + + + const + integer + IntlCalendar::FIELD_MONTH + 2 + + + const + integer + IntlCalendar::FIELD_WEEK_OF_YEAR + 3 + + + const + integer + IntlCalendar::FIELD_WEEK_OF_MONTH + 4 + + + const + integer + IntlCalendar::FIELD_DATE + 5 + + + const + integer + IntlCalendar::FIELD_DAY_OF_YEAR + 6 + + + const + integer + IntlCalendar::FIELD_DAY_OF_WEEK + 7 + + + const + integer + IntlCalendar::FIELD_DAY_OF_WEEK_IN_MONTH + 8 + + + const + integer + IntlCalendar::FIELD_AM_PM + 9 + + + const + integer + IntlCalendar::FIELD_HOUR + 10 + + + const + integer + IntlCalendar::FIELD_HOUR_OF_DAY + 11 + + + const + integer + IntlCalendar::FIELD_MINUTE + 12 + + + const + integer + IntlCalendar::FIELD_SECOND + 13 + + + const + integer + IntlCalendar::FIELD_MILLISECOND + 14 + + + const + integer + IntlCalendar::FIELD_ZONE_OFFSET + 15 + + + const + integer + IntlCalendar::FIELD_DST_OFFSET + 16 + + + const + integer + IntlCalendar::FIELD_YEAR_WOY + 17 + + + const + integer + IntlCalendar::FIELD_DOW_LOCAL + 18 + + + const + integer + IntlCalendar::FIELD_EXTENDED_YEAR + 19 + + + const + integer + IntlCalendar::FIELD_JULIAN_DAY + 20 + + + const + integer + IntlCalendar::FIELD_MILLISECONDS_IN_DAY + 21 + + + const + integer + IntlCalendar::FIELD_IS_LEAP_MONTH + 22 + + + const + integer + IntlCalendar::FIELD_FIELD_COUNT + 23 + + + const + integer + IntlCalendar::FIELD_DAY_OF_MONTH + 5 + + + const + integer + IntlCalendar::DOW_SUNDAY + 1 + + + const + integer + IntlCalendar::DOW_MONDAY + 2 + + + const + integer + IntlCalendar::DOW_TUESDAY + 3 + + + const + integer + IntlCalendar::DOW_WEDNESDAY + 4 + + + const + integer + IntlCalendar::DOW_THURSDAY + 5 + + + const + integer + IntlCalendar::DOW_FRIDAY + 6 + + + const + integer + IntlCalendar::DOW_SATURDAY + 7 + + + const + integer + IntlCalendar::DOW_TYPE_WEEKDAY + 0 + + + const + integer + IntlCalendar::DOW_TYPE_WEEKEND + 1 + + + const + integer + IntlCalendar::DOW_TYPE_WEEKEND_OFFSET + 2 + + + const + integer + IntlCalendar::DOW_TYPE_WEEKEND_CEASE + 3 + + + const + integer + IntlCalendar::WALLTIME_FIRST + 1 + + + const + integer + IntlCalendar::WALLTIME_LAST + 0 + + + const + integer + IntlCalendar::WALLTIME_NEXT_VALID + 2 + + + &Methods; + + + + +
+ + +
+ &reftitle.constants; + + + + IntlCalendar::FIELD_ERA + + + + + + + IntlCalendar::FIELD_YEAR + + + + + + + IntlCalendar::FIELD_MONTH + + + + + + + IntlCalendar::FIELD_WEEK_OF_YEAR + + + + + + + IntlCalendar::FIELD_WEEK_OF_MONTH + + + + + + + IntlCalendar::FIELD_DATE + + + + + + + IntlCalendar::FIELD_DAY_OF_YEAR + + + + + + + IntlCalendar::FIELD_DAY_OF_WEEK + + + + + + + IntlCalendar::FIELD_DAY_OF_WEEK_IN_MONTH + + + + + + + IntlCalendar::FIELD_AM_PM + + + + + + + IntlCalendar::FIELD_HOUR + + + + + + + IntlCalendar::FIELD_HOUR_OF_DAY + + + + + + + IntlCalendar::FIELD_MINUTE + + + + + + + IntlCalendar::FIELD_SECOND + + + + + + + IntlCalendar::FIELD_MILLISECOND + + + + + + + IntlCalendar::FIELD_ZONE_OFFSET + + + + + + + IntlCalendar::FIELD_DST_OFFSET + + + + + + + IntlCalendar::FIELD_YEAR_WOY + + + + + + + IntlCalendar::FIELD_DOW_LOCAL + + + + + + + IntlCalendar::FIELD_EXTENDED_YEAR + + + + + + + IntlCalendar::FIELD_JULIAN_DAY + + + + + + + IntlCalendar::FIELD_MILLISECONDS_IN_DAY + + + + + + + IntlCalendar::FIELD_IS_LEAP_MONTH + + + + + + + IntlCalendar::FIELD_FIELD_COUNT + + + + + + + IntlCalendar::FIELD_DAY_OF_MONTH + + + + + + + IntlCalendar::DOW_SUNDAY + + + + + + + IntlCalendar::DOW_MONDAY + + + + + + + IntlCalendar::DOW_TUESDAY + + + + + + + IntlCalendar::DOW_WEDNESDAY + + + + + + + IntlCalendar::DOW_THURSDAY + + + + + + + IntlCalendar::DOW_FRIDAY + + + + + + + IntlCalendar::DOW_SATURDAY + + + + + + + IntlCalendar::DOW_TYPE_WEEKDAY + + + + + + + IntlCalendar::DOW_TYPE_WEEKEND + + + + + + + IntlCalendar::DOW_TYPE_WEEKEND_OFFSET + + + + + + + IntlCalendar::DOW_TYPE_WEEKEND_CEASE + + + + + + + IntlCalendar::WALLTIME_FIRST + + + + + + + IntlCalendar::WALLTIME_LAST + + + + + + + IntlCalendar::WALLTIME_NEXT_VALID + + + + + + +
+ + + + + + &reference.intl.entities.intlcalendar; + + + + diff --git a/reference/intl/intlcalendar/add.xml b/reference/intl/intlcalendar/add.xml new file mode 100644 index 0000000000..9e34ce4234 --- /dev/null +++ b/reference/intl/intlcalendar/add.xml @@ -0,0 +1,76 @@ + + + + + + IntlCalendar::add + Add a (signed) amount of time to a field + + + + &reftitle.description; + + public boolIntlCalendar::add + intfield + intamount + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + field + + + + + + + + amount + + + + + + + + + + + &reftitle.returnvalues; + + Returns &true; on success&return.falseforfailure;. + + + + + + + diff --git a/reference/intl/intlcalendar/after.xml b/reference/intl/intlcalendar/after.xml new file mode 100644 index 0000000000..61b635e818 --- /dev/null +++ b/reference/intl/intlcalendar/after.xml @@ -0,0 +1,71 @@ + + + + + + IntlCalendar::after + Whether this objectʼs time is after that of the passed object + + + + &reftitle.description; + + public boolIntlCalendar::after + IntlCalendarcalendar + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + calendar + + + + + + + + + + + &reftitle.returnvalues; + + Returns &true; if this objectʼs current time is after that of the + calendar argumentʼs time. Returns &false; otherwise. + Also returns &false; on failure, but this can only happen if the arguments + are invalid. In any case, it is possible to disambiguate using + IntlCalendar::getErrorCode. + + + + + + + diff --git a/reference/intl/intlcalendar/before.xml b/reference/intl/intlcalendar/before.xml new file mode 100644 index 0000000000..2964fdabff --- /dev/null +++ b/reference/intl/intlcalendar/before.xml @@ -0,0 +1,71 @@ + + + + + + IntlCalendar::before + Whether this objectʼs time is before that of the passed object + + + + &reftitle.description; + + public boolIntlCalendar::before + IntlCalendarcalendar + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + calendar + + + + + + + + + + + &reftitle.returnvalues; + + Returns &true; if this objectʼs current time is after that of the + calendar argumentʼs time. Returns &false; otherwise. + Also returns &false; on failure, but this can only happen if the arguments + are invalid. In any case, it is possible to disambiguate using + IntlCalendar::getErrorCode. + + + + + + + diff --git a/reference/intl/intlcalendar/clear.xml b/reference/intl/intlcalendar/clear.xml new file mode 100644 index 0000000000..bf780c68f9 --- /dev/null +++ b/reference/intl/intlcalendar/clear.xml @@ -0,0 +1,68 @@ + + + + + + IntlCalendar::clear + Clear a field or all fields + + + + &reftitle.description; + + public boolIntlCalendar::clear + intfieldNULL + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + field + + + + + + + + + + + &reftitle.returnvalues; + + Returns &true; on success&return.falseforfailure;. Failure can only occur is + invalid arguments are provided. + + + + + + + diff --git a/reference/intl/intlcalendar/construct.xml b/reference/intl/intlcalendar/construct.xml new file mode 100644 index 0000000000..28ccb75ada --- /dev/null +++ b/reference/intl/intlcalendar/construct.xml @@ -0,0 +1,58 @@ + + + + + + IntlCalendar::__construct + Private constructor for disallowing instantiation + + + + &reftitle.description; + + private IntlCalendar::__construct + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + &return.void; + + + + + + + diff --git a/reference/intl/intlcalendar/createinstance.xml b/reference/intl/intlcalendar/createinstance.xml new file mode 100644 index 0000000000..febcac2e18 --- /dev/null +++ b/reference/intl/intlcalendar/createinstance.xml @@ -0,0 +1,77 @@ + + + + + + IntlCalendar::createInstance + Create a new IntlCalendar + + + + &reftitle.description; + + public static IntlCalendarIntlCalendar::createInstance + mixedtimeZoneNULL + stringlocaleNULL + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + timeZone + + + + + + + + locale + + + + + + + + + + + &reftitle.returnvalues; + + The created IntlCalendar instance or &null; on + failure. + + + + + + + diff --git a/reference/intl/intlcalendar/equals.xml b/reference/intl/intlcalendar/equals.xml new file mode 100644 index 0000000000..57698ef763 --- /dev/null +++ b/reference/intl/intlcalendar/equals.xml @@ -0,0 +1,71 @@ + + + + + + IntlCalendar::equals + Compare time of two IntlCalendar objects for equality + + + + &reftitle.description; + + public boolIntlCalendar::equals + IntlCalendarcalendar + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + calendar + + + + + + + + + + + &reftitle.returnvalues; + + Returns &true; if the current time of both this and the passed in + IntlCalendar object are the same, or &false; + otherwise. The value &false; can also be returned on failure. This can only + happen if bad arguments are passed in. In any case, the two cases can be + distinguished by calling IntlCalendar::getErrorCode. + + + + + + + diff --git a/reference/intl/intlcalendar/fielddifference.xml b/reference/intl/intlcalendar/fielddifference.xml new file mode 100644 index 0000000000..4b8fe545ee --- /dev/null +++ b/reference/intl/intlcalendar/fielddifference.xml @@ -0,0 +1,77 @@ + + + + + + IntlCalendar::fieldDifference + Calculate difference between given time and this objectʼs time + + + + &reftitle.description; + + public intIntlCalendar::fieldDifference + floatwhen + intfield + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + when + + + + + + + + field + + + + + + + + + + + &reftitle.returnvalues; + + Returns a (signed) difference of time in the unit associated with the + specified field&return.falseforfailure;. + + + + + + + diff --git a/reference/intl/intlcalendar/fromdatetime.xml b/reference/intl/intlcalendar/fromdatetime.xml new file mode 100644 index 0000000000..8735f67133 --- /dev/null +++ b/reference/intl/intlcalendar/fromdatetime.xml @@ -0,0 +1,68 @@ + + + + + + IntlCalendar::fromDateTime + Create an IntlCalendar from a DateTime object or string + + + + &reftitle.description; + + public static IntlCalendarIntlCalendar::fromDateTime + mixeddateTime + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + dateTime + + + + + + + + + + + &reftitle.returnvalues; + + The created IntlCalendar + object&return.falseforfailure;. + + + + + + + diff --git a/reference/intl/intlcalendar/get.xml b/reference/intl/intlcalendar/get.xml new file mode 100644 index 0000000000..c402a7c27c --- /dev/null +++ b/reference/intl/intlcalendar/get.xml @@ -0,0 +1,67 @@ + + + + + + IntlCalendar::get + Get the value for a field + + + + &reftitle.description; + + public intIntlCalendar::get + intfield + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + field + + + + + + + + + + + &reftitle.returnvalues; + + An integer with the value of the time field. + + + + + + + diff --git a/reference/intl/intlcalendar/getactualmaximum.xml b/reference/intl/intlcalendar/getactualmaximum.xml new file mode 100644 index 0000000000..141557d8ca --- /dev/null +++ b/reference/intl/intlcalendar/getactualmaximum.xml @@ -0,0 +1,67 @@ + + + + + + IntlCalendar::getActualMaximum + The maximum value for a field, considering the objectʼs current time + + + + &reftitle.description; + + public intIntlCalendar::getActualMaximum + intfield + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + field + + + + + + + + + + + &reftitle.returnvalues; + + An int representing the maximum value&return.falseforfailure;. + + + + + + + diff --git a/reference/intl/intlcalendar/getactualminimum.xml b/reference/intl/intlcalendar/getactualminimum.xml new file mode 100644 index 0000000000..3160f4d4d4 --- /dev/null +++ b/reference/intl/intlcalendar/getactualminimum.xml @@ -0,0 +1,67 @@ + + + + + + IntlCalendar::getActualMinimum + The minimum value for a field, considering the objectʼs current time + + + + &reftitle.description; + + public intIntlCalendar::getActualMinimum + intfield + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + field + + + + + + + + + + + &reftitle.returnvalues; + + An int representing the minimum value&return.falseforfailure;. + + + + + + + diff --git a/reference/intl/intlcalendar/getavailablelocales.xml b/reference/intl/intlcalendar/getavailablelocales.xml new file mode 100644 index 0000000000..7b7c781b76 --- /dev/null +++ b/reference/intl/intlcalendar/getavailablelocales.xml @@ -0,0 +1,58 @@ + + + + + + IntlCalendar::getAvailableLocales + Get array of locales for which there is data + + + + &reftitle.description; + + public static arrayIntlCalendar::getAvailableLocales + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + An array of strings, one for which locale. + + + + + + + diff --git a/reference/intl/intlcalendar/getdayofweektype.xml b/reference/intl/intlcalendar/getdayofweektype.xml new file mode 100644 index 0000000000..d69db34a24 --- /dev/null +++ b/reference/intl/intlcalendar/getdayofweektype.xml @@ -0,0 +1,141 @@ + + + + + + IntlCalendar::getDayOfWeekType + Tell whether a day is a weekday, weekend or a day that has a transition between the two + + + + &reftitle.description; + + public intIntlCalendar::getDayOfWeekType + intdayOfWeek + + + Returns whether the passed day is a weekday + (IntlCalendar::DOW_TYPE_WEEKDAY), a weekend day + (IntlCalendar::DOW_TYPE_WEEKEND), a day during which a + transition occurs into the weekend + (IntlCalendar::DOW_TYPE_WEEKEND_OFFSET) or a day during + which the weekend ceases + (IntlCalendar::DOW_TYPE_WEEKEND_CEASE). + + + If the return is either + IntlCalendar::DOW_TYPE_WEEKEND_OFFSET or + IntlCalendar::DOW_TYPE_WEEKEND_CEASE, then + IntlCalendar::getWeekendTransition can be called to + obtain the time of the transition. + + + This function requires ICU 4.4 or later. + + + + + + &reftitle.parameters; + + + dayOfWeek + + + One of the constants IntlCalendar::DOW_SUNDAY, + IntlCalendar::DOW_MONDAY, …, + IntlCalendar::DOW_SATURDAY. + + + + + + + + &reftitle.returnvalues; + + Returns one of the constants + IntlCalendar::DOW_TYPE_WEEKDAY, + IntlCalendar::DOW_TYPE_WEEKEND, + IntlCalendar::DOW_TYPE_WEEKEND_OFFSET or + IntlCalendar::DOW_TYPE_WEEKEND_CEASE&return.falseforfailure;. + + + + + + &reftitle.examples; + + + <function>IntlCalendar::getDayOfWeekType</function> + +getDayOfWeekType($i), " ", + $cal->getDayOfWeekType($i) >= IntlCalendar::DOW_TYPE_WEEKEND_OFFSET + ? $cal->getWeekendTransition($i) + : '', + "\n"; + } + echo "\n"; +} + + +]]> + + &example.outputs; + + + + + + + + + + diff --git a/reference/intl/intlcalendar/geterrorcode.xml b/reference/intl/intlcalendar/geterrorcode.xml new file mode 100644 index 0000000000..c014b4a0ae --- /dev/null +++ b/reference/intl/intlcalendar/geterrorcode.xml @@ -0,0 +1,74 @@ + + + + + + IntlCalendar::getErrorCode + intlcal_get_error_code + Get last error code on the object + + + + &reftitle.description; + &style.oop; (method): + + public intIntlCalendar::getErrorCode + + + &style.procedural;: + + intintlcal_get_error_code + IntlCalendarcalendar + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + calendar + + + The calendar object, on the procedural style interface. + + + + + + + + &reftitle.returnvalues; + + An ICU error code indicating either success, failure or a warning. + + + + + + + diff --git a/reference/intl/intlcalendar/geterrormessage.xml b/reference/intl/intlcalendar/geterrormessage.xml new file mode 100644 index 0000000000..ea586eaf43 --- /dev/null +++ b/reference/intl/intlcalendar/geterrormessage.xml @@ -0,0 +1,108 @@ + + + + + + IntlCalendar::getErrorMessage + intlcal_get_error_message + Get last error message on the object + + + + &reftitle.description; + &style.oop; (method): + + public stringIntlCalendar::getErrorMessage + + + &style.procedural;: + + stringintlcal_get_error_message + IntlCalendarcalendar + + + Returns the error message associated with the last error error that occurred + on a method call on this object, in any of the alternative functions that + take an IntlCalendar as its first argument or in some + other contexts such as cloning. However, invalid argument errors on the PHP + side do not set any error retrievable through this function (only through the + global intl_get_error_message. + + + The message generally includes a string representation of an ICU error code + (its constant name) and a message set on the side of the PHP binding. + + + + + + &reftitle.parameters; + + + calendar + + + The calendar object, on the procedural style interface. + + + + + + + + &reftitle.returnvalues; + + The error message associated with last error that occurred in a function call + on this object, or a string indicating the non-existance of an error. + + + + + &reftitle.examples; + + + <function>XXX</function> examples + +getErrorMessage()); + +$cal->getWeekendTransition(IntlCalendar::DOW_WEDNESDAY); +var_dump($cal->getErrorMessage()); + +]]> + + &example.outputs; + + + + + + + + + + diff --git a/reference/intl/intlcalendar/getfirstdayofweek.xml b/reference/intl/intlcalendar/getfirstdayofweek.xml new file mode 100644 index 0000000000..c0f126f0c1 --- /dev/null +++ b/reference/intl/intlcalendar/getfirstdayofweek.xml @@ -0,0 +1,60 @@ + + + + + + IntlCalendar::getFirstDayOfWeek + Get the first day of the week for the calendarʼs locale + + + + &reftitle.description; + + public intIntlCalendar::getFirstDayOfWeek + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + One of the constants IntlCalendar::DOW_SUNDAY, + IntlCalendar::DOW_MONDAY, …, + IntlCalendar::DOW_SATURDAY&return.falseforfailure;. + + + + + + + diff --git a/reference/intl/intlcalendar/getgreatestminimum.xml b/reference/intl/intlcalendar/getgreatestminimum.xml new file mode 100644 index 0000000000..75944de7c4 --- /dev/null +++ b/reference/intl/intlcalendar/getgreatestminimum.xml @@ -0,0 +1,68 @@ + + + + + + IntlCalendar::getGreatestMinimum + Get the largest local minimum value for a field + + + + &reftitle.description; + + public intIntlCalendar::getGreatestMinimum + intfield + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + field + + + + + + + + + + + &reftitle.returnvalues; + + The globally smaller value a field can have; an integer. Returns &false; on + failure. + + + + + + + diff --git a/reference/intl/intlcalendar/getkeywordvaluesforlocale.xml b/reference/intl/intlcalendar/getkeywordvaluesforlocale.xml new file mode 100644 index 0000000000..743f047c9e --- /dev/null +++ b/reference/intl/intlcalendar/getkeywordvaluesforlocale.xml @@ -0,0 +1,141 @@ + + + + + + IntlCalendar::getKeywordValuesForLocale + Get set of locale keyword values + + + + &reftitle.description; + + public static IteratorIntlCalendar::getKeywordValuesForLocale + stringkey + stringlocale + booleancommonlyUsed + + + For a given locale key, get the set of values for that key that would result + in a different behavior. For now, only the 'calendar' + keyword is supported. + + + + + + &reftitle.parameters; + + + key + + + The locale keyword for which relevant values are to be queried. Only + 'calendar' is supported. + + + + + locale + + + The locale onto which the keyword/value pair are to be appended. + + + + + commonlyUsed + + + Whether to show only the values commonly used for the specified locale. + + + + + + + + &reftitle.returnvalues; + + An iterator that yields strings with the locale keyword + values&return.falseforfailure;. + + + + + &reftitle.examples; + + + <function>IntlCalendar::getKeyworkValuesForLocale</function> + + + + &example.outputs; + + persian + [1] => gregorian + [2] => islamic + [3] => islamic-civil +) +Array +( + [0] => persian + [1] => gregorian + [2] => islamic + [3] => islamic-civil + [4] => japanese + [5] => buddhist + [6] => roc + [7] => hebrew + [8] => chinese + [9] => indian + [10] => coptic + [11] => ethiopic + [12] => ethiopic-amete-alem +) + +]]> + + + + + + + + diff --git a/reference/intl/intlcalendar/getleastmaximum.xml b/reference/intl/intlcalendar/getleastmaximum.xml new file mode 100644 index 0000000000..bff466e455 --- /dev/null +++ b/reference/intl/intlcalendar/getleastmaximum.xml @@ -0,0 +1,67 @@ + + + + + + IntlCalendar::getLeastMaximum + Get the smallest local maximum for a field + + + + &reftitle.description; + + public intIntlCalendar::getLeastMaximum + intfield + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + field + + + + + + + + + + + &reftitle.returnvalues; + + An int representing a field value&return.falseforfailure;. + + + + + + + diff --git a/reference/intl/intlcalendar/getlocale.xml b/reference/intl/intlcalendar/getlocale.xml new file mode 100644 index 0000000000..8f7240f805 --- /dev/null +++ b/reference/intl/intlcalendar/getlocale.xml @@ -0,0 +1,67 @@ + + + + + + IntlCalendar::getLocale + Get the locale associated with the object + + + + &reftitle.description; + + public stringIntlCalendar::getLocale + intlocaleType + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + localeType + + + + + + + + + + + &reftitle.returnvalues; + + A locale string&return.falseforfailure;. + + + + + + + diff --git a/reference/intl/intlcalendar/getmaximum.xml b/reference/intl/intlcalendar/getmaximum.xml new file mode 100644 index 0000000000..df595b818b --- /dev/null +++ b/reference/intl/intlcalendar/getmaximum.xml @@ -0,0 +1,67 @@ + + + + + + IntlCalendar::getMaximum + Get the global maximum value for a field + + + + &reftitle.description; + + public intIntlCalendar::getMaximum + intfield + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + field + + + + + + + + + + + &reftitle.returnvalues; + + An int representing a field value&return.falseforfailure;. + + + + + + + diff --git a/reference/intl/intlcalendar/getminimaldaysinfirstweek.xml b/reference/intl/intlcalendar/getminimaldaysinfirstweek.xml new file mode 100644 index 0000000000..360f9fdb69 --- /dev/null +++ b/reference/intl/intlcalendar/getminimaldaysinfirstweek.xml @@ -0,0 +1,58 @@ + + + + + + IntlCalendar::getMinimalDaysInFirstWeek + Get minimal number of days the first week in a year can have + + + + &reftitle.description; + + public intIntlCalendar::getMinimalDaysInFirstWeek + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + An int representing a number of days&return.falseforfailure;. + + + + + + + diff --git a/reference/intl/intlcalendar/getminimum.xml b/reference/intl/intlcalendar/getminimum.xml new file mode 100644 index 0000000000..8033473593 --- /dev/null +++ b/reference/intl/intlcalendar/getminimum.xml @@ -0,0 +1,68 @@ + + + + + + IntlCalendar::getMinimum + Get the global minimum value for a field + + + + &reftitle.description; + + public intIntlCalendar::getMinimum + intfield + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + field + + + + + + + + + + + &reftitle.returnvalues; + + An int representing a value for the given + field&return.falseforfailure;. + + + + + + + diff --git a/reference/intl/intlcalendar/getnow.xml b/reference/intl/intlcalendar/getnow.xml new file mode 100644 index 0000000000..6195ec7180 --- /dev/null +++ b/reference/intl/intlcalendar/getnow.xml @@ -0,0 +1,88 @@ + + + + + + IntlCalendar::getNow + Get number representing the current time + + + + &reftitle.description; + + public static floatIntlCalendar::getNow + + + + The number of milliseconds that have passed since the reference date. This + number is derived from the system time. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + A float representing a number of milliseconds since the epoch. + + + + + + &reftitle.examples; + + + <function>IntlCalendar::getNow</function> + +format(IntlCalendar::getNow() / 1000.), "\n"; + +]]> + + &example.outputs; + + + + + + + + + + diff --git a/reference/intl/intlcalendar/getrepeatedwalltimeoption.xml b/reference/intl/intlcalendar/getrepeatedwalltimeoption.xml new file mode 100644 index 0000000000..fea4885900 --- /dev/null +++ b/reference/intl/intlcalendar/getrepeatedwalltimeoption.xml @@ -0,0 +1,59 @@ + + + + + + IntlCalendar::getRepeatedWallTimeOption + Get behavior for handling repeating wall time + + + + &reftitle.description; + + public intIntlCalendar::getRepeatedWallTimeOption + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + One of the constants IntlCalendar::WALLTIME_FIRST or + IntlCalendar::WALLTIME_LAST. + + + + + + + diff --git a/reference/intl/intlcalendar/getskippedwalltimeoption.xml b/reference/intl/intlcalendar/getskippedwalltimeoption.xml new file mode 100644 index 0000000000..b328dbb6db --- /dev/null +++ b/reference/intl/intlcalendar/getskippedwalltimeoption.xml @@ -0,0 +1,60 @@ + + + + + + IntlCalendar::getSkippedWallTimeOption + Get behavior for handling skipped wall time + + + + &reftitle.description; + + public intIntlCalendar::getSkippedWallTimeOption + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + One of the constants IntlCalendar::WALLTIME_FIRST, + IntlCalendar::WALLTIME_LAST or + IntlCalendar::WALLTIME_NEXT_VALID. + + + + + + + diff --git a/reference/intl/intlcalendar/gettime.xml b/reference/intl/intlcalendar/gettime.xml new file mode 100644 index 0000000000..4cc756cff8 --- /dev/null +++ b/reference/intl/intlcalendar/gettime.xml @@ -0,0 +1,59 @@ + + + + + + IntlCalendar::getTime + Get time currently represented by the object + + + + &reftitle.description; + + public floatIntlCalendar::getTime + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + A float represeting the number of milliseconds elapsed since the + reference time (1 Jan 1970 UTC). + + + + + + + diff --git a/reference/intl/intlcalendar/gettimezone.xml b/reference/intl/intlcalendar/gettimezone.xml new file mode 100644 index 0000000000..d1b6dd0523 --- /dev/null +++ b/reference/intl/intlcalendar/gettimezone.xml @@ -0,0 +1,59 @@ + + + + + + IntlCalendar::getTimeZone + Get the objectʼs timezone + + + + &reftitle.description; + + public IntlTimeZoneIntlCalendar::getTimeZone + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + An IntlTimeZone object corresponding to the one used + internally in this object. + + + + + + + diff --git a/reference/intl/intlcalendar/gettype.xml b/reference/intl/intlcalendar/gettype.xml new file mode 100644 index 0000000000..3d26417b9f --- /dev/null +++ b/reference/intl/intlcalendar/gettype.xml @@ -0,0 +1,59 @@ + + + + + + IntlCalendar::getType + Get the calendar type + + + + &reftitle.description; + + public stringIntlCalendar::getType + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + A string representing the calendar type, such as + 'gregorian', islamic, etc. + + + + + + + diff --git a/reference/intl/intlcalendar/getweekendtransition.xml b/reference/intl/intlcalendar/getweekendtransition.xml new file mode 100644 index 0000000000..af57f4a869 --- /dev/null +++ b/reference/intl/intlcalendar/getweekendtransition.xml @@ -0,0 +1,68 @@ + + + + + + IntlCalendar::getWeekendTransition + Get time of the day at which weekend begins or ends + + + + &reftitle.description; + + public intIntlCalendar::getWeekendTransition + stringdayOfWeek + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + dayOfWeek + + + + + + + + + + + &reftitle.returnvalues; + + The number of milliseconds into the day at which the the weekend begins or + ends&return.falseforfailure;. + + + + + + + diff --git a/reference/intl/intlcalendar/indaylighttime.xml b/reference/intl/intlcalendar/indaylighttime.xml new file mode 100644 index 0000000000..3686a3f12f --- /dev/null +++ b/reference/intl/intlcalendar/indaylighttime.xml @@ -0,0 +1,62 @@ + + + + + + IntlCalendar::inDaylightTime + Whether the objectʼs time is in Daylight Savings Time + + + + &reftitle.description; + + public boolIntlCalendar::inDaylightTime + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns &true; if the date is in Daylight Savings Time, &false; otherwise. + The value &false; may also be returned on failure, for instance after + specifying invalid field values on non-lenient mode; use exceptions or query + IntlCalendar::getErrorCode to disambiguate. + + + + + + + diff --git a/reference/intl/intlcalendar/isequivalentto.xml b/reference/intl/intlcalendar/isequivalentto.xml new file mode 100644 index 0000000000..41095af29e --- /dev/null +++ b/reference/intl/intlcalendar/isequivalentto.xml @@ -0,0 +1,68 @@ + + + + + + IntlCalendar::isEquivalentTo + Whether another calendar is equal but for a different time + + + + &reftitle.description; + + public boolIntlCalendar::isEquivalentTo + IntlCalendarcalendar + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + calendar + + + + + + + + + + + &reftitle.returnvalues; + + Assuming there are no argument errors, returns &true; iif the calendars are + equivalent except possibly for their set time. + + + + + + + diff --git a/reference/intl/intlcalendar/islenient.xml b/reference/intl/intlcalendar/islenient.xml new file mode 100644 index 0000000000..86538092c6 --- /dev/null +++ b/reference/intl/intlcalendar/islenient.xml @@ -0,0 +1,58 @@ + + + + + + IntlCalendar::isLenient + Whether date/time interpretation is in lenient mode + + + + &reftitle.description; + + public boolIntlCalendar::isLenient + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + A bool representing whether the calendar is set to lenient mode. + + + + + + + diff --git a/reference/intl/intlcalendar/isset.xml b/reference/intl/intlcalendar/isset.xml new file mode 100644 index 0000000000..1181b46f17 --- /dev/null +++ b/reference/intl/intlcalendar/isset.xml @@ -0,0 +1,67 @@ + + + + + + IntlCalendar::isSet + Whether a field is set + + + + &reftitle.description; + + public boolIntlCalendar::isSet + intfield + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + field + + + + + + + + + + + &reftitle.returnvalues; + + Assuming there are no argument errors, returns &true; iif the field is set. + + + + + + + diff --git a/reference/intl/intlcalendar/isweekend.xml b/reference/intl/intlcalendar/isweekend.xml new file mode 100644 index 0000000000..a7c79b7c81 --- /dev/null +++ b/reference/intl/intlcalendar/isweekend.xml @@ -0,0 +1,74 @@ + + + + + + IntlCalendar::isWeekend + Whether a certain date/time is in the weekend + + + + &reftitle.description; + + public boolIntlCalendar::isWeekend + floatdateNULL + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + date + + + + + + + + + + + &reftitle.returnvalues; + + A bool indicating whether the given or this objectʼs time occurs + in a weekend. + + + The value &false; may also be returned on failure, for instance after giving + a date out of bounds on non-lenient mode; use exceptions or query + IntlCalendar::getErrorCode to disambiguate. + + + + + + + diff --git a/reference/intl/intlcalendar/roll.xml b/reference/intl/intlcalendar/roll.xml new file mode 100644 index 0000000000..79ebb71d6b --- /dev/null +++ b/reference/intl/intlcalendar/roll.xml @@ -0,0 +1,78 @@ + + + + + + IntlCalendar::roll + Add value to field without carrying into more significant fields + + + + &reftitle.description; + + public boolIntlCalendar::roll + intfield + mixedamountOrUpOrDownTRUE + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + field + + + + + + + + amountOrUpOrDown + + + The (signed) amount to add to the field, &true; for rolling up (adding + 1), or &false; for rolling down (subtracting + 1). + + + + + + + + &reftitle.returnvalues; + + Returns &true; on success or &false; on failure. + + + + + + + diff --git a/reference/intl/intlcalendar/set.xml b/reference/intl/intlcalendar/set.xml new file mode 100644 index 0000000000..68803231d2 --- /dev/null +++ b/reference/intl/intlcalendar/set.xml @@ -0,0 +1,133 @@ + + + + + + IntlCalendar::set + Set a time field or several common fields at once + + + + &reftitle.description; + + public boolIntlCalendar::set + intfield + intvalue + + + public boolIntlCalendar::set + intyear + intmonth + intdayOfMonthNULL + inthourNULL + intminuteNULL + intsecondNULL + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + field + + + + + + + + value + + + + + + + + year + + + + + + + + month + + + + + + + + dayOfMonth + + + + + + + + hour + + + + + + + + minute + + + + + + + + second + + + + + + + + + + + &reftitle.returnvalues; + + Returns &true; on success and &false; on failure. + + + + + + + diff --git a/reference/intl/intlcalendar/setfirstdayofweek.xml b/reference/intl/intlcalendar/setfirstdayofweek.xml new file mode 100644 index 0000000000..4e6a34f13d --- /dev/null +++ b/reference/intl/intlcalendar/setfirstdayofweek.xml @@ -0,0 +1,67 @@ + + + + + + IntlCalendar::setFirstDayOfWeek + Set the day on which the week is deemed to start + + + + &reftitle.description; + + public boolIntlCalendar::setFirstDayOfWeek + intdayOfWeek + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + dayOfWeek + + + + + + + + + + + &reftitle.returnvalues; + + Returns &true; on success. Failure can only happen due to invalid parameters. + + + + + + + diff --git a/reference/intl/intlcalendar/setlenient.xml b/reference/intl/intlcalendar/setlenient.xml new file mode 100644 index 0000000000..a4c85df49c --- /dev/null +++ b/reference/intl/intlcalendar/setlenient.xml @@ -0,0 +1,67 @@ + + + + + + IntlCalendar::setLenient + Set whether date/time interpretation is to be lenient + + + + &reftitle.description; + + public ReturnTypeIntlCalendar::setLenient + stringisLenient + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + isLenient + + + + + + + + + + + &reftitle.returnvalues; + + Returns &true; on success. Failure can only happen due to invalid parameters. + + + + + + + diff --git a/reference/intl/intlcalendar/setrepeatedwalltimeoption.xml b/reference/intl/intlcalendar/setrepeatedwalltimeoption.xml new file mode 100644 index 0000000000..7548fc5111 --- /dev/null +++ b/reference/intl/intlcalendar/setrepeatedwalltimeoption.xml @@ -0,0 +1,67 @@ + + + + + + IntlCalendar::setRepeatedWallTimeOption + Set behavior for handling repeating wall times at negative timezone offset transitions + + + + &reftitle.description; + + public boolIntlCalendar::setRepeatedWallTimeOption + intwallTimeOption + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + wallTimeOption + + + + + + + + + + + &reftitle.returnvalues; + + Returns &true; on success. Failure can only happen due to invalid parameters. + + + + + + + diff --git a/reference/intl/intlcalendar/setskippedwalltimeoption.xml b/reference/intl/intlcalendar/setskippedwalltimeoption.xml new file mode 100644 index 0000000000..a657905271 --- /dev/null +++ b/reference/intl/intlcalendar/setskippedwalltimeoption.xml @@ -0,0 +1,67 @@ + + + + + + IntlCalendar::setSkippedWallTimeOption + Set behavior for handling skipped wall times at positive timezone offset transitions + + + + &reftitle.description; + + public boolIntlCalendar::setSkippedWallTimeOption + intwallTimeOption + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + wallTimeOption + + + + + + + + + + + &reftitle.returnvalues; + + Returns &true; on success. Failure can only happen due to invalid parameters. + + + + + + + diff --git a/reference/intl/intlcalendar/settime.xml b/reference/intl/intlcalendar/settime.xml new file mode 100644 index 0000000000..503937707e --- /dev/null +++ b/reference/intl/intlcalendar/settime.xml @@ -0,0 +1,67 @@ + + + + + + IntlCalendar::setTime + Set the calendar time in milliseconds since the epoch + + + + &reftitle.description; + + public boolIntlCalendar::setTime + floatdate + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + date + + + + + + + + + + + &reftitle.returnvalues; + + Returns &true; on success and &false; on failure. + + + + + + + diff --git a/reference/intl/intlcalendar/settimezone.xml b/reference/intl/intlcalendar/settimezone.xml new file mode 100644 index 0000000000..9de5cb240d --- /dev/null +++ b/reference/intl/intlcalendar/settimezone.xml @@ -0,0 +1,67 @@ + + + + + + IntlCalendar::setTimeZone + Set the timezone used by this calendar + + + + &reftitle.description; + + public boolIntlCalendar::setTimeZone + mixedtimeZone + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + timeZone + + + + + + + + + + + &reftitle.returnvalues; + + Returns &true; on success and &false; on failure. + + + + + + + diff --git a/reference/intl/intlcalendar/todatetime.xml b/reference/intl/intlcalendar/todatetime.xml new file mode 100644 index 0000000000..d1801a60bb --- /dev/null +++ b/reference/intl/intlcalendar/todatetime.xml @@ -0,0 +1,61 @@ + + + + + + IntlCalendar::toDateTime + Convert an IntlCalendar into a DateTime object + + + + &reftitle.description; + + public DateTimeIntlCalendar::toDateTime + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + A DateTime object with the same timezone as this + object (though using PHPʼs database instead of ICUʼs) and the same time, + except for the smaller precision (second precision isntead of millisecond). + Returns &false; on failure. + + + + + + + diff --git a/reference/intl/versions.xml b/reference/intl/versions.xml index 1e1e00b005..281e9a29f7 100644 --- a/reference/intl/versions.xml +++ b/reference/intl/versions.xml @@ -23,6 +23,53 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +