15187574500

Committed 22 May 2025 01:14PM UTC coverage: 27.347%. Remained the same

Build # 15187574500

Build Type

push

github

Committed by

soyuka

Commit Message

docs: changelog 4.1.11

Run Details

13482 of 49299 relevant lines covered (27.35%)

74.57 hits per line

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

100.0

/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\HttpOperation;
use ApiPlatform\Metadata\NotExposed;
use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;

/**
 * Adds a {@see ApiPlatform\Metadata\NotExposed} operation with {@see ApiPlatform\Symfony\Action\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
{
    use OperationDefaultsTrait;

    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();

            /** @var HttpOperation $operation */
            foreach ($operations as $operation) {
                // An item operation has been found, nothing to do anymore in this factory
                if (('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 */
        [$key, $operation] = $this->getOperationWithDefaults(resource: $resource, operation: new NotExposed(), generated: true, ignoredOptions: ['uriTemplate', 'uriVariables']); // @phpstan-ignore-line $resource is defined if count > 0

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

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

api-platform / core / 15187574500

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