Documentation

Introspection
in package

Table of Contents

SCHEMA_FIELD_NAME  = '__schema'
TYPE_FIELD_NAME  = '__type'
TYPE_NAME_FIELD_NAME  = '__typename'
$map  : array<string, mixed>
_directive()  : mixed
_directiveLocation()  : mixed
_enumValue()  : mixed
_field()  : mixed
_inputValue()  : mixed
_schema()  : mixed
_type()  : mixed
_typeKind()  : mixed
fromSchema()  : array<string, array<string|int, mixed>>|null
Build an introspection query from a Schema
getIntrospectionQuery()  : string
getTypes()  : mixed
isIntrospectionType()  : bool
schemaMetaFieldDef()  : FieldDefinition
typeMetaFieldDef()  : FieldDefinition
typeNameMetaFieldDef()  : FieldDefinition

Constants

SCHEMA_FIELD_NAME

public mixed SCHEMA_FIELD_NAME = '__schema'

TYPE_NAME_FIELD_NAME

public mixed TYPE_NAME_FIELD_NAME = '__typename'

Properties

Methods

_directive()

public static _directive() : mixed
Return values
mixed —

_directiveLocation()

public static _directiveLocation() : mixed
Return values
mixed —

_enumValue()

public static _enumValue() : mixed
Return values
mixed —

_field()

public static _field() : mixed
Return values
mixed —

_inputValue()

public static _inputValue() : mixed
Return values
mixed —

_schema()

public static _schema() : mixed
Return values
mixed —

_type()

public static _type() : mixed
Return values
mixed —

_typeKind()

public static _typeKind() : mixed
Return values
mixed —

fromSchema()

Build an introspection query from a Schema

public static fromSchema(Schema $schema[, array<string, bool> $options = [] ]) : array<string, array<string|int, mixed>>|null

Introspection is useful for utilities that care about type and field relationships, but do not need to traverse through those relationships.

This is the inverse of BuildClientSchema::build(). The primary use case is outside of the server context, for instance when doing schema comparisons.

Parameters
$schema : Schema
$options : array<string, bool> = []

Available options:

  • descriptions Whether to include isRepeatable flag on directives. Default: true
  • directiveIsRepeatable Whether to include descriptions in the introspection result. Default: true
Return values
array<string, array<string|int, mixed>>|null —

getIntrospectionQuery()

public static getIntrospectionQuery([array<string, bool> $options = [] ]) : string
Parameters
$options : array<string, bool> = []

Available options:

  • descriptions Whether to include descriptions in the introspection result. Default: true
  • directiveIsRepeatable Whether to include isRepeatable flag on directives. Default: false
Return values
string —

getTypes()

public static getTypes() : mixed
Return values
mixed —

isIntrospectionType()

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

schemaMetaFieldDef()

public static schemaMetaFieldDef() : FieldDefinition
Return values
FieldDefinition —

typeMetaFieldDef()

public static typeMetaFieldDef() : FieldDefinition
Return values
FieldDefinition —

typeNameMetaFieldDef()

public static typeNameMetaFieldDef() : FieldDefinition
Return values
FieldDefinition —

Search results