PHP Date & Time Predefined Interfaces & Classes

Last Updated : 26 Jul, 2021

Date & Time Predefined Interfaces

DateTimeInterface

1. PHP DateTimeInterface Interface

DateTimeInterface {
	/* Constants */
	const string ATOM = "Y-m-d\TH:i:sP" ;
	const string COOKIE = "l, d-M-Y H:i:s T" ;
	const string ISO8601 = "Y-m-d\TH:i:sO" ;
	const string RFC822 = "D, d M y H:i:s O" ;
	const string RFC850 = "l, d-M-y H:i:s T" ;
	const string RFC1036 = "D, d M y H:i:s O" ;
	const string RFC1123 = "D, d M Y H:i:s O" ;
	const string RFC2822 = "D, d M Y H:i:s O" ;
	const string RFC3339 = "Y-m-d\TH:i:sP" ;
	const string RFC3339_EXTENDED = "Y-m-d\TH:i:s.vP" ;
	const string RSS = "D, d M Y H:i:s O" ;
	const string W3C = "Y-m-d\TH:i:sP" ;
	
	/* Methods */
	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 )
}

DateTimeInterface's Predefined Methods

DateTime::diff — Returns the difference between two DateTime objects
DateTime::format — Returns date formatted according to given format
DateTime::getOffset — Returns the timezone offset
DateTime::getTimestamp — Gets the Unix timestamp
DateTime::getTimezone — Return time zone relative to given DateTime
DateTime::__wakeup — The __wakeup handler

Date & Time Predefined Classes

DateTime
DateTimeImmutable
DateTimeZone
DateInterval
DatePeriod

1. PHP DateTime Class

Representation of date and time.

DateTime 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 DateTime add ( DateInterval $interval )
	public static DateTime createFromFormat ( string $format , string $time [, DateTimeZone $timezone ] )
	public static array getLastErrors ( void )
	public DateTime modify ( string $modify )
	public static DateTime __set_state ( array $array )
	public DateTime setDate ( int $year , int $month , int $day )
	public DateTime setISODate ( int $year , int $week [, int $day = 1 ] )
	public DateTime setTime ( int $hour , int $minute [, int $second = 0 [, int $microseconds = 0 ]] )
	public DateTime setTimestamp ( int $unixtimestamp )
	public DateTime setTimezone ( DateTimeZone $timezone )
	public DateTime 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 )
}

DateTime's Predefined Methods

DateTime::add — Adds a number of days, months, years, hours, minutes, and seconds to a DateTime object
DateTime::__construct — Returns new DateTime object
DateTime::createFromFormat — Parses a time string according to a specified format
DateTime::getLastErrors — Returns the warnings and errors
DateTime::modify — Alters the timestamp
DateTime::__set_state — The __set_state handler
DateTime::setDate — Sets the date
DateTime::setISODate — Sets the ISO date
DateTime::setTime — Sets the time
DateTime::setTimestamp — Sets the date and time based on a Unix timestamp
DateTime::setTimezone — Sets the time zone for the DateTime object
DateTime::sub — Subtracts a number of days, months, years, hours, minutes, and seconds from a DateTime object

2. PHP DateTimeImmutable Class

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's Predefined Methods

DateTimeImmutable::add — Adds a number 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 a number of days, months, years, hours, minutes, and seconds

3.PHP DateTimeZone Class

Representation of time zone.

DateTimeZone {
	/* Constants */
	const integer AFRICA = 1 ;
	const integer AMERICA = 2 ;
	const integer ANTARCTICA = 4 ;
	const integer ARCTIC = 8 ;
	const integer ASIA = 16 ;
	const integer ATLANTIC = 32 ;
	const integer AUSTRALIA = 64 ;
	const integer EUROPE = 128 ;
	const integer INDIAN = 256 ;
	const integer PACIFIC = 512 ;
	const integer UTC = 1024 ;
	const integer ALL = 2047 ;
	const integer ALL_WITH_BC = 4095 ;
	const integer PER_COUNTRY = 4096 ;
	
	/* Methods */
	public __construct ( string $timezone )
	public array getLocation ( void )
	public string getName ( void )
	public int getOffset ( DateTime $datetime )
	public array getTransitions ([ int $timestamp_begin [, int $timestamp_end ]] )
	public static array listAbbreviations ( void )
	public static array listIdentifiers ([ int $what = DateTimeZone::ALL [, string $country = NULL ]] )
}

DateTimeZone's Predefined Methods

DateTimeZone::__construct — Creates new DateTimeZone object
DateTimeZone::getLocation — Returns location information for a timezone
DateTimeZone::getName — Returns the name of the timezone
DateTimeZone::getOffset — Returns the timezone offset from GMT
DateTimeZone::getTransitions — Returns all transitions for the timezone
DateTimeZone::listAbbreviations — Returns associative array containing dst, offset and the timezone name
DateTimeZone::listIdentifiers — Returns a numerically indexed array containing all defined timezone identifiers

4. PHP DateInterval Class

Represents a date interval.

DateInterval {
	/* Properties */
	public integer $y ;
	public integer $m ;
	public integer $d ;
	public integer $h ;
	public integer $i ;
	public integer $s ;
	public float $f ;
	public integer $invert ;
	public mixed $days ;
	
	/* Methods */
	public __construct ( string $interval_spec )
	public static DateInterval createFromDateString ( string $time )
	public string format ( string $format )
}

DateInterval's Predefined Methods

DateInterval::__construct — Creates a new DateInterval object
DateInterval::createFromDateString — Sets up a DateInterval from the relative parts of the string
DateInterval::format — Formats the interval

4. PHP DatePeriod Class

Represents a date period.

A date period allows iteration over a set of dates and times, recurring at regular intervals, over a given period.

DatePeriod implements Traversable {
	/* Constants */
	const integer EXCLUDE_START_DATE = 1 ;
	
	/* Properties */
	public integer $recurrences ;
	public boolean $include_start_date ;
	public DateTimeInterface $start ;
	public DateTimeInterface $current ;
	public DateTimeInterface $end ;
	public DateInterval $interval ;

	/* Methods */
	public __construct ( DateTimeInterface $start , DateInterval $interval , int $recurrences [, int $options ] )
	public __construct ( DateTimeInterface $start , DateInterval $interval , DateTimeInterface $end [, int $options ] )
	public __construct ( string $isostr [, int $options ] )
	public DateInterval getDateInterval ( void )
	public DateTimeInterface getEndDate ( void )
	public DateTimeInterface getStartDate ( void )
}

DatePeriod's Predefined Methods

DatePeriod::__construct — Creates a new DatePeriod object
DatePeriod::getDateInterval — Gets the interval
DatePeriod::getEndDate — Gets the end date
DatePeriod::getStartDate — Gets the start date