# A interface DateTimeInterface

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

## Introdução

DateTimeInterface foi criada para que os parâmetros, variáveis de retorno ou declarações de tipo de propriedades aceitem tanto DateTimeImmutable ou DateTime como um valor. Não é possível implementar esta interface em classes no espaço de usuário.

Constantes comuns que permitem formatar objetos DateTimeImmutable ou DateTime através de DateTimeImmutable::format() e DateTime::format() também são definidas nesta interface.

## Resumo da Interface

interface DateTimeInterface {
/* Constantes */
public const string ATOM = "Y-m-d\\TH:i:sP";
public const string COOKIE = "l, d-M-Y H:i:s T";
public const string ISO8601 = "Y-m-d\\TH:i:sO";
public const string ISO8601_EXPANDED = "X-m-d\\TH:i:sP";
public const string RFC822 = "D, d M y H:i:s O";
public const string RFC850 = "l, d-M-y H:i:s T";
public const string RFC1036 = "D, d M y H:i:s O";
public const string RFC1123 = "D, d M Y H:i:s O";
public const string RFC7231 = "D, d M Y H:i:s \\G\\M\\T";
public const string RFC2822 = "D, d M Y H:i:s O";
public const string RFC3339 = "Y-m-d\\TH:i:sP";
public const string RFC3339_EXTENDED = "Y-m-d\\TH:i:s.vP";
public const string RSS = "D, d M Y H:i:s O";
public const string W3C = "Y-m-d\\TH:i:sP";
/* Métodos */
public function diff(DateTimeInterface `$targetObject`, bool `$absolute` = `false`): DateInterval
public function format(string `$format`): string
public function getMicrosecond(): int
public function getOffset(): int
public function getTimestamp(): int
public function getTimezone(): DateTimeZone|false
public function __serialize(): array
public function __unserialize(array `$data`): void
#[\Deprecated]
public function __wakeup(): void
}

## Constantes predefinidas

DateTimeInterface::ATOM string
DATE_ATOM
  Atômico (exemplo: 2005-08-15T15:52:01+00:00); compatível com ISO-8601, RFC 3339 e esquema XML
DateTimeInterface::COOKIE string
DATE_COOKIE
  Cookies HTTP (exemplo: Monday, 15-Aug-2005 15:52:01 UTC)
DateTimeInterface::ISO8601 string
DATE_ISO8601
  Tipo ISO-8601 (exemplo: 2005-08-15T15:52:01+0000)

  > Nota: Este formato não é compatível com a ISO-8601, mas foi deixado assim por motivo de compatibilidade com versões anteriores. Use DateTimeInterface::ISO8601_EXPANDED, DateTimeInterface::ATOM para compatibilidade com a ISO-8601, alternativamente. (ref ISO8601:2004 seção 4.3.3 cláusula d)

DateTimeInterface::ISO8601_EXPANDED string
DATE_ISO8601_EXPANDED
  ISO-8601 Expandida (exemplo: +10191-07-26T08:59:52+01:00)

  > Nota: Este formato permite valores de ano fora do intervalo normal da ISO-8601 de `0000`-`9999` porque sempre inclui um caractere de sinal. Ele também garante que a parte do fuso horário (`+01:00`) seja compatível com a ISO-8601.

DateTimeInterface::RFC822 string
DATE_RFC822
  RFC 822 (exemplo: Mon, 15 Aug 05 15:52:01 +0000)
DateTimeInterface::RFC850 string
DATE_RFC850
  RFC 850 (exemplo: Monday, 15-Aug-05 15:52:01 UTC)
DateTimeInterface::RFC1036 string
DATE_RFC1036
  RFC 1036 (exemplo: Mon, 15 Aug 05 15:52:01 +0000)
DateTimeInterface::RFC1123 string
DATE_RFC1123
  RFC 1123 (exemplo: Mon, 15 Aug 2005 15:52:01 +0000)
DateTimeInterface::RFC7231 string
DATE_RFC7231
  RFC 7231 (desde o PHP 7.0.19 e 7.1.5) (exemplo: Sat, 30 Apr 2016 17:52:13 GMT)
DateTimeInterface::RFC2822 string
DATE_RFC2822
  RFC 2822 (exemplo: Mon, 15 Aug 2005 15:52:01 +0000)
DateTimeInterface::RFC3339 string
DATE_RFC3339
  O mesmo que DATE_ATOM
DateTimeInterface::RFC3339_EXTENDED string
DATE_RFC3339_EXTENDED
  RFC 3339 formato ESTENDIDO (exemplo: 2005-08-15T15:52:01.000+00:00)
DateTimeInterface::RSS string
DATE_RSS
  RSS (exemplo: Mon, 15 Aug 2005 15:52:01 +0000)
DateTimeInterface::W3C string
DATE_W3C
  World Wide Web Consortium (exemplo: 2005-08-15T15:52:01+00:00)

## Registro de Alterações

Versão | Descrição
--- | ---
8.5.0 | As constantes `DATE_RFC7231` e `DateTimeInterface::RFC7231` foram descontinuadas.
8.4.0 | As constantes de classe agora são tipadas.
8.2.0 | A constante `DateTimeInterface::ISO8601_EXPANDED` foi adicionada.
7.2.0 | As constantes da classe DateTime agora são definidas na classe DateTimeInterface.

## Índice

- DateTimeInterface::diff — Retorna a diferença entre dois objetos DateTime
- DateTimeInterface::format — Retorna a data formatada de acordo com um formato informado
- DateTimeInterface::getMicrosecond — Obtém a parte de microssegundos do timestamp Unix
- DateTimeInterface::getOffset — Retorna o deslocamento do fuso horário
- DateTimeInterface::getTimestamp — Obtém o timestamp Unix
- DateTimeInterface::getTimezone — Retorna o fuso horário correspondente a um DateTime informado
- DateTime::__serialize — Serializa um DateTime
- DateTime::__unserialize — Desserializa um Datetime
- DateTime::__wakeup — O manipulador __wakeup

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open