Vendor

vendor/webonyx/graphql-php/src/Executor/ExecutionResult.php

@@ -0,0 +1,162 @@
+<?php
+
+declare(strict_types=1);
+
+namespace GraphQL\Executor;
+
+use GraphQL\Error\Error;
+use GraphQL\Error\FormattedError;
+use JsonSerializable;
+use function array_map;
+
+/**
+ * Returned after [query execution](executing-queries.md).
+ * Represents both - result of successful execution and of a failed one
+ * (with errors collected in `errors` prop)
+ *
+ * Could be converted to [spec-compliant](https://facebook.github.io/graphql/#sec-Response-Format)
+ * serializable array using `toArray()`
+ */
+class ExecutionResult implements JsonSerializable
+{
+    /**
+     * Data collected from resolvers during query execution
+     *
+     * @api
+     * @var mixed[]
+     */
+    public $data;
+
+    /**
+     * Errors registered during query execution.
+     *
+     * If an error was caused by exception thrown in resolver, $error->getPrevious() would
+     * contain original exception.
+     *
+     * @api
+     * @var Error[]
+     */
+    public $errors;
+
+    /**
+     * User-defined serializable array of extensions included in serialized result.
+     * Conforms to
+     *
+     * @api
+     * @var mixed[]
+     */
+    public $extensions;
+
+    /** @var callable */
+    private $errorFormatter;
+
+    /** @var callable */
+    private $errorsHandler;
+
+    /**
+     * @param mixed[] $data
+     * @param Error[] $errors
+     * @param mixed[] $extensions
+     */
+    public function __construct($data = null, array $errors = [], array $extensions = [])
+    {
+        $this->data       = $data;
+        $this->errors     = $errors;
+        $this->extensions = $extensions;
+    }
+
+    /**
+     * Define custom error formatting (must conform to http://facebook.github.io/graphql/#sec-Errors)
+     *
+     * Expected signature is: function (GraphQL\Error\Error $error): array
+     *
+     * Default formatter is "GraphQL\Error\FormattedError::createFromException"
+     *
+     * Expected returned value must be an array:
+     * array(
+     *    'message' => 'errorMessage',
+     *    // ... other keys
+     * );
+     *
+     * @return self
+     *
+     * @api
+     */
+    public function setErrorFormatter(callable $errorFormatter)
+    {
+        $this->errorFormatter = $errorFormatter;
+
+        return $this;
+    }
+
+    /**
+     * Define custom logic for error handling (filtering, logging, etc).
+     *
+     * Expected handler signature is: function (array $errors, callable $formatter): array
+     *
+     * Default handler is:
+     * function (array $errors, callable $formatter) {
+     *     return array_map($formatter, $errors);
+     * }
+     *
+     * @return self
+     *
+     * @api
+     */
+    public function setErrorsHandler(callable $handler)
+    {
+        $this->errorsHandler = $handler;
+
+        return $this;
+    }
+
+    /**
+     * @return mixed[]
+     */
+    public function jsonSerialize()
+    {
+        return $this->toArray();
+    }
+
+    /**
+     * Converts GraphQL query result to spec-compliant serializable array using provided
+     * errors handler and formatter.
+     *
+     * If debug argument is passed, output of error formatter is enriched which debugging information
+     * ("debugMessage", "trace" keys depending on flags).
+     *
+     * $debug argument must be either bool (only adds "debugMessage" to result) or sum of flags from
+     * GraphQL\Error\Debug
+     *
+     * @param bool|int $debug
+     *
+     * @return mixed[]
+     *
+     * @api
+     */
+    public function toArray($debug = false)
+    {
+        $result = [];
+
+        if (! empty($this->errors)) {
+            $errorsHandler = $this->errorsHandler ?: static function (array $errors, callable $formatter) {
+                return array_map($formatter, $errors);
+            };
+
+            $result['errors'] = $errorsHandler(
+                $this->errors,
+                FormattedError::prepareFormatter($this->errorFormatter, $debug)
+            );
+        }
+
+        if ($this->data !== null) {
+            $result['data'] = $this->data;
+        }
+
+        if (! empty($this->extensions)) {
+            $result['extensions'] = $this->extensions;
+        }
+
+        return $result;
+    }
+}