createfromiso8601string.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0070ddc45d60b6eda095053847dba544aa4339bf Maintainer: mumumu Status: ready -->
<refentry xml:id="dateperiod.createfromiso8601string" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>DatePeriod::createFromISO8601String</refname>
  <refpurpose>ISO8601 形式の文字列から、新しい DatePeriod オブジェクトを作成する</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="DatePeriod">
   <modifier>public</modifier> <modifier>static</modifier> <type>static</type><methodname>DatePeriod::createFromISO8601String</methodname>
   <methodparam><type>string</type><parameter>specification</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   ISO8601 形式の文字列から、<parameter>specification</parameter>
   の指定に従い、新しい DatePeriod オブジェクトを作成します。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>specification</parameter></term>
    <listitem>
     <para>
      <link xlink:href="&url.iso-8601.repeating_intervals;">ISO 8601 repeating
      interval specification</link> のサブセットを指定します。
     </para>
     <para>
      有効な ISO8601 形式の期間指定のサンプルとして、
    　<literal>R5/2008-03-01T13:00:00Z/P1Y2M10DT2H30M</literal>
      のようなものがあります。これは、以下を指定しています:
     </para>
     <itemizedlist>
      <listitem>
       <simpara>
        5 回繰り返す (<literal>R5/</literal>)
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        <literal>2008-03-01T13:00:00Z</literal> から開始
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        それぞれの繰り返しは、
        1 year, 2 months, 10 days, 2 hours, 30 minute の間隔を持つ。
        (<literal>/P1Y2M10DT2H30M</literal>).
       </simpara>
      </listitem>
     </itemizedlist>

     <para>
      ISO8601 形式の期間指定によっては、PHP がサポートしていないものがあります。
      たとえば以下のようなものがあります:
     </para>
     <orderedlist>
      <listitem>
       <simpara>
        繰り返しが0回 (<literal>R0/</literal>)
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        UTC (<literal>Z</literal>) 以外のタイムオフセット。
        たとえば <literal>+02:00</literal> のようなものです。
       </simpara>
      </listitem>
     </orderedlist>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>options</parameter></term>
    <listitem>
     <para>
      開始日と、終了日についての振る舞いを制御するのに使うビットフィールドです。
     </para>
     <para>
      <constant>DatePeriod::EXCLUDE_START_DATE</constant>
      を指定すると、期間内に繰り返される集合から開始日を除外できます。
     </para>
     <para>
      <constant>DatePeriod::INCLUDE_END_DATE</constant>
      を指定すると、期間内に繰り返される集合に終了日を含めることができます。
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   新しい DatePeriod オブジェクトを作成します。
  </para>
  <para>
   このメソッドを使って作成された <classname>DatePeriod</classname>
   オブジェクトは、多くの <classname>DateTimeImmutable</classname>
   オブジェクトを生成するイテレータとして使えます。
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   <parameter>specification</parameter> が、有効な ISO8601 形式の期間として
   パースできない場合、<classname>DateMalformedPeriodStringException</classname>
   がスローされます。
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>DatePeriod::createFromISO8601String の例</title>
    <programlisting role="php">
<![CDATA[
<?php
$iso = 'R4/2023-07-01T00:00:00Z/P7D';

$period = DatePeriod::createFromISO8601String($iso);

// DatePeriod オブジェクトを走査することで、
// その期間内で発生する日付を全て出力します
foreach ($period as $date) {
    echo $date->format('Y-m-d'), "\n";
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
2023-07-01
2023-07-08
2023-07-15
2023-07-22
2023-07-29
]]>
    </screen>
   </example>
  </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
-->