GraphQLException::getLocations() - Code Metrics - Inspection of "Error handler" - digiaonline/graphql-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#288)

by Christoffer

created 2018-10-01 12:16 UTC

GraphQLException::getLocations() A

↳ Parent: GraphQLException

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php

namespace Digia\GraphQL\Error;

use Digia\GraphQL\Language\Node\NodeInterface;
use Digia\GraphQL\Language\Source;
use Digia\GraphQL\Language\SourceLocation;
use Digia\GraphQL\Util\ArrayToJsonTrait;
use Digia\GraphQL\Util\SerializationInterface;

/**
 * An GraphQLException describes an exception thrown during the execute
 * phase of performing a GraphQL operation. In addition to a message
 * and stack trace, it also includes information about the locations in a
 * GraphQL document and/or execution result that correspond to the Error.
 */
class GraphQLException extends AbstractException implements SerializationInterface
{
    use ArrayToJsonTrait;

    /**
     * An array of { line, column } locations within the source GraphQL document
     * which correspond to this error.
     *
     * Errors during validation often contain multiple locations, for example to
     * point out two things with the same name. Errors during execution include a
     * single location, the field which produced the error.
     *
     * @var array|null
     */
    protected $locations;

    /**
     * An array describing the JSON-path into the execution response which
     * corresponds to this error. Only included for errors during execution.
     *
     * @var string[]|null
     */
    protected $path;

    /**
     * An array of GraphQL AST Nodes corresponding to this error.
     *
     * @var NodeInterface[]|null
     */
    protected $nodes;

    /**
     * The source GraphQL document for the first location of this error.
     *
     * Note that if this Error represents more than one node, the source may not
     * represent nodes after the first node.
     *
     * @var Source|null
     */
    protected $source;

    /**
     * An array of character offsets within the source GraphQL document
     * which correspond to this error.
     *
     * @var int[]|null
     */
    protected $positions;

    /**
     * Extension fields to add to the formatted error.
     *
     * @var array|null
     */
    protected $extensions;

    /**
     * @var null|\Throwable
     */
    protected $originalException;

    /**
     * ExecutionException constructor.
     *
     * @param string          $message
     * @param array|null      $nodes
     * @param Source|null     $source
     * @param array|null      $positions
     * @param array|null      $path
     * @param array|null      $extensions
     * @param \Throwable|null $originalException
     */
    public function __construct(
        string $message,
        ?array $nodes = null,
        ?Source $source = null,
        ?array $positions = null,
        ?array $path = null,
        ?array $extensions = null,
        ?\Throwable $originalException = null
    ) {
        parent::__construct($message);

        $this->resolveNodes($nodes);
        $this->resolveSource($source);
        $this->resolvePositions($positions);
        $this->resolveLocations($positions, $source);

        $this->path              = $path;
        $this->extensions        = $extensions;
        $this->originalException = $originalException;
    }

    /**
     * @return NodeInterface[]
     */
    public function getNodes(): ?array
    {
        return $this->nodes;
    }

    /**
     * @return bool
     */
    public function hasSource(): bool
    {
        return null !== $this->source;
    }

    /**
     * @return Source|null
     */
    public function getSource(): ?Source
    {
        return $this->source;
    }

    /**
     * @return int[]|null
     */
    public function getPositions(): ?array
    {
        return $this->positions;
    }

    /**
     * @return bool
     */
    public function hasLocations(): bool
    {
        return !empty($this->locations);
    }

    /**
     * @return array|null
     */
    public function getLocations(): ?array
    {
        return $this->locations;
    }

    /**
     * @return array|null
     */
    public function getLocationsAsArray(): ?array
    {
        return !empty($this->locations) ? \array_map(function (SourceLocation $location) {
            return $location->toArray();
        }, $this->locations) : null;
    }

    /**
     * @return array|null
     */
    public function getPath(): ?array
    {
        return $this->path;
    }

    /**
     * @return array|null
     */
    public function getExtensions(): ?array
    {
        return $this->extensions;
    }

    /**
     * @param array|null $extensions
     * @return self
     */
    public function setExtensions(?array $extensions): self
    {
        $this->extensions = $extensions;
        return $this;
    }

    /**
     * @return \Throwable|null
     */
    public function getOriginalException(): ?\Throwable
    {
        return $this->originalException;
    }

    /**
     * @return null|string
     */
    public function getOriginalErrorMessage(): ?string
    {
        return null !== $this->originalException ? $this->originalException->getMessage() : null;
    }

    /**
     * @inheritdoc
     */
    public function toArray(): array
    {
        return [
            'message'   => $this->message,
            'locations' => $this->getLocationsAsArray(),
            'path'      => $this->path,
        ];
    }

    /**
     * @inheritdoc
     */
    public function __toString(): string
    {
        return printError($this);
    }

    /**
     * @param array|null $nodes
     * @return $this
     */
    protected function resolveNodes(?array $nodes)
    {
        if (\is_array($nodes)) {
            $nodes = !empty($nodes) ? $nodes : [];
        } else {
            $nodes = [$nodes];
        }

        $this->nodes = \array_filter($nodes, function ($node) {
            return null !== $node;
        });

        return $this;
    }

    /**
     * @param Source|null $source
     * @return $this
     */
    protected function resolveSource(?Source $source)
    {
        if (null === $source && !empty($this->nodes)) {
            $firstNode = $this->nodes[0] ?? null;
            $location  = null !== $firstNode ? $firstNode->getLocation() : null;
            $source    = null !== $location ? $location->getSource() : null;
        }

        $this->source = $source;

        return $this;
    }

    /**
     * @param array|null $positions
     * @return $this
     */
    protected function resolvePositions(?array $positions)
    {
        if (null === $positions && !empty($this->nodes)) {
            $positions = \array_reduce($this->nodes, function (array $list, ?NodeInterface $node) {
                if (null !== $node) {
                    $location = $node->getLocation();
                    if (null !== $location) {
                        $list[] = $location->getStart();
                    }
                }
                return $list;
            }, []);
        }

        if (null !== $positions && empty($positions)) {
            $positions = null;
        }

        $this->positions = $positions;

        return $this;
    }

    /**
     * @param array|null  $positions
     * @param Source|null $source
     * @return $this
     */
    protected function resolveLocations(?array $positions, ?Source $source)
    {
        if (null !== $positions && null !== $source) {
            $locations = \array_map(function ($position) use ($source) {
                return SourceLocation::fromSource($source, $position);
            }, $positions);
        } elseif (!empty($this->nodes)) {
            $locations = \array_reduce($this->nodes, function (array $list, NodeInterface $node) {
                $location = $node->getLocation();
                if (null !== $location) {
                    $list[] = SourceLocation::fromSource($location->getSource(), $location->getStart());
                }
                return $list;
            }, []);
        }

        if (isset($locations)) {
            $this->locations = $locations;
        }

        return $this;
    }
}


1			<?php
2
3			namespace Digia\GraphQL\Error;
4
5			use Digia\GraphQL\Language\Node\NodeInterface;
6			use Digia\GraphQL\Language\Source;
7			use Digia\GraphQL\Language\SourceLocation;
8			use Digia\GraphQL\Util\ArrayToJsonTrait;
9			use Digia\GraphQL\Util\SerializationInterface;
10
11			/**
12			* An GraphQLException describes an exception thrown during the execute
13			* phase of performing a GraphQL operation. In addition to a message
14			* and stack trace, it also includes information about the locations in a
15			* GraphQL document and/or execution result that correspond to the Error.
16			*/
17			class GraphQLException extends AbstractException implements SerializationInterface
18			{
19			use ArrayToJsonTrait;
20
21			/**
22			* An array of { line, column } locations within the source GraphQL document
23			* which correspond to this error.
24			*
25			* Errors during validation often contain multiple locations, for example to
26			* point out two things with the same name. Errors during execution include a
27			* single location, the field which produced the error.
28			*
29			* @var array\|null
30			*/
31			protected $locations;
32
33			/**
34			* An array describing the JSON-path into the execution response which
35			* corresponds to this error. Only included for errors during execution.
36			*
37			* @var string[]\|null
38			*/
39			protected $path;
40
41			/**
42			* An array of GraphQL AST Nodes corresponding to this error.
43			*
44			* @var NodeInterface[]\|null
45			*/
46			protected $nodes;
47
48			/**
49			* The source GraphQL document for the first location of this error.
50			*
51			* Note that if this Error represents more than one node, the source may not
52			* represent nodes after the first node.
53			*
54			* @var Source\|null
55			*/
56			protected $source;
57
58			/**
59			* An array of character offsets within the source GraphQL document
60			* which correspond to this error.
61			*
62			* @var int[]\|null
63			*/
64			protected $positions;
65
66			/**
67			* Extension fields to add to the formatted error.
68			*
69			* @var array\|null
70			*/
71			protected $extensions;
72
73			/**
74			* @var null\|\Throwable
75			*/
76			protected $originalException;
77
78			/**
79			* ExecutionException constructor.
80			*
81			* @param string $message
82			* @param array\|null $nodes
83			* @param Source\|null $source
84			* @param array\|null $positions
85			* @param array\|null $path
86			* @param array\|null $extensions
87			* @param \Throwable\|null $originalException
88			*/
89			public function __construct(
90			string $message,
91			?array $nodes = null,
92			?Source $source = null,
93			?array $positions = null,
94			?array $path = null,
95			?array $extensions = null,
96			?\Throwable $originalException = null
97			) {
98			parent::__construct($message);
99
100			$this->resolveNodes($nodes);
101			$this->resolveSource($source);
102			$this->resolvePositions($positions);
103			$this->resolveLocations($positions, $source);
104
105			$this->path = $path;
106			$this->extensions = $extensions;
107			$this->originalException = $originalException;
108			}
109
110			/**
111			* @return NodeInterface[]
112			*/
113			public function getNodes(): ?array
114			{
115			return $this->nodes;
116			}
117
118			/**
119			* @return bool
120			*/
121			public function hasSource(): bool
122			{
123			return null !== $this->source;
124			}
125
126			/**
127			* @return Source\|null
128			*/
129			public function getSource(): ?Source
130			{
131			return $this->source;
132			}
133
134			/**
135			* @return int[]\|null
136			*/
137			public function getPositions(): ?array
138			{
139			return $this->positions;
140			}
141
142			/**
143			* @return bool
144			*/
145			public function hasLocations(): bool
146			{
147			return !empty($this->locations);
148			}
149
150			/**
151			* @return array\|null
152			*/
153			public function getLocations(): ?array
154			{
155			return $this->locations;
156			}
157
158			/**
159			* @return array\|null
160			*/
161			public function getLocationsAsArray(): ?array
162			{
163			return !empty($this->locations) ? \array_map(function (SourceLocation $location) {
164			return $location->toArray();
165			}, $this->locations) : null;
166			}
167
168			/**
169			* @return array\|null
170			*/
171			public function getPath(): ?array
172			{
173			return $this->path;
174			}
175
176			/**
177			* @return array\|null
178			*/
179			public function getExtensions(): ?array
180			{
181			return $this->extensions;
182			}
183
184			/**
185			* @param array\|null $extensions
186			* @return self
187			*/
188			public function setExtensions(?array $extensions): self
189			{
190			$this->extensions = $extensions;
191			return $this;
192			}
193
194			/**
195			* @return \Throwable\|null
196			*/
197			public function getOriginalException(): ?\Throwable
198			{
199			return $this->originalException;
200			}
201
202			/**
203			* @return null\|string
204			*/
205			public function getOriginalErrorMessage(): ?string
206			{
207			return null !== $this->originalException ? $this->originalException->getMessage() : null;
208			}
209
210			/**
211			* @inheritdoc
212			*/
213			public function toArray(): array
214			{
215			return [
216			'message' => $this->message,
217			'locations' => $this->getLocationsAsArray(),
218			'path' => $this->path,
219			];
220			}
221
222			/**
223			* @inheritdoc
224			*/
225			public function __toString(): string
226			{
227			return printError($this);
228			}
229
230			/**
231			* @param array\|null $nodes
232			* @return $this
233			*/
234			protected function resolveNodes(?array $nodes)
235			{
236			if (\is_array($nodes)) {
237			$nodes = !empty($nodes) ? $nodes : [];
238			} else {
239			$nodes = [$nodes];
240			}
241
242			$this->nodes = \array_filter($nodes, function ($node) {
243			return null !== $node;
244			});
245
246			return $this;
247			}
248
249			/**
250			* @param Source\|null $source
251			* @return $this
252			*/
253			protected function resolveSource(?Source $source)
254			{
255			if (null === $source && !empty($this->nodes)) {
256			$firstNode = $this->nodes[0] ?? null;
257			$location = null !== $firstNode ? $firstNode->getLocation() : null;
258			$source = null !== $location ? $location->getSource() : null;
259			}
260
261			$this->source = $source;
262
263			return $this;
264			}
265
266			/**
267			* @param array\|null $positions
268			* @return $this
269			*/
270			protected function resolvePositions(?array $positions)
271			{
272			if (null === $positions && !empty($this->nodes)) {
273			$positions = \array_reduce($this->nodes, function (array $list, ?NodeInterface $node) {
274			if (null !== $node) {
275			$location = $node->getLocation();
276			if (null !== $location) {
277			$list[] = $location->getStart();
278			}
279			}
280			return $list;
281			}, []);
282			}
283
284			if (null !== $positions && empty($positions)) {
285			$positions = null;
286			}
287
288			$this->positions = $positions;
289
290			return $this;
291			}
292
293			/**
294			* @param array\|null $positions
295			* @param Source\|null $source
296			* @return $this
297			*/
298			protected function resolveLocations(?array $positions, ?Source $source)
299			{
300			if (null !== $positions && null !== $source) {
301			$locations = \array_map(function ($position) use ($source) {
302			return SourceLocation::fromSource($source, $position);
303			}, $positions);
304			} elseif (!empty($this->nodes)) {
305			$locations = \array_reduce($this->nodes, function (array $list, NodeInterface $node) {
306			$location = $node->getLocation();
307			if (null !== $location) {
308			$list[] = SourceLocation::fromSource($location->getSource(), $location->getStart());
309			}
310			return $list;
311			}, []);
312			}
313
314			if (isset($locations)) {
315			$this->locations = $locations;
316			}
317
318			return $this;
319			}
320			}
321

digiaonline / graphql-php

Pull Request — master (#288)

GraphQLException::getLocations() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like