DXNTimestamp
in package
implements
DXNValueInterface
DXN `timestamp` (`~U[YYYY-MM-DD HH:MM:SSZ]`) -- a UTC instant.
epochMicroseconds follows the project's hybrid integer rule
(DXNInteger). Unlike the JS port (Date, milliseconds
only), toDateTimeImmutable()/fromDateTimeImmutable() here are
exact, not lossy -- PHP's DateTimeImmutable natively supports
microsecond precision.
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 = 'timestamp'
Properties
- $epochMicroseconds : int|DXNInteger
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
- toDateTimeImmutable() : DateTimeImmutable
- asString() : numeric-string
- splitEpochMicroseconds() : array{0: numeric-string, 1: int}
Constants
DXN_TYPE
private
mixed
DXN_TYPE
= 'timestamp'
Properties
$epochMicroseconds read-only
public
int|DXNInteger
$epochMicroseconds
Methods
__construct()
public
__construct(int|DXNInteger $epochMicroseconds) : mixed
Parameters
- $epochMicroseconds : int|DXNInteger
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
intdxnType()
The DXN type name this value represents, e.g. "symbol", "uuid".
public
dxnType() : string
Return values
stringequals()
Structural equality, recursing into nested DXN values as needed.
public
equals(mixed $other) : bool
Parameters
- $other : mixed
Return values
boolfromDateTimeImmutable()
public
static fromDateTimeImmutable(DateTimeImmutable $date) : self
Parameters
- $date : DateTimeImmutable
Return values
selftoDateTimeImmutable()
public
toDateTimeImmutable() : DateTimeImmutable
Return values
DateTimeImmutableasString()
private
static asString(int|DXNInteger $value) : numeric-string
Parameters
- $value : int|DXNInteger
Return values
numeric-stringsplitEpochMicroseconds()
private
static splitEpochMicroseconds(int|DXNInteger $epochMicroseconds) : array{0: numeric-string, 1: int}
Parameters
- $epochMicroseconds : int|DXNInteger
Return values
array{0: numeric-string, 1: int} —[floored whole seconds, microsecond remainder 0..999999]