DateTimeInterface インターフェイス

(PHP 5 >= 5.5.0, PHP 7, PHP 8)

はじめに

DateTimeInterface は、 DateTimeImmutable や DateTime を引数や戻り値、プロパティの型宣言で使えるようにするために作られたものです。このインターフェイスを実装したクラスをユーザー側で作ることはできません。

DateTimeImmutable::format() や DateTime::format() を通じて、 DateTimeImmutable や DateTime をフォーマットするための共通の定数も、このインターフェイスに定義されています。

インターフェイス概要

interface DateTimeInterface {

/* 定数 */

public const string ATOM = "Y-m-d\\TH:i:sP";

public const string COOKIE = "l, d-M-Y H:i:s T";

public const string ISO8601 = "Y-m-d\\TH:i:sO";

public const string ISO8601_EXPANDED = "X-m-d\\TH:i:sP";

public const string RFC822 = "D, d M y H:i:s O";

public const string RFC850 = "l, d-M-y H:i:s T";

public const string RFC1036 = "D, d M y H:i:s O";

public const string RFC1123 = "D, d M Y H:i:s O";

public const string RFC7231 = "D, d M Y H:i:s \\G\\M\\T";

public const string RFC2822 = "D, d M Y H:i:s O";

public const string RFC3339 = "Y-m-d\\TH:i:sP";

public const string RFC3339_EXTENDED = "Y-m-d\\TH:i:s.vP";

public const string RSS = "D, d M Y H:i:s O";

public const string W3C = "Y-m-d\\TH:i:sP";

/* メソッド */

public diff(DateTimeInterface $targetObject, bool $absolute = false): DateInterval

public format(string $format): string

public getOffset(): int

public getTimestamp(): int

public getTimezone(): DateTimeZone|false

public __wakeup(): void

}

定義済み定数

DateTimeInterface::ATOM
DATE_ATOM: Atom (例: 2005-08-15T15:52:01+00:00)
DateTimeInterface::COOKIE
DATE_COOKIE: HTTP Cookie (例: Monday, 15-Aug-2005 15:52:01 UTC)
DateTimeInterface::ISO8601
DATE_ISO8601: ISO-8601 (例: 2005-08-15T15:52:01+0000)
注意: このフォーマットは、ISO-8601 と互換性がありません。しかし、後方互換性を保つために残されています。 ISO-8601 と互換性を保つためには、 DateTimeInterface::ISO8601_EXPANDED, DateTimeInterface::ATOM を使うようにしてください。 (ISO8601:2004 section 4.3.3 clause d も参照ください)
DateTimeInterface::ISO8601_EXPANDED
DATE_ISO8601_EXPANDED: ISO-8601 拡張形式 (例: +10191-07-26T08:59:52+01:00)
注意: 年に常に符号を含めることで、ISO-8601 の通常の範囲 0000-9999 以外の値が許されています。タイムゾーンの部分 (+01:00) については、 ISO-8601 と互換性をとるようにもなっています。
DateTimeInterface::RFC822
DATE_RFC822: RFC 822 (例: Mon, 15 Aug 05 15:52:01 +0000)
DateTimeInterface::RFC850
DATE_RFC850: RFC 850 (例: Monday, 15-Aug-05 15:52:01 UTC)
DateTimeInterface::RFC1036
DATE_RFC1036: RFC 1036 (例: Mon, 15 Aug 05 15:52:01 +0000)
DateTimeInterface::RFC1123
DATE_RFC1123: RFC 1123 (例: Mon, 15 Aug 2005 15:52:01 +0000)
DateTimeInterface::RFC7231
DATE_RFC7231: RFC 7231 (PHP 7.0.19 と 7.1.5以降) (例: Sat, 30 Apr 2016 17:52:13 GMT)
DateTimeInterface::RFC2822
DATE_RFC2822: RFC 2822 (例: Mon, 15 Aug 2005 15:52:01 +0000)
DateTimeInterface::RFC3339
DATE_RFC3339: DATE_ATOM と同じです
DateTimeInterface::RFC3339_EXTENDED
DATE_RFC3339_EXTENDED: RFC 3339 EXTENDED フォーマット (例: 2005-08-15T15:52:01.000+00:00)
DateTimeInterface::RSS
DATE_RSS: RSS (例: Mon, 15 Aug 2005 15:52:01 +0000)
DateTimeInterface::W3C
DATE_W3C: World Wide Web Consortium (例: 2005-08-15T15:52:01+00:00)

変更履歴

バージョン	説明
8.2.0	定数 `DateTimeInterface::ISO8601_EXPANDED` が追加されました。
7.2.0	DateTime クラスの定数は、 DateTimeInterface で定義されるようになりました。

DateTimeInterface::diff — ふたつの DateTime オブジェクトの差を返す
DateTimeInterface::format — 指定した書式でフォーマットした日付を返す
DateTimeInterface::getOffset — タイムゾーンのオフセットを返す
DateTimeInterface::getTimestamp — Unix タイムスタンプを取得する
DateTimeInterface::getTimezone — 指定した DateTime に関連するタイムゾーンを返す
DateTime::__wakeup — __wakeup ハンドラ

add a note

User Contributed Notes 1 note

down

bohwaz ¶

2 years ago


Please note that if you are using DATE_RFC7231 format (used in HTTP/1.1), you'll need to change the DateTime object timezone to GMT *before*, or you'll encounter weird results, as this format DOES NOT convert the date to GMT.

So if you have a DateTime object using UTC+01:00 as its timezone, you will get a difference of 1 hour between your resulting date string and what should be the "correct" date.

Recommended use:

<?php
$date_gmt = clone $date;
$date_gmt->setTimezone(new \DateTimeZone('GMT'));
echo $date_gmt->format(DATE_RFC7231);
?>