php-doc-en/reference/datetime/dateperiod.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<phpdoc:classref xml:id="class.dateperiod" xmlns:phpdoc="http://php.net/ns/phpdoc" 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>
    <ooclass><classname>DatePeriod</classname></ooclass>

<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
      <classname>DatePeriod</classname>
     </ooclass>
     
     <oointerface>
      <interfacename>Traversable</interfacename>
     </oointerface>
    </classsynopsisinfo>
<!-- }}} -->
    <classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="dateperiod.constants.exclude-start-date">DatePeriod::EXCLUDE_START_DATE</varname>
     <initializer>1</initializer>
    </fieldsynopsis>

    <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>int</type>
     <varname linkend="dateperiod.props.recurrences">recurrences</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>bool</type>
     <varname linkend="dateperiod.props.include_start_date">include_start_date</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>DateTimeInterface</type>
     <varname linkend="dateperiod.props.start">start</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>DateTimeInterface</type>
     <varname linkend="dateperiod.props.current">current</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>DateTimeInterface</type>
     <varname linkend="dateperiod.props.end">end</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>DateInterval</type>
     <varname linkend="dateperiod.props.interval">interval</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[not(@role='procedural')])">
     <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:destructorsynopsis[not(@role='procedural')])">
     <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[not(@role='procedural')])">
     <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></term>
     <listitem>
      <para>Exclude start 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 number of recurrences, if the <classname>DatePeriod</classname> instance
       had been created by explicitly passing <literal>$recurrences</literal>.
       See also <methodname>DatePeriod::getRecurrences</methodname>.
      </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" xml:id="dateperiod.changelog">
   &reftitle.changelog;
   <para>
    <informaltable>
     <tgroup cols="2">
      <thead>
       <row>
        <entry>&Version;</entry>
        <entry>&Description;</entry>
       </row>
      </thead>
      <tbody>
       <row>
        <entry>5.3.27, 5.4.17</entry>
        <entry>
         The public properties <varname>recurrences</varname>,
         <varname>include_start_date</varname>, <varname>start</varname>,
         <varname>current</varname>, <varname>end</varname> and
         <varname>interval</varname> have been exposed.
        </entry>
       </row>
      </tbody>
     </tgroup>
    </informaltable>
   </para>
  </section>

 </partintro>

 &reference.datetime.entities.dateperiod;

</phpdoc:classref>

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