<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.dateperiod.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'dateperiod.getdateinterval.php',
    1 => 'DatePeriod::getDateInterval',
    2 => 'Gets the interval',
  ),
  'up' => 
  array (
    0 => 'class.dateperiod.php',
    1 => 'DatePeriod',
  ),
  'prev' => 
  array (
    0 => 'dateperiod.createfromiso8601string.php',
    1 => 'DatePeriod::createFromISO8601String',
  ),
  'next' => 
  array (
    0 => 'dateperiod.getenddate.php',
    1 => 'DatePeriod::getEndDate',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/datetime/dateperiod/getdateinterval.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="dateperiod.getdateinterval" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">DatePeriod::getDateInterval</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.6.5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">DatePeriod::getDateInterval</span> &mdash; <span class="dc-title">
   Gets the interval
  </span></p>

 </div>

 <div class="refsect1 description" id="refsect1-dateperiod.getdateinterval-description">
  <h3 class="title">Description</h3>
  <p class="para">Object-oriented style</p>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>DatePeriod::getDateInterval</strong></span>(): <span class="type"><a href="class.dateinterval.php" class="type DateInterval">DateInterval</a></span></div>

  <p class="para rdfs-comment">
   Gets a <span class="classname"><a href="class.dateinterval.php" class="classname">DateInterval</a></span> <span class="type"><a href="language.types.object.php" class="type object">object</a></span>
   representing the interval used for the period.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-dateperiod.getdateinterval-parameters">
  <h3 class="title">Parameters</h3>
  <p class="para">This function has no parameters.</p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-dateperiod.getdateinterval-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="para">
   Returns a <span class="classname"><a href="class.dateinterval.php" class="classname">DateInterval</a></span> <span class="type"><a href="language.types.object.php" class="type object">object</a></span>
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-dateperiod.getdateinterval-examples">
  <h3 class="title">Examples</h3>
  <div class="example" id="example-1">
   <p><strong>Example #1 <span class="methodname"><strong>DatePeriod::getDateInterval()</strong></span> example</strong></p>
   <div class="example-contents">
<div class="annotation-interactive phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$period </span><span style="color: #007700">= </span><span style="color: #0000BB">DatePeriod</span><span style="color: #007700">::</span><span style="color: #0000BB">createFromIso8601String</span><span style="color: #007700">(</span><span style="color: #DD0000">'R7/2016-05-16T00:00:00Z/P1D'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$interval </span><span style="color: #007700">= </span><span style="color: #0000BB">$period</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getDateInterval</span><span style="color: #007700">();<br />echo </span><span style="color: #0000BB">$interval</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">format</span><span style="color: #007700">(</span><span style="color: #DD0000">'%d day'</span><span style="color: #007700">);</span></span></code></div>
   </div>

   <div class="example-contents"><p>The above example will output:</p></div>
   <div class="example-contents screen">
<div class="annotation-interactive examplescode"><pre class="examplescode">1 day</pre>
</div>
   </div>
  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-dateperiod.getdateinterval-seealso">
  <h3 class="title">See Also</h3>
  <ul class="simplelist">
   <li><span class="methodname"><a href="dateperiod.getstartdate.php" class="methodname" rel="rdfs-seeAlso">DatePeriod::getStartDate()</a> - Gets the start date</span></li>
   <li><span class="methodname"><a href="dateperiod.getenddate.php" class="methodname" rel="rdfs-seeAlso">DatePeriod::getEndDate()</a> - Gets the end date</span></li>
  </ul>
 </div>


</div><?php manual_footer($setup); ?>