modify.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 911fe79de766ef4475bf22446903667a0f3a24d3 Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->

<refentry xml:id="datetimeimmutable.modify" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>DateTimeImmutable::modify</refname>
  <refpurpose>タイムスタンプを変更した新しいオブジェクトを作る</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="DateTimeImmutable">
   <modifier role="attribute">#[\NoDiscard(message: "as DateTimeImmutable::modify() does not modify the object itself")]</modifier>
   <modifier>public</modifier> <type>DateTimeImmutable</type><methodname>DateTimeImmutable::modify</methodname>
   <methodparam><type>string</type><parameter>modifier</parameter></methodparam>
  </methodsynopsis>
  <para>
   タイムスタンプを変更した新しい <type>DateTimeImmutable</type> オブジェクトを作ります。
   元のオブジェクトは変更されません。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>modifier</parameter></term>
    <listitem>
     <para>&date.formats.parameter;</para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   成功時に <classname>DateTimeImmutable</classname> を返します。
   &return.falseforfailure.style.procedural;
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   無効な日付/時刻の文字列が渡された場合、
   <exceptionname>DateMalformedStringException</exceptionname> がスローされます。
   PHP 8.3.0 より前のバージョンでは、警告が発生していました。
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.4.0</entry>
      <entry>
       仮の戻り値の型が、<type>DateTimeImmutable</type> になりました。
       これより前のバージョンでは、
       <type class="union"><type>DateTimeImmutable</type><type>false</type></type> でした。
      </entry>
     </row>
     <row>
      <entry>8.3.0</entry>
      <entry>
       無効な文字列が渡された場合、
       <methodname>DateTimeImmutable::modify</methodname>
       は <exceptionname>DateMalformedStringException</exceptionname>
       をスローするようになりました。
       これより前のバージョンでは、
       警告が発生して &false; を返していました。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title><function>DateTimeImmutable::modify</function> の例</title>
   <para>&style.oop;</para>
   <programlisting role="php">
<![CDATA[
<?php
$date = new DateTimeImmutable('2006-12-12');
$newDate = $date->modify('+1 day');
echo $newDate->format('Y-m-d');
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
2006-12-13
]]>
   </screen>
  </example>
  <example>
   <title>月の加減算には注意</title>
   <programlisting role="php">
<![CDATA[
<?php
$date = new DateTimeImmutable('2000-12-31');

$newDate1 = $date->modify('+1 month');
echo $newDate1->format('Y-m-d') . "\n";

$newDate2 = $newDate1->modify('+1 month');
echo $newDate2->format('Y-m-d') . "\n";
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
2001-01-31
2001-03-03
]]>
   </screen>
  </example>
 </refsect1>

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