<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.datetimeinterface.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'datetime.diff.php',
    1 => 'DateTimeInterface::diff',
  ),
  'up' => 
  array (
    0 => 'class.datetimeinterface.php',
    1 => 'DateTimeInterface',
  ),
  'prev' => 
  array (
    0 => 'class.datetimeinterface.php',
    1 => 'DateTimeInterface',
  ),
  'next' => 
  array (
    0 => 'datetime.format.php',
    1 => 'DateTimeInterface::format',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'pt_BR',
    'path' => 'reference/datetime/datetimeinterface/diff.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="datetime.diff" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">DateTimeInterface::diff</h1>
  <h1 class="refname">DateTimeImmutable::diff</h1>
  <h1 class="refname">DateTime::diff</h1>
  <h1 class="refname">date_diff</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.3.0, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">DateTimeInterface::diff</span> -- <span class="refname">DateTimeImmutable::diff</span> -- <span class="refname">DateTime::diff</span> -- <span class="refname">date_diff</span> &mdash; <span class="dc-title">Retorna a diferença entre dois objetos DateTime</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-datetime.diff-description">
  <h3 class="title">Descrição</h3>
  <p class="para">Estilo orientado a objetos</p>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>DateTimeInterface::diff</strong></span>(<span class="methodparam"><span class="type"><a href="class.datetimeinterface.php" class="type DateTimeInterface">DateTimeInterface</a></span> <code class="parameter">$targetObject</code></span>, <span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$absolute</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong></span></span>): <span class="type"><a href="class.dateinterval.php" class="type DateInterval">DateInterval</a></span></div>

  <div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><strong>DateTimeImmutable::diff</strong></span>(<span class="methodparam"><span class="type"><a href="class.datetimeinterface.php" class="type DateTimeInterface">DateTimeInterface</a></span> <code class="parameter">$targetObject</code></span>, <span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$absolute</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong></span></span>): <span class="type"><a href="class.dateinterval.php" class="type DateInterval">DateInterval</a></span></div>

  <div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><strong>DateTime::diff</strong></span>(<span class="methodparam"><span class="type"><a href="class.datetimeinterface.php" class="type DateTimeInterface">DateTimeInterface</a></span> <code class="parameter">$targetObject</code></span>, <span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$absolute</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong></span></span>): <span class="type"><a href="class.dateinterval.php" class="type DateInterval">DateInterval</a></span></div>

  <p class="para rdfs-comment">Estilo procedural</p>
  <div class="methodsynopsis dc-description"><span class="methodname"><a href="function.date-diff.php" class="methodname">date_diff</a></span>(<span class="methodparam"><span class="type"><a href="class.datetimeinterface.php" class="type DateTimeInterface">DateTimeInterface</a></span> <code class="parameter">$baseObject</code></span>, <span class="methodparam"><span class="type"><a href="class.datetimeinterface.php" class="type DateTimeInterface">DateTimeInterface</a></span> <code class="parameter">$targetObject</code></span>, <span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$absolute</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong></span></span>): <span class="type"><a href="class.dateinterval.php" class="type DateInterval">DateInterval</a></span></div>

  <p class="para rdfs-comment">
   Retorna a diferença entre dois objetos que implementam a classe
   <span class="classname"><a href="class.datetimeinterface.php" class="classname">DateTimeInterface</a></span>.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-datetime.diff-parameters">
  <h3 class="title">Parâmetros</h3>
  <dl>
   
    <dt><code class="parameter">datetime</code></dt>
    <dd>
     <p class="para">
      A data a ser comparada.
     </p>
    </dd>
   
   
    <dt><code class="parameter">absolute</code></dt>
    <dd>
     <p class="para">
      O intervalo deve ser forçado como positivo?
     </p>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-datetime.diff-returnvalues">
  <h3 class="title">Valor Retornado</h3>
  <p class="para">
   O objeto <span class="classname"><a href="class.dateinterval.php" class="classname">DateInterval</a></span> representa a
   diferença entre as duas datas.
  </p>
  <p class="para">
   O parâmetro <code class="parameter">absolute</code> afeta somente a
   propriedade <code class="parameter">invert</code> de um
   objeto <span class="classname"><a href="class.dateinterval.php" class="classname">DateInterval</a></span>.
  </p>
  <p class="para">
   O valor de retorno representa mais especificamente o intervalo de tempo a
   ser aplicado ao objeto original (<code class="parameter">$this</code> ou
   <code class="parameter">$originObject</code>) para se chegar ao
   <code class="parameter">$targetObject</code>. Este processo nem sempre é
   reversível.
  </p>
  <p class="para">
   O método leva em conta mudanças de horário de verão, e por isso pode
   retornar um intervalo de <code class="literal">24 horas e 30 minutos</code>, por exemplo.
   Se a intenção for fazer cálculos com horários absolutos, será necessário converter
   tanto <code class="parameter">$this</code>/<code class="parameter">$baseObject</code> quanto
   <code class="parameter">$targetObject</code> para UTC primeiro.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-datetime.diff-examples">
  <h3 class="title">Exemplos</h3>
  <div class="example" id="example-2224">
   <p><strong>Exemplo #1 Exemplo do método <span class="function"><strong>DateTimeImmutable::diff()</strong></span></strong></p>
   <div class="example-contents"><p>Estilo orientado a objetos</p></div>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$origin </span><span style="color: #007700">= new </span><span style="color: #0000BB">DateTime</span><span style="color: #007700">(</span><span style="color: #DD0000">'2009-10-11'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$target </span><span style="color: #007700">= new </span><span style="color: #0000BB">DateTime</span><span style="color: #007700">(</span><span style="color: #DD0000">'2009-10-13'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$interval </span><span style="color: #007700">= </span><span style="color: #0000BB">$origin</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">diff</span><span style="color: #007700">(</span><span style="color: #0000BB">$target</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">'%R%a dias'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

   <div class="example-contents"><p>Estilo procedural</p></div>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$origin </span><span style="color: #007700">= </span><span style="color: #0000BB">date_create</span><span style="color: #007700">(</span><span style="color: #DD0000">'2009-10-11'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$target </span><span style="color: #007700">= </span><span style="color: #0000BB">date_create</span><span style="color: #007700">(</span><span style="color: #DD0000">'2009-10-13'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$interval </span><span style="color: #007700">= </span><span style="color: #0000BB">date_diff</span><span style="color: #007700">(</span><span style="color: #0000BB">$origin</span><span style="color: #007700">, </span><span style="color: #0000BB">$target</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">'%R%a dias'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

   <div class="example-contents"><p>Os exemplos acima produzirão:</p></div>
   <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">+2 dias</pre>
</div>
   </div>
  </div>

  <div class="example" id="example-2225">
   <p><strong>Exemplo #2 <span class="methodname"><strong>DateTimeInterface::diff()</strong></span> durante mudança
   de horário de verão</strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$originalTime </span><span style="color: #007700">= new </span><span style="color: #0000BB">DateTimeImmutable</span><span style="color: #007700">(</span><span style="color: #DD0000">"2021-10-30 09:00:00 Europe/London"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$targetTime </span><span style="color: #007700">= new </span><span style="color: #0000BB">DateTimeImmutable</span><span style="color: #007700">(</span><span style="color: #DD0000">"2021-10-31 08:30:00 Europe/London"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$interval </span><span style="color: #007700">= </span><span style="color: #0000BB">$originalTime</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">diff</span><span style="color: #007700">(</span><span style="color: #0000BB">$targetTime</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">"%H:%I:%S (Dias inteiros: %a)"</span><span style="color: #007700">), </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

   <div class="example-contents"><p>O exemplo acima produzirá:</p></div>
   <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">24:30:00 (Dias inteiros: 0)</pre>
</div>
   </div>
  </div>

  <div class="example" id="example-2226">
   <p><strong>Exemplo #3 Intervalo do método <span class="methodname"><strong>DateTimeInterface::diff()</strong></span></strong></p>
   <div class="example-contents"><p>
    O valor que o método retorna é a quantidade exata de tempo para sair de
    <code class="parameter">$this</code> e chegar em <code class="parameter">$targetObject</code>.
    Comparando 1º de janeiro com 31 de dezembro retorna portanto 364, e não 365
    dias (para anos não bissextos).
   </p></div>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$originalTime </span><span style="color: #007700">= new </span><span style="color: #0000BB">DateTimeImmutable</span><span style="color: #007700">(</span><span style="color: #DD0000">"2023-01-01 UTC"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$targetTime </span><span style="color: #007700">= new </span><span style="color: #0000BB">DateTimeImmutable</span><span style="color: #007700">(</span><span style="color: #DD0000">"2023-12-31 UTC"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$interval </span><span style="color: #007700">= </span><span style="color: #0000BB">$originalTime</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">diff</span><span style="color: #007700">(</span><span style="color: #0000BB">$targetTime</span><span style="color: #007700">);<br />echo </span><span style="color: #DD0000">"Dias inteiros: "</span><span style="color: #007700">, </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">"%a"</span><span style="color: #007700">), </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

   <div class="example-contents"><p>O exemplo acima produzirá:</p></div>
   <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">Dias inteiros: 364</pre>
</div>
   </div>
  </div>

  <div class="example" id="example-2227">
   <p><strong>Exemplo #4 Comparação entre objetos <span class="classname"><a href="class.datetime.php" class="classname">DateTime</a></span></strong></p>
   <blockquote class="note"><p><strong class="note">Nota</strong>: 
    <p class="para">
     Objetos das classes <span class="classname"><a href="class.datetimeimmutable.php" class="classname">DateTimeImmutable</a></span> e <span class="classname"><a href="class.datetime.php" class="classname">DateTime</a></span>
     podem ser comparados utilizando os
     <a href="language.operators.comparison.php" class="link">operadores de comparação</a>.
    </p>
   </p></blockquote>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$date1 </span><span style="color: #007700">= new </span><span style="color: #0000BB">DateTime</span><span style="color: #007700">(</span><span style="color: #DD0000">"now"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$date2 </span><span style="color: #007700">= new </span><span style="color: #0000BB">DateTime</span><span style="color: #007700">(</span><span style="color: #DD0000">"tomorrow"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$date1 </span><span style="color: #007700">== </span><span style="color: #0000BB">$date2</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$date1 </span><span style="color: #007700">&lt; </span><span style="color: #0000BB">$date2</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$date1 </span><span style="color: #007700">&gt; </span><span style="color: #0000BB">$date2</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

   <div class="example-contents"><p>O exemplo acima produzirá:</p></div>
   <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">bool(false)
bool(true)
bool(false)</pre>
</div>
   </div>
  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-datetime.diff-seealso">
  <h3 class="title">Veja Também</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="dateinterval.format.php" class="function" rel="rdfs-seeAlso">DateInterval::format()</a> - Formata um intervalo</span></li>
   <li><span class="function"><a href="datetime.add.php" class="function" rel="rdfs-seeAlso">DateTime::add()</a> - Modifica um objeto DateTime, com adi&ccedil;&atilde;o de dias, meses, anos, horas, minutos e segundos.</span></li>
   <li><span class="function"><a href="datetime.sub.php" class="function" rel="rdfs-seeAlso">DateTime::sub()</a> - Subtrai uma quantidade de dias, meses, anos, horas, minutos e segundos de
   um objeto DateTime</span></li>
  </ul>
 </div>


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