- ChromeiQL
or GraphiQL Feen -
GraphiQL as Google Chrome extension
+GraphQL Playground - GraphQL IDE for better development workflows (GraphQL Subscriptions, interactive docs & collaboration).
diff --git a/data-fetching/index.html b/data-fetching/index.html
index d8fcda2..c949156 100755
--- a/data-fetching/index.html
+++ b/data-fetching/index.html
@@ -298,7 +298,7 @@ function defaultFieldResolver($source, $args, $context, \GraphQL\Type\Definition
}
}
- return $property instanceof \Closure ? $property($source, $args, $context) : $property;
+ return $property instanceof Closure ? $property($source, $args, $context, $info) : $property;
}
diff --git a/error-handling/index.html b/error-handling/index.html
index 5a6207e..1d280be 100755
--- a/error-handling/index.html
+++ b/error-handling/index.html
@@ -296,7 +296,7 @@ $result = GraphQL::executeQuery(/*args*/)->toArray($debug);
];
-Type Registry
+Config Validation
+Defining types using arrays may be error-prone, but graphql-php provides config validation +tool to report when config has unexpected structure.
+This validation tool is disabled by default because it is time-consuming operation which only +makes sense during development.
+To enable validation - call: GraphQL\Type\Definition\Config::enableValidation(); in your bootstrap
+but make sure to restrict it to debug/development mode only.
Type Registry
graphql-php expects that each type in Schema is presented by single instance. Therefore if you define your types as separate PHP classes you need to ensure that each type is referenced only once.
Technically you can create several instances of your type (for example for tests), but GraphQL\Type\Schema
diff --git a/complementary-tools/index.html b/complementary-tools/index.html
index 17a9209..3c07158 100755
--- a/complementary-tools/index.html
+++ b/complementary-tools/index.html
@@ -209,6 +209,7 @@
If you prefer first resolver exception to be re-thrown, use following flags:
+If you prefer the first resolver exception to be re-thrown, use following flags:
<?php
use GraphQL\GraphQL;
use GraphQL\Error\Debug;
@@ -306,6 +306,8 @@ $debug = Debug::INCLUDE_DEBUG_MESSAGE | Debug::RETHROW_INTERNAL_EXCEPTIONS;
$result = GraphQL::executeQuery(/*args*/)->toArray($debug);
If you only want to re-throw Exceptions that are not marked as safe through the ClientAware interface, use
+the flag Debug::RETHROW_UNSAFE_EXCEPTIONS.
Custom Error Handling and Formatting
It is possible to define custom formatter and handler for result errors.
Formatter is responsible for converting instances of GraphQL\Error\Error
diff --git a/getting-started/index.html b/getting-started/index.html
index 316853f..d07ecf3 100755
--- a/getting-started/index.html
+++ b/getting-started/index.html
@@ -201,7 +201,7 @@
This documentation assumes your familiarity with GraphQL concepts. If it is not the case - first learn about GraphQL on the official website.
Installation
-Using composer, simply run:
+Using composer, run:
composer require webonyx/graphql-php
/**
* Returns directives defined in GraphQL spec
*
- * @api
* @return Directive[]
+ *
+ * @api
*/
static function getStandardDirectives()
/**
* Returns types defined in GraphQL spec
*
- * @api
* @return Type[]
+ *
+ * @api
*/
static function getStandardTypes()
/**
- * Returns standard validation rules implementing GraphQL spec
+ * Replaces standard types with types from this list (matching by name)
+ * Standard types not listed here remain untouched.
+ *
+ * @param Type[] $types
+ *
+ * @api
+ */
+static function overrideStandardTypes(array $types)
+/**
+ * Returns standard validation rules implementing GraphQL spec
+ *
+ * @return ValidationRule[]
*
* @api
- * @return AbstractValidationRule[]
*/
static function getStandardValidationRules()
/**
+ * Set default resolver implementation
+ *
+ * @api
+ */
+static function setDefaultFieldResolver(callable $fn)
+GraphQL\Type\Definition\Type
Registry of standard GraphQL types and a base class for all other types.
Class Methods:
/**
- * @api
* @return IDType
+ *
+ * @api
*/
static function id()
/**
- * @api
* @return StringType
+ *
+ * @api
*/
static function string()
/**
- * @api
* @return BooleanType
+ *
+ * @api
*/
static function boolean()
/**
- * @api
* @return IntType
+ *
+ * @api
*/
static function int()
/**
- * @api
* @return FloatType
+ *
+ * @api
*/
static function float()
/**
- * @api
* @param Type|ObjectType|InterfaceType|UnionType|ScalarType|InputObjectType|EnumType|ListOfType|NonNull $wrappedType
+ *
* @return ListOfType
+ *
+ * @api
*/
static function listOf($wrappedType)
/**
- * @api
* @param ObjectType|InterfaceType|UnionType|ScalarType|InputObjectType|EnumType|ListOfType $wrappedType
+ *
* @return NonNull
+ *
+ * @api
*/
static function nonNull($wrappedType)
/**
- * @api
* @param Type $type
+ *
* @return bool
+ *
+ * @api
*/
static function isInputType($type)
/**
- * @api
* @param Type $type
+ *
+ * @return ObjectType|InterfaceType|UnionType|ScalarType|InputObjectType|EnumType
+ *
+ * @api
+ */
+static function getNamedType($type)
+/**
+ * @param Type $type
+ *
* @return bool
+ *
+ * @api
*/
static function isOutputType($type)
/**
- * @api
- * @param $type
+ * @param Type $type
+ *
* @return bool
+ *
+ * @api
*/
static function isLeafType($type)
/**
- * @api
* @param Type $type
+ *
* @return bool
+ *
+ * @api
*/
static function isCompositeType($type)
/**
- * @api
* @param Type $type
+ *
* @return bool
+ *
+ * @api
*/
static function isAbstractType($type)
/**
- * @api
* @param Type $type
+ *
* @return bool
+ *
+ * @api
*/
static function isType($type)
/**
- * @api
* @param Type $type
+ *
* @return ObjectType|InterfaceType|UnionType|ScalarType|InputObjectType|EnumType|ListOfType
+ *
+ * @api
*/
static function getNullableType($type)
/**
- * @api
- * @param Type $type
- * @return ObjectType|InterfaceType|UnionType|ScalarType|InputObjectType|EnumType
- */
-static function getNamedType($type)
-GraphQL\Type\Definition\ResolveInfo
Structure containing information useful for field resolution process. Passed as 3rd argument to every field resolver. See docs on field resolving (data fetching).
@@ -504,7 +542,7 @@ Passed as 3rd argument to every field resolver. See * The name of the field being resolved * * @api - * @var string + * @var string|null */ public $fieldName; @@ -512,7 +550,7 @@ public $fieldName; * AST of all nodes referencing this field in the query. * * @api - * @var FieldNode[] + * @var FieldNode[]|null */ public $fieldNodes; @@ -528,7 +566,7 @@ public $returnType; * Parent type of the field being resolved * * @api - * @var ObjectType + * @var ObjectType|null */ public $parentType; @@ -536,7 +574,7 @@ public $parentType; * Path to this field from the very root value * * @api - * @var array + * @var string[] */ public $path; @@ -544,7 +582,7 @@ public $path; * Instance of a schema used for execution * * @api - * @var Schema + * @var Schema|null */ public $schema; @@ -552,7 +590,7 @@ public $schema; * AST of all fragments defined in query * * @api - * @var FragmentDefinitionNode[] + * @var FragmentDefinitionNode[]|null */ public $fragments; @@ -560,7 +598,7 @@ public $fragments; * Root value passed to query execution * * @api - * @var mixed + * @var mixed|null */ public $rootValue; @@ -568,7 +606,7 @@ public $rootValue; * AST of operation definition node (query, mutation) * * @api - * @var OperationDefinitionNode + * @var OperationDefinitionNode|null */ public $operation; @@ -576,7 +614,7 @@ public $operation; * Array of variables passed to query execution * * @api - * @var array + * @var mixed[]|null */ public $variableValues; @@ -613,9 +651,11 @@ public $variableValues; * Warning: this method it is a naive implementation which does not take into account * conditional typed fragments. So use it with care for fields of interface and union types. * - * @api * @param int $depth How many levels to include in output - * @return array + * + * @return bool[] + * + * @api */ function getFieldSelection($depth = 0) @@ -659,103 +699,121 @@ $schema = new Schema($config); * Converts an array of options to instance of SchemaConfig * (or just returns empty config when array is not passed). * - * @api - * @param array $options + * @param mixed[] $options + * * @return SchemaConfig + * + * @api */ static function create(array $options = [])/**
- * @api
- * @param ObjectType $query
- * @return SchemaConfig
- */
-function setQuery($query)
-/**
- * @api
- * @param ObjectType $mutation
- * @return SchemaConfig
- */
-function setMutation($mutation)
-/**
- * @api
- * @param ObjectType $subscription
- * @return SchemaConfig
- */
-function setSubscription($subscription)
-/**
- * @api
- * @param Type[]|callable $types
- * @return SchemaConfig
- */
-function setTypes($types)
-/**
- * @api
- * @param Directive[] $directives
- * @return SchemaConfig
- */
-function setDirectives(array $directives)
-/**
- * @api
- * @param callable $typeLoader
- * @return SchemaConfig
- */
-function setTypeLoader(callable $typeLoader)
-/**
- * @api
* @return ObjectType
+ *
+ * @api
*/
function getQuery()
/**
+ * @param ObjectType $query
+ *
+ * @return SchemaConfig
+ *
* @api
+ */
+function setQuery($query)
+/**
* @return ObjectType
+ *
+ * @api
*/
function getMutation()
/**
+ * @param ObjectType $mutation
+ *
+ * @return SchemaConfig
+ *
* @api
+ */
+function setMutation($mutation)
+/**
* @return ObjectType
+ *
+ * @api
*/
function getSubscription()
/**
+ * @param ObjectType $subscription
+ *
+ * @return SchemaConfig
+ *
* @api
+ */
+function setSubscription($subscription)
+/**
* @return Type[]
+ *
+ * @api
*/
function getTypes()
/**
+ * @param Type[]|callable $types
+ *
+ * @return SchemaConfig
+ *
* @api
+ */
+function setTypes($types)
+/**
* @return Directive[]
+ *
+ * @api
*/
function getDirectives()
/**
+ * @param Directive[] $directives
+ *
+ * @return SchemaConfig
+ *
* @api
+ */
+function setDirectives(array $directives)
+/**
* @return callable
+ *
+ * @api
*/
function getTypeLoader()
/**
+ * @return SchemaConfig
+ *
+ * @api
+ */
+function setTypeLoader(callable $typeLoader)
+GraphQL\Type\Schema
Schema Definition (see related docs)
A Schema is created by supplying the root types of each type of operation: @@ -775,66 +833,82 @@ $schema = new GraphQL\Type\Schema($config);
Class Methods:
/**
- * Schema constructor.
+ * @param mixed[]|SchemaConfig $config
*
* @api
- * @param array|SchemaConfig $config
*/
function __construct($config)
/**
- * Returns schema query type
- *
- * @api
- * @return ObjectType
- */
-function getQueryType()
-/**
- * Returns schema mutation type
- *
- * @api
- * @return ObjectType|null
- */
-function getMutationType()
-/**
- * Returns schema subscription
- *
- * @api
- * @return ObjectType|null
- */
-function getSubscriptionType()
-/**
- * @api
- * @return SchemaConfig
- */
-function getConfig()
-/**
* Returns array of all types in this schema. Keys of this array represent type names, values are instances
* of corresponding type definitions
*
* This operation requires full schema scan. Do not use in production environment.
*
- * @api
* @return Type[]
+ *
+ * @api
*/
function getTypeMap()
/**
- * Returns type by it's name
+ * Returns a list of directives supported by this schema
+ *
+ * @return Directive[]
*
* @api
+ */
+function getDirectives()
+/**
+ * Returns schema query type
+ *
+ * @return ObjectType
+ *
+ * @api
+ */
+function getQueryType()
+/**
+ * Returns schema mutation type
+ *
+ * @return ObjectType|null
+ *
+ * @api
+ */
+function getMutationType()
+/**
+ * Returns schema subscription
+ *
+ * @return ObjectType|null
+ *
+ * @api
+ */
+function getSubscriptionType()
+/**
+ * @return SchemaConfig
+ *
+ * @api
+ */
+function getConfig()
+/**
+ * Returns type by it's name
+ *
* @param string $name
- * @return Type
+ *
+ * @return Type|null
+ *
+ * @api
*/
function getType($name)
/**
- * Returns a list of directives supported by this schema
- *
- * @api
- * @return Directive[]
- */
-function getDirectives()
-/**
* Returns instance of directive by name
*
- * @api
- * @param $name
+ * @param string $name
+ *
* @return Directive
+ *
+ * @api
*/
function getDirective($name)
/**
@@ -902,10 +969,11 @@ function validate()
*
* This operation requires full schema scan. Do not use in production environment.
*
+ * @return InvariantViolation[]|Error[]
+ *
* @api
- * @throws InvariantViolation
*/
-function assertValid()
+function validate()
GraphQL\Language\Parser
@@ -918,29 +986,48 @@ function assertValid() * Available options: * * noLocation: boolean, - * (By default, the parser creates AST nodes that know the location - * in the source that they correspond to. This configuration flag - * disables that behavior for performance or testing.) + * (By default, the parser creates AST nodes that know the location + * in the source that they correspond to. This configuration flag + * disables that behavior for performance or testing.) + * + * allowLegacySDLEmptyFields: boolean + * If enabled, the parser will parse empty fields sets in the Schema + * Definition Language. Otherwise, the parser will follow the current + * specification. + * + * This option is provided to ease adoption of the final SDL specification + * and will be removed in a future major release. + * + * allowLegacySDLImplementsInterfaces: boolean + * If enabled, the parser will parse implemented interfaces with no `&` + * character between each interface. Otherwise, the parser will follow the + * current specification. + * + * This option is provided to ease adoption of the final SDL specification + * and will be removed in a future major release. * * experimentalFragmentVariables: boolean, - * (If enabled, the parser will understand and parse variable definitions - * contained in a fragment definition. They'll be represented in the - * `variableDefinitions` field of the FragmentDefinitionNode. + * (If enabled, the parser will understand and parse variable definitions + * contained in a fragment definition. They'll be represented in the + * `variableDefinitions` field of the FragmentDefinitionNode. * - * The syntax is identical to normal, query-defined variables. For example: + * The syntax is identical to normal, query-defined variables. For example: * - * fragment A($var: Boolean = false) on T { - * ... - * } + * fragment A($var: Boolean = false) on T { + * ... + * } * - * Note: this feature is experimental and may change or be removed in the - * future.) + * Note: this feature is experimental and may change or be removed in the + * future.) + * + * @param Source|string $source + * @param bool[] $options + * + * @return DocumentNode + * + * @throws SyntaxError * * @api - * @param Source|string $source - * @param array $options - * @return DocumentNode - * @throws SyntaxError */ static function parse($source, array $options = []) @@ -955,10 +1042,12 @@ static function parse($source, array $options = []) * * Consider providing the results to the utility function: `GraphQL\Utils\AST::valueFromAST()`. * - * @api * @param Source|string $source - * @param array $options + * @param bool[] $options + * * @return BooleanValueNode|EnumValueNode|FloatValueNode|IntValueNode|ListValueNode|ObjectValueNode|StringValueNode|VariableNode + * + * @api */ static function parseValue($source, array $options = []) @@ -973,10 +1062,12 @@ static function parseValue($source, array $options = []) * * Consider providing the results to the utility function: `GraphQL\Utils\AST::typeFromAST()`. * - * @api * @param Source|string $source - * @param array $options + * @param bool[] $options + * * @return ListTypeNode|NameNode|NonNullTypeNode + * + * @api */ static function parseType($source, array $options = []) @@ -994,9 +1085,11 @@ $printed = GraphQL\Language\Printer::doPrint($ast);/**
* Prints AST to string. Capable of printing GraphQL queries and Type definition language.
*
- * @api
* @param Node $ast
+ *
* @return string
+ *
+ * @api
*/
static function doPrint($ast)
/**
* Visit the AST (see class description for details)
*
- * @api
- * @param Node $root
- * @param array $visitor
- * @param array $keyMap
+ * @param Node|ArrayObject|stdClass $root
+ * @param callable[] $visitor
+ * @param mixed[]|null $keyMap
+ *
* @return Node|mixed
- * @throws \Exception
+ *
+ * @throws Exception
+ *
+ * @api
*/
static function visit($root, $visitor, $keyMap = null)
/**
* Returns marker for visitor break
*
- * @api
* @return VisitorOperation
+ *
+ * @api
*/
static function stop()
/**
* Returns marker for skipping current node
*
- * @api
* @return VisitorOperation
+ *
+ * @api
*/
static function skipNode()
/**
* Returns marker for removing a node
*
- * @api
* @return VisitorOperation
+ *
+ * @api
*/
static function removeNode()
GraphQL\Executor\Executor
@@ -1175,20 +1275,18 @@ const DIRECTIVE_DEFINITION = "DirectiveDefinition"; * Always returns ExecutionResult and never throws. All errors which occur during operation * execution are collected in `$result->errors`. * - * @api - * @param Schema $schema - * @param DocumentNode $ast - * @param $rootValue - * @param $contextValue - * @param array|\ArrayAccess $variableValues - * @param null $operationName - * @param callable $fieldResolver + * @param mixed|null $rootValue + * @param mixed[]|null $contextValue + * @param mixed[]|ArrayAccess|null $variableValues + * @param string|null $operationName * * @return ExecutionResult|Promise + * + * @api */ static function execute( GraphQL\Type\Schema $schema, - GraphQL\Language\AST\DocumentNode $ast, + GraphQL\Language\AST\DocumentNode $documentNode, $rootValue = null, $contextValue = null, $variableValues = null, @@ -1203,21 +1301,19 @@ static function execute( * * Useful for async PHP platforms. * - * @api - * @param PromiseAdapter $promiseAdapter - * @param Schema $schema - * @param DocumentNode $ast - * @param null $rootValue - * @param null $contextValue - * @param null $variableValues - * @param null $operationName - * @param callable|null $fieldResolver + * @param mixed[]|null $rootValue + * @param mixed[]|null $contextValue + * @param mixed[]|null $variableValues + * @param string|null $operationName + * * @return Promise + * + * @api */ static function promiseToExecute( GraphQL\Executor\Promise\PromiseAdapter $promiseAdapter, GraphQL\Type\Schema $schema, - GraphQL\Language\AST\DocumentNode $ast, + GraphQL\Language\AST\DocumentNode $documentNode, $rootValue = null, $contextValue = null, $variableValues = null, @@ -1237,7 +1333,7 @@ serializable array usingtoArray()
* Data collected from resolvers during query execution
*
* @api
- * @var array
+ * @var mixed[]
*/
public $data;
@@ -1248,7 +1344,7 @@ public $data;
* contain original exception.
*
* @api
- * @var \GraphQL\Error\Error[]
+ * @var Error[]
*/
public $errors;
@@ -1257,7 +1353,7 @@ public $errors;
* Conforms to
*
* @api
- * @var array
+ * @var mixed[]
*/
public $extensions;
@@ -1276,9 +1372,9 @@ public $extensions;
* // ... other keys
* );
*
+ * @return self
+ *
* @api
- * @param callable $errorFormatter
- * @return $this
*/
function setErrorFormatter(callable $errorFormatter)
@@ -1293,9 +1389,9 @@ function setErrorFormatter(callable $errorFormatter)
* return array_map($formatter, $errors);
* }
*
+ * @return self
+ *
* @api
- * @param callable $handler
- * @return $this
*/
function setErrorsHandler(callable $handler)
@@ -1310,9 +1406,11 @@ function setErrorsHandler(callable $handler)
* $debug argument must be either bool (only adds "debugMessage" to result) or sum of flags from
* GraphQL\Error\Debug
*
- * @api
* @param bool|int $debug
- * @return array
+ *
+ * @return mixed[]
+ *
+ * @api
*/
function toArray($debug = false)
@@ -1323,9 +1421,11 @@ function toArray($debug = false)
/**
* Return true if the value is a promise or a deferred of the underlying platform
*
- * @api
* @param mixed $value
+ *
* @return bool
+ *
+ * @api
*/
function isThenable($value)
/**
* Converts thenable of the underlying platform into GraphQL\Executor\Promise\Promise instance
*
- * @api
* @param object $thenable
+ *
* @return Promise
+ *
+ * @api
*/
function convertThenable($thenable)
/**
* Creates a fulfilled Promise for a value if the value is not a promise.
*
- * @api
* @param mixed $value
+ *
* @return Promise
+ *
+ * @api
*/
function createFulfilled($value = null)
A list of specific validation rules may be provided. If not provided, the default list of rules defined by the GraphQL specification will be used.
-Each validation rule is an instance of GraphQL\Validator\Rules\AbstractValidationRule +
Each validation rule is an instance of GraphQL\Validator\Rules\ValidationRule which returns a visitor (see the GraphQL\Language\Visitor API).
Visitor methods are expected to return an instance of GraphQL\Error\Error, or array of such instances when invalid.
@@ -1419,12 +1524,11 @@ will be created from the provided schema./**
* Primary method for query validation. See class description for details.
*
- * @api
- * @param Schema $schema
- * @param DocumentNode $ast
- * @param AbstractValidationRule[]|null $rules
- * @param TypeInfo|null $typeInfo
+ * @param ValidationRule[]|null $rules
+ *
* @return Error[]
+ *
+ * @api
*/
static function validate(
GraphQL\Type\Schema $schema,
@@ -1437,8 +1541,9 @@ static function validate(
/**
* Returns all global validation rules.
*
+ * @return ValidationRule[]
+ *
* @api
- * @return AbstractValidationRule[]
*/
static function allRules()
@@ -1449,9 +1554,11 @@ static function allRules()
*
* $rule = DocumentValidator::getRule(GraphQL\Validator\Rules\QueryComplexity::class);
*
- * @api
* @param string $name
- * @return AbstractValidationRule
+ *
+ * @return ValidationRule
+ *
+ * @api
*/
static function getRule($name)
GraphQL\Error\Error
@@ -1492,8 +1598,9 @@ const CATEGORY_INTERNAL = "internal"; * point out to field mentioned in multiple fragments. Errors during execution include a * single location, the field which produced the error. * - * @api * @return SourceLocation[] + * + * @api */ function getLocations() @@ -1502,8 +1609,9 @@ function getLocations() * Returns an array describing the path from the root value to the field which produced this error. * Only included for execution errors. * + * @return mixed[]|null + * * @api - * @return array|null */ function getPath() @@ -1527,7 +1635,6 @@ const ALL = 63; * When not set, trigger_error() is used to notify about warnings. * * @api - * @param callable|null $warningHandler */ static function setWarningHandler(callable $warningHandler = null) @@ -1540,8 +1647,9 @@ static function setWarningHandler(callable $warningHandler = null) * * When passing true - suppresses all warnings. * - * @api * @param bool|int $suppress + * + * @api */ static function suppress($suppress = true) @@ -1554,8 +1662,9 @@ static function suppress($suppress = true) * * When passing true - re-enables all warnings. * - * @api * @param bool|int $enable + * + * @api */ static function enable($enable = true) @@ -1569,8 +1678,9 @@ will be formatted with original error message./**
* Returns true when exception message is safe to be displayed to a client.
*
- * @api
* @return bool
+ *
+ * @api
*/
function isClientSafe()
const INCLUDE_DEBUG_MESSAGE = 1;
const INCLUDE_TRACE = 2;
const RETHROW_INTERNAL_EXCEPTIONS = 4;
+const RETHROW_UNSAFE_EXCEPTIONS = 8;
GraphQL\Error\FormattedError
@@ -1603,8 +1715,9 @@ and provides tools for error debugging. * Set default error message for internal errors formatted using createFormattedError(). * This value can be overridden by passing 3rd argument to `createFormattedError()`. * - * @api * @param string $msg + * + * @api */ static function setInternalErrorMessage($msg) @@ -1618,12 +1731,15 @@ static function setInternalErrorMessage($msg) * * For a list of available debug flags see GraphQL\Error\Debug constants. * + * @param Throwable $e + * @param bool|int $debug + * @param string $internalErrorMessage + * + * @return mixed[] + * + * @throws Throwable + * * @api - * @param \Throwable $e - * @param bool|int $debug - * @param string $internalErrorMessage - * @return array - * @throws \Throwable */ static function createFromException($e, $debug = false, $internalErrorMessage = null) @@ -1631,9 +1747,11 @@ static function createFromException($e, $debug = false, $internalErrorMessage =/**
* Returns error trace as serializable array
*
+ * @param Throwable $error
+ *
+ * @return mixed[]
+ *
* @api
- * @param \Throwable $error
- * @return array
*/
static function toSafeTrace($error)
/**
* Creates new instance of a standard GraphQL HTTP server
*
+ * @param ServerConfig|mixed[] $config
+ *
* @api
- * @param ServerConfig|array $config
*/
function __construct($config)
/**
+ * @return self
+ *
* @api
- * @param Schema $schema
- * @return $this
*/
function setSchema(GraphQL\Type\Schema $schema)
/**
+ * @param mixed|callable $context
+ *
+ * @return self
+ *
* @api
- * @param mixed|\Closure $context
- * @return $this
*/
function setContext($context)
/**
+ * @param mixed|callable $rootValue
+ *
+ * @return self
+ *
* @api
- * @param mixed|\Closure $rootValue
- * @return $this
*/
function setRootValue($rootValue)
/**
* Expects function(Throwable $e) : array
*
+ * @return self
+ *
* @api
- * @param callable $errorFormatter
- * @return $this
*/
function setErrorFormatter(callable $errorFormatter)
/**
* Expects function(array $errors, callable $formatter) : array
*
+ * @return self
+ *
* @api
- * @param callable $handler
- * @return $this
*/
function setErrorsHandler(callable $handler)
/**
* Set validation rules for this server.
*
+ * @param ValidationRule[]|callable $validationRules
+ *
+ * @return self
+ *
* @api
- * @param array|callable
- * @return $this
*/
function setValidationRules($validationRules)
/**
+ * @return self
+ *
* @api
- * @param callable $fieldResolver
- * @return $this
*/
function setFieldResolver(callable $fieldResolver)
/**
* Set response debug flags. See GraphQL\Error\Debug class for a list of all available flags
*
- * @api
* @param bool|int $set
- * @return $this
+ *
+ * @return self
+ *
+ * @api
*/
function setDebug($set = true)
/**
* Allow batching queries (disabled by default)
*
- * @api
* @param bool $enableBatching
- * @return $this
+ *
+ * @return self
+ *
+ * @api
*/
function setQueryBatching($enableBatching)
/**
+ * @return self
+ *
* @api
- * @param PromiseAdapter $promiseAdapter
- * @return $this
*/
function setPromiseAdapter(GraphQL\Executor\Promise\PromiseAdapter $promiseAdapter)
/**
* Send response using standard PHP `header()` and `echo`.
*
- * @api
* @param Promise|ExecutionResult|ExecutionResult[] $result
- * @param bool $exitWhenDone
+ * @param bool $exitWhenDone
+ *
+ * @api
*/
function sendResponse($result, $exitWhenDone = false)
/**
* Converts PSR-7 request to OperationParams[]
*
- * @api
- * @param ServerRequestInterface $request
- * @return array|Helper
+ * @return OperationParams[]|OperationParams
+ *
* @throws RequestError
+ *
+ * @api
*/
function parsePsrRequest(Psr\Http\Message\ServerRequestInterface $request)
/**
* Converts query execution result to PSR-7 response
*
- * @api
* @param Promise|ExecutionResult|ExecutionResult[] $result
- * @param ResponseInterface $response
- * @param StreamInterface $writableBodyStream
+ *
* @return Promise|ResponseInterface
+ *
+ * @api
*/
function toPsrResponse(
$result,
@@ -2024,7 +2164,7 @@ public $operation;
/**
* @api
- * @var array
+ * @var mixed[]|null
*/
public $variables;
/**
* Creates an instance from given array
*
- * @api
- * @param array $params
- * @param bool $readonly
+ * @param mixed[] $params
+ * @param bool $readonly
+ *
* @return OperationParams
+ *
+ * @api
*/
static function create(array $params, $readonly = false)
/**
- * @api
* @param string $key
+ *
* @return mixed
+ *
+ * @api
*/
function getOriginalInput($key)
Build instance of GraphQL\Type\Schema out of type language definition (string or parsed AST)
See section in docs for details.
Class Methods:
+/**
+ * A helper function to build a GraphQLSchema directly from a source
+ * document.
+ *
+ * @param DocumentNode|Source|string $source
+ * @param bool[] $options
+ *
+ * @return Schema
+ *
+ * @api
+ */
+static function build($source, callable $typeConfigDecorator = null, array $options = [])
+/**
* This takes the ast of a schema document produced by the parse function in
* GraphQL\Language\Parser.
@@ -2073,31 +2232,24 @@ See section in docs for details.
* Given that AST it constructs a GraphQL\Type\Schema. The resulting schema
* has no resolve methods, so execution will use default resolvers.
*
- * Accepts options as a second argument:
+ * Accepts options as a third argument:
*
* - commentDescriptions:
* Provide true to use preceding comments as the description.
*
+ * @param bool[] $options
*
- * @api
- * @param DocumentNode $ast
- * @param array $options
* @return Schema
+ *
* @throws Error
- */
-static function buildAST(GraphQL\Language\AST\DocumentNode $ast, array $options = [])
-/**
- * A helper function to build a GraphQLSchema directly from a source
- * document.
*
* @api
- * @param DocumentNode|Source|string $source
- * @param array $options
- * @return Schema
*/
-static function build($source, array $options = [])
+static function buildAST(
+ GraphQL\Language\AST\DocumentNode $ast,
+ callable $typeConfigDecorator = null,
+ array $options = []
+)
GraphQL\Utils\AST
@@ -2124,9 +2276,9 @@ static function build($source, array $options = []) * * This is a reverse operation for AST::toArray($node) * + * @param mixed[] $node + * * @api - * @param array $node - * @return Node */ static function fromArray(array $node) @@ -2134,9 +2286,9 @@ static function fromArray(array $node)/**
* Convert AST node to serializable array
*
+ * @return mixed[]
+ *
* @api
- * @param Node $node
- * @return array
*/
static function toArray(GraphQL\Language\AST\Node $node)
/**
* Produces a PHP value given a GraphQL Value AST.
*
- * Unlike `valueFromAST()`, no type is provided. The resulting JavaScript value
+ * Unlike `valueFromAST()`, no type is provided. The resulting PHP value
* will reflect the provided GraphQL value AST.
*
* | GraphQL Value | PHP Value |
@@ -2212,11 +2367,14 @@ static function valueFromAST($valueNode, GraphQL\Type\Definition\InputType $type
* | Enum | Mixed |
* | Null | null |
*
- * @api
- * @param Node $valueNode
- * @param array|null $variables
+ * @param Node $valueNode
+ * @param mixed[]|null $variables
+ *
* @return mixed
- * @throws \Exception
+ *
+ * @throws Exception
+ *
+ * @api
*/
static function valueFromASTUntyped($valueNode, array $variables = null)
/**
* Returns type definition for given AST Type node
*
- * @api
- * @param Schema $schema
* @param NamedTypeNode|ListTypeNode|NonNullTypeNode $inputTypeNode
- * @return Type
- * @throws \Exception
+ *
+ * @return Type|null
+ *
+ * @throws Exception
+ *
+ * @api
*/
static function typeFromAST(GraphQL\Type\Schema $schema, $inputTypeNode)
/**
* Returns operation type ("query", "mutation" or "subscription") given a document and operation name
*
- * @api
- * @param DocumentNode $document
* @param string $operationName
+ *
* @return bool
+ *
+ * @api
*/
static function getOperation(GraphQL\Language\AST\DocumentNode $document, $operationName = null)
/**
+ * @param bool[] $options
+ *
* @api
- * @param Schema $schema
- * @return string
*/
-static function printIntrosepctionSchema(GraphQL\Type\Schema $schema, array $options = [])
+static function printIntrospectionSchema(GraphQL\Type\Schema $schema, array $options = [])