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 function diff(DateTimeInterface $targetObject, bool $absolute = false): DateInterval
public function format(string $format): string
public function getMicrosecond(): int
public function getOffset(): int
public function getTimestamp(): int
public function getTimezone(): DateTimeZone|false
public function __serialize(): array
public function __unserialize(array $data): void
#[\Deprecated]
public function __wakeup(): void
}

定義済み定数

DateTimeInterface::ATOM string
DATE_ATOM
Atom (例: 2005-08-15T15:52:01+00:00)。ISO-8601、RFC 3339、および XML Schema と互換性があります
DateTimeInterface::COOKIE string
DATE_COOKIE
HTTP Cookie (例: Monday, 15-Aug-2005 15:52:01 UTC)
DateTimeInterface::ISO8601 string
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 string
DATE_ISO8601_EXPANDED
ISO-8601 拡張形式 (例: +10191-07-26T08:59:52+01:00)

注意: 年に常に符号を含めることで、ISO-8601 の通常の範囲 0000-9999 以外の値が許されています。 タイムゾーンの部分 (+01:00) については、 ISO-8601 と互換性を保証するようにもなっています。

DateTimeInterface::RFC822 string
DATE_RFC822
RFC 822 (例: Mon, 15 Aug 05 15:52:01 +0000)
DateTimeInterface::RFC850 string
DATE_RFC850
RFC 850 (例: Monday, 15-Aug-05 15:52:01 UTC)
DateTimeInterface::RFC1036 string
DATE_RFC1036
RFC 1036 (例: Mon, 15 Aug 05 15:52:01 +0000)
DateTimeInterface::RFC1123 string
DATE_RFC1123
RFC 1123 (例: Mon, 15 Aug 2005 15:52:01 +0000)
DateTimeInterface::RFC7231 string
DATE_RFC7231
RFC 7231 (PHP 7.0.19 と 7.1.5以降) (例: Sat, 30 Apr 2016 17:52:13 GMT)
DateTimeInterface::RFC2822 string
DATE_RFC2822
RFC 2822 (例: Mon, 15 Aug 2005 15:52:01 +0000)
DateTimeInterface::RFC3339 string
DATE_RFC3339
DATE_ATOM と同じです
DateTimeInterface::RFC3339_EXTENDED string
DATE_RFC3339_EXTENDED
RFC 3339 EXTENDED フォーマット (例: 2005-08-15T15:52:01.000+00:00)
DateTimeInterface::RSS string
DATE_RSS
RSS (例: Mon, 15 Aug 2005 15:52:01 +0000)
DateTimeInterface::W3C string
DATE_W3C
World Wide Web Consortium (例: 2005-08-15T15:52:01+00:00)

変更履歴

バージョン 説明
8.5.0 定数 DATE_RFC7231 および DateTimeInterface::RFC7231 は、推奨されなくなりました。
8.4.0 クラス定数が型付けされました。
8.2.0 定数 DateTimeInterface::ISO8601_EXPANDED が追加されました。
7.2.0 DateTime クラスの定数は、 DateTimeInterface で定義されるようになりました。

目次