mirror of
https://github.com/php/doc-pt_br.git
synced 2026-03-24 07:02:09 +01:00
236 lines
7.4 KiB
XML
236 lines
7.4 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- EN-Revision: 3a8c3e77df070a046c9d5b56b68926ca2d7e5ee3 Maintainer: leonardolara Status: ready --><!-- CREDITS: fabioluciano, leonardolara -->
|
|
<refentry xml:id="datetime.diff" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>DateTimeInterface::diff</refname>
|
|
<refname>DateTimeImmutable::diff</refname>
|
|
<refname>DateTime::diff</refname>
|
|
<refname>date_diff</refname>
|
|
<refpurpose>Retorna a diferença entre dois objetos DateTime</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<para>&style.oop;</para>
|
|
<methodsynopsis role="DateTimeInterface">
|
|
<modifier>public</modifier> <type>DateInterval</type><methodname>DateTimeInterface::diff</methodname>
|
|
<methodparam><type>DateTimeInterface</type><parameter>targetObject</parameter></methodparam>
|
|
<methodparam choice="opt"><type>bool</type><parameter>absolute</parameter><initializer>&false;</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<methodsynopsis role="DateTimeImmutable">
|
|
<modifier>public</modifier> <type>DateInterval</type><methodname>DateTimeImmutable::diff</methodname>
|
|
<methodparam><type>DateTimeInterface</type><parameter>targetObject</parameter></methodparam>
|
|
<methodparam choice="opt"><type>bool</type><parameter>absolute</parameter><initializer>&false;</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<methodsynopsis role="DateTime">
|
|
<modifier>public</modifier> <type>DateInterval</type><methodname>DateTime::diff</methodname>
|
|
<methodparam><type>DateTimeInterface</type><parameter>targetObject</parameter></methodparam>
|
|
<methodparam choice="opt"><type>bool</type><parameter>absolute</parameter><initializer>&false;</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>&style.procedural;</para>
|
|
<methodsynopsis>
|
|
<type>DateInterval</type><methodname>date_diff</methodname>
|
|
<methodparam><type>DateTimeInterface</type><parameter>baseObject</parameter></methodparam>
|
|
<methodparam><type>DateTimeInterface</type><parameter>targetObject</parameter></methodparam>
|
|
<methodparam choice="opt"><type>bool</type><parameter>absolute</parameter><initializer>&false;</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Retorna a diferença entre dois objetos que implementam a classe
|
|
<classname>DateTimeInterface</classname>.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>datetime</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A data a ser comparada.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>absolute</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Informa se o intervalo deve ser forçado como positivo.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
O objeto <classname>DateInterval</classname> representa a
|
|
diferença entre as duas datas.
|
|
</para>
|
|
<para>
|
|
O parâmetro <parameter>absolute</parameter> afeta somente a
|
|
propriedade <parameter>invert</parameter> de um
|
|
objeto <classname>DateInterval</classname>.
|
|
</para>
|
|
<para>
|
|
O valor de retorno representa mais especificamente o intervalo de tempo a
|
|
ser aplicado ao objeto original (<parameter>$this</parameter> ou
|
|
<parameter>$originObject</parameter>) para se chegar ao
|
|
<parameter>$targetObject</parameter>. Este processo nem sempre é
|
|
reversível.
|
|
</para>
|
|
<para>
|
|
O método leva em conta mudanças de horário de verão, e por isso pode
|
|
retornar um intervalo de <literal>24 horas e 30 minutos</literal>, por exemplo.
|
|
Se a intenção for fazer cálculos com horários absolutos, será necessário converter
|
|
tanto <parameter>$this</parameter>/<parameter>$baseObject</parameter> quanto
|
|
<parameter>$targetObject</parameter> para UTC primeiro.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<example>
|
|
<title>Exemplo do método <function>DateTimeImmutable::diff</function></title>
|
|
<para>&style.oop;</para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$origin = new DateTime('2009-10-11');
|
|
$target = new DateTime('2009-10-13');
|
|
$interval = $origin->diff($target);
|
|
echo $interval->format('%R%a dias');
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
+2 dias
|
|
]]>
|
|
</screen>
|
|
<para>&style.procedural;</para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$origin = date_create('2009-10-11');
|
|
$target = date_create('2009-10-13');
|
|
$interval = date_diff($origin, $target);
|
|
echo $interval->format('%R%a dias');
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
+2 dias
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
|
|
<example>
|
|
<title><methodname>DateTimeInterface::diff</methodname> durante mudança
|
|
de horário de verão</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$originalTime = new DateTimeImmutable("2021-10-30 09:00:00 Europe/London");
|
|
$targetTime = new DateTimeImmutable("2021-10-31 08:30:00 Europe/London");
|
|
$interval = $originalTime->diff($targetTime);
|
|
echo $interval->format("%H:%I:%S (Dias inteiros: %a)"), "\n";
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
24:30:00 (Dias inteiros: 0)
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
|
|
<example>
|
|
<title>Intervalo do método <methodname>DateTimeInterface::diff</methodname></title>
|
|
<para>
|
|
O valor que o método retorna é a quantidade exata de tempo para sair de
|
|
<parameter>$this</parameter> e chegar em <parameter>$targetObject</parameter>.
|
|
Comparando 1º de janeiro com 31 de dezembro retorna portanto 364, e não 365
|
|
dias (para anos não bissextos).
|
|
</para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$originalTime = new DateTimeImmutable("2023-01-01 UTC");
|
|
$targetTime = new DateTimeImmutable("2023-12-31 UTC");
|
|
$interval = $originalTime->diff($targetTime);
|
|
echo "Dias inteiros: ", $interval->format("%a"), "\n";
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
Dias inteiros: 364
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
|
|
<example>
|
|
<title>Comparação entre objetos <classname>DateTime</classname></title>
|
|
<note>
|
|
<para>
|
|
Objetos das classes <classname>DateTimeImmutable</classname> e <classname>DateTime</classname>
|
|
podem ser comparados utilizando os
|
|
<link linkend="language.operators.comparison">operadores de comparação</link>.
|
|
</para>
|
|
</note>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$date1 = new DateTime("now");
|
|
$date2 = new DateTime("tomorrow");
|
|
|
|
var_dump($date1 == $date2);
|
|
var_dump($date1 < $date2);
|
|
var_dump($date1 > $date2);
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
bool(false)
|
|
bool(true)
|
|
bool(false)
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<simplelist>
|
|
<member><function>DateInterval::format</function></member>
|
|
<member><function>DateTime::add</function></member>
|
|
<member><function>DateTime::sub</function></member>
|
|
</simplelist>
|
|
</refsect1>
|
|
|
|
</refentry>
|
|
<!-- 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
|
|
-->
|