13175309672

Committed 06 Feb 2025 09:04AM UTC coverage: 7.663% (-0.2%) from 7.841%

Build # 13175309672

Build Type

push

github

Committed by

web-flow

Commit Message

fix: ensure template files have a tpl file extension (#6826) (#6829)

Run Details

2 of 5 new or added lines in 4 files covered. (40.0%)

3676 existing lines in 122 files now uncovered.

13073 of 170593 relevant lines covered (7.66%)

27.3 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

62.5

/src/State/ApiResource/Error.php

<?php

/*
 * This file is part of the API Platform project.
 *
 * (c) Kévin Dunglas <dunglas@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace ApiPlatform\State\ApiResource;

use ApiPlatform\Metadata\ApiProperty;
use ApiPlatform\Metadata\Error as Operation;
use ApiPlatform\Metadata\ErrorResource;
use ApiPlatform\Metadata\Exception\HttpExceptionInterface;
use ApiPlatform\Metadata\Exception\ProblemExceptionInterface;
use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface as SymfonyHttpExceptionInterface;
use Symfony\Component\Serializer\Annotation\Groups;
use Symfony\Component\Serializer\Annotation\Ignore;
use Symfony\Component\Serializer\Annotation\SerializedName;
use Symfony\Component\WebLink\Link;

#[ErrorResource(
    openapi: false,
    uriVariables: ['status'],
    uriTemplate: '/errors/{status}',
    operations: [
        new Operation(
            name: '_api_errors_problem',
            routeName: 'api_errors',
            outputFormats: ['json' => ['application/problem+json']],
            normalizationContext: [
                'groups' => ['jsonproblem'],
                'skip_null_values' => true,
            ],
        ),
        new Operation(
            name: '_api_errors_hydra',
            routeName: 'api_errors',
            outputFormats: ['jsonld' => ['application/problem+json']],
            normalizationContext: [
                'groups' => ['jsonld'],
                'skip_null_values' => true,
            ],
            links: [new Link(rel: 'http://www.w3.org/ns/json-ld#error', href: 'http://www.w3.org/ns/hydra/error')],
        ),
        new Operation(
            name: '_api_errors_jsonapi',
            routeName: 'api_errors',
            outputFormats: ['jsonapi' => ['application/vnd.api+json']],
            normalizationContext: [
                'groups' => ['jsonapi'],
                'skip_null_values' => true,
            ],
        ),
        new Operation(
            name: '_api_errors',
            routeName: 'api_errors'
        ),
    ],
    provider: 'api_platform.state.error_provider',
    graphQlOperations: []
)]
class Error extends \Exception implements ProblemExceptionInterface, HttpExceptionInterface
{
    public function __construct(
        private string $title,
        private string $detail,
        #[ApiProperty(identifier: true)] private int $status,
        ?array $originalTrace = null,
        private ?string $instance = null,
        private string $type = 'about:blank',
        private array $headers = [],
        ?\Throwable $previous = null,
    ) {
        parent::__construct($title, $status, $previous);

        if (!$originalTrace) {
            return;
        }

        $this->originalTrace = [];
        foreach ($originalTrace as $i => $t) {
            unset($t['args']); // we don't want arguments in our JSON traces, especially with xdebug
            $this->originalTrace[$i] = $t;
        }
    }

    #[Groups(['jsonapi'])]
    public function getId(): string
    {
        return (string) $this->status;
    }

    #[SerializedName('trace')]
    #[Groups(['trace'])]
    public ?array $originalTrace = null;

    #[Groups(['jsonld'])]
    public function getDescription(): ?string
    {
        return $this->detail;
    }

    public static function createFromException(\Exception|\Throwable $exception, int $status): self
    {
        $headers = ($exception instanceof SymfonyHttpExceptionInterface || $exception instanceof HttpExceptionInterface) ? $exception->getHeaders() : [];

        return new self('An error occurred', $exception->getMessage(), $status, $exception->getTrace(), type: "/errors/$status", headers: $headers, previous: $exception->getPrevious());
    }

    #[Ignore]
    #[ApiProperty(readable: false)]
    public function getHeaders(): array
    {
        return $this->headers;
    }

    #[Ignore]
    #[ApiProperty(readable: false)]
    public function getStatusCode(): int
    {
        return $this->status;
    }

    /**
     * @param array<string, string> $headers
     */
    public function setHeaders(array $headers): void
    {
        $this->headers = $headers;
    }

    #[Groups(['jsonld', 'jsonproblem', 'jsonapi'])]
    public function getType(): string
    {
        return $this->type;
    }

    public function setType(string $type): void
    {
        $this->type = $type;
    }

    #[Groups(['jsonld', 'jsonproblem', 'jsonapi'])]
    public function getTitle(): ?string
    {
        return $this->title;
    }

    public function setTitle(?string $title = null): void
    {
        $this->title = $title;
    }

    #[Groups(['jsonld', 'jsonproblem', 'jsonapi'])]
    public function getStatus(): ?int
    {
        return $this->status;
    }

    public function setStatus(int $status): void
    {
        $this->status = $status;
    }

    #[Groups(['jsonld', 'jsonproblem', 'jsonapi'])]
    public function getDetail(): ?string
    {
        return $this->detail;
    }

    public function setDetail(?string $detail = null): void
    {
        $this->detail = $detail;
    }

    #[Groups(['jsonld', 'jsonproblem'])]
    public function getInstance(): ?string
    {
        return $this->instance;
    }

    public function setInstance(?string $instance = null): void
    {
        $this->instance = $instance;
    }
}

1	<?php
2
3	/*
4	* This file is part of the API Platform project.
5	*
6	* (c) Kévin Dunglas <dunglas@gmail.com>
7	*
8	* For the full copyright and license information, please view the LICENSE
9	* file that was distributed with this source code.
10	*/
11
12	declare(strict_types=1);
13
14	namespace ApiPlatform\State\ApiResource;
15
16	use ApiPlatform\Metadata\ApiProperty;
17	use ApiPlatform\Metadata\Error as Operation;
18	use ApiPlatform\Metadata\ErrorResource;
19	use ApiPlatform\Metadata\Exception\HttpExceptionInterface;
20	use ApiPlatform\Metadata\Exception\ProblemExceptionInterface;
21	use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface as SymfonyHttpExceptionInterface;
22	use Symfony\Component\Serializer\Annotation\Groups;
23	use Symfony\Component\Serializer\Annotation\Ignore;
24	use Symfony\Component\Serializer\Annotation\SerializedName;
25	use Symfony\Component\WebLink\Link;
26
27	#[ErrorResource(
28	openapi: false,
29	uriVariables: ['status'],
30	uriTemplate: '/errors/{status}',
31	operations: [
32	new Operation(
33	name: '_api_errors_problem',
34	routeName: 'api_errors',
35	outputFormats: ['json' => ['application/problem+json']],
36	normalizationContext: [
37	'groups' => ['jsonproblem'],
38	'skip_null_values' => true,
39	],
40	),
41	new Operation(
42	name: '_api_errors_hydra',
43	routeName: 'api_errors',
44	outputFormats: ['jsonld' => ['application/problem+json']],
45	normalizationContext: [
46	'groups' => ['jsonld'],
47	'skip_null_values' => true,
48	],
49	links: [new Link(rel: 'http://www.w3.org/ns/json-ld#error', href: 'http://www.w3.org/ns/hydra/error')],
50	),
51	new Operation(
52	name: '_api_errors_jsonapi',
53	routeName: 'api_errors',
54	outputFormats: ['jsonapi' => ['application/vnd.api+json']],
55	normalizationContext: [
56	'groups' => ['jsonapi'],
57	'skip_null_values' => true,
58	],
59	),
60	new Operation(
61	name: '_api_errors',
62	routeName: 'api_errors'
63	),
64	],
65	provider: 'api_platform.state.error_provider',
66	graphQlOperations: []
67	)]
68	class Error extends \Exception implements ProblemExceptionInterface, HttpExceptionInterface
69	{
70	public function __construct(
71	private string $title,
72	private string $detail,
73	#[ApiProperty(identifier: true)] private int $status,
74	?array $originalTrace = null,
75	private ?string $instance = null,
76	private string $type = 'about:blank',
77	private array $headers = [],
78	?\Throwable $previous = null,
79	) {
80	parent::__construct($title, $status, $previous);	209✔
81
82	if (!$originalTrace) {	209✔
83	return;	×
84	}
85
86	$this->originalTrace = [];	209✔
87	foreach ($originalTrace as $i => $t) {	209✔
88	unset($t['args']); // we don't want arguments in our JSON traces, especially with xdebug	209✔
89	$this->originalTrace[$i] = $t;	209✔
90	}
91	}
92
93	#[Groups(['jsonapi'])]
94	public function getId(): string
95	{
96	return (string) $this->status;	11✔
97	}
98
99	#[SerializedName('trace')]
100	#[Groups(['trace'])]
101	public ?array $originalTrace = null;
102
103	#[Groups(['jsonld'])]
104	public function getDescription(): ?string
105	{
106	return $this->detail;	159✔
107	}
108
109	public static function createFromException(\Exception\|\Throwable $exception, int $status): self
110	{
111	$headers = ($exception instanceof SymfonyHttpExceptionInterface \|\| $exception instanceof HttpExceptionInterface) ? $exception->getHeaders() : [];	209✔
112
113	return new self('An error occurred', $exception->getMessage(), $status, $exception->getTrace(), type: "/errors/$status", headers: $headers, previous: $exception->getPrevious());	209✔
114	}
115
116	#[Ignore]
117	#[ApiProperty(readable: false)]
118	public function getHeaders(): array
119	{
UNCOV 120	return $this->headers;	×
121	}
122
123	#[Ignore]
124	#[ApiProperty(readable: false)]
125	public function getStatusCode(): int
126	{
UNCOV 127	return $this->status;	×
128	}
129
130	/**
131	* @param array<string, string> $headers
132	*/
133	public function setHeaders(array $headers): void
134	{
UNCOV 135	$this->headers = $headers;	×
136	}
137
138	#[Groups(['jsonld', 'jsonproblem', 'jsonapi'])]
139	public function getType(): string
140	{
141	return $this->type;	209✔
142	}
143
144	public function setType(string $type): void
145	{
UNCOV 146	$this->type = $type;	×
147	}
148
149	#[Groups(['jsonld', 'jsonproblem', 'jsonapi'])]
150	public function getTitle(): ?string
151	{
152	return $this->title;	209✔
153	}
154
155	public function setTitle(?string $title = null): void
156	{
UNCOV 157	$this->title = $title;	×
158	}
159
160	#[Groups(['jsonld', 'jsonproblem', 'jsonapi'])]
161	public function getStatus(): ?int
162	{
163	return $this->status;	209✔
164	}
165
166	public function setStatus(int $status): void
167	{
UNCOV 168	$this->status = $status;	×
169	}
170
171	#[Groups(['jsonld', 'jsonproblem', 'jsonapi'])]
172	public function getDetail(): ?string
173	{
174	return $this->detail;	209✔
175	}
176
177	public function setDetail(?string $detail = null): void
178	{
UNCOV 179	$this->detail = $detail;	×
180	}
181
182	#[Groups(['jsonld', 'jsonproblem'])]
183	public function getInstance(): ?string
184	{
185	return $this->instance;	198✔
186	}
187
188	public function setInstance(?string $instance = null): void
189	{
UNCOV 190	$this->instance = $instance;	×
191	}
192	}

api-platform / core / 13175309672

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous