Description
Read onlyYes
FinalYes
Tags
Properties
- $class : string
- $data : array<string|int, mixed>
- $extensions : array<string|int, mixed>
- $secret : bool
- $settings : array<string|int, mixed>
Methods
- __construct() : mixed
-
__debugInfo()
: array{class: string, secret: bool, data: array
- compose() : self|null
- new self($class, $data, $secret) with every Describable inside $data (at any depth of arrays) replaced by its description; null when one of them describes to null. Any other object in $data is refused: callers pass enums as their case name and Type/Schema/Path/Partitioning already normalized.
- composeData() : null|array<string|int, mixed>
- $data with every Describable inside it (at any depth of arrays) replaced by its description; null when one of them describes to null. Any other object is refused, named with $class and its key.
- extensions() : array<int, string>
- fromArray() : self
-
normalize()
: array{class: string, secret: bool, data: array
- sensitive() : bool
- settings() : array<string, DeclaredSetting>
- unionSettings() : array<string, DeclaredSetting>
Properties
$class
public
string
$class
$data
public
array<string|int, mixed>
$data
Attributes
- #[SensitiveParameter]
$extensions
public
array<string|int, mixed>
$extensions
= []
$secret
public
bool
$secret
= false
$settings
public
array<string|int, mixed>
$settings
= []
Methods
__construct()
public
__construct(class-string $class, array<string|int, mixed> $data[, bool $secret = false ][, array<int, string> $extensions = [] ][, array<string, string> $settings = [] ]) : mixed
Parameters
- $class : class-string
-
a Describable
- $data : array<string|int, mixed>
- $secret : bool = false
- $extensions : array<int, string> = []
-
the PHP extensions $class needs where it is rebuilt, lower-case module names
- $settings : array<string, string> = []
-
the php.ini settings $class needs where it is rebuilt
__debugInfo()
public
__debugInfo() : array{class: string, secret: bool, data: array|string}
Return values
array{class: string, secret: bool, data: arraycompose()
new self($class, $data, $secret) with every Describable inside $data (at any depth of arrays) replaced by its description; null when one of them describes to null. Any other object in $data is refused: callers pass enums as their case name and Type/Schema/Path/Partitioning already normalized.
public
static compose(class-string $class, array<string|int, mixed> $data[, bool $secret = false ][, array<int, string> $extensions = [] ][, array<string, string> $settings = [] ]) : self|null
Parameters
- $class : class-string
- $data : array<string|int, mixed>
- $secret : bool = false
- $extensions : array<int, string> = []
- $settings : array<string, string> = []
Tags
Return values
self|nullcomposeData()
$data with every Describable inside it (at any depth of arrays) replaced by its description; null when one of them describes to null. Any other object is refused, named with $class and its key.
public
static composeData(array<string|int, mixed> $data, class-string $class) : null|array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
- $class : class-string
-
the class describing $data
Tags
Return values
null|array<string|int, mixed>extensions()
public
extensions() : array<int, string>
Return values
array<int, string> —its own and every nested description's, sorted, unique
fromArray()
public
static fromArray(array<string|int, mixed> $data) : self
Parameters
- $data : array<string|int, mixed>
Tags
Return values
selfnormalize()
public
normalize() : array{class: string, secret: bool, data: array}
Return values
array{class: string, secret: bool, data: arraysensitive()
public
sensitive() : bool
Return values
boolsettings()
public
settings() : array<string, DeclaredSetting>
Tags
Return values
array<string, DeclaredSetting> —its own and every nested description's, by setting
unionSettings()
public
static unionSettings(array<string, DeclaredSetting> $settings, array<string, DeclaredSetting> $other) : array<string, DeclaredSetting>
Parameters
- $settings : array<string, DeclaredSetting>
- $other : array<string, DeclaredSetting>