The DateTimeInterface interface
Introduction
(PHP 5 >= 5.5.0, PHP 7, PHP 8)
DateTimeInterface was created so that parameter, return, or property type declarations may accept either DateTime or DateTimeImmutable as a value. It is not possible to implement this interface with userland classes.
Interface synopsis
interface DateTimeInterface {
/* Constants */
/* Methods */
public diff(DateTimeInterface $targetObject, bool $absolute = false): DateInterval
public format(string $format): string
public getOffset(): int
public getTimestamp(): int
public getTimezone(): DateTimeZone|false
public __wakeup(): void}
Predefined Constants
-
DateTimeInterface::ATOM
-
DATE_ATOM
- Atom (example: 2005-08-15T15:52:01+00:00)
-
DATE_COOKIE
- HTTP Cookies (example: Monday, 15-Aug-2005 15:52:01 UTC)
-
DateTimeInterface::ISO8601
-
DATE_ISO8601
-
ISO-8601 (example: 2005-08-15T15:52:01+0000)
Note: This format is not compatible with ISO-8601, but is left this way for backward compatibility reasons. Use
DateTime::ATOM
orDATE_ATOM
for compatibility with ISO-8601 instead. -
DateTimeInterface::RFC822
-
DATE_RFC822
- RFC 822 (example: Mon, 15 Aug 05 15:52:01 +0000)
-
DateTimeInterface::RFC850
-
DATE_RFC850
- RFC 850 (example: Monday, 15-Aug-05 15:52:01 UTC)
-
DateTimeInterface::RFC1036
-
DATE_RFC1036
- RFC 1036 (example: Mon, 15 Aug 05 15:52:01 +0000)
-
DateTimeInterface::RFC1123
-
DATE_RFC1123
- RFC 1123 (example: Mon, 15 Aug 2005 15:52:01 +0000)
-
DateTimeInterface::RFC7231
-
DATE_RFC7231
- RFC 7231 (since PHP 7.0.19 and 7.1.5) (example: Sat, 30 Apr 2016 17:52:13 GMT)
-
DateTimeInterface::RFC2822
-
DATE_RFC2822
- RFC 2822 (example: Mon, 15 Aug 2005 15:52:01 +0000)
-
DateTimeInterface::RFC3339
-
DATE_RFC3339
-
Same as
DATE_ATOM
-
DateTimeInterface::RFC3339_EXTENDED
-
DATE_RFC3339_EXTENDED
- RFC 3339 EXTENDED format (example: 2005-08-15T15:52:01.000+00:00)
-
DateTimeInterface::RSS
-
DATE_RSS
- RSS (example: Mon, 15 Aug 2005 15:52:01 +0000)
-
DateTimeInterface::W3C
-
DATE_W3C
- World Wide Web Consortium (example: 2005-08-15T15:52:01+00:00)
Changelog
Version | Description |
---|---|
7.2.0 | The class constants of DateTime are now defined on DateTimeInterface. |
Table of Contents
- 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
© 1997–2021 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://www.php.net/manual/en/class.datetimeinterface.php