<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <title>Creates a new DatePeriod object</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="class.dateperiod.html">DatePeriod</a></div> <div class="next" style="text-align: right; float: right;"><a href="dateperiod.getdateinterval.html">DatePeriod::getDateInterval</a></div> <div class="up"><a href="class.dateperiod.html">DatePeriod</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="dateperiod.construct" class="refentry"> <div class="refnamediv"> <h1 class="refname">DatePeriod::__construct</h1> <p class="verinfo">(PHP 5 >= 5.3.0, PHP 7)</p><p class="refpurpose"><span class="refname">DatePeriod::__construct</span> — <span class="dc-title">Creates a new DatePeriod object</span></p> </div> <div class="refsect1 description" id="refsect1-dateperiod.construct-description"> <h3 class="title">Description</h3> <div class="constructorsynopsis dc-description"> <span class="modifier">public</span> <span class="methodname"><strong>DatePeriod::__construct</strong></span> ( <span class="methodparam"><span class="type"><a href="class.datetimeinterface.html" class="type DateTimeInterface">DateTimeInterface</a></span> <code class="parameter">$start</code></span> , <span class="methodparam"><span class="type"><a href="class.dateinterval.html" class="type DateInterval">DateInterval</a></span> <code class="parameter">$interval</code></span> , <span class="methodparam"><span class="type">int</span> <code class="parameter">$recurrences</code></span> [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$options</code></span> ] )</div> <div class="constructorsynopsis dc-description"> <span class="modifier">public</span> <span class="methodname"><strong>DatePeriod::__construct</strong></span> ( <span class="methodparam"><span class="type"><a href="class.datetimeinterface.html" class="type DateTimeInterface">DateTimeInterface</a></span> <code class="parameter">$start</code></span> , <span class="methodparam"><span class="type"><a href="class.dateinterval.html" class="type DateInterval">DateInterval</a></span> <code class="parameter">$interval</code></span> , <span class="methodparam"><span class="type"><a href="class.datetimeinterface.html" class="type DateTimeInterface">DateTimeInterface</a></span> <code class="parameter">$end</code></span> [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$options</code></span> ] )</div> <div class="constructorsynopsis dc-description"> <span class="modifier">public</span> <span class="methodname"><strong>DatePeriod::__construct</strong></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$isostr</code></span> [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$options</code></span> ] )</div> <p class="para rdfs-comment"> Creates a new DatePeriod object. </p> </div> <div class="refsect1 parameters" id="refsect1-dateperiod.construct-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <code class="parameter">start</code></dt> <dd> <p class="para"> The start date of the period. </p> </dd> <dt> <code class="parameter">interval</code></dt> <dd> <p class="para"> The interval between recurrences within the period. </p> </dd> <dt> <code class="parameter">recurrences</code></dt> <dd> <p class="para"> The number of recurrences. </p> </dd> <dt> <code class="parameter">end</code></dt> <dd> <p class="para"> The end date of the period. </p> </dd> <dt> <code class="parameter">isostr</code></dt> <dd> <p class="para"> An ISO 8601 repeating interval specification. </p> </dd> <dt> <code class="parameter">options</code></dt> <dd> <p class="para"> Can be set to <strong><code>DatePeriod::EXCLUDE_START_DATE</code></strong> to exclude the start date from the set of recurring dates within the period. </p> </dd> </dl> </p> </div> <div class="refsect1 changelog" id="refsect1-dateperiod.construct-changelog"> <h3 class="title">Changelog</h3> <p class="para"> <table class="doctable informaltable"> <thead> <tr> <th>Version</th> <th>Description</th> </tr> </thead> <tbody class="tbody"> <tr> <td>5.5.8</td> <td> <code class="parameter">end</code> type changed to <span class="interfacename"><a href="class.datetimeinterface.html" class="interfacename">DateTimeInterface</a></span>. Previously, <a href="class.datetime.html" class="classname">DateTime</a>. </td> </tr> <tr> <td>5.5.0</td> <td> <code class="parameter">start</code> type changed to <span class="interfacename"><a href="class.datetimeinterface.html" class="interfacename">DateTimeInterface</a></span>. Previously, <a href="class.datetime.html" class="classname">DateTime</a>. </td> </tr> </tbody> </table> </p> </div> <div class="refsect1 examples" id="refsect1-dateperiod.construct-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-2781"> <p><strong>Example #1 DatePeriod example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$start </span><span style="color: #007700">= new </span><span style="color: #0000BB">DateTime</span><span style="color: #007700">(</span><span style="color: #DD0000">'2012-07-01'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$interval </span><span style="color: #007700">= new </span><span style="color: #0000BB">DateInterval</span><span style="color: #007700">(</span><span style="color: #DD0000">'P7D'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$end </span><span style="color: #007700">= new </span><span style="color: #0000BB">DateTime</span><span style="color: #007700">(</span><span style="color: #DD0000">'2012-07-31'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$recurrences </span><span style="color: #007700">= </span><span style="color: #0000BB">4</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$iso </span><span style="color: #007700">= </span><span style="color: #DD0000">'R4/2012-07-01T00:00:00Z/P7D'</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">// All of these periods are equivalent.<br /></span><span style="color: #0000BB">$period </span><span style="color: #007700">= new </span><span style="color: #0000BB">DatePeriod</span><span style="color: #007700">(</span><span style="color: #0000BB">$start</span><span style="color: #007700">, </span><span style="color: #0000BB">$interval</span><span style="color: #007700">, </span><span style="color: #0000BB">$recurrences</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$period </span><span style="color: #007700">= new </span><span style="color: #0000BB">DatePeriod</span><span style="color: #007700">(</span><span style="color: #0000BB">$start</span><span style="color: #007700">, </span><span style="color: #0000BB">$interval</span><span style="color: #007700">, </span><span style="color: #0000BB">$end</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$period </span><span style="color: #007700">= new </span><span style="color: #0000BB">DatePeriod</span><span style="color: #007700">(</span><span style="color: #0000BB">$iso</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// By iterating over the DatePeriod object, all of the<br />// recurring dates within that period are printed.<br /></span><span style="color: #007700">foreach (</span><span style="color: #0000BB">$period </span><span style="color: #007700">as </span><span style="color: #0000BB">$date</span><span style="color: #007700">) {<br /> echo </span><span style="color: #0000BB">$date</span><span style="color: #007700">-></span><span style="color: #0000BB">format</span><span style="color: #007700">(</span><span style="color: #DD0000">'Y-m-d'</span><span style="color: #007700">).</span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> <div class="example-contents"><p>The above example will output:</p></div> <div class="example-contents screen"> <div class="cdata"><pre> 2012-07-01 2012-07-08 2012-07-15 2012-07-22 2012-07-29 </pre></div> </div> </div> </p> <p class="para"> <div class="example" id="example-2782"> <p><strong>Example #2 DatePeriod example with <strong><code>DatePeriod::EXCLUDE_START_DATE</code></strong></strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$start </span><span style="color: #007700">= new </span><span style="color: #0000BB">DateTime</span><span style="color: #007700">(</span><span style="color: #DD0000">'2012-07-01'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$interval </span><span style="color: #007700">= new </span><span style="color: #0000BB">DateInterval</span><span style="color: #007700">(</span><span style="color: #DD0000">'P7D'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$end </span><span style="color: #007700">= new </span><span style="color: #0000BB">DateTime</span><span style="color: #007700">(</span><span style="color: #DD0000">'2012-07-31'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$period </span><span style="color: #007700">= new </span><span style="color: #0000BB">DatePeriod</span><span style="color: #007700">(</span><span style="color: #0000BB">$start</span><span style="color: #007700">, </span><span style="color: #0000BB">$interval</span><span style="color: #007700">, </span><span style="color: #0000BB">$end</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">DatePeriod</span><span style="color: #007700">::</span><span style="color: #0000BB">EXCLUDE_START_DATE</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// By iterating over the DatePeriod object, all of the<br />// recurring dates within that period are printed.<br />// Note that, in this case, 2012-07-01 is not printed.<br /></span><span style="color: #007700">foreach (</span><span style="color: #0000BB">$period </span><span style="color: #007700">as </span><span style="color: #0000BB">$date</span><span style="color: #007700">) {<br /> echo </span><span style="color: #0000BB">$date</span><span style="color: #007700">-></span><span style="color: #0000BB">format</span><span style="color: #007700">(</span><span style="color: #DD0000">'Y-m-d'</span><span style="color: #007700">).</span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> <div class="example-contents"><p>The above example will output:</p></div> <div class="example-contents screen"> <div class="cdata"><pre> 2012-07-08 2012-07-15 2012-07-22 2012-07-29 </pre></div> </div> </div> </p> </div> <div class="refsect1 notes" id="refsect1-dateperiod.construct-notes"> <h3 class="title">Notes</h3> <p class="simpara"> Unbound numbers of repetitions as specified by ISO 8601 section 4.5 "Recurring time interval" are not supported, i.e. neither passing <em>"R/..."</em> as <code class="parameter">isostr</code> nor passing <strong><code>NULL</code></strong> as <code class="parameter">end</code> would work. </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="class.dateperiod.html">DatePeriod</a></div> <div class="next" style="text-align: right; float: right;"><a href="dateperiod.getdateinterval.html">DatePeriod::getDateInterval</a></div> <div class="up"><a href="class.dateperiod.html">DatePeriod</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>