<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.dateperiod" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

 <title>The DatePeriod class</title>
 <titleabbrev>DatePeriod</titleabbrev>

 <partintro>

<!-- {{{ DatePeriod intro -->
  <section xml:id="dateperiod.intro">
   &reftitle.intro;
   <para>
    Represents a date period.
   </para>
   <para>
    A date period allows iteration over a set of dates and times, recurring at
    regular intervals, over a given period.
   </para>
  </section>
<!-- }}} -->

  <section xml:id="dateperiod.synopsis">
   &reftitle.classsynopsis;

<!-- {{{ Synopsis -->
   <classsynopsis class="class">
    <ooclass>
     <classname>DatePeriod</classname>
    </ooclass>

    <oointerface>
     <modifier>implements</modifier>
     <interfacename>IteratorAggregate</interfacename>
    </oointerface>

    <classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="dateperiod.constants.exclude-start-date">DatePeriod::EXCLUDE_START_DATE</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="dateperiod.constants.include-end-date">DatePeriod::INCLUDE_END_DATE</varname>
    </fieldsynopsis>

    <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>readonly</modifier>
     <type class="union"><type>DateTimeInterface</type><type>null</type></type>
     <varname linkend="dateperiod.props.start">start</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>readonly</modifier>
     <type class="union"><type>DateTimeInterface</type><type>null</type></type>
     <varname linkend="dateperiod.props.current">current</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>readonly</modifier>
     <type class="union"><type>DateTimeInterface</type><type>null</type></type>
     <varname linkend="dateperiod.props.end">end</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>readonly</modifier>
     <type class="union"><type>DateInterval</type><type>null</type></type>
     <varname linkend="dateperiod.props.interval">interval</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>readonly</modifier>
     <type>int</type>
     <varname linkend="dateperiod.props.recurrences">recurrences</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>readonly</modifier>
     <type>bool</type>
     <varname linkend="dateperiod.props.include-start-date">include_start_date</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>readonly</modifier>
     <type>bool</type>
     <varname linkend="dateperiod.props.include-end-date">include_end_date</varname>
    </fieldsynopsis>

    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.dateperiod')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[@role='DatePeriod'])">
     <xi:fallback/>
    </xi:include>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.dateperiod')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='DatePeriod'])">
     <xi:fallback/>
    </xi:include>
   </classsynopsis>
<!-- }}} -->

  </section>

<!-- {{{ DatePeriod constants -->
  <section xml:id="dateperiod.constants">
   &reftitle.constants;
   <variablelist>
    <varlistentry xml:id="dateperiod.constants.exclude-start-date">
     <term>
      <constant>DatePeriod::EXCLUDE_START_DATE</constant>
      <type>int</type>
     </term>
     <listitem>
      <para>Exclude start date, used in <function>DatePeriod::__construct</function>.</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="dateperiod.constants.include-end-date">
     <term>
      <constant>DatePeriod::INCLUDE_END_DATE</constant>
      <type>int</type>
     </term>
     <listitem>
      <para>Include end date, used in <function>DatePeriod::__construct</function>.</para>
     </listitem>
    </varlistentry>

   </variablelist>
  </section>
<!-- }}} -->

  <section xml:id="dateperiod.props">
   &reftitle.properties;
   <variablelist>
    <varlistentry xml:id="dateperiod.props.recurrences">
     <term><varname>recurrences</varname></term>
     <listitem>
      <para>
       The minimum amount of instances as retured by the iterator.
      </para>
      <para>
       If the number of recurrences has been explicitly passed through the
       <varname>recurrences</varname> parameter in the constructor of the
       <classname>DatePeriod</classname> instance, then this property contains
       this value, <emphasis>plus</emphasis> one if the start date has not been disabled
       through <constant>DatePeriod::EXCLUDE_START_DATE</constant>,
       <emphasis>plus</emphasis> one if the end date has been enabled through
       <constant>DatePeriod::INCLUDE_END_DATE</constant>.
      </para>
      <para>
       If the number of recurrences has not been explicitly passed, then this
       property contains the minimum number of returned instances. This would
       be <literal>0</literal>, <emphasis>plus</emphasis> one if the start date
       has not been disabled through
       <constant>DatePeriod::EXCLUDE_START_DATE</constant>,
       <emphasis>plus</emphasis> one if the end date has been enabled through
       <constant>DatePeriod::INCLUDE_END_DATE</constant>.
      </para>
      <para>
       <informalexample>
        <programlisting role="php">
<![CDATA[<?php
$start = new DateTime('2018-12-31 00:00:00');
$end   = new DateTime('2021-12-31 00:00:00');
$interval = new DateInterval('P1M');
$recurrences = 5;

// recurrences explicitly set through the constructor
$period = new DatePeriod($start, $interval, $recurrences, DatePeriod::EXCLUDE_START_DATE);
echo $period->recurrences, "\n";

$period = new DatePeriod($start, $interval, $recurrences);
echo $period->recurrences, "\n";

$period = new DatePeriod($start, $interval, $recurrences, DatePeriod::INCLUDE_END_DATE);
echo $period->recurrences, "\n";

// recurrences not set in the constructor
$period = new DatePeriod($start, $interval, $end);
echo $period->recurrences, "\n";

$period = new DatePeriod($start, $interval, $end, DatePeriod::EXCLUDE_START_DATE);
echo $period->recurrences, "\n";
?>]]>
         </programlisting>
         &example.outputs;
         <screen role="php">
5
6
7
1
0
         </screen>
        </informalexample>
       </para>
      <para>
       See also <methodname>DatePeriod::getRecurrences</methodname>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="dateperiod.props.include-end-date">
     <term><varname>include_end_date</varname></term>
     <listitem>
      <para>
       Whether to include the end date in the set of recurring dates or not.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="dateperiod.props.include-start-date">
     <term><varname>include_start_date</varname></term>
     <listitem>
      <para>
       Whether to include the start date in the set of recurring dates or not.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="dateperiod.props.start">
     <term><varname>start</varname></term>
     <listitem>
      <para>
       The start date of the period.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="dateperiod.props.current">
     <term><varname>current</varname></term>
     <listitem>
      <para>
       During iteration this will contain the current date within the period.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="dateperiod.props.end">
     <term><varname>end</varname></term>
     <listitem>
      <para>
       The end date of the period.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="dateperiod.props.interval">
     <term><varname>interval</varname></term>
     <listitem>
      <para>
       An ISO 8601 repeating interval specification.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </section>

  <section 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>
        The class constants are now typed.
       </entry>
      </row>
      <row>
       <entry>8.2.0</entry>
       <entry>
        The <constant>DatePeriod::INCLUDE_END_DATE</constant> constant and
        <property>include_end_date</property> property have been added.
       </entry>
      </row>
      <row>
       <entry>8.0.0</entry>
       <entry>
        <classname>DatePeriod</classname> implements
        <interfacename>IteratorAggregate</interfacename> now.
        Previously, <interfacename>Traversable</interfacename> was implemented instead.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </section>

 </partintro>

 &reference.datetime.entities.dateperiod;

</reference>
<!-- 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
-->