EnumSchemaDefinition extends AbstractSchemaDefinition
FinalYes
Schema definition for string enum fields in elicitation requests.
Provides a list of allowed values with optional human-readable labels.
Tags
Table of Contents
Properties
- $default : string|null
- $description : string|null
- $enum : array<string|int, mixed>
- $enumNames : array<string|int, mixed>|null
- $title : string|null
Methods
- __construct() : mixed
- fromArray() : self
- jsonSerialize() : array{type: string, title?: string, enum: string[], description?: string, default?: string, enumNames?: string[]}
- 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
$enum read-only
public
array<string|int, mixed>
$enum
$enumNames read-only
public
array<string|int, mixed>|null
$enumNames
= null
$title read-only
public
string|null
$title
= null
Methods
__construct()
public
__construct(string|null $title, array<string|int, string> $enum[, string|null $description = null ][, string|null $default = null ][, array<string|int, string>|null $enumNames = null ]) : mixed
Parameters
- $title : string|null
-
Optional human-readable title for the field
- $enum : array<string|int, string>
-
Array of allowed string values
- $description : string|null = null
-
Optional description/help text
- $default : string|null = null
-
Optional default value (must be in enum)
- $enumNames : array<string|int, string>|null = null
-
Optional human-readable labels for each enum value
fromArray()
public
static fromArray(array{title?: string, enum: string[], description?: string, default?: string, enumNames?: string[]} $data) : self
Parameters
- $data : array{title?: string, enum: string[], description?: string, default?: string, enumNames?: string[]}
Return values
selfjsonSerialize()
public
jsonSerialize() : array{type: string, title?: string, enum: string[], description?: string, default?: string, enumNames?: string[]}
Return values
array{type: string, title?: string, enum: string[], description?: string, default?: string, enumNames?: string[]}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