variable->name->value; $varType = Utils\TypeInfo::typeFromAST($schema, $definitionNode->type); if (!Type::isInputType($varType)) { throw new Error( 'Variable "$'.$varName.'" expected value of type ' . '"' . Printer::doPrint($definitionNode->type) . '" which cannot be used as an input type.', [$definitionNode->type] ); } if (!array_key_exists($varName, $inputs)) { $defaultValue = $definitionNode->defaultValue; if ($defaultValue) { $coercedValues[$varName] = Utils\AST::valueFromAST($defaultValue, $varType); } if ($varType instanceof NonNull) { throw new Error( 'Variable "$'.$varName .'" of required type ' . '"'. Utils::printSafe($varType) . '" was not provided.', [$definitionNode] ); } } else { $value = $inputs[$varName]; $errors = self::isValidPHPValue($value, $varType); if (!empty($errors)) { $message = "\n" . implode("\n", $errors); throw new Error( 'Variable "$' . $varName . '" got invalid value ' . json_encode($value) . '.' . $message, [$definitionNode] ); } $coercedValue = self::coerceValue($varType, $value); Utils::invariant($coercedValue !== Utils::undefined(), 'Should have reported error.'); $coercedValues[$varName] = $coercedValue; } } return $coercedValues; } /** * Prepares an object map of argument values given a list of argument * definitions and list of argument AST nodes. * * @param FieldDefinition|Directive $def * @param FieldNode|\GraphQL\Language\AST\DirectiveNode $node * @param $variableValues * @return array * @throws Error */ public static function getArgumentValues($def, $node, $variableValues = null) { $argDefs = $def->args; $argNodes = $node->arguments; if (!$argDefs || null === $argNodes) { return []; } $coercedValues = []; $undefined = Utils::undefined(); /** @var ArgumentNode[] $argNodeMap */ $argNodeMap = $argNodes ? Utils::keyMap($argNodes, function (ArgumentNode $arg) { return $arg->name->value; }) : []; foreach ($argDefs as $argDef) { $name = $argDef->name; $argType = $argDef->getType(); $argumentNode = isset($argNodeMap[$name]) ? $argNodeMap[$name] : null; if (!$argumentNode) { if ($argDef->defaultValueExists()) { $coercedValues[$name] = $argDef->defaultValue; } else if ($argType instanceof NonNull) { throw new Error( 'Argument "' . $name . '" of required type ' . '"' . Utils::printSafe($argType) . '" was not provided.', [$node] ); } } else if ($argumentNode->value instanceof VariableNode) { $variableName = $argumentNode->value->name->value; if ($variableValues && array_key_exists($variableName, $variableValues)) { // Note: this does not check that this variable value is correct. // This assumes that this query has been validated and the variable // usage here is of the correct type. $coercedValues[$name] = $variableValues[$variableName]; } else if ($argDef->defaultValueExists()) { $coercedValues[$name] = $argDef->defaultValue; } else if ($argType instanceof NonNull) { throw new Error( 'Argument "' . $name . '" of required type "' . Utils::printSafe($argType) . '" was ' . 'provided the variable "$' . $variableName . '" which was not provided ' . 'a runtime value.', [ $argumentNode->value ] ); } } else { $valueNode = $argumentNode->value; $coercedValue = Utils\AST::valueFromAST($valueNode, $argType, $variableValues); if ($coercedValue === $undefined) { $errors = DocumentValidator::isValidLiteralValue($argType, $valueNode); $message = !empty($errors) ? ("\n" . implode("\n", $errors)) : ''; throw new Error( 'Argument "' . $name . '" got invalid value ' . Printer::doPrint($valueNode) . '.' . $message, [ $argumentNode->value ] ); } $coercedValues[$name] = $coercedValue; } } return $coercedValues; } /** * @deprecated as of 8.0 (Moved to Utils\AST::valueFromAST) * * @param $valueNode * @param InputType $type * @param null $variables * @return array|null|\stdClass */ public static function valueFromAST($valueNode, InputType $type, $variables = null) { return Utils\AST::valueFromAST($valueNode, $type, $variables); } /** * Given a PHP value and a GraphQL type, determine if the value will be * accepted for that type. This is primarily useful for validating the * runtime values of query variables. * * @param $value * @param InputType $type * @return array */ public static function isValidPHPValue($value, InputType $type) { // A value must be provided if the type is non-null. if ($type instanceof NonNull) { if (null === $value) { return ['Expected "' . Utils::printSafe($type) . '", found null.']; } return self::isValidPHPValue($value, $type->getWrappedType()); } if (null === $value) { return []; } // Lists accept a non-list value as a list of one. if ($type instanceof ListOfType) { $itemType = $type->getWrappedType(); if (is_array($value)) { $tmp = []; foreach ($value as $index => $item) { $errors = self::isValidPHPValue($item, $itemType); $tmp = array_merge($tmp, Utils::map($errors, function ($error) use ($index) { return "In element #$index: $error"; })); } return $tmp; } return self::isValidPHPValue($value, $itemType); } // Input objects check each defined field. if ($type instanceof InputObjectType) { if (!is_object($value) && !is_array($value)) { return ["Expected \"{$type->name}\", found not an object."]; } $fields = $type->getFields(); $errors = []; // Ensure every provided field is defined. $props = is_object($value) ? get_object_vars($value) : $value; foreach ($props as $providedField => $tmp) { if (!isset($fields[$providedField])) { $errors[] = "In field \"{$providedField}\": Unknown field."; } } // Ensure every defined field is valid. foreach ($fields as $fieldName => $tmp) { $newErrors = self::isValidPHPValue(isset($value[$fieldName]) ? $value[$fieldName] : null, $fields[$fieldName]->getType()); $errors = array_merge( $errors, Utils::map($newErrors, function ($error) use ($fieldName) { return "In field \"{$fieldName}\": {$error}"; }) ); } return $errors; } if ($type instanceof LeafType) { try { // Scalar/Enum input checks to ensure the type can parse the value to // a non-null value. $parseResult = $type->parseValue($value); if (null === $parseResult) { $v = Utils::printSafe($value); return [ "Expected type \"{$type->name}\", found $v." ]; } return []; } catch (\Exception $e) { return [ "Expected type \"{$type->name}\", found " . Utils::printSafe($value) . ': ' . $e->getMessage() ]; } catch (\Throwable $e) { return [ "Expected type \"{$type->name}\", found " . Utils::printSafe($value) . ': ' . $e->getMessage() ]; } } throw new InvariantViolation('Must be input type'); } /** * Given a type and any value, return a runtime value coerced to match the type. */ private static function coerceValue(Type $type, $value) { $undefined = Utils::undefined(); if ($value === $undefined) { return $undefined; } if ($type instanceof NonNull) { if ($value === null) { // Intentionally return no value. return $undefined; } return self::coerceValue($type->getWrappedType(), $value); } if (null === $value) { return null; } if ($type instanceof ListOfType) { $itemType = $type->getWrappedType(); if (is_array($value) || $value instanceof \Traversable) { $coercedValues = []; foreach ($value as $item) { $itemValue = self::coerceValue($itemType, $item); if ($undefined === $itemValue) { // Intentionally return no value. return $undefined; } $coercedValues[] = $itemValue; } return $coercedValues; } else { $coercedValue = self::coerceValue($itemType, $value); if ($coercedValue === $undefined) { // Intentionally return no value. return $undefined; } return [$coercedValue]; } } if ($type instanceof InputObjectType) { $coercedObj = []; $fields = $type->getFields(); foreach ($fields as $fieldName => $field) { if (!array_key_exists($fieldName, $value)) { if ($field->defaultValueExists()) { $coercedObj[$fieldName] = $field->defaultValue; } else if ($field->getType() instanceof NonNull) { // Intentionally return no value. return $undefined; } continue; } $fieldValue = self::coerceValue($field->getType(), $value[$fieldName]); if ($fieldValue === $undefined) { // Intentionally return no value. return $undefined; } $coercedObj[$fieldName] = $fieldValue; } return $coercedObj; } if ($type instanceof LeafType) { $parsed = $type->parseValue($value); if (null === $parsed) { // null or invalid values represent a failure to parse correctly, // in which case no value is returned. return $undefined; } return $parsed; } throw new InvariantViolation('Must be input type'); } }