UnionType
class UnionType extends Type (View source)
Constants
| SUPPORTED |
The JSON Schema primitive type names a union may be composed of. |
Properties
| protected | $required | Whether the type is required. |
from Type |
| protected | $title | The type's title. |
from Type |
| protected | $description | The type's description. |
from Type |
| protected | $default | The default value for the type. |
from Type |
| protected array<int,mixed>|null | $enum | The set of allowed values for the type. |
from Type |
| protected | $nullable | Indicates if the type is nullable. |
from Type |
| protected array<int,string> | $types | The union's member type names. |
Methods
Build a type from a raw array of the Laravel-supported JSON Schema subset.
Dynamically pass static methods to the schema instance.
Create a new union type instance.
Get the union's member type names.
Details
static Type
fromArray(array $schema)
Build a type from a raw array of the Laravel-supported JSON Schema subset.
static Type
__callStatic(string $name, mixed $arguments)
Dynamically pass static methods to the schema instance.
in
Type at line 47
Type
required(bool $required = true)
Indicate that the type is required.
in
Type at line 57
Type
nullable(bool $nullable = true)
Indicate that the type is optional.
in
Type at line 67
Type
title(string $value)
Set the type's title.
in
Type at line 77
Type
description(string $value)
Set the type's description.
in
Type at line 91
Type
enum(array|string $values)
Restrict the value to one of the provided enumerated values.
in
Type at line 112
array
toArray()
Convert the type to an array.
in
Type at line 120
string
toString()
Convert the type to its string representation.
in
Type at line 128
string
__toString()
Convert the type to its string representation.
__construct(array $types)
Create a new union type instance.
array
types()
Get the union's member type names.