4498909317

Build Type

push

github

Committed by soyuka

Commit Message

Merge 3.1

Run Details

364 of 364 new or added lines in 61 files covered. (100.0%)

10781 of 17989 relevant lines covered (59.93%)

11.36 hits per line

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

94.12

/src/Metadata/Resource/Factory/NotExposedOperationResourceMetadataCollectionFactory.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\Metadata\Resource\Factory;

use ApiPlatform\Metadata\ApiResource;
use ApiPlatform\Metadata\CollectionOperationInterface;
use ApiPlatform\Metadata\Get;
use ApiPlatform\Metadata\HttpOperation;
use ApiPlatform\Metadata\NotExposed;
use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;

/**
 * Adds a {@see NotExposed} operation with {@see NotFoundAction} on a resource which only has a GetCollection.
 * This operation helps to generate resource IRI for items.
 *
 * @author Vincent Chalamon <vincentchalamon@gmail.com>
 */
final class NotExposedOperationResourceMetadataCollectionFactory implements ResourceMetadataCollectionFactoryInterface
{
    public static $skolemUriTemplate = '/.well-known/genid/{id}';

    private $linkFactory;
    private $decorated;

    public function __construct(LinkFactoryInterface $linkFactory, ?ResourceMetadataCollectionFactoryInterface $decorated = null)
    {
        $this->linkFactory = $linkFactory;
        $this->decorated = $decorated;
    }

    /**
     * {@inheritdoc}
     */
    public function create(string $resourceClass): ResourceMetadataCollection
    {
        $resourceMetadataCollection = new ResourceMetadataCollection($resourceClass);
        if ($this->decorated) {
            $resourceMetadataCollection = $this->decorated->create($resourceClass);
        }

        // Do not add a NotExposed operation on a resourceClass with no resource
        if (!$resourceMetadataCollection->count()) {
            return $resourceMetadataCollection;
        }

        /** @var ApiResource $resource */
        foreach ($resourceMetadataCollection as $resource) {
            $operations = $resource->getOperations();

            foreach ($operations as $operation) {
                // An item operation has been found, nothing to do anymore in this factory
                if ((HttpOperation::METHOD_GET === $operation->getMethod() && !$operation instanceof CollectionOperationInterface) || ($operation->getExtraProperties()['is_legacy_resource_metadata'] ?? false)) {
                    return $resourceMetadataCollection;
                }
            }
        }

        // No item operation has been found on all resources for resource class: generate one on the last resource
        // Helpful to generate an IRI for a resource without declaring the Get operation
        /** @var HttpOperation $operation */
        $operation = (new NotExposed())->withClass($resource->getClass())->withShortName($resource->getShortName()); // @phpstan-ignore-line $resource is defined if count > 0

        if (!$this->linkFactory->createLinksFromIdentifiers($operation)) {
            $operation = $operation->withUriTemplate(self::$skolemUriTemplate);
        }

        $operations->add(sprintf('_api_%s_get', $operation->getShortName()), $operation)->sort(); // @phpstan-ignore-line $operation exists

        return $resourceMetadataCollection;
    }
}

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\Metadata\Resource\Factory;
15
16	use ApiPlatform\Metadata\ApiResource;
17	use ApiPlatform\Metadata\CollectionOperationInterface;
18	use ApiPlatform\Metadata\Get;
19	use ApiPlatform\Metadata\HttpOperation;
20	use ApiPlatform\Metadata\NotExposed;
21	use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
22
23	/**
24	* Adds a {@see NotExposed} operation with {@see NotFoundAction} on a resource which only has a GetCollection.
25	* This operation helps to generate resource IRI for items.
26	*
27	* @author Vincent Chalamon <vincentchalamon@gmail.com>
28	*/
29	final class NotExposedOperationResourceMetadataCollectionFactory implements ResourceMetadataCollectionFactoryInterface
30	{
31	public static $skolemUriTemplate = '/.well-known/genid/{id}';
32
33	private $linkFactory;
34	private $decorated;
35
36	public function __construct(LinkFactoryInterface $linkFactory, ?ResourceMetadataCollectionFactoryInterface $decorated = null)
37	{
38	$this->linkFactory = $linkFactory;	34✔
39	$this->decorated = $decorated;	34✔
40	}
41
42	/**
43	* {@inheritdoc}
44	*/
45	public function create(string $resourceClass): ResourceMetadataCollection
46	{
47	$resourceMetadataCollection = new ResourceMetadataCollection($resourceClass);	3✔
48	if ($this->decorated) {	3✔
49	$resourceMetadataCollection = $this->decorated->create($resourceClass);	3✔
50	}
51
52	// Do not add a NotExposed operation on a resourceClass with no resource
53	if (!$resourceMetadataCollection->count()) {	3✔
54	return $resourceMetadataCollection;	×
55	}
56
57	/** @var ApiResource $resource */
58	foreach ($resourceMetadataCollection as $resource) {	3✔
59	$operations = $resource->getOperations();	3✔
60
61	foreach ($operations as $operation) {	3✔
62	// An item operation has been found, nothing to do anymore in this factory
63	if ((HttpOperation::METHOD_GET === $operation->getMethod() && !$operation instanceof CollectionOperationInterface) \|\| ($operation->getExtraProperties()['is_legacy_resource_metadata'] ?? false)) {	3✔
64	return $resourceMetadataCollection;	2✔
65	}
66	}
67	}
68
69	// No item operation has been found on all resources for resource class: generate one on the last resource
70	// Helpful to generate an IRI for a resource without declaring the Get operation
71	/** @var HttpOperation $operation */
72	$operation = (new NotExposed())->withClass($resource->getClass())->withShortName($resource->getShortName()); // @phpstan-ignore-line $resource is defined if count > 0	2✔
73
74	if (!$this->linkFactory->createLinksFromIdentifiers($operation)) {	2✔
75	$operation = $operation->withUriTemplate(self::$skolemUriTemplate);	2✔
76	}
77
78	$operations->add(sprintf('_api_%s_get', $operation->getShortName()), $operation)->sort(); // @phpstan-ignore-line $operation exists	2✔
79
80	return $resourceMetadataCollection;	2✔
81	}
82	}

api-platform / core / 4498909317

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