Documentation

ObjectType extends TypeWithFields

in package

• Application

implements OutputType, CompositeType, NullableType, NamedType, ImplementingType

Object Type Definition

$AddressType = new ObjectType([
  'name' => 'Address',
  'fields' => [
    'street' => [ 'type' => GraphQL\Type\Definition\Type::string() ],
    'number' => [ 'type' => GraphQL\Type\Definition\Type::int() ],
    'formatted' => [
      'type' => GraphQL\Type\Definition\Type::string(),
      'resolve' => function($obj) {
        return $obj->number . ' ' . $obj->street;
      }
    ]
  ]
]);

$PersonType = null;
$PersonType = new ObjectType([
  'name' => 'Person',
  'fields' => function() use (&$PersonType) {
     return [
         'name' => ['type' => GraphQL\Type\Definition\Type::string() ],
         'bestFriend' => [ 'type' => $PersonType ],
     ];
   }
]);

Interfaces, Classes, Traits and Enums

OutputType

CompositeType

NullableType

NamedType

export type NamedType = | ScalarType | ObjectType | InterfaceType | UnionType | EnumType | InputObjectType;

ImplementingType

export type GraphQLImplementingType = GraphQLObjectType | GraphQLInterfaceType;

Table of Contents

BOOLEAN  = 'Boolean'

FLOAT  = 'Float'

ID  = 'ID'

INT  = 'Int'

STRING  = 'String'

$astNode  : ObjectTypeDefinitionNode|null

$config  : array<string|int, mixed>

$description  : string|null

$extensionASTNodes  : array<string|int, ObjectTypeExtensionNode>

$name  : string

$resolveFieldFn  : callable|null

$standardTypes  : array<string, ScalarType>

$builtInTypes  : array<string|int, Type>

$fields  : array<string, FieldDefinition>

Lazily initialized.

$interfaceMap  : array<string, InterfaceType>

Lazily initialized.

$interfaces  : array<int, InterfaceType>

Lazily initialized.

__construct()  : mixed

__toString()  : string

assertObjectType()  : $this

assertType()  : Type

assertValid()  : void

Validates type config and throws if one of type options is invalid.

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>

getInterfaces()  : array<int, InterfaceType>

getInternalTypes()  : array<string|int, Type>

getNamedType()  : Type|null

getNullableType()  : Type

getStandardTypes()  : array<string|int, ScalarType>

Returns all builtin scalar types

hasField()  : bool

id()  : ScalarType

implementsInterface()  : bool

int()  : ScalarType

isAbstractType()  : bool

isBuiltInType()  : bool

Checks if the type is a builtin type

isCompositeType()  : bool

isInputType()  : bool

isLeafType()  : bool

isOutputType()  : bool

isTypeOf()  : bool|Deferred|null

jsonSerialize()  : string

listOf()  : ListOfType

nonNull()  : NonNull

overrideStandardTypes()  : mixed

string()  : ScalarType

toString()  : string

tryInferName()  : string|null

initializeFields()  : void