abstract class Type extends JsonSchema (View source)

Properties

protected $required

Whether the type is required.

protected $title

The type's title.

protected $description

The type's description.

protected $default

The default value for the type.

protected array<int,mixed>|null $enum

The set of allowed values for the type.

Methods

static Type
__callStatic(string $name, mixed $arguments)

Dynamically pass static methods to the schema instance.

required()

Indicate that the type is required.

title(string $value)

Set the type's title.

description(string $value)

Set the type's description.

enum(array $values)

Restrict the value to one of the provided enumerated values.

array
toArray()

Convert the type to an array.

string
toString()

Convert the type to its string representation.

string
__toString()

Convert the type to its string representation.

Details

static Type __callStatic(string $name, mixed $arguments)

Dynamically pass static methods to the schema instance.

Parameters

string $name
mixed $arguments

Return Value

Type

Type required()

Indicate that the type is required.

Return Value

Type

Type title(string $value)

Set the type's title.

Parameters

string $value

Return Value

Type

Type description(string $value)

Set the type's description.

Parameters

string $value

Return Value

Type

Type enum(array $values)

Restrict the value to one of the provided enumerated values.

Parameters

array $values

Return Value

Type

array toArray()

Convert the type to an array.

Return Value

array

string toString()

Convert the type to its string representation.

Return Value

string

string __toString()

Convert the type to its string representation.

Return Value

string