Documentation

TypeWithFields extends Type
in package
implements HasFieldsType

Registry of standard GraphQL types and a base class for all other types.

Interfaces, Classes, Traits and Enums

HasFieldsType

Table of Contents

BOOLEAN  = 'Boolean'
FLOAT  = 'Float'
ID  = 'ID'
INT  = 'Int'
STRING  = 'String'
$astNode  : TypeDefinitionNode|null
$config  : array<string|int, mixed>
$description  : string|null
$extensionASTNodes  : array<string|int, TypeExtensionNode>
$name  : string
$standardTypes  : array<string, ScalarType>
$builtInTypes  : array<string|int, Type>
$fields  : array<string, FieldDefinition>
Lazily initialized.
__toString()  : string
assertType()  : Type
assertValid()  : mixed
boolean()  : ScalarType
findField()  : FieldDefinition|null
float()  : ScalarType
getAllBuiltInTypes()  : array<string|int, Type>
Returns all builtin in types including base scalar and introspection types
getField()  : FieldDefinition
getFieldNames()  : array<int, string>
getFields()  : array<string, FieldDefinition>
getInternalTypes()  : array<string|int, Type>
getNamedType()  : Type|null
getNullableType()  : Type
getStandardTypes()  : array<string|int, ScalarType>
Returns all builtin scalar types
hasField()  : bool
id()  : ScalarType
int()  : ScalarType
isAbstractType()  : bool
isBuiltInType()  : bool
Checks if the type is a builtin type
isCompositeType()  : bool
isInputType()  : bool
isLeafType()  : bool
isOutputType()  : bool
jsonSerialize()  : string
listOf()  : ListOfType
nonNull()  : NonNull
overrideStandardTypes()  : mixed
string()  : ScalarType
toString()  : string
tryInferName()  : string|null
initializeFields()  : void

Constants

BOOLEAN

public mixed BOOLEAN = 'Boolean'

FLOAT

public mixed FLOAT = 'Float'

ID

public mixed ID = 'ID'

INT

public mixed INT = 'Int'

STRING

public mixed STRING = 'String'

Properties

$config

public array<string|int, mixed> $config

$description

public string|null $description

$name

public string $name

$builtInTypes

private static array<string|int, Type> $builtInTypes

$fields

Lazily initialized.

private array<string, FieldDefinition> $fields

Methods

__toString()

public __toString() : string
Return values
string

assertType()

public static assertType(mixed $type) : Type
Parameters
$type : mixed
Return values
Type

findField()

public findField(string $name) : FieldDefinition|null
Parameters
$name : string
Return values
FieldDefinition|null

getAllBuiltInTypes()

Returns all builtin in types including base scalar and introspection types

public static getAllBuiltInTypes() : array<string|int, Type>
Return values
array<string|int, Type>

getField()

public getField(string $name) : FieldDefinition
Parameters
$name : string
Return values
FieldDefinition

getFieldNames()

public getFieldNames() : array<int, string>
Tags
inheritDoc
Return values
array<int, string>

getFields()

public getFields() : array<string, FieldDefinition>
Tags
inheritDoc
Return values
array<string, FieldDefinition>

getInternalTypes()

public static getInternalTypes() : array<string|int, Type>
Tags
deprecated

Use method getStandardTypes() instead

codeCoverageIgnore
Return values
array<string|int, Type>

getNamedType()

public static getNamedType(Type $type) : Type|null
Parameters
$type : Type
Return values
Type|null

getNullableType()

public static getNullableType(Type $type) : Type
Parameters
$type : Type
Return values
Type

getStandardTypes()

Returns all builtin scalar types

public static getStandardTypes() : array<string|int, ScalarType>
Return values
array<string|int, ScalarType>

hasField()

public hasField(string $name) : bool
Parameters
$name : string
Return values
bool

isAbstractType()

public static isAbstractType(Type $type) : bool
Parameters
$type : Type
Return values
bool

isBuiltInType()

Checks if the type is a builtin type

public static isBuiltInType(Type $type) : bool
Parameters
$type : Type
Return values
bool

isCompositeType()

public static isCompositeType(Type $type) : bool
Parameters
$type : Type
Return values
bool

isInputType()

public static isInputType(Type $type) : bool
Parameters
$type : Type
Return values
bool

isLeafType()

public static isLeafType(Type $type) : bool
Parameters
$type : Type
Return values
bool

isOutputType()

public static isOutputType(Type $type) : bool
Parameters
$type : Type
Return values
bool

jsonSerialize()

public jsonSerialize() : string
Return values
string

listOf()

public static listOf(Type $wrappedType) : ListOfType
Parameters
$wrappedType : Type
Return values
ListOfType

nonNull()

public static nonNull(callable|NullableType $wrappedType) : NonNull
Parameters
$wrappedType : callable|NullableType
Return values
NonNull

overrideStandardTypes()

public static overrideStandardTypes(array<string, ScalarType$types) : mixed
Parameters
$types : array<string, ScalarType>
Return values
mixed

toString()

public toString() : string
Return values
string

tryInferName()

protected tryInferName() : string|null
Return values
string|null

initializeFields()

private initializeFields() : void
Return values
void

Search results