php-dextrin

DXNStruct

in package

• Application

implements DXNValueInterface

DXN `struct` (`%Name{...}` / `%Name[...]`), opaque without a schema. Keeps the keyed/positional shapes distinct rather than normalizing to one, same as the Elixir and JS ports -- `.dxnb` is always positional and can't recover field names without a schema.

Tags

phpstan-type

Pair array{0: string, 1: mixed}

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 = 'struct'

Properties

$extra  : array<int, array{0: mixed, 1: mixed}>

$kind  : string

$name  : string

$version  : int|null

$pairs  : array<int, Pair>

$values  : array<int, mixed>

Methods

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.

extraKey()  : mixed

An entry's key as an extra field's key: a keyword, symbol or string is a name (its text); any other map key (DXN.md §1.6) is kept as itself.

head()  : string

How a struct literal opens: `%Name`, or `%Name(3)` when it carries a version. Shared by every writer, so they agree.

isKeyed()  : bool

isPositional()  : bool

keyed()  : self

pairs()  : array<int, Pair>

parseTypeName()  : array{0: string, 1: ?int}|null

The other direction: a `.dxnb` type name read back into its name and version, or `null` when its version is not a positive integer.

positional()  : self

typeName()  : string

The struct's name as `.dxnb` writes it: `Name`, or `Name(3)` when it carries a version (DXN.md §2.4, §4.8).

values()  : array<int, mixed>

withPairs()  : self

This struct holding `$pairs` instead, and otherwise unchanged -- what every walk over a keyed struct's fields goes through, so a walk never rebuilds a struct from its name and loses its version.

withValues()  : self

This struct holding `$values` instead, and otherwise unchanged -- the positional counterpart of {@see withPairs()}.

withVersion()  : self

This struct carrying `$version` instead, and otherwise unchanged.

__construct()  : mixed