#27298

pending completion

Build # #27298

Build Type

push

github

Committed by

web-flow

Commit Message

<a href="https://github.com/api-platform/core/commit/<a class=hub.com/api-platform/core/commit/036314ad1dfe8456aef237538f7d867c18927012">036314ad1<a href="https://github.com/api-platform/core/commit/036314ad1dfe8456aef237538f7d867c18927012">">Merge </a><a class="double-link" href="https://github.com/api-platform/core/commit/<a class="double-link" href="https://github.com/api-platform/core/commit/40175d072b1bf33430eaca46025cb81b3ee33404">40175d072</a>">40175d072</a><a href="https://github.com/api-platform/core/commit/036314ad1dfe8456aef237538f7d867c18927012"> into cd198d20b">cd198d20b</a>

Run Details

2 of 2 new or added lines in 1 file covered. (100.0%)

9962 of 11912 relevant lines covered (83.63%)

15.0 hits per line

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

98.55

/src/Metadata/Resource/ResourceMetadata.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\Core\Metadata\Resource;

use ApiPlatform\Core\Api\OperationType;

/**
 * Resource metadata.
 *
 * @author Kévin Dunglas <dunglas@gmail.com>
 */
final class ResourceMetadata
{
    private $shortName;
    private $description;
    private $iri;
    private $itemOperations;
    private $collectionOperations;
    private $subresourceOperations;
    private $graphql;
    private $attributes;

    public function __construct(string $shortName = null, string $description = null, string $iri = null, array $itemOperations = null, array $collectionOperations = null, array $attributes = null, array $subresourceOperations = null, array $graphql = null)
    {
        $this->shortName = $shortName;
        $this->description = $description;
        $this->iri = $iri;
        $this->itemOperations = $itemOperations;
        $this->collectionOperations = $collectionOperations;
        $this->subresourceOperations = $subresourceOperations;
        $this->graphql = $graphql;
        $this->attributes = $attributes;
    }

    /**
     * Gets the short name.
     */
    public function getShortName(): ?string
    {
        return $this->shortName;
    }

    /**
     * Returns a new instance with the given short name.
     */
    public function withShortName(string $shortName): self
    {
        $metadata = clone $this;
        $metadata->shortName = $shortName;

        return $metadata;
    }

    /**
     * Gets the description.
     */
    public function getDescription(): ?string
    {
        return $this->description;
    }

    /**
     * Returns a new instance with the given description.
     */
    public function withDescription(string $description): self
    {
        $metadata = clone $this;
        $metadata->description = $description;

        return $metadata;
    }

    /**
     * Gets the associated IRI.
     */
    public function getIri(): ?string
    {
        return $this->iri;
    }

    /**
     * Returns a new instance with the given IRI.
     */
    public function withIri(string $iri): self
    {
        $metadata = clone $this;
        $metadata->iri = $iri;

        return $metadata;
    }

    /**
     * Gets item operations.
     */
    public function getItemOperations(): ?array
    {
        return $this->itemOperations;
    }

    /**
     * Returns a new instance with the given item operations.
     */
    public function withItemOperations(array $itemOperations): self
    {
        $metadata = clone $this;
        $metadata->itemOperations = $itemOperations;

        return $metadata;
    }

    /**
     * Gets collection operations.
     */
    public function getCollectionOperations(): ?array
    {
        return $this->collectionOperations;
    }

    /**
     * Returns a new instance with the given collection operations.
     */
    public function withCollectionOperations(array $collectionOperations): self
    {
        $metadata = clone $this;
        $metadata->collectionOperations = $collectionOperations;

        return $metadata;
    }

    /**
     * Gets subresource operations.
     */
    public function getSubresourceOperations(): ?array
    {
        return $this->subresourceOperations;
    }

    /**
     * Returns a new instance with the given subresource operations.
     */
    public function withSubresourceOperations(array $subresourceOperations): self
    {
        $metadata = clone $this;
        $metadata->subresourceOperations = $subresourceOperations;

        return $metadata;
    }

    /**
     * Gets a collection operation attribute, optionally fallback to a resource attribute.
     *
     * @param mixed|null $defaultValue
     */
    public function getCollectionOperationAttribute(?string $operationName, string $key, $defaultValue = null, bool $resourceFallback = false)
    {
        return $this->findOperationAttribute($this->collectionOperations, $operationName, $key, $defaultValue, $resourceFallback);
    }

    /**
     * Gets an item operation attribute, optionally fallback to a resource attribute.
     *
     * @param mixed|null $defaultValue
     */
    public function getItemOperationAttribute(?string $operationName, string $key, $defaultValue = null, bool $resourceFallback = false)
    {
        return $this->findOperationAttribute($this->itemOperations, $operationName, $key, $defaultValue, $resourceFallback);
    }

    /**
     * Gets a subresource operation attribute, optionally fallback to a resource attribute.
     *
     * @param mixed|null $defaultValue
     */
    public function getSubresourceOperationAttribute(?string $operationName, string $key, $defaultValue = null, bool $resourceFallback = false)
    {
        return $this->findOperationAttribute($this->subresourceOperations, $operationName, $key, $defaultValue, $resourceFallback);
    }

    public function getGraphqlAttribute(string $operationName, string $key, $defaultValue = null, bool $resourceFallback = false)
    {
        if (isset($this->graphql[$operationName][$key])) {
            return $this->graphql[$operationName][$key];
        }

        if ($resourceFallback && isset($this->attributes[$key])) {
            return $this->attributes[$key];
        }

        return $defaultValue;
    }

    /**
     * Gets the first available operation attribute according to the following order: collection, item, subresource, optionally fallback to a default value.
     *
     * @param mixed|null $defaultValue
     */
    public function getOperationAttribute(array $attributes, string $key, $defaultValue = null, bool $resourceFallback = false)
    {
        if (isset($attributes['collection_operation_name'])) {
            return $this->getCollectionOperationAttribute($attributes['collection_operation_name'], $key, $defaultValue, $resourceFallback);
        }

        if (isset($attributes['item_operation_name'])) {
            return $this->getItemOperationAttribute($attributes['item_operation_name'], $key, $defaultValue, $resourceFallback);
        }

        if (isset($attributes['subresource_operation_name'])) {
            return $this->getSubresourceOperationAttribute($attributes['subresource_operation_name'], $key, $defaultValue, $resourceFallback);
        }

        if ($resourceFallback && isset($this->attributes[$key])) {
            return $this->attributes[$key];
        }

        return $defaultValue;
    }

    /**
     * Gets an attribute for a given operation type and operation name.
     *
     * @param mixed|null $defaultValue
     */
    public function getTypedOperationAttribute(string $operationType, string $operationName, string $key, $defaultValue = null, bool $resourceFallback = false)
    {
        switch ($operationType) {
            case OperationType::COLLECTION:
                return $this->getCollectionOperationAttribute($operationName, $key, $defaultValue, $resourceFallback);
            case OperationType::ITEM:
                return $this->getItemOperationAttribute($operationName, $key, $defaultValue, $resourceFallback);
            default:
                return $this->getSubresourceOperationAttribute($operationName, $key, $defaultValue, $resourceFallback);
        }
    }

    /**
     * Gets attributes.
     */
    public function getAttributes(): ?array
    {
        return $this->attributes;
    }

    /**
     * Gets an attribute.
     *
     * @param mixed|null $defaultValue
     */
    public function getAttribute(string $key, $defaultValue = null)
    {
        return $this->attributes[$key] ?? $defaultValue;
    }

    /**
     * Returns a new instance with the given attribute.
     */
    public function withAttributes(array $attributes): self
    {
        $metadata = clone $this;
        $metadata->attributes = $attributes;

        return $metadata;
    }

    /**
     * Gets options of for the GraphQL query.
     */
    public function getGraphql(): ?array
    {
        return $this->graphql;
    }

    /**
     * Returns a new instance with the given GraphQL options.
     */
    public function withGraphql(array $graphql): self
    {
        $metadata = clone $this;
        $metadata->graphql = $graphql;

        return $metadata;
    }

    /**
     * Gets an operation attribute, optionally fallback to a resource attribute.
     *
     * @param mixed|null $defaultValue
     */
    private function findOperationAttribute(?array $operations, ?string $operationName, string $key, $defaultValue, bool $resourceFallback)
    {
        if (null !== $operationName && isset($operations[$operationName][$key])) {
            return $operations[$operationName][$key];
        }

        if ($resourceFallback && isset($this->attributes[$key])) {
            return $this->attributes[$key];
        }

        return $defaultValue;
    }
}

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\Core\Metadata\Resource;
15
16	use ApiPlatform\Core\Api\OperationType;
17
18	/**
19	* Resource metadata.
20	*
21	* @author Kévin Dunglas <dunglas@gmail.com>
22	*/
23	final class ResourceMetadata
24	{
25	private $shortName;
26	private $description;
27	private $iri;
28	private $itemOperations;
29	private $collectionOperations;
30	private $subresourceOperations;
31	private $graphql;
32	private $attributes;
33
34	public function __construct(string $shortName = null, string $description = null, string $iri = null, array $itemOperations = null, array $collectionOperations = null, array $attributes = null, array $subresourceOperations = null, array $graphql = null)
35	{
36	$this->shortName = $shortName;	539✔
37	$this->description = $description;	539✔
38	$this->iri = $iri;	539✔
39	$this->itemOperations = $itemOperations;	539✔
40	$this->collectionOperations = $collectionOperations;	539✔
41	$this->subresourceOperations = $subresourceOperations;	539✔
42	$this->graphql = $graphql;	539✔
43	$this->attributes = $attributes;	539✔
44	}	539✔
45
46	/**
47	* Gets the short name.
48	*/
49	public function getShortName(): ?string
50	{
51	return $this->shortName;	192✔
52	}
53
54	/**
55	* Returns a new instance with the given short name.
56	*/
57	public function withShortName(string $shortName): self
58	{
59	$metadata = clone $this;	14✔
60	$metadata->shortName = $shortName;	14✔
61
62	return $metadata;	14✔
63	}
64
65	/**
66	* Gets the description.
67	*/
68	public function getDescription(): ?string
69	{
70	return $this->description;	99✔
71	}
72
73	/**
74	* Returns a new instance with the given description.
75	*/
76	public function withDescription(string $description): self
77	{
78	$metadata = clone $this;	10✔
79	$metadata->description = $description;	10✔
80
81	return $metadata;	10✔
82	}
83
84	/**
85	* Gets the associated IRI.
86	*/
87	public function getIri(): ?string
88	{
89	return $this->iri;	83✔
90	}
91
92	/**
93	* Returns a new instance with the given IRI.
94	*/
95	public function withIri(string $iri): self
96	{
97	$metadata = clone $this;	7✔
98	$metadata->iri = $iri;	7✔
99
100	return $metadata;	7✔
101	}
102
103	/**
104	* Gets item operations.
105	*/
106	public function getItemOperations(): ?array
107	{
108	return $this->itemOperations;	148✔
109	}
110
111	/**
112	* Returns a new instance with the given item operations.
113	*/
114	public function withItemOperations(array $itemOperations): self
115	{
116	$metadata = clone $this;	48✔
117	$metadata->itemOperations = $itemOperations;	48✔
118
119	return $metadata;	48✔
120	}
121
122	/**
123	* Gets collection operations.
124	*/
125	public function getCollectionOperations(): ?array
126	{
127	return $this->collectionOperations;	130✔
128	}
129
130	/**
131	* Returns a new instance with the given collection operations.
132	*/
133	public function withCollectionOperations(array $collectionOperations): self
134	{
135	$metadata = clone $this;	39✔
136	$metadata->collectionOperations = $collectionOperations;	39✔
137
138	return $metadata;	39✔
139	}
140
141	/**
142	* Gets subresource operations.
143	*/
144	public function getSubresourceOperations(): ?array
145	{
146	return $this->subresourceOperations;	37✔
147	}
148
149	/**
150	* Returns a new instance with the given subresource operations.
151	*/
152	public function withSubresourceOperations(array $subresourceOperations): self
153	{
154	$metadata = clone $this;	16✔
155	$metadata->subresourceOperations = $subresourceOperations;	16✔
156
157	return $metadata;	16✔
158	}
159
160	/**
161	* Gets a collection operation attribute, optionally fallback to a resource attribute.
162	*
163	* @param mixed\|null $defaultValue
164	*/
165	public function getCollectionOperationAttribute(?string $operationName, string $key, $defaultValue = null, bool $resourceFallback = false)
166	{
167	return $this->findOperationAttribute($this->collectionOperations, $operationName, $key, $defaultValue, $resourceFallback);	187✔
168	}
169
170	/**
171	* Gets an item operation attribute, optionally fallback to a resource attribute.
172	*
173	* @param mixed\|null $defaultValue
174	*/
175	public function getItemOperationAttribute(?string $operationName, string $key, $defaultValue = null, bool $resourceFallback = false)
176	{
177	return $this->findOperationAttribute($this->itemOperations, $operationName, $key, $defaultValue, $resourceFallback);	98✔
178	}
179
180	/**
181	* Gets a subresource operation attribute, optionally fallback to a resource attribute.
182	*
183	* @param mixed\|null $defaultValue
184	*/
185	public function getSubresourceOperationAttribute(?string $operationName, string $key, $defaultValue = null, bool $resourceFallback = false)
186	{
187	return $this->findOperationAttribute($this->subresourceOperations, $operationName, $key, $defaultValue, $resourceFallback);	15✔
188	}
189
190	public function getGraphqlAttribute(string $operationName, string $key, $defaultValue = null, bool $resourceFallback = false)
191	{
192	if (isset($this->graphql[$operationName][$key])) {	129✔
193	return $this->graphql[$operationName][$key];	53✔
194	}
195
196	if ($resourceFallback && isset($this->attributes[$key])) {	98✔
197	return $this->attributes[$key];	9✔
198	}
199
200	return $defaultValue;	95✔
201	}
202
203	/**
204	* Gets the first available operation attribute according to the following order: collection, item, subresource, optionally fallback to a default value.
205	*
206	* @param mixed\|null $defaultValue
207	*/
208	public function getOperationAttribute(array $attributes, string $key, $defaultValue = null, bool $resourceFallback = false)
209	{
210	if (isset($attributes['collection_operation_name'])) {	100✔
211	return $this->getCollectionOperationAttribute($attributes['collection_operation_name'], $key, $defaultValue, $resourceFallback);	60✔
212	}
213
214	if (isset($attributes['item_operation_name'])) {	40✔
215	return $this->getItemOperationAttribute($attributes['item_operation_name'], $key, $defaultValue, $resourceFallback);	38✔
216	}
217
218	if (isset($attributes['subresource_operation_name'])) {	2✔
219	return $this->getSubresourceOperationAttribute($attributes['subresource_operation_name'], $key, $defaultValue, $resourceFallback);	×
220	}
221
222	if ($resourceFallback && isset($this->attributes[$key])) {	2✔
223	return $this->attributes[$key];	1✔
224	}
225
226	return $defaultValue;	1✔
227	}
228
229	/**
230	* Gets an attribute for a given operation type and operation name.
231	*
232	* @param mixed\|null $defaultValue
233	*/
234	public function getTypedOperationAttribute(string $operationType, string $operationName, string $key, $defaultValue = null, bool $resourceFallback = false)
235	{
236	switch ($operationType) {
237	case OperationType::COLLECTION:	88✔
238	return $this->getCollectionOperationAttribute($operationName, $key, $defaultValue, $resourceFallback);	63✔
239	case OperationType::ITEM:	59✔
240	return $this->getItemOperationAttribute($operationName, $key, $defaultValue, $resourceFallback);	59✔
241	default:
242	return $this->getSubresourceOperationAttribute($operationName, $key, $defaultValue, $resourceFallback);	15✔
243	}
244	}
245
246	/**
247	* Gets attributes.
248	*/
249	public function getAttributes(): ?array
250	{
251	return $this->attributes;	93✔
252	}
253
254	/**
255	* Gets an attribute.
256	*
257	* @param mixed\|null $defaultValue
258	*/
259	public function getAttribute(string $key, $defaultValue = null)
260	{
261	return $this->attributes[$key] ?? $defaultValue;	207✔
262	}
263
264	/**
265	* Returns a new instance with the given attribute.
266	*/
267	public function withAttributes(array $attributes): self
268	{
269	$metadata = clone $this;	115✔
270	$metadata->attributes = $attributes;	115✔
271
272	return $metadata;	115✔
273	}
274
275	/**
276	* Gets options of for the GraphQL query.
277	*/
278	public function getGraphql(): ?array
279	{
280	return $this->graphql;	51✔
281	}
282
283	/**
284	* Returns a new instance with the given GraphQL options.
285	*/
286	public function withGraphql(array $graphql): self
287	{
288	$metadata = clone $this;	76✔
289	$metadata->graphql = $graphql;	76✔
290
291	return $metadata;	76✔
292	}
293
294	/**
295	* Gets an operation attribute, optionally fallback to a resource attribute.
296	*
297	* @param mixed\|null $defaultValue
298	*/
299	private function findOperationAttribute(?array $operations, ?string $operationName, string $key, $defaultValue, bool $resourceFallback)
300	{
301	if (null !== $operationName && isset($operations[$operationName][$key])) {	251✔
302	return $operations[$operationName][$key];	132✔
303	}
304
305	if ($resourceFallback && isset($this->attributes[$key])) {	208✔
306	return $this->attributes[$key];	119✔
307	}
308
309	return $defaultValue;	183✔
310	}
311	}

api-platform / core / #27298

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