ElicitationSchema implements JsonSerializable
FinalYes
Schema wrapper for elicitation requestedSchema (JSON Schema object type).
Represents an object schema with primitive property definitions and optional required fields.
Tags
Table of Contents
Interfaces
- JsonSerializable
Properties
- $properties : array<string|int, mixed>
- $required : array<string|int, mixed>
Methods
- __construct() : mixed
- fromArray() : self
- Create an ElicitationSchema from array data.
-
jsonSerialize()
: array{type: string, properties: array
Properties
$properties read-only
public
array<string|int, mixed>
$properties
$required read-only
public
array<string|int, mixed>
$required
= []
Methods
__construct()
public
__construct(array<string, StringSchemaDefinition|NumberSchemaDefinition|BooleanSchemaDefinition|EnumSchemaDefinition> $properties[, array<string|int, string> $required = [] ]) : mixed
Parameters
- $properties : array<string, StringSchemaDefinition|NumberSchemaDefinition|BooleanSchemaDefinition|EnumSchemaDefinition>
-
Property definitions keyed by name
- $required : array<string|int, string> = []
-
Array of required property names
fromArray()
Create an ElicitationSchema from array data.
public
static fromArray(array{type?: string, properties: array, required?: string[]} $data) : self
Parameters
-
$data
: array{type?: string, properties: array
Return values
selfjsonSerialize()
public
jsonSerialize() : array{type: string, properties: array, required?: string[]}