Type

interface Type

Methods

listTypes

List all custom types (ENUMs and composite types) in the current schema.

public listTypes(): array|false

Returns: array|false

typeExists

Check if a custom type exists.

public typeExists(string $name): bool

Returns: bool

Parameters

Parameter	Type	Description
$name	string

describeType

Describe a custom type, including its enum values or composite fields.

public describeType(string $name): array|false

Returns: array|false

Parameters

Parameter	Type	Description
$name	string

createType

Create a custom type.

public createType(string $name, array $info): bool

Returns: bool

Parameters

Parameter	Type	Description
$name	string
$info	array

dropType

Drop a custom type.

public dropType(string $name, bool $ifExists, bool $cascade): bool

Returns: bool

Parameters

Parameter	Type	Description
$name	string
$ifExists	bool
$cascade	bool

addEnumValue

Add a new value to an existing ENUM type.

public addEnumValue(string $name, string $value, ?string $before, ?string $after): bool

Returns: bool

Parameters

Parameter	Type	Description
$name	string
$value	string
$before	string
$after	string

addTypeAttribute

Add a new attribute (field) to an existing composite type.

public addTypeAttribute(string $name, string $fieldName, string $fieldType): bool

Returns: bool

Parameters

Parameter	Type	Description
$name	string
$fieldName	string
$fieldType	string

---

Generated by Hazaar API Doc Generator on Fri, 04 Sep 2026 23:32:16 +0000