php-dextrin

DXNDateTime
in package
implements DXNValueInterface

FinalYes

DXN `datetime` (`@datetime "..."`) -- an offset-aware instant, non-UTC. Mirrors `.dxnb`'s wire shape directly: an instant plus an informational offset. Same exact (not lossy) microsecond-precision conversion as {@see DXNTimestamp}.

Table of Contents

Interfaces

DXNValueInterface
Implemented by every `DXN*` wrapper class -- the PHP analog of the `dxnType` string tag used for kind dispatch in the JS port, and of `Dextrin.Value`'s closed type union in the Elixir original. Native PHP values (`null`, `bool`, `int`, `float`, `string`, and `array` for `map`/`array`) never implement this; {@see Equality::kindOf()} handles those directly.

Constants

DXN_TYPE  : mixed = 'datetime'

Properties

$epochMicroseconds  : int|DXNInteger
$offsetMinutes  : int

Methods

__construct()  : mixed
compareTo()  : int
A total order against any other DXN value, not just another instance of this class -- backs {@see DXNSortedSet}. Cross-kind ordering is implementation-defined per DXN.md; within a kind, uses the kind's own natural order where one exists, or a deterministic structural fallback where it doesn't.
dxnType()  : string
The DXN type name this value represents, e.g. "symbol", "uuid".
equals()  : bool
Structural equality, recursing into nested DXN values as needed.
fromDateTimeImmutable()  : self
`$offsetMinutes` must be supplied explicitly -- `DateTimeImmutable` can't infer "the offset the caller means" any more than a plain instant can; it only knows the offset its own `DateTimeZone` carries, which this defaults to when not given.
toDateTimeImmutable()  : DateTimeImmutable
asString()  : numeric-string

Constants

Properties

Methods

__construct()

public __construct(int|DXNInteger $epochMicroseconds, int $offsetMinutes) : mixed
Parameters
$epochMicroseconds : int|DXNInteger
$offsetMinutes : int

compareTo()

A total order against any other DXN value, not just another instance of this class -- backs {@see DXNSortedSet}. Cross-kind ordering is implementation-defined per DXN.md; within a kind, uses the kind's own natural order where one exists, or a deterministic structural fallback where it doesn't.

public compareTo(mixed $other) : int
Parameters
$other : mixed
Return values
int

dxnType()

The DXN type name this value represents, e.g. "symbol", "uuid".

public dxnType() : string
Return values
string

equals()

Structural equality, recursing into nested DXN values as needed.

public equals(mixed $other) : bool
Parameters
$other : mixed
Return values
bool

fromDateTimeImmutable()

`$offsetMinutes` must be supplied explicitly -- `DateTimeImmutable` can't infer "the offset the caller means" any more than a plain instant can; it only knows the offset its own `DateTimeZone` carries, which this defaults to when not given.

public static fromDateTimeImmutable(DateTimeImmutable $date[, int|null $offsetMinutes = null ]) : self
Parameters
$date : DateTimeImmutable
$offsetMinutes : int|null = null
Return values
self

toDateTimeImmutable()

public toDateTimeImmutable() : DateTimeImmutable
Return values
DateTimeImmutable
On this page

Search results