1. class
  2. Hypervel
  3. \
  4. JsonSchema
  5. \
  6. Types
  7. \
  8. ObjectType

ObjectType

class ObjectType extends Type

Properties

protected bool|null $required

Whether the type is required.

 from  Type
protected string|null $title

The type's title.

 from  Type
protected string|null $description

The type's description.

 from  Type
protected mixed $default

The default value for the type.

 from  Type
protected bool $hasDefault

Whether a default value was provided.

 from  Type
protected null|array<int, mixed> $enum

The set of allowed values for the type.

 from  Type
protected bool|null $nullable

Indicates if the type is nullable.

 from  Type
protected bool|null $additionalProperties

Whether additional properties are allowed.

Methods

static Type
fromArray(array $schema)

Build a type from a raw array of the Hypervel-supported JSON Schema subset.

from  JsonSchema
static Type
__callStatic(string $name, array $arguments)

Dynamically pass static methods to the schema instance.

from  JsonSchema
static ObjectType
object(Closure|array<string $, Type> $properties = '[]')

No description

from  JsonSchema
static AnyOfType
anyOf(Closure|array<int $, Type> $schemas)

No description

from  JsonSchema
static IntegerType
integer()

No description

from  JsonSchema
static NumberType
number()

No description

from  JsonSchema
static StringType
string()

No description

from  JsonSchema
static BooleanType
boolean()

No description

from  JsonSchema
static ArrayType
array()

No description

from  JsonSchema
static UnionType
union(array<int $, string> $types)

No description

from  JsonSchema
Type
required(bool $required = true)

Indicate that the type is required.

from  Type
Type
nullable(bool $nullable = true)

Indicate that the type may be null.

from  Type
Type
title(string $value)

Set the type's title.

from  Type
Type
description(string $value)

Set the type's description.

from  Type
Type
setDefault(mixed $value)

Set the type's default value.

from  Type
Type
enum(array|string $values)

Restrict the value to one of the provided enumerated values.

from  Type
array
toArray()

Convert the type to an array.

from  Type
string
toString()

Convert the type to its string representation.

from  Type
string
__toString()

Convert the type to its string representation.

from  Type
__construct(array $properties = [])

Create a new object type instance.

ObjectType
withoutAdditionalProperties()

Disallow additional properties.

ObjectType
default(array|null $value)

Set the type's default value.

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.

Parameters

array $schema

Return Value

Type

Exceptions

InvalidArgumentException

in JsonSchema at line 46
static Type __callStatic(string $name, array $arguments)

Dynamically pass static methods to the schema instance.

Parameters

string $name
array $arguments

Return Value

Type

in JsonSchema at line 29
static ObjectType object(Closure|array<string $, Type> $properties = '[]')

No description

Parameters

Closure|array<string $
Type> $properties

Return Value

ObjectType

in JsonSchema at line 29
static AnyOfType anyOf(Closure|array<int $, Type> $schemas)

No description

Parameters

Closure|array<int $
Type> $schemas

Return Value

AnyOfType

in JsonSchema at line 29
static IntegerType integer()

No description

Return Value

IntegerType

in JsonSchema at line 29
static NumberType number()

No description

Return Value

NumberType

in JsonSchema at line 29
static StringType string()

No description

Return Value

StringType

in JsonSchema at line 29
static BooleanType boolean()

No description

Return Value

BooleanType

in JsonSchema at line 29
static ArrayType array()

No description

Return Value

ArrayType

in JsonSchema at line 29
static UnionType union(array<int $, string> $types)

No description

Parameters

array<int $
string> $types

Return Value

UnionType

in Type at line 56
Type required(bool $required = true)

Indicate that the type is required.

Parameters

bool $required

Return Value

Type

in Type at line 66
Type nullable(bool $nullable = true)

Indicate that the type may be null.

Parameters

bool $nullable

Return Value

Type

in Type at line 76
Type title(string $value)

Set the type's title.

Parameters

string $value

Return Value

Type

in Type at line 86
Type description(string $value)

Set the type's description.

Parameters

string $value

Return Value

Type

in Type at line 96
protected Type setDefault(mixed $value)

Set the type's default value.

Parameters

mixed $value

Return Value

Type

in Type at line 111
Type enum(array|string $values)

Restrict the value to one of the provided enumerated values.

Parameters

array|string $values

Return Value

Type

Exceptions

InvalidArgumentException

in Type at line 135
array toArray()

Convert the type to an array.

Return Value

array

Exceptions

InvalidArgumentException
RuntimeException

in Type at line 147
string toString()

Convert the type to its string representation.

Return Value

string

Exceptions

InvalidArgumentException
JsonException
RuntimeException

in Type at line 159
string __toString()

Convert the type to its string representation.

Return Value

string

Exceptions

InvalidArgumentException
JsonException
RuntimeException

at line 19
__construct(array $properties = [])

Create a new object type instance.

Parameters

array $properties

at line 26
ObjectType withoutAdditionalProperties()

Disallow additional properties.

Return Value

ObjectType

at line 38
ObjectType default(array|null $value)

Set the type's default value.

Parameters

array|null $value

Return Value

ObjectType