php-doc-en/reference/datetime/datetimeimmutable/setdate.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="datetimeimmutable.setdate" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>DateTimeImmutable::setDate</refname>
  <refpurpose>Sets the date</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type>DateTimeImmutable</type><methodname>DateTimeImmutable::setDate</methodname>
   <methodparam><type>int</type><parameter>year</parameter></methodparam>
   <methodparam><type>int</type><parameter>month</parameter></methodparam>
   <methodparam><type>int</type><parameter>day</parameter></methodparam>
  </methodsynopsis>
  <para>
   Returns a new DateTimeImmutable object with the current date of the
   DateTimeImmutable object set to the given date.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   &date.datetime.description.modified;
   <varlistentry>
    <term><parameter>year</parameter></term>
    <listitem>
     <para>
      Year of the date.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>month</parameter></term>
    <listitem>
     <para>
      Month of the date.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>day</parameter></term>
    <listitem>
     <para>
      Day of the date.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &date.datetimeimmutable.return.modifiedobjectorfalseforfailure;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title><function>DateTimeImmutable::setDate</function> example</title>
   <para>&style.oop;</para>
   <programlisting role="php">
<![CDATA[
<?php
$date = new DateTimeImmutable();
$newDate = $date->setDate(2001, 2, 3);
echo $newDate->format('Y-m-d');
?>
]]>
   </programlisting>
   &examples.outputs;
   <screen>
<![CDATA[
2001-02-03
]]>
   </screen>
  </example>
  <example>
   <title>Values exceeding ranges are added to their parent values</title>
   <programlisting role="php">
<![CDATA[
<?php
$date = new DateTimeImmutable();

$newDate = $date->setDate(2001, 2, 28);
echo $newDate->format('Y-m-d') . "\n";

$newDate = $date->setDate(2001, 2, 29);
echo $newDate->format('Y-m-d') . "\n";

$newDate = $date->setDate(2001, 14, 3);
echo $newDate->format('Y-m-d') . "\n";
?>
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
2001-02-28
2001-03-01
2002-02-03
]]>
   </screen>
  </example>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><function>DateTimeImmutable::setISODate</function></member>
   <member><function>DateTimeImmutable::setTime</function></member>
  </simplelist>
 </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
-->