sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-15 16:38:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Improve IntlCalendar documentation

Browse source 
Add style.oop/style.procedural sections for dual interface.
Document IntlCalendar::setMinimalDaysInFirstWeek().
Add libicu version requirements.



git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@332609 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Sara Golemon 2014-01-13 22:28:40 +00:00
parent 0f9c08359b
commit 9e0df2f6fe
43 changed files with 824 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
reference/intl/intlcalendar/add.xml
View file

@ -9,11 +9,23 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>IntlCalendar::add</methodname>
<methodparam><type>int</type><parameter>field</parameter></methodparam>
<methodparam><type>int</type><parameter>amount</parameter></methodparam>
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>bool</type><methodname>intlcal_add</methodname>
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
<methodparam><type>int</type><parameter>field</parameter></methodparam>
<methodparam><type>int</type><parameter>amount</parameter></methodparam>
</methodsynopsis>
<para>
Add a signed amount to a field. Adding a positive amount allows advances in
time, even if the numeric value of the field decreases (e.g. when working
@ -31,6 +43,12 @@
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>cal</parameter></term>
<listitem>
The IntlCalendar resource.
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>field</parameter></term>
<listitem>

23
reference/intl/intlcalendar/after.xml
View file

@ -9,9 +9,20 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>IntlCalendar::after</methodname>
<methodparam><type>IntlCalendar</type><parameter>calendar</parameter></methodparam>
<methodparam><type>IntlCalendar</type><parameter>other</parameter></methodparam>
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>bool</type><methodname>intlcal_after</methodname>
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
<methodparam><type>IntlCalendar</type><parameter>other</parameter></methodparam>
</methodsynopsis>
<para>
Returns whether this objectʼs time succeeds the argumentʼs time.
@ -22,10 +33,16 @@
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>calendar</parameter></term>
<term><parameter>cal</parameter></term>
<listitem>
The IntlCalendar resource.
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>other</parameter></term>
<listitem>
<para>
The calendar whose time will be checked against this objectʼs time.
The calendar whose time will be checked against the primary objectʼs time.
</para>
</listitem>
</varlistentry>

23
reference/intl/intlcalendar/before.xml
View file

@ -9,9 +9,20 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>IntlCalendar::before</methodname>
<methodparam><type>IntlCalendar</type><parameter>calendar</parameter></methodparam>
<methodparam><type>IntlCalendar</type><parameter>other</parameter></methodparam>
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>bool</type><methodname>IntlCalendar::before</methodname>
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
<methodparam><type>IntlCalendar</type><parameter>other</parameter></methodparam>
</methodsynopsis>
<para>
Returns whether this objectʼs time precedes the argumentʼs time.
@ -22,10 +33,16 @@
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>calendar</parameter></term>
<term><parameter>cal</parameter></term>
<listitem>
The IntlCalendar resource.
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>other</parameter></term>
<listitem>
<para>
The calendar whose time will be checked against this objectʼs time.
The calendar whose time will be checked against the primary objectʼs time.
</para>
</listitem>
</varlistentry>

17
reference/intl/intlcalendar/clear.xml
View file

@ -9,10 +9,21 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>IntlCalendar::clear</methodname>
<methodparam choice="opt"><type>int</type><parameter>field</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>bool</type><methodname>intcal_clear</methodname>
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>field</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
Clears either all of the fields or a specific field. A cleared field is
marked as unset, giving it the lowest priority against overlapping fields or
@ -26,6 +37,12 @@
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>cal</parameter></term>
<listitem>
The IntlCalendar resource.
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>field</parameter></term>
<listitem>

13
reference/intl/intlcalendar/createinstance.xml
View file

@ -9,10 +9,21 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <modifier>static</modifier> <type>IntlCalendar</type><methodname>IntlCalendar::createInstance</methodname>
<methodparam choice="opt"><type>mixed</type><parameter>timeZone</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>locale</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>locale</parameter><initializer>""</initializer></methodparam>
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>IntlCalendar</type><methodname>intlcal_create_instance</methodname>
<methodparam choice="opt"><type>mixed</type><parameter>timeZone</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>locale</parameter><initializer>""</initializer></methodparam>
</methodsynopsis>
<para>
Given a timezone and locale, this method creates an

23
reference/intl/intlcalendar/equals.xml
View file

@ -9,9 +9,20 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>IntlCalendar::equals</methodname>
<methodparam><type>IntlCalendar</type><parameter>calendar</parameter></methodparam>
<methodparam><type>IntlCalendar</type><parameter>other</parameter></methodparam>
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>bool</type><methodname>intlcal_equals</methodname>
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
<methodparam><type>IntlCalendar</type><parameter>other</parameter></methodparam>
</methodsynopsis>
<para>
Returns true if this calendar and the given calendar have the same time.
@ -23,10 +34,16 @@
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>calendar</parameter></term>
<term><parameter>cal</parameter></term>
<listitem>
The IntlCalendar resource.
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>other</parameter></term>
<listitem>
<para>
The calendar to compare with this object.
The calendar to compare with the primary object.
</para>
</listitem>
</varlistentry>

18
reference/intl/intlcalendar/fielddifference.xml
View file

@ -9,11 +9,23 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>IntlCalendar::fieldDifference</methodname>
<methodparam><type>float</type><parameter>when</parameter></methodparam>
<methodparam><type>int</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>int</type><methodname>intlcal_field_difference</methodname>
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
<methodparam><type>float</type><parameter>when</parameter></methodparam>
<methodparam><type>int</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<para>
Return the difference between the given time and the time this object is
set to, with respect to the quantity specified the
@ -30,6 +42,12 @@
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>cal</parameter></term>
<listitem>
The IntlCalendar resource.
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>when</parameter></term>
<listitem>

10
reference/intl/intlcalendar/fromdatetime.xml
View file

@ -9,10 +9,20 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <modifier>static</modifier> <type>IntlCalendar</type><methodname>IntlCalendar::fromDateTime</methodname>
<methodparam><type>mixed</type><parameter>dateTime</parameter></methodparam>
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>IntlCalendar</type><methodname>intlcal_from_date_time</methodname>
<methodparam><type>mixed</type><parameter>dateTime</parameter></methodparam>
</methodsynopsis>
<para>
Creates an <classname>IntlCalendar</classname> object either from a
<classname>DateTime</classname> object or from a string from which a

17
reference/intl/intlcalendar/get.xml
View file

@ -9,10 +9,21 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>IntlCalendar::get</methodname>
<methodparam><type>int</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>int</type><methodname>intlcal_get</methodname>
<methodparam><type>IntlCalendar></type><parameter>cal</parameter></methodparam>
<methodparam><type>int</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<para>
Gets the value for a specific field.
</para>
@ -21,6 +32,12 @@
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>cal</parameter></term>
<listitem>
The IntlCalendar resource.
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>field</parameter></term>
<listitem>

17
reference/intl/intlcalendar/getactualmaximum.xml
View file

@ -9,10 +9,21 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>IntlCalendar::getActualMaximum</methodname>
<methodparam><type>int</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>int</type><methodname>intcal_get_actual_maximum</methodname>
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
<methodparam><type>int</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<para>
Returns a fieldʼs relative maximum value around the current time. The exact
semantics vary by field, but in the general case this is the value that
@ -35,6 +46,12 @@
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>cal</parameter></term>
<listitem>
The IntlCalendar resource.
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>field</parameter></term>
<listitem>

17
reference/intl/intlcalendar/getactualminimum.xml
View file

@ -9,10 +9,21 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>IntlCalendar::getActualMinimum</methodname>
<methodparam><type>int</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>int</type><methodname>intlcal_get_actual_minimum</methodname>
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
<methodparam><type>int</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<para>
Returns a fieldʼs relative minimum value around the current time. The exact
semantics vary by field, but in the general case this is the value that
@ -32,6 +43,12 @@
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>cal</parameter></term>
<listitem>
The IntlCalendar resource.
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>field</parameter></term>
<listitem>

10
reference/intl/intlcalendar/getavailablelocales.xml
View file

@ -9,10 +9,20 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <modifier>static</modifier> <type>array</type><methodname>IntlCalendar::getAvailableLocales</methodname>
<void />
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>array</type><methodname>intlcal_get_available_locales</methodname>
<void />
</methodsynopsis>
<para>
Gives the list of locales for which calendars are installed. As of ICU 51,
this is the list of all installed ICU locales.

17
reference/intl/intlcalendar/getdayofweektype.xml
View file

@ -9,10 +9,21 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>IntlCalendar::getDayOfWeekType</methodname>
<methodparam><type>int</type><parameter>dayOfWeek</parameter></methodparam>
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>int</type><methodname>intlcal_get_day_of_week_type</methodname>
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
<methodparam><type>int</type><parameter>dayOfWeek</parameter></methodparam>
</methodsynopsis>
<para>
Returns whether the passed day is a weekday
(<constant>IntlCalendar::DOW_TYPE_WEEKDAY</constant>), a weekend day
@ -38,6 +49,12 @@
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>cal</parameter></term>
<listitem>
The IntlCalendar resource.
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>dayOfWeek</parameter></term>
<listitem>

19
reference/intl/intlcalendar/getfirstdayofweek.xml
View file

@ -9,10 +9,20 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>IntlCalendar::getFirstDayOfWeek</methodname>
<void />
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>int</type><methodname>intl_get_first_day_of_week</methodname>
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
</methodsynopsis>
<para>
The week day deemed to start a week, either the default value for this
locale or the value set with
@ -22,7 +32,14 @@
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
<variablelist>
<varlistentry>
<term><parameter>cal</parameter></term>
<listitem>
The IntlCalendar resource.
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">

17
reference/intl/intlcalendar/getgreatestminimum.xml
View file

@ -9,10 +9,21 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>IntlCalendar::getGreatestMinimum</methodname>
<methodparam><type>int</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>int</type><methodname>intlcal_get_greatest_minimum</methodname>
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
<methodparam><type>int</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<para>
Returns the largest local minimum for a field. This should be a value
larger or equal to that returned by
@ -26,6 +37,12 @@
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>cal</parameter></term>
<listitem>
The IntlCalendar resource.
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>field</parameter></term>
<listitem>

15
reference/intl/intlcalendar/getkeywordvaluesforlocale.xml
View file

@ -9,17 +9,32 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <modifier>static</modifier> <type>Iterator</type><methodname>IntlCalendar::getKeywordValuesForLocale</methodname>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam><type>string</type><parameter>locale</parameter></methodparam>
<methodparam><type>boolean</type><parameter>commonlyUsed</parameter></methodparam>
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>Iterator</type><methodname>intlcal_get_keyword_values_for_locale</methodname>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam><type>string</type><parameter>locale</parameter></methodparam>
<methodparam><type>boolean</type><parameter>commonlyUsed</parameter></methodparam>
</methodsynopsis>
<para>
For a given locale key, get the set of values for that key that would result
in a different behavior. For now, only the <literal>'calendar'</literal>
keyword is supported.
</para>
<para>
This function requires ICU 4.2 or later.
</para>
</refsect1>

17
reference/intl/intlcalendar/getleastmaximum.xml
View file

@ -9,10 +9,21 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>IntlCalendar::getLeastMaximum</methodname>
<methodparam><type>int</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>int</type><methodname>intlcal_get_least_maximum</methodname>
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
<methodparam><type>int</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<para>
Returns the smallest local maximumw for a field. This should be a value
smaller or equal to that returned by
@ -25,6 +36,12 @@
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>cal</parameter></term>
<listitem>
The IntlCalendar resource.
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>field</parameter></term>
<listitem>

17
reference/intl/intlcalendar/getlocale.xml
View file

@ -9,10 +9,21 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>IntlCalendar::getLocale</methodname>
<methodparam><type>int</type><parameter>localeType</parameter></methodparam>
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>string</type><methodname>intlcal_get_locale</methodname>
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
<methodparam><type>int</type><parameter>localeType</parameter></methodparam>
</methodsynopsis>
<para>
Returns the locale used by this calendar object.
</para>
@ -21,6 +32,12 @@
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>cal</parameter></term>
<listitem>
The IntlCalendar resource.
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>localeType</parameter></term>
<listitem>

17
reference/intl/intlcalendar/getmaximum.xml
View file

@ -9,10 +9,21 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>IntlCalendar::getMaximum</methodname>
<methodparam><type>int</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>int</type><methodname>intlcal_get_maximum</methodname>
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
<methodparam><type>int</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<para>
Gets the global maximum for a field, in this specific calendar. This value
is larger or equal to that returned by
@ -25,6 +36,12 @@
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>cal</parameter></term>
<listitem>
The IntlCalendar resource.
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>field</parameter></term>
<listitem>

19
reference/intl/intlcalendar/getminimaldaysinfirstweek.xml
View file

@ -9,10 +9,20 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>IntlCalendar::getMinimalDaysInFirstWeek</methodname>
<void />
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>int</type><methodname>intlcal_get_minimal_days_in_first_week</methodname>
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
</methodsynopsis>
<para>
Returns the smallest number of days the first week of a year or month must
have in the new year or month. For instance, in the Gregorian calendar, if
@ -27,7 +37,14 @@
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
<variablelist>
<varlistentry>
<term><parameter>cal</parameter></term>
<listitem>
The IntlCalendar resource.
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">

17
reference/intl/intlcalendar/getminimum.xml
View file

@ -9,10 +9,21 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>IntlCalendar::getMinimum</methodname>
<methodparam><type>int</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>int</type><methodname>intlcal_get_minimum</methodname>
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
<methodparam><type>int</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<para>
Gets the global minimum for a field, in this specific calendar. This value
is smaller or equal to that returned by
@ -27,6 +38,12 @@
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>cal</parameter></term>
<listitem>
The IntlCalendar resource.
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>field</parameter></term>
<listitem>

10
reference/intl/intlcalendar/getnow.xml
View file

@ -9,10 +9,20 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <modifier>static</modifier> <type>float</type><methodname>IntlCalendar::getNow</methodname>
<void />
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>float</type><methodname>intlcal_get_now</methodname>
<void />
</methodsynopsis>
<para>
The number of milliseconds that have passed since the reference date. This
number is derived from the system time.

22
reference/intl/intlcalendar/getrepeatedwalltimeoption.xml
View file

@ -9,20 +9,40 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>IntlCalendar::getRepeatedWallTimeOption</methodname>
<void />
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>int</type><methodname>intlcal_get_repeated_wall_time_option</methodname>
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
</methodsynopsis>
<para>
Gets the current strategy for dealing with wall times that are repeated
whenever the clock is set back during dailight saving time end transitions.
The default value is <constant>IntlCalendar::WALLTIME_LAST</constant>.
</para>
<para>
This function requires ICU 4.9 or later.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
<variablelist>
<varlistentry>
<term><parameter>cal</parameter></term>
<listitem>
The IntlCalendar resource.
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">

22
reference/intl/intlcalendar/getskippedwalltimeoption.xml
View file

@ -9,10 +9,20 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>IntlCalendar::getSkippedWallTimeOption</methodname>
<void />
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>int</type><methodname>intlcal_get_skipped_wall_time_option</methodname>
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
</methodsynopsis>
<para>
Gets the current strategy for dealing with wall times that are skipped
whenever the clock is forwarded during dailight saving time start transitions.
@ -24,11 +34,21 @@
any effect, otherwise attempting to set a non-existing time will cause an
error.
</para>
<para>
This function requires ICU 4.9 or later.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
<variablelist>
<varlistentry>
<term><parameter>cal</parameter></term>
<listitem>
The IntlCalendar resource.
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">

19
reference/intl/intlcalendar/gettime.xml
View file

@ -9,10 +9,20 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <type>float</type><methodname>IntlCalendar::getTime</methodname>
<void />
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>float</type><methodname>intlcal_get_time</methodname>
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
</methodsynopsis>
<para>
Returns the time associated with this object, expressed as the number of
milliseconds since the epoch.
@ -21,7 +31,14 @@
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
<variablelist>
<varlistentry>
<term><parameter>cal</parameter></term>
<listitem>
The IntlCalendar resource.
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">

19
reference/intl/intlcalendar/gettimezone.xml
View file

@ -9,10 +9,20 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <type>IntlTimeZone</type><methodname>IntlCalendar::getTimeZone</methodname>
<void />
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>IntlTimeZone</type><methodname>intlcal_get_time_zone</methodname>
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
</methodsynopsis>
<para>
Returns the <classname>IntlTimeZone</classname> object associated with this
calendar.
@ -21,7 +31,14 @@
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
<variablelist>
<varlistentry>
<term><parameter>cal</parameter></term>
<listitem>
The IntlCalendar resource.
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">

19
reference/intl/intlcalendar/gettype.xml
View file

@ -9,10 +9,20 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>IntlCalendar::getType</methodname>
<void />
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>string</type><methodname>intlcal_get_type</methodname>
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
</methodsynopsis>
<para>
A string describing the type of this calendar. This is one of the <link
linkend="intlcalendar.getkeywordvaluesforlocale">valid values</link> for
@ -22,7 +32,14 @@
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
<variablelist>
<varlistentry>
<term><parameter>cal</parameter></term>
<listitem>
The IntlCalendar resource.
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">

20
reference/intl/intlcalendar/getweekendtransition.xml
View file

@ -9,10 +9,21 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>IntlCalendar::getWeekendTransition</methodname>
<methodparam><type>string</type><parameter>dayOfWeek</parameter></methodparam>
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>int</type><methodname>intlcal_get_weekend_transition</methodname>
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
<methodparam><type>string</type><parameter>dayOfWeek</parameter></methodparam>
</methodsynopsis>
<para>
Returns the number of milliseconds after midnight at which the weekend
begins or ends.
@ -24,11 +35,20 @@
<constant>IntlCalendar::DOW_TYPE_WEEKEND_CEASE</constant>. Calling this
function for other days of the week is an error condition.
</para>
<para>
This function requires ICU 4.4 or later.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>cal</parameter></term>
<listitem>
The IntlCalendar resource.
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>dayOfWeek</parameter></term>
<listitem>

19
reference/intl/intlcalendar/indaylighttime.xml
View file

@ -9,10 +9,20 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>IntlCalendar::inDaylightTime</methodname>
<void />
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>bool</type><methodname>intlcal_in_daylight_time</methodname>
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
</methodsynopsis>
<para>
Whether, for the instant represented by this object and for this objectʼs
timezone, daylight saving time is in place.
@ -21,7 +31,14 @@
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
<variablelist>
<varlistentry>
<term><parameter>cal</parameter></term>
<listitem>
The IntlCalendar resource.
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">

21
reference/intl/intlcalendar/isequivalentto.xml
View file

@ -9,9 +9,20 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>IntlCalendar::isEquivalentTo</methodname>
<methodparam><type>IntlCalendar</type><parameter>calendar</parameter></methodparam>
<methodparam><type>IntlCalendar</type><parameter>other</parameter></methodparam>
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>bool</type><methodname>intlcal_is_equivalent_to</methodname>
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
<methodparam><type>IntlCalendar</type><parameter>other</parameter></methodparam>
</methodsynopsis>
<para>
Returns whether this and the given object are equivalent for all purposes
@ -33,7 +44,13 @@
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>calendar</parameter></term>
<term><parameter>cal</parameter></term>
<listitem>
The IntlCalendar resource.
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>other</parameter></term>
<listitem>
<para>
The other calendar against which the comparison is to be made.

19
reference/intl/intlcalendar/islenient.xml
View file

@ -9,10 +9,20 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>IntlCalendar::isLenient</methodname>
<void />
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>bool</type><methodname>intlcal_is_lenient</methodname>
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
</methodsynopsis>
<para>
Returns whether the current date/time interpretations is lenient (the
default). If that is case, some out of range values for fields will be
@ -22,7 +32,14 @@
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
<variablelist>
<varlistentry>
<term><parameter>cal</parameter></term>
<listitem>
The IntlCalendar resource.
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">

17
reference/intl/intlcalendar/isset.xml
View file

@ -9,10 +9,21 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>IntlCalendar::isSet</methodname>
<methodparam><type>int</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>bool</type><methodname>intlcal_is_set</methodname>
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
<methodparam><type>int</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<para>
Returns whether a field is set (as opposed to <link
linkend="intlcalendar.clear">clear</link>). Set fields take priority over
@ -24,6 +35,12 @@
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>cal</parameter></term>
<listitem>
The IntlCalendar resource.
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>field</parameter></term>
<listitem>

20
reference/intl/intlcalendar/isweekend.xml
View file

@ -9,19 +9,39 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>IntlCalendar::isWeekend</methodname>
<methodparam choice="opt"><type>float</type><parameter>date</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>bool</type><methodname>intlcal_is_weekend</methodname>
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
<methodparam choice="opt"><type>float</type><parameter>date</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
Returns whether either the obejctʼs current time or the provided timestamp
occur during a weekend in this objectʼs calendar system.
</para>
<para>
This function requires ICU 4.4 or later.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>cal</parameter></term>
<listitem>
The IntlCalendar resource.
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>date</parameter></term>
<listitem>

18
reference/intl/intlcalendar/roll.xml
View file

@ -9,11 +9,23 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>IntlCalendar::roll</methodname>
<methodparam><type>int</type><parameter>field</parameter></methodparam>
<methodparam><type>mixed</type><parameter>amountOrUpOrDown</parameter></methodparam>
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>bool</type><methodname>intlcal_roll</methodname>
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
<methodparam><type>int</type><parameter>field</parameter></methodparam>
<methodparam><type>mixed</type><parameter>amountOrUpOrDown</parameter></methodparam>
</methodsynopsis>
<para>
Adds a (signed) amount to a field. The difference with respect to
<function>IntlCalendar::add</function> is that when the field value
@ -24,6 +36,12 @@
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>cal</parameter></term>
<listitem>
The IntlCalendar resource.
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>field</parameter></term>
<listitem>

28
reference/intl/intlcalendar/set.xml
View file

@ -9,6 +9,9 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>IntlCalendar::set</methodname>
<methodparam><type>int</type><parameter>field</parameter></methodparam>
@ -23,6 +26,25 @@
<methodparam choice="opt"><type>int</type><parameter>minute</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>second</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>bool</type><methodname>intlcal_set</methodname>
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
<methodparam><type>int</type><parameter>field</parameter></methodparam>
<methodparam><type>int</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>bool</type><methodname>intlcal_set</methodname>
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
<methodparam><type>int</type><parameter>year</parameter></methodparam>
<methodparam><type>int</type><parameter>month</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>dayOfMonth</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>hour</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>minute</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>second</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
Sets either a specific field to the given value, or sets at once several
common fields. The range of values that are accepted depend on whether the
@ -40,6 +62,12 @@
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>cal</parameter></term>
<listitem>
The IntlCalendar resource.
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>field</parameter></term>
<listitem>

17
reference/intl/intlcalendar/setfirstdayofweek.xml
View file

@ -9,10 +9,21 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>IntlCalendar::setFirstDayOfWeek</methodname>
<methodparam><type>int</type><parameter>dayOfWeek</parameter></methodparam>
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>bool</type><methodname>intlcal_set_first_day_of_week</methodname>
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
<methodparam><type>int</type><parameter>dayOfWeek</parameter></methodparam>
</methodsynopsis>
<para>
Defines the day of week deemed to start the week. This affects the behavior
of fields that depend on the concept of week start and end such as
@ -24,6 +35,12 @@
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>cal</parameter></term>
<listitem>
The IntlCalendar resource.
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>dayOfWeek</parameter></term>
<listitem>

17
reference/intl/intlcalendar/setlenient.xml
View file

@ -9,10 +9,21 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <type>ReturnType</type><methodname>IntlCalendar::setLenient</methodname>
<methodparam><type>string</type><parameter>isLenient</parameter></methodparam>
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>ReturnType</type><methodname>intlcal_set_lenient</methodname>
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
<methodparam><type>string</type><parameter>isLenient</parameter></methodparam>
</methodsynopsis>
<para>
Defines whether the calendar is ‘lenient mode’. In such a mode, some of
out-of-bounds values for some fields are accepted, the behavior being
@ -25,6 +36,12 @@
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>cal</parameter></term>
<listitem>
The IntlCalendar resource.
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>isLenient</parameter></term>
<listitem>

85
reference/intl/intlcalendar/setminimaldaysinfirstweek.xml Normal file
View file

@ -0,0 +1,85 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 331331 $ -->
<refentry xml:id="intlcalendar.setminimaldaysinfirstweek" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>IntlCalendar::setMinimalDaysInFirstWeek</refname>
<refpurpose>Set minimal number of days the first week in a year or month can have</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>IntlCalendar::setMinimalDaysInFirstWeek</methodname>
<methodparam><type>int</type><parameter>minimalDays</parameter></methodparam>
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>bool</type><methodname>intlcal_get_minimal_days_in_first_week</methodname>
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
<methodparam><type>int</type><parameter>minimalDays</parameter></methodparam>
</methodsynopsis>
<para>
Sets the smallest number of days the first week of a year or month must
have in the new year or month. For instance, in the Gregorian calendar, if
this value is 1, then the first week of the year will necessarily include
January 1st, while if this value is 7, then the week with January 1st will
be the first week of the year only if the day of the week for January 1st
matches the day of the week returned by
<function>IntlCalendar::getFirstDayOfWeek</function>; otherwise it will be
the previous yearʼs last week.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>cal</parameter></term>
<listitem>
The IntlCalendar resource.
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>minimalDays</parameter></term>
<listitem>
The number of minimal days to set.
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&true; on success, &false; on failure.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

20
reference/intl/intlcalendar/setrepeatedwalltimeoption.xml
View file

@ -9,10 +9,21 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>IntlCalendar::setRepeatedWallTimeOption</methodname>
<methodparam><type>int</type><parameter>wallTimeOption</parameter></methodparam>
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>bool</type><methodname>intlcal_set_repeated_wall_time_option</methodname>
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
<methodparam><type>int</type><parameter>wallTimeOption</parameter></methodparam>
</methodsynopsis>
<para>
Sets the current strategy for dealing with wall times that are repeated
whenever the clock is set back during dailight saving time end transitions.
@ -21,11 +32,20 @@
<constant>IntlCalendar::WALLTIME_FIRST</constant> (take the instant that
occurs during DST).
</para>
<para>
This function requires ICU 4.9 or later.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>cal</parameter></term>
<listitem>
The IntlCalendar resource.
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>wallTimeOption</parameter></term>
<listitem>

20
reference/intl/intlcalendar/setskippedwalltimeoption.xml
View file

@ -9,10 +9,21 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>IntlCalendar::setSkippedWallTimeOption</methodname>
<methodparam><type>int</type><parameter>wallTimeOption</parameter></methodparam>
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>bool</type><methodname>intlcal_set_skipped_wall_time_option</methodname>
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
<methodparam><type>int</type><parameter>wallTimeOption</parameter></methodparam>
</methodsynopsis>
<para>
Sets the current strategy for dealing with wall times that are skipped
whenever the clock is forwarded during dailight saving time start transitions.
@ -35,11 +46,20 @@
any effect, otherwise attempting to set a non-existing time will cause an
error.
</para>
<para>
This function requires ICU 4.9 or later.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>cal</parameter></term>
<listitem>
The IntlCalendar resource.
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>wallTimeOption</parameter></term>
<listitem>

17
reference/intl/intlcalendar/settime.xml
View file

@ -9,10 +9,21 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>IntlCalendar::setTime</methodname>
<methodparam><type>float</type><parameter>date</parameter></methodparam>
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>bool</type><methodname>intlcal_set_time</methodname>
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
<methodparam><type>float</type><parameter>date</parameter></methodparam>
</methodsynopsis>
<para>
Sets the instant represented by this object. The instant is represented by
a <type>float</type> whose value should be an integer number of
@ -24,6 +35,12 @@
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>cal</parameter></term>
<listitem>
The IntlCalendar resource.
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>date</parameter></term>
<listitem>

17
reference/intl/intlcalendar/settimezone.xml
View file

@ -9,10 +9,21 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>IntlCalendar::setTimeZone</methodname>
<methodparam><type>mixed</type><parameter>timeZone</parameter></methodparam>
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>bool</type><methodname>intlcal_set_time_zone</methodname>
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
<methodparam><type>mixed</type><parameter>timeZone</parameter></methodparam>
</methodsynopsis>
<para>
Defines a new timezone for this calendar. The time represented by the
object is preserved to the detriment of the field values.
@ -22,6 +33,12 @@
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>cal</parameter></term>
<listitem>
The IntlCalendar resource.
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>timeZone</parameter></term>
<listitem>

19
reference/intl/intlcalendar/todatetime.xml
View file

@ -9,10 +9,20 @@
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier> <type>DateTime</type><methodname>IntlCalendar::toDateTime</methodname>
<void />
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>DateTime</type><methodname>intlcal_to_date_time</methodname>
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
</methodsynopsis>
<para>
Create a <classname>DateTime</classname> object that represents the same
instant (up to second precision, with a rounding error of less than 1
@ -24,7 +34,14 @@
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
<variablelist>
<varlistentry>
<term><parameter>cal</parameter></term>
<listitem>
The IntlCalendar resource.
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">