DateTimeImmutable クラス

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

はじめに

日付と時刻を表現します。

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

class DateTimeImmutable implements DateTimeInterface {

/* 継承した定数 */

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

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

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

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

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

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

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

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

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

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

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

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

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

/* メソッド */

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

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

public static getLastErrors(): array|false

public modify(string $modifier): DateTimeImmutable|false

public static __set_state(array $array): DateTimeImmutable

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

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

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

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

public format(string $format): string

public getOffset(): int

public getTimestamp(): int

public __wakeup(): void

}

DateTimeImmutable::add — 年月日時分秒の値を加え、新しいオブジェクトを返す
DateTimeImmutable::__construct — 新しい DateTimeImmutable オブジェクトを返す
DateTimeImmutable::createFromFormat — 時刻の文字列を指定されたフォーマットに従ってパースする
DateTimeImmutable::createFromInterface — 指定された DateTimeInterface オブジェクトをカプセル化した、新しい DateTimeImmutable オブジェクトを返す
DateTimeImmutable::createFromMutable — 与えられた DateTime オブジェクトをカプセル化した、新しいDateTimeImmutable オブジェクトを返す
DateTimeImmutable::getLastErrors — 警告およびエラーを返す
DateTimeImmutable::modify — タイムスタンプを変更した新しいオブジェクトを作る
DateTimeImmutable::__set_state — __set_state ハンドラ
DateTimeImmutable::setDate — 日付を設定する
DateTimeImmutable::setISODate — ISO 日付を設定する
DateTimeImmutable::setTime — 時刻を設定する
DateTimeImmutable::setTimestamp — Unix タイムスタンプを用いて日付と時刻を設定する
DateTimeImmutable::setTimezone — タイムゾーンを設定する
DateTimeImmutable::sub — 年月日時分秒の値を引く