The DateTimeImmutable class

(PHP 5 >= 5.5.0, PHP 7)

Introduction

This class behaves the same as DateTime except it never modifies itself but returns a new object instead.

DateTimeImmutable implements DateTimeInterface {

/* Inherited constants */

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::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" ;

/* Methods */

public __construct ([ string $time = "now" [, DateTimeZone $timezone = NULL ]] )

public DateTimeImmutable add ( DateInterval $interval )

public static DateTimeImmutable createFromFormat ( string $format , string $time [, DateTimeZone $timezone ] )

public static DateTimeImmutable createFromMutable ( DateTime $datetime )

public static array getLastErrors ( void )

public DateTimeImmutable modify ( string $modify )

public static DateTimeImmutable __set_state ( array $array )

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

public DateTimeImmutable setISODate ( int $year , int $week [, int $day = 1 ] )

public DateTimeImmutable setTime ( int $hour , int $minute [, int $second = 0 [, int $microseconds = 0 ]] )

public DateTimeImmutable setTimestamp ( int $unixtimestamp )

public DateTimeImmutable setTimezone ( DateTimeZone $timezone )

public DateTimeImmutable sub ( DateInterval $interval )

public DateInterval diff ( DateTimeInterface $datetime2 [, bool $absolute = FALSE ] )

public string format ( string $format )

public int getOffset ( void )

public int getTimestamp ( void )

public DateTimeZone getTimezone ( void )

public __wakeup ( void )

}

DateTimeImmutable::add — Adds an amount of days, months, years, hours, minutes and seconds
DateTimeImmutable::__construct — Returns new DateTimeImmutable object
DateTimeImmutable::createFromFormat — Parses a time string according to a specified format
DateTimeImmutable::createFromMutable — Returns new DateTimeImmutable object encapsulating the given DateTime object
DateTimeImmutable::getLastErrors — Returns the warnings and errors
DateTimeImmutable::modify — Creates a new object with modified timestamp
DateTimeImmutable::__set_state — The __set_state handler
DateTimeImmutable::setDate — Sets the date
DateTimeImmutable::setISODate — Sets the ISO date
DateTimeImmutable::setTime — Sets the time
DateTimeImmutable::setTimestamp — Sets the date and time based on a Unix timestamp
DateTimeImmutable::setTimezone — Sets the time zone
DateTimeImmutable::sub — Subtracts an amount of days, months, years, hours, minutes and seconds