construct.xml

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

<refentry xml:id="dateperiod.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>DatePeriod::__construct</refname>
  <refpurpose>新しい DatePeriod オブジェクトを作成する</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <constructorsynopsis role="DatePeriod">
   <modifier>public</modifier> <methodname>DatePeriod::__construct</methodname>
   <methodparam><type>DateTimeInterface</type><parameter>start</parameter></methodparam>
   <methodparam><type>DateInterval</type><parameter>interval</parameter></methodparam>
   <methodparam><type>int</type><parameter>recurrences</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
  </constructorsynopsis>
  <constructorsynopsis role="DatePeriod">
   <modifier>public</modifier> <methodname>DatePeriod::__construct</methodname>
   <methodparam><type>DateTimeInterface</type><parameter>start</parameter></methodparam>
   <methodparam><type>DateInterval</type><parameter>interval</parameter></methodparam>
   <methodparam><type>DateTimeInterface</type><parameter>end</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
  </constructorsynopsis>
  <warning>
   <constructorsynopsis role="DatePeriod">
    <modifier>public</modifier> <methodname>DatePeriod::__construct</methodname>
    <methodparam><type>string</type><parameter>isostr</parameter></methodparam>
    <methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
   </constructorsynopsis>
   <simpara>
    このコンストラクタのバリエーションは、推奨されなくなりました。
    代わりに、<methodname>DatePeriod::createFromISO8601String</methodname>
    を使いましょう。
   </simpara>
  </warning>
  <para>
   新しい DatePeriod オブジェクトを作成します。
  </para>
  <para>
   <classname>DatePeriod</classname> オブジェクトは、
   たくさんの <classname>DateTimeImmutable</classname>
   や <classname>DateTime</classname> を生成するイテレータとして使えます。
   パラメータ <parameter>start</parameter>,
   <parameter>interval</parameter>,
   <parameter>end</parameter>, および <parameter>recurrences</parameter>
   の数を指定できます。
  </para>
  <para>
   返されるオブジェクトのクラスは、
   <parameter>start</parameter> の祖先になるオブジェクトで、
   <classname>DateTimeImmutable</classname> や
   <classname>DateTime</classname> に等しくなります。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>start</parameter></term>
     <listitem>
      <para>
       期間の開始日。デフォルトでは、
       結果セットに含まれています。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>interval</parameter></term>
     <listitem>
      <para>
       期間内での発生間隔。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>recurrences</parameter></term>
     <listitem>
      <para>
       反復回数。
       返される結果の数は、この値よりひとつ大きくなります。
       なぜなら、デフォルトでは結果セットに開始日が含まれているからです。
       <literal>0</literal> より大きな値でなければいけません。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>end</parameter></term>
     <listitem>
      <para>
       期間の終了日。
       デフォルトでは、結果セットから除外されています。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>isostr</parameter></term>
     <listitem>
      <para>
       <link
        xlink:href="&url.iso-8601.repeating_intervals;">ISO 8601 repeating interval specification</link> のサブセットを指定します。
      </para>
      <para>
       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>
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   <parameter>isostr</parameter> が有効な ISO 8601 の期間としてパースできない場合、
   <classname>DateMalformedPeriodStringException</classname> をスローします。
   これより前のバージョンでは、<exceptionname>Exception</exceptionname> がスローされていました。
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>8.3.0</entry>
       <entry>
        <exceptionname>Exception</exceptionname> ではなく、
        <exceptionname>DateMalformedPeriodStringException</exceptionname>
        がスローされるようになりました。
       </entry>
      </row>
      <row>
       <entry>8.2.0</entry>
       <entry>
        定数 <constant>DatePeriod::INCLUDE_END_DATE</constant>
        が追加されました。
       </entry>
      </row>
      <row>
       <entry>7.2.19, 7.3.6, 7.4.0</entry>
       <entry>
        <parameter>recurrences</parameter> は、<literal>0</literal> より大きな値が必須になりました。
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>DatePeriod の例</title>
    <programlisting role="php">
<![CDATA[
<?php
$start = new DateTime('2012-07-01');
$interval = new DateInterval('P7D');
$end = new DateTime('2012-07-31');
$recurrences = 4;
$iso = 'R4/2012-07-01T00:00:00Z/P7D';

// これらはすべて同じ意味です
$period = new DatePeriod($start, $interval, $recurrences);
$period = new DatePeriod($start, $interval, $end);
$period = new DatePeriod($iso);

// DatePeriod の反復処理をすると、
// 期間内のすべての発生日が表示されます。
foreach ($period as $date) {
    echo $date->format('Y-m-d')."\n";
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
2012-07-01
2012-07-08
2012-07-15
2012-07-22
2012-07-29
]]>
    </screen>
   </example>
  </para>
  <para>
   <example>
    <title>DatePeriod で <constant>DatePeriod::EXCLUDE_START_DATE</constant> を使う例</title>
    <programlisting role="php">
<![CDATA[
<?php
$start = new DateTime('2012-07-01');
$interval = new DateInterval('P7D');
$end = new DateTime('2012-07-31');

$period = new DatePeriod($start, $interval, $end,
                         DatePeriod::EXCLUDE_START_DATE);

// DatePeriod の反復処理をすると、
// 期間内のすべての発生日が表示されます。
// ただし、今回の場合は 2012-07-01 が表示されません。
foreach ($period as $date) {
    echo $date->format('Y-m-d')."\n";
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
2012-07-08
2012-07-15
2012-07-22
2012-07-29
]]>
    </screen>
   </example>
  </para>
  <para>
   <example>
    <title>一年間に含まれる、月の最後の木曜日を全て表示する、DatePeriod の例</title>
    <programlisting role="php">
<![CDATA[
<?php
$begin = new DateTime('2021-12-31');
$end = new DateTime('2022-12-31 23:59:59');

$interval = DateInterval::createFromDateString('last thursday of next month');
$period = new DatePeriod($begin, $interval, $end, DatePeriod::EXCLUDE_START_DATE);

foreach ($period as $dt) {
    echo $dt->format('l Y-m-d'), "\n";
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Thursday 2022-01-27
Thursday 2022-02-24
Thursday 2022-03-31
Thursday 2022-04-28
Thursday 2022-05-26
Thursday 2022-06-30
Thursday 2022-07-28
Thursday 2022-08-25
Thursday 2022-09-29
Thursday 2022-10-27
Thursday 2022-11-24
Thursday 2022-12-29
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <simpara>
   ISO 8601 のセクション 4.5 "Recurring time interval" に記載されている無限回数の繰り返しには対応していません。
   つまり、<parameter>isostr</parameter> に
   <literal>"R/..."</literal> を渡したり <parameter>end</parameter>
   に &null; を渡したりしても動作しません。
  </simpara>
 </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
-->