<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Add value to field without carrying into more significant fields</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="intlcalendar.isweekend.html">IntlCalendar::isWeekend</a></div>
<div class="next" style="text-align: right; float: right;"><a href="intlcalendar.set.html">IntlCalendar::set</a></div>
<div class="up"><a href="class.intlcalendar.html">IntlCalendar</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="intlcalendar.roll" class="refentry">
<div class="refnamediv">
<h1 class="refname">IntlCalendar::roll</h1>
<p class="verinfo">(PHP 5.5.0, PECL >= 3.0.0a1)</p><p class="refpurpose"><span class="refname">IntlCalendar::roll</span> — <span class="dc-title">Add value to field without carrying into more significant fields</span></p>
</div>
<div class="refsect1 description" id="refsect1-intlcalendar.roll-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>IntlCalendar::roll</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$field</code></span>
, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$amountOrUpOrDown</code></span>
)</div>
<p class="para rdfs-comment">
Adds a (signed) amount to a field. The difference with respect to
<span class="function"><a href="intlcalendar.add.html" class="function">IntlCalendar::add()</a></span> is that when the field value
overflows, it does not carry into more significant fields.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-intlcalendar.roll-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<span class="term"><em><code class="parameter">field</code></em></span>
<dd>
<p class="para">
One of the <a href="class.intlcalendar.html" class="classname">IntlCalendar</a> date/time <a href="class.intlcalendar.html#intlcalendar.constants" class="link">field constants</a>. These are integer
values between <em>0</em> and
<strong><code>IntlCalendar::FIELD_COUNT</code></strong>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">amountOrUpOrDown</code></em></span>
<dd>
<p class="para">
The (signed) amount to add to the field, <strong><code>TRUE</code></strong> for rolling up (adding
<em>1</em>), or <strong><code>FALSE</code></strong> for rolling down (subtracting
<em>1</em>).
</p>
</dd>
</dt>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-intlcalendar.roll-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-intlcalendar.roll-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2619">
<p><strong>Example #1 <span class="function"><strong>IntlCalendar::roll()</strong></span></strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />ini_set</span><span style="color: #007700">(</span><span style="color: #DD0000">'date.timezone'</span><span style="color: #007700">, </span><span style="color: #DD0000">'Europe/Lisbon'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">ini_set</span><span style="color: #007700">(</span><span style="color: #DD0000">'intl.default_locale'</span><span style="color: #007700">, </span><span style="color: #DD0000">'pt_PT'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$cal </span><span style="color: #007700">= new </span><span style="color: #0000BB">IntlGregorianCalendar</span><span style="color: #007700">(</span><span style="color: #0000BB">2013</span><span style="color: #007700">, </span><span style="color: #0000BB">5 </span><span style="color: #FF8000">/* June */</span><span style="color: #007700">, </span><span style="color: #0000BB">30</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$cal</span><span style="color: #007700">-></span><span style="color: #0000BB">add</span><span style="color: #007700">(</span><span style="color: #0000BB">IntlCalendar</span><span style="color: #007700">::</span><span style="color: #0000BB">FIELD_DAY_OF_MONTH</span><span style="color: #007700">, </span><span style="color: #0000BB">1</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">IntlDateFormatter</span><span style="color: #007700">::</span><span style="color: #0000BB">formatObject</span><span style="color: #007700">(</span><span style="color: #0000BB">$cal</span><span style="color: #007700">)); </span><span style="color: #FF8000">// "01/07/2013, 00:00:00"<br /><br /></span><span style="color: #0000BB">$cal</span><span style="color: #007700">-></span><span style="color: #0000BB">set</span><span style="color: #007700">(</span><span style="color: #0000BB">2013</span><span style="color: #007700">, </span><span style="color: #0000BB">5 </span><span style="color: #FF8000">/* June */</span><span style="color: #007700">, </span><span style="color: #0000BB">30</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$cal</span><span style="color: #007700">-></span><span style="color: #0000BB">roll</span><span style="color: #007700">(</span><span style="color: #0000BB">IntlCalendar</span><span style="color: #007700">::</span><span style="color: #0000BB">FIELD_DAY_OF_MONTH</span><span style="color: #007700">, </span><span style="color: #0000BB">true</span><span style="color: #007700">); </span><span style="color: #FF8000">// roll up, same as rolling +1<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">IntlDateFormatter</span><span style="color: #007700">::</span><span style="color: #0000BB">formatObject</span><span style="color: #007700">(</span><span style="color: #0000BB">$cal</span><span style="color: #007700">)); </span><span style="color: #FF8000">// "01/06/2013, 00:00:00"</span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
string(20) "01/07/2013, 00:00:00"
string(20) "01/06/2013, 00:00:00"
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-intlcalendar.roll-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="intlcalendar.add.html" class="methodname" rel="rdfs-seeAlso">IntlCalendar::add()</a> - Add a (signed) amount of time to a field</span></li>
<li class="member"> <span class="methodname"><a href="intlcalendar.set.html" class="methodname" rel="rdfs-seeAlso">IntlCalendar::set()</a> - Set a time field or several common fields at once</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="intlcalendar.isweekend.html">IntlCalendar::isWeekend</a></div>
<div class="next" style="text-align: right; float: right;"><a href="intlcalendar.set.html">IntlCalendar::set</a></div>
<div class="up"><a href="class.intlcalendar.html">IntlCalendar</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
