DateTime クラス

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

はじめに

日付と時刻を表現するクラスです。

このクラスは、 DateTimeImmutable と同じ振る舞いをします。但し、DateTime::modify() のような、オブジェクトそのものを変更するメソッドが呼び出された時を除きます。

警告

DateTime クラスのメソッドをコールすると、そのインスタンスにカプセル化された情報が変更されます。そうした変更を防ぎたい場合には、新しいオブジェクトを作るために clone 演算子を使わなければいけません。オブジェクトの変更を防ぐ、望ましい挙動をデフォルトで実現するには、 DateTime ではなく、 DateTimeImmutable を使います。

クラス概要

class DateTime implements DateTimeInterface {

/* 継承した定数 */

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

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

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

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

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

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

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

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

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

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

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

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

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

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

/* メソッド */

public __construct(string $datetime = "now", ?DateTimeZone $timezone = null)

public add(DateInterval $interval): DateTime

public static createFromFormat(string $format, string $datetime, ?DateTimeZone $timezone = null): DateTime|false

public static createFromImmutable(DateTimeImmutable $object): static

public static createFromInterface(DateTimeInterface $object): DateTime

public modify(string $modifier): DateTime

public static __set_state(array $array): DateTime

public setDate(int $year, int $month, int $day): DateTime

public setISODate(int $year, int $week, int $dayOfWeek = 1): DateTime

public setTime(
    int $hour,
    int $minute,
    int $second = 0,
    int $microsecond = 0
): DateTime

public setTimestamp(int $timestamp): DateTime

public setTimezone(DateTimeZone $timezone): DateTime

public sub(DateInterval $interval): DateTime

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

public format(string $format): string

public getOffset(): int

public getTimestamp(): int

public getTimezone(): DateTimeZone|false

public __serialize(): array

public __unserialize(array $data): void

#[\Deprecated]
public __wakeup(): void

}

変更履歴

バージョン	説明
8.4.0	クラス定数が型付けされました。
7.2.0	DateTime クラスの定数は、 DateTimeInterface で定義されるようになりました。
7.1.0	DateTime のコンストラクタで構築される値に、現在時刻のマイクロ秒が含まれるようになりました。これより前のバージョンでは、このマイクロ秒の情報は常に `0` で初期化されていました。

DateTime::add — 年月日時分秒の値を加えることで、DateTime オブジェクトを変更する
DateTime::__construct — 新しい DateTime オブジェクトを返す
DateTime::createFromFormat — 指定した書式で時刻文字列をパースする
DateTime::createFromImmutable — 与えられた DateTimeImmutable オブジェクトをカプセル化した、新しい DateTime のインスタンスを返す
DateTime::createFromInterface — 指定された DateTimeInterface オブジェクトをカプセル化した、新しい DateTime オブジェクトを返す
DateTime::getLastErrors — DateTimeImmutable::getLastErrors のエイリアス
DateTime::modify — タイムスタンプを変更する
DateTime::__set_state — __set_state ハンドラ
DateTime::setDate — 日付を設定する
DateTime::setISODate — ISO 形式の日付を設定する
DateTime::setTime — 時刻を設定する
DateTime::setTimestamp — Unix タイムスタンプを用いて日付と時刻を設定する
DateTime::setTimezone — DateTime オブジェクトのタイムゾーンを設定する
DateTime::sub — 年月日時分秒の値を DateTime オブジェクトから引く

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes

There are no user contributed notes for this page.