Documentation

Values
in package

Table of Contents

getArgumentValues()  : array<string|int, mixed>
Prepares an object map of argument values given a list of argument definitions and list of argument AST nodes.
getArgumentValuesForMap()  : array<string|int, mixed>
getDirectiveValues()  : array<string|int, mixed>|null
Prepares an object map of argument values given a directive definition and a AST node which may contain directives. Optionally also accepts a map of variable values.
getVariableValues()  : array<string|int, mixed>
Prepares an object map of variables of the correct type based on the provided variable definitions and arbitrary input. If the input cannot be coerced to match the variable definitions, a Error will be thrown.
isValidPHPValue()  : array<string|int, string>
valueFromAST()  : array<string|int, mixed>|stdClass|null

Methods

getArgumentValues()

Prepares an object map of argument values given a list of argument definitions and list of argument AST nodes.

public static getArgumentValues(FieldDefinition|Directive $def, FieldNode|DirectiveNode $node[, array<string|int, mixed> $variableValues = null ]) : array<string|int, mixed>
Parameters
$def : FieldDefinition|Directive
$node : FieldNode|DirectiveNode
$variableValues : array<string|int, mixed> = null
Tags
throws
Error
Return values
array<string|int, mixed>

getArgumentValuesForMap()

public static getArgumentValuesForMap(FieldDefinition|Directive $fieldDefinition, array<string|int, ArgumentNode$argumentValueMap[, array<string|int, mixed> $variableValues = null ][, Node|null $referenceNode = null ]) : array<string|int, mixed>
Parameters
$fieldDefinition : FieldDefinition|Directive
$argumentValueMap : array<string|int, ArgumentNode>
$variableValues : array<string|int, mixed> = null
$referenceNode : Node|null = null
Tags
throws
Error
Return values
array<string|int, mixed>

getDirectiveValues()

Prepares an object map of argument values given a directive definition and a AST node which may contain directives. Optionally also accepts a map of variable values.

public static getDirectiveValues(Directive $directiveDef, FragmentSpreadNode|FieldNode|InlineFragmentNode|EnumValueDefinitionNode|FieldDefinitionNode $node[, array<string|int, mixed>|null $variableValues = null ]) : array<string|int, mixed>|null

If the directive does not exist on the node, returns undefined.

Parameters
$directiveDef : Directive
$node : FragmentSpreadNode|FieldNode|InlineFragmentNode|EnumValueDefinitionNode|FieldDefinitionNode
$variableValues : array<string|int, mixed>|null = null
Return values
array<string|int, mixed>|null

getVariableValues()

Prepares an object map of variables of the correct type based on the provided variable definitions and arbitrary input. If the input cannot be coerced to match the variable definitions, a Error will be thrown.

public static getVariableValues(Schema $schema, array<string|int, VariableDefinitionNode$varDefNodes, array<string|int, mixed> $inputs) : array<string|int, mixed>
Parameters
$schema : Schema
$varDefNodes : array<string|int, VariableDefinitionNode>
$inputs : array<string|int, mixed>
Return values
array<string|int, mixed>

isValidPHPValue()

public static isValidPHPValue(array<string|int, mixed> $value, ScalarType|EnumType|InputObjectType|ListOfType|NonNull $type) : array<string|int, string>
Parameters
$value : array<string|int, mixed>
$type : ScalarType|EnumType|InputObjectType|ListOfType|NonNull
Tags
deprecated

as of 0.12 (Use coerceValue() directly for richer information)

codeCoverageIgnore
Return values
array<string|int, string>

valueFromAST()

public static valueFromAST(VariableNode|NullValueNode|IntValueNode|FloatValueNode|StringValueNode|BooleanValueNode|EnumValueNode|ListValueNode|ObjectValueNode $valueNode, ScalarType|EnumType|InputObjectType|ListOfType|NonNull $type[, array<string|int, mixed>|null $variables = null ]) : array<string|int, mixed>|stdClass|null
Parameters
$valueNode : VariableNode|NullValueNode|IntValueNode|FloatValueNode|StringValueNode|BooleanValueNode|EnumValueNode|ListValueNode|ObjectValueNode
$type : ScalarType|EnumType|InputObjectType|ListOfType|NonNull
$variables : array<string|int, mixed>|null = null
Tags
deprecated

as of 8.0 (Moved to \GraphQL\Utils\AST::valueFromAST)

codeCoverageIgnore
Return values
array<string|int, mixed>|stdClass|null

Search results