<!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>Clear a field or all fields</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="intlcalendar.before.html">IntlCalendar::before</a></div> <div class="next" style="text-align: right; float: right;"><a href="intlcalendar.construct.html">IntlCalendar::__construct</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.clear" class="refentry"> <div class="refnamediv"> <h1 class="refname">IntlCalendar::clear</h1> <p class="verinfo">(PHP 5.5.0, PECL >= 3.0.0a1)</p><p class="refpurpose"><span class="refname">IntlCalendar::clear</span> — <span class="dc-title">Clear a field or all fields</span></p> </div> <div class="refsect1 description" id="refsect1-intlcalendar.clear-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::clear</strong></span> ([ <span class="methodparam"><span class="type">int</span> <code class="parameter">$field</code><span class="initializer"> = NULL</span></span> ] )</div> <p class="para rdfs-comment"> 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 even default values when calculating the time. Additionally, its value is set to <em>0</em>, though given the fieldʼs low priority, its value may have been internally set to another value by the time the field has finished been queried. </p> </div> <div class="refsect1 parameters" id="refsect1-intlcalendar.clear-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> </dl> </div> <div class="refsect1 returnvalues" id="refsect1-intlcalendar.clear-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. Failure can only occur is invalid arguments are provided. </p> </div> <div class="refsect1 examples" id="refsect1-intlcalendar.clear-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-2593"> <p><strong>Example #1 <span class="function"><strong>IntlCalendar::clear()</strong></span> examples</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">'intl.default_locale'</span><span style="color: #007700">, </span><span style="color: #DD0000">'es_ES'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">ini_set</span><span style="color: #007700">(</span><span style="color: #DD0000">'date.timezone'</span><span style="color: #007700">, </span><span style="color: #DD0000">'UTC'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$fields </span><span style="color: #007700">= array(<br /> </span><span style="color: #DD0000">'FIELD_ERA' </span><span style="color: #007700">=> </span><span style="color: #0000BB">0</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'FIELD_YEAR' </span><span style="color: #007700">=> </span><span style="color: #0000BB">1</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'FIELD_MONTH' </span><span style="color: #007700">=> </span><span style="color: #0000BB">2</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'FIELD_WEEK_OF_YEAR' </span><span style="color: #007700">=> </span><span style="color: #0000BB">3</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'FIELD_WEEK_OF_MONTH' </span><span style="color: #007700">=> </span><span style="color: #0000BB">4</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'FIELD_DATE' </span><span style="color: #007700">=> </span><span style="color: #0000BB">5</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'FIELD_DAY_OF_YEAR' </span><span style="color: #007700">=> </span><span style="color: #0000BB">6</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'FIELD_DAY_OF_WEEK' </span><span style="color: #007700">=> </span><span style="color: #0000BB">7</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'FIELD_DAY_OF_WEEK_IN_MONTH' </span><span style="color: #007700">=> </span><span style="color: #0000BB">8</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'FIELD_AM_PM' </span><span style="color: #007700">=> </span><span style="color: #0000BB">9</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'FIELD_HOUR' </span><span style="color: #007700">=> </span><span style="color: #0000BB">10</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'FIELD_HOUR_OF_DAY' </span><span style="color: #007700">=> </span><span style="color: #0000BB">11</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'FIELD_MINUTE' </span><span style="color: #007700">=> </span><span style="color: #0000BB">12</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'FIELD_SECOND' </span><span style="color: #007700">=> </span><span style="color: #0000BB">13</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'FIELD_MILLISECOND' </span><span style="color: #007700">=> </span><span style="color: #0000BB">14</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'FIELD_ZONE_OFFSET' </span><span style="color: #007700">=> </span><span style="color: #0000BB">15</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'FIELD_DST_OFFSET' </span><span style="color: #007700">=> </span><span style="color: #0000BB">16</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'FIELD_YEAR_WOY' </span><span style="color: #007700">=> </span><span style="color: #0000BB">17</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'FIELD_DOW_LOCAL' </span><span style="color: #007700">=> </span><span style="color: #0000BB">18</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'FIELD_EXTENDED_YEAR' </span><span style="color: #007700">=> </span><span style="color: #0000BB">19</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'FIELD_JULIAN_DAY' </span><span style="color: #007700">=> </span><span style="color: #0000BB">20</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'FIELD_MILLISECONDS_IN_DAY' </span><span style="color: #007700">=> </span><span style="color: #0000BB">21</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'FIELD_IS_LEAP_MONTH' </span><span style="color: #007700">=> </span><span style="color: #0000BB">22</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'FIELD_FIELD_COUNT' </span><span style="color: #007700">=> </span><span style="color: #0000BB">23</span><span style="color: #007700">,<br />);<br />function </span><span style="color: #0000BB">getSetFields</span><span style="color: #007700">(</span><span style="color: #0000BB">IntlCalendar $cal</span><span style="color: #007700">) {<br /> global </span><span style="color: #0000BB">$fields</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$ret </span><span style="color: #007700">= array();<br /> foreach (</span><span style="color: #0000BB">$fields </span><span style="color: #007700">as </span><span style="color: #0000BB">$name </span><span style="color: #007700">=> </span><span style="color: #0000BB">$value</span><span style="color: #007700">) {<br /> if (</span><span style="color: #0000BB">$cal</span><span style="color: #007700">-></span><span style="color: #0000BB">isSet</span><span style="color: #007700">(</span><span style="color: #0000BB">$value</span><span style="color: #007700">)) {<br /> </span><span style="color: #0000BB">$ret</span><span style="color: #007700">[] = </span><span style="color: #0000BB">$name</span><span style="color: #007700">;<br /> }<br /> }<br /> return </span><span style="color: #0000BB">$ret</span><span style="color: #007700">;<br />}<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">2 </span><span style="color: #FF8000">/* March */</span><span style="color: #007700">, </span><span style="color: #0000BB">15</span><span style="color: #007700">);<br />echo </span><span style="color: #DD0000">"After GregorianCalendar creation\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">getSetFields</span><span style="color: #007700">(</span><span style="color: #0000BB">$cal</span><span style="color: #007700">));<br />echo </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /><br />echo </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: #DD0000">"\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">"After the formatter requested the extended year\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">getSetFields</span><span style="color: #007700">(</span><span style="color: #0000BB">$cal</span><span style="color: #007700">));<br />echo </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$cal</span><span style="color: #007700">-></span><span style="color: #0000BB">clear</span><span style="color: #007700">(</span><span style="color: #0000BB">IntlCalendar</span><span style="color: #007700">::</span><span style="color: #0000BB">FIELD_YEAR</span><span style="color: #007700">);<br />echo </span><span style="color: #DD0000">"After the year has been cleared, the date stays the same\n"</span><span style="color: #007700">;<br />echo </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: #DD0000">"\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">"because FIELD_EXTENDED_YEAR is still set\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">getSetFields</span><span style="color: #007700">(</span><span style="color: #0000BB">$cal</span><span style="color: #007700">));<br />echo </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$cal</span><span style="color: #007700">-></span><span style="color: #0000BB">clear</span><span style="color: #007700">(</span><span style="color: #0000BB">IntlCalendar</span><span style="color: #007700">::</span><span style="color: #0000BB">FIELD_EXTENDED_YEAR</span><span style="color: #007700">));<br />echo </span><span style="color: #DD0000">"After the extended year has been cleared\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">getSetFields</span><span style="color: #007700">(</span><span style="color: #0000BB">$cal</span><span style="color: #007700">));<br />echo </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: #DD0000">"\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /><br />echo </span><span style="color: #DD0000">"After the fields are recalculated,\n"<br /> </span><span style="color: #007700">. </span><span style="color: #DD0000">" extended year is set again (to 1970)\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">getSetFields</span><span style="color: #007700">(</span><span style="color: #0000BB">$cal</span><span style="color: #007700">));<br />echo </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$cal</span><span style="color: #007700">-></span><span style="color: #0000BB">clear</span><span style="color: #007700">();<br />echo </span><span style="color: #DD0000">"After calling variant with no arguments\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">getSetFields</span><span style="color: #007700">(</span><span style="color: #0000BB">$cal</span><span style="color: #007700">));<br />echo </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: #DD0000">"\n"</span><span style="color: #007700">;</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> After GregorianCalendar creation Array ( [0] => FIELD_ERA [1] => FIELD_YEAR [2] => FIELD_MONTH [3] => FIELD_DATE ) 15/03/2013 00:00:00 After the formatter requested the extended year Array ( [0] => FIELD_ERA [1] => FIELD_YEAR [2] => FIELD_MONTH [3] => FIELD_DATE [4] => FIELD_EXTENDED_YEAR ) After the year has been cleared, the date stays the same 15/03/2013 00:00:00 because FIELD_EXTENDED_YEAR is still set Array ( [0] => FIELD_ERA [1] => FIELD_MONTH [2] => FIELD_DATE [3] => FIELD_EXTENDED_YEAR ) bool(true) After the extended year has been cleared Array ( [0] => FIELD_ERA [1] => FIELD_MONTH [2] => FIELD_DATE ) 15/03/1970 00:00:00 After the fields are recalculated, extended year is set again (to 1970) Array ( [0] => FIELD_ERA [1] => FIELD_MONTH [2] => FIELD_DATE [3] => FIELD_EXTENDED_YEAR ) After calling variant with no arguments Array ( ) 01/01/1970 00:00:00 </pre></div> </div> </div> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="intlcalendar.before.html">IntlCalendar::before</a></div> <div class="next" style="text-align: right; float: right;"><a href="intlcalendar.construct.html">IntlCalendar::__construct</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>