TitledEnumSchemaDefinition extends AbstractSchemaDefinition
FinalYes
Schema definition for single-select enum fields with titled options (SEP-1330).
Uses the oneOf pattern with const/title pairs instead of enum/enumNames. Produces: {"type": "string", "oneOf": [{"const": "value", "title": "Label"}, ...]}
Tags
Table of Contents
Properties
- $default : string|null
- $description : string|null
- $oneOf : array<string|int, mixed>
- $title : string|null
Methods
- __construct() : mixed
- fromArray() : self
- jsonSerialize() : array<string, mixed>
- buildBaseJson() : array<string, mixed>
- Build the base JSON structure with type, optional title and description.
- validateTitle() : void
- Reject a title that is present but not a string.
Properties
$default read-only
public
string|null
$default
= null
$description read-only
public
string|null
$description
= null
$oneOf read-only
public
array<string|int, mixed>
$oneOf
$title read-only
public
string|null
$title
= null
Methods
__construct()
public
__construct(string|null $title, array<int, array{const: string, title: string}> $oneOf[, string|null $description = null ][, string|null $default = null ]) : mixed
Parameters
- $title : string|null
-
Optional human-readable title for the field
- $oneOf : array<int, array{const: string, title: string}>
-
Array of const/title pairs
- $description : string|null = null
-
Optional description/help text
- $default : string|null = null
-
Optional default value (must match a const)
fromArray()
public
static fromArray(array{title?: string, oneOf: list, description?: string, default?: string} $data) : self
Parameters
-
$data
: array{title?: string, oneOf: list
Return values
selfjsonSerialize()
public
jsonSerialize() : array<string, mixed>
Return values
array<string, mixed>buildBaseJson()
Build the base JSON structure with type, optional title and description.
protected
buildBaseJson(string $type) : array<string, mixed>
Parameters
- $type : string
Return values
array<string, mixed>validateTitle()
Reject a title that is present but not a string.
protected
static validateTitle(array<string, mixed> $data, string $schemaType) : void
Parameters
- $data : array<string, mixed>
- $schemaType : string