mirror of
https://github.com/php/doc-ja.git
synced 2026-03-24 15:12:22 +01:00
240 lines
7.5 KiB
XML
240 lines
7.5 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- EN-Revision: 3a8c3e77df070a046c9d5b56b68926ca2d7e5ee3 Maintainer: takagi Status: ready -->
|
|
<!-- Credits: mumumu -->
|
|
|
|
<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>ふたつの 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>
|
|
ふたつの DateTime オブジェクトの差を返します。
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>datetime</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
比較する日付。
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>absolute</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
間隔が正の数になるようにするか否か。
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
ふたつの日付の差をあらわす <classname>DateInterval</classname> オブジェクトを返します。
|
|
</para>
|
|
<para>
|
|
<parameter>absolute</parameter> は、
|
|
<classname>DateInterval</classname> オブジェクトの
|
|
<parameter>invert</parameter> プロパティにのみ影響します。
|
|
</para>
|
|
<para>
|
|
さらに厳密に言うと、戻り値はもともとのオブジェクト
|
|
(<parameter>$this</parameter> または
|
|
<parameter>$originObject</parameter>) を
|
|
<parameter>$targetObject</parameter> にするために適用すべき経過時間の差分を示しています。
|
|
このプロセスは可逆とは限りません。
|
|
</para>
|
|
<para>
|
|
このメソッドは夏時間の切り替えを認識するため、
|
|
<literal>24 hours and 30 minutes</literal>
|
|
という時間差を返す可能性があります。
|
|
以下で例示するサンプルコードでそれを示します。
|
|
完全な時間差を計算したい場合、
|
|
<parameter>$this</parameter>/<parameter>$baseObject</parameter> と
|
|
<parameter>$targetObject</parameter> をUTC に変換する必要があります。
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<example>
|
|
<title><function>DateTimeImmutable::diff</function> の例</title>
|
|
<para>&style.oop;</para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$origin = new DateTimeImmutable('2009-10-11');
|
|
$target = new DateTimeImmutable('2009-10-13');
|
|
$interval = $origin->diff($target);
|
|
echo $interval->format('%R%a days');
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
+2 days
|
|
]]>
|
|
</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 days');
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
+2 days
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
|
|
<example>
|
|
<title>夏時間の切り替え期間中の <methodname>DateTimeInterface::diff</methodname> の動き</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 (Full days: %a)"), "\n";
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
24:30:00 (Full days: 0)
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
|
|
<example>
|
|
<title><methodname>DateTimeInterface::diff</methodname> range</title>
|
|
<para>
|
|
このメソッドが返す値は、
|
|
<parameter>$this</parameter> から <parameter>$targetObject</parameter>
|
|
までの範囲から取得した正確な時間です。
|
|
よって、（うるう年でない場合) 1月1日から12月31日までを比較すると、
|
|
365 ではなく、364 が返ってきます。
|
|
</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 "Full days: ", $interval->format("%a"), "\n";
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
Full days: 364
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
|
|
<example>
|
|
<title><classname>DateTime</classname> オブジェクトの比較</title>
|
|
<note>
|
|
<para>
|
|
<classname>DateTimeImmutable</classname> と
|
|
<classname>DateTime</classname> オブジェクトは、
|
|
<link linkend="language.operators.comparison">比較演算子</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
|
|
-->
|