mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 22:38:55 +00:00
fc1383edb3
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@332615 c90b9560-bf6c-de11-be94-00142212c4b1
136 lines
3.7 KiB
XML
136 lines
3.7 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="intlcalendar.roll" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>IntlCalendar::roll</refname>
|
|
<refpurpose>Add value to field without carrying into more significant fields</refpurpose>
|
|
</refnamediv>
|
|
|
|
<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
|
|
overflows, it does not carry into more significant fields.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>cal</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The IntlCalendar resource.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>field</parameter></term>
|
|
<listitem>
|
|
&reference.intl.incfieldparam;
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>amountOrUpOrDown</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The (signed) amount to add to the field, &true; for rolling up (adding
|
|
<literal>1</literal>), or &false; for rolling down (subtracting
|
|
<literal>1</literal>).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns &true; on success or &false; on failure.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>IntlCalendar::roll</function></title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
ini_set('date.timezone', 'Europe/Lisbon');
|
|
ini_set('intl.default_locale', 'pt_PT');
|
|
|
|
$cal = new IntlGregorianCalendar(2013, 5 /* June */, 30);
|
|
|
|
$cal->add(IntlCalendar::FIELD_DAY_OF_MONTH, 1);
|
|
var_dump(IntlDateFormatter::formatObject($cal)); // "01/07/2013, 00:00:00"
|
|
|
|
$cal->set(2013, 5 /* June */, 30);
|
|
$cal->roll(IntlCalendar::FIELD_DAY_OF_MONTH, true); // roll up, same as rolling +1
|
|
var_dump(IntlDateFormatter::formatObject($cal)); // "01/06/2013, 00:00:00"
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
string(20) "01/07/2013, 00:00:00"
|
|
string(20) "01/06/2013, 00:00:00"
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><methodname>IntlCalendar::add</methodname></member>
|
|
<member><methodname>IntlCalendar::set</methodname></member>
|
|
</simplelist>
|
|
</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
|
|
-->
|