Type
abstract class Type extends JsonSchema
Properties
| protected bool|null | $required | Whether the type is required. |
|
| protected string|null | $title | The type's title. |
|
| protected string|null | $description | The type's description. |
|
| protected mixed | $default | The default value for the type. |
|
| protected bool | $hasDefault | Whether a default value was provided. |
|
| protected null|array<int, mixed> | $enum | The set of allowed values for the type. |
|
| protected bool|null | $nullable | Indicates if the type is nullable. |
Methods
Build a type from a raw array of the Hypervel-supported JSON Schema subset.
Dynamically pass static methods to the schema instance.
No description
Set the type's description.
Set the type's default value.
Convert the type to an array.
Convert the type to its string representation.
Convert the type to its string representation.
Details
in
JsonSchema at line 38
static Type
fromArray(array $schema)
Build a type from a raw array of the Hypervel-supported JSON Schema subset.
in
JsonSchema at line 46
static Type
__callStatic(string $name, array $arguments)
Dynamically pass static methods to the schema instance.
in
JsonSchema at line 29
static ObjectType
object(Closure|array<string $, Type> $properties = '[]')
No description
in
JsonSchema at line 29
static AnyOfType
anyOf(Closure|array<int $, Type> $schemas)
No description
in
JsonSchema at line 29
static IntegerType
integer()
No description
in
JsonSchema at line 29
static NumberType
number()
No description
in
JsonSchema at line 29
static StringType
string()
No description
in
JsonSchema at line 29
static BooleanType
boolean()
No description
in
JsonSchema at line 29
static ArrayType
array()
No description
in
JsonSchema at line 29
static UnionType
union(array<int $, string> $types)
No description
at line 56
Type
required(bool $required = true)
Indicate that the type is required.
at line 66
Type
nullable(bool $nullable = true)
Indicate that the type may be null.
at line 76
Type
title(string $value)
Set the type's title.
at line 86
Type
description(string $value)
Set the type's description.
at line 96
protected Type
setDefault(mixed $value)
Set the type's default value.
at line 111
Type
enum(array|string $values)
Restrict the value to one of the provided enumerated values.
at line 135
array
toArray()
Convert the type to an array.
at line 147
string
toString()
Convert the type to its string representation.
at line 159
string
__toString()
Convert the type to its string representation.