set.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="intlcalendar.set" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>IntlCalendar::set</refname>
  <refpurpose>Set a time field or several common fields at once</refpurpose>
 </refnamediv>

 <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>
   <methodparam><type>int</type><parameter>value</parameter></methodparam>
  </methodsynopsis>
  <methodsynopsis>
   <modifier>public</modifier> <type>bool</type><methodname>IntlCalendar::set</methodname>
   <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>
   &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
   calendar is using the <link linkend="intlcalendar.setlenient">lenient
   mode</link>.
  </para>
  <para>
   For fields that conflict, the fields that are set later have priority.
  </para>
  <para>
   This method cannot be called with exactly four arguments.
  </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>value</parameter></term>
    <listitem>
     <para>
      The new value of the given field.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>year</parameter></term>
    <listitem>
     <para>
      The new value for <constant>IntlCalendar::FIELD_YEAR</constant>.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>month</parameter></term>
    <listitem>
     <para>
      The new value for <constant>IntlCalendar::FIELD_MONTH</constant>.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>dayOfMonth</parameter></term>
    <listitem>
     <para>
      The new value for <constant>IntlCalendar::FIELD_DAY_OF_MONTH</constant>.
      The month sequence is zero-based, i.e., January is represented by 0,
      February by 1, …, December is 11 and Undecember (if the calendar has
      it) is 12.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>hour</parameter></term>
    <listitem>
     <para>
      The new value for <constant>IntlCalendar::FIELD_HOUR_OF_DAY</constant>. 
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>minute</parameter></term>
    <listitem>
     <para>
      The new value for <constant>IntlCalendar::FIELD_MINUTE</constant>.
      </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>second</parameter></term>
    <listitem>
     <para>
      The new value for <constant>IntlCalendar::FIELD_SECOND</constant>.  
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns &true; on success and &false; on failure.
  </para>
 </refsect1>


 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
   <title><function>IntlCalendar::set</function></title>
    <programlisting role="php">
<![CDATA[
<?php
ini_set('date.timezone', 'Europe/Lisbon');
ini_set('intl.default_locale', 'pt_PT');

//Calls made later have priority
$cal = new IntlGregorianCalendar(2013, 6 /* July */, 1);
$cal->set(IntlCalendar::FIELD_YEAR, 2012);
$cal->set(IntlCalendar::FIELD_EXTENDED_YEAR, 2011);
var_dump(IntlDateFormatter::formatObject($cal));


$cal = new IntlGregorianCalendar(2013, 6 /* July */, 1);
$cal->set(IntlCalendar::FIELD_YEAR, 2012);
$cal->set(IntlCalendar::FIELD_EXTENDED_YEAR, 2011);
//the time has not been recalculated yet. If we clear the extended year,
//the year set before will be used
$cal->clear(IntlCalendar::FIELD_EXTENDED_YEAR);
var_dump(IntlDateFormatter::formatObject($cal));
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
string(20) "01/07/2011, 00:00:00"
string(20) "01/07/2012, 00:00:00"
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><methodname>IntlCalendar::get</methodname></member>
    <member><methodname>IntlCalendar::add</methodname></member>
    <member><methodname>IntlCalendar::roll</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
-->