#27673

pending completion

Build # #27673

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/34961b76317421cff66ca5b1755257a8966df07a">34961b763<a href="https://github.com/api-platform/core/commit/34961b76317421cff66ca5b1755257a8966df07a">">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/33f5988a09092812cee0e4b438e004f24d8504b4">33f5988a0</a>">33f5988a0</a><a href="https://github.com/api-platform/core/commit/34961b76317421cff66ca5b1755257a8966df07a"> into 5e2eb4d11">5e2eb4d11</a>

Run Details

225 of 225 new or added lines in 30 files covered. (100.0%)

13216 of 16017 relevant lines covered (82.51%)

14.85 hits per line

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

93.55

/src/Core/EventListener/WriteListener.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\EventListener;

use ApiPlatform\Api\IriConverterInterface;
use ApiPlatform\Core\Api\IriConverterInterface as LegacyIriConverterInterface;
use ApiPlatform\Core\Api\ResourceClassResolverInterface;
use ApiPlatform\Core\DataPersister\DataPersisterInterface;
use ApiPlatform\Core\Identifier\ContextAwareIdentifierConverterInterface;
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
use ApiPlatform\Core\Metadata\Resource\ToggleableOperationAttributeTrait;
use ApiPlatform\Core\Util\RequestAttributesExtractor;
use ApiPlatform\Core\Util\ResourceClassInfoTrait;
use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
use ApiPlatform\State\ProcessorInterface;
use ApiPlatform\State\UriVariablesResolverTrait;
use ApiPlatform\Util\OperationRequestInitiatorTrait;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Event\ViewEvent;

/**
 * Bridges persistence and the API system.
 *
 * @author Kévin Dunglas <dunglas@gmail.com>
 * @author Baptiste Meyer <baptiste.meyer@gmail.com>
 */
final class WriteListener
{
    use OperationRequestInitiatorTrait;
    use ResourceClassInfoTrait;
    use ToggleableOperationAttributeTrait;

    // TODO: 3.0 remove this trait
    use UriVariablesResolverTrait;

    public const OPERATION_ATTRIBUTE_KEY = 'write';

    private $dataPersister;
    private $iriConverter;

    public function __construct($dataPersister, $iriConverter = null, $resourceMetadataFactory = null, ResourceClassResolverInterface $resourceClassResolver = null, ContextAwareIdentifierConverterInterface $identifierConverter = null)
    {
        if ($dataPersister instanceof DataPersisterInterface) {
            trigger_deprecation('api-platform/core', '2.7', sprintf('Use an implementation of "%s" instead of "%s".', ProcessorInterface::class, DataPersisterInterface::class));
        }
        $this->dataPersister = $dataPersister;

        if ($iriConverter instanceof LegacyIriConverterInterface) {
            trigger_deprecation('api-platform/core', '2.7', sprintf('Use an implementation of "%s" instead of "%s".', IriConverterInterface::class, LegacyIriConverterInterface::class));
        }

        $this->iriConverter = $iriConverter;
        if (!$resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface) {
            trigger_deprecation('api-platform/core', '2.7', sprintf('Use "%s" instead of "%s".', ResourceMetadataCollectionFactoryInterface::class, ResourceMetadataFactoryInterface::class));
        } else {
            $this->resourceMetadataCollectionFactory = $resourceMetadataFactory;
        }

        $this->resourceMetadataFactory = $resourceMetadataFactory;
        $this->resourceClassResolver = $resourceClassResolver;
        $this->uriVariablesConverter = $identifierConverter;
    }

    /**
     * Persists, updates or delete data return by the controller if applicable.
     */
    public function onKernelView(ViewEvent $event): void
    {
        $controllerResult = $event->getControllerResult();
        $request = $event->getRequest();

        $operation = $this->initializeOperation($request);

        if (
            $controllerResult instanceof Response
            || $request->isMethodSafe()
            || !($attributes = RequestAttributesExtractor::extractAttributes($request))
        ) {
            return;
        }

        if ($this->resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface &&
            (!$operation || !$operation->canWrite() || !$attributes['persist'])
        ) {
            return;
            // TODO: 3.0 remove condition
        }

        if (
            !$this->resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface &&
            (!$attributes['persist']
            || $this->isOperationAttributeDisabled($attributes, self::OPERATION_ATTRIBUTE_KEY)
        )) {
            return;
        }

        if ($this->dataPersister instanceof DataPersisterInterface && !$this->dataPersister->supports($controllerResult, $attributes)) {
            return;
        }

        $identifiers = $this->getOperationIdentifiers($operation, $request->attributes->all(), $attributes['resource_class']);
        $context = $operation ? ['operation' => $operation, 'legacy_attributes' => $attributes + ['has_composite_identifier' => $operation->getCompositeIdentifier()]] : [];
        if ($this->dataPersister instanceof ProcessorInterface && !$this->dataPersister->supports($controllerResult, $identifiers, $operation->getName(), $context)) {
            return;
        }

        switch ($request->getMethod()) {
            case 'PUT':
            case 'PATCH':
            case 'POST':
                $persistResult = $this->dataPersister instanceof DataPersisterInterface ? $this->dataPersister->persist($controllerResult, $attributes) : $this->dataPersister->process($controllerResult, $identifiers, $operation->getName(), $context);

                if ($this->dataPersister instanceof DataPersisterInterface && !\is_object($persistResult)) {
                    @trigger_error(sprintf('Not returning an object from %s::persist() is deprecated since API Platform 2.3 and will not be supported in API Platform 3.', DataPersisterInterface::class), \E_USER_DEPRECATED);
                } elseif ($persistResult) {
                    $controllerResult = $persistResult;
                    $event->setControllerResult($controllerResult);
                }

                if ($controllerResult instanceof Response) {
                    break;
                }

                $outputMetadata = $operation && $operation->getOutput() ? $operation->getOutput() : ['class' => $attributes['resource_class']];
                if ($this->resourceMetadataFactory instanceof ResourceMetadataFactoryInterface) {
                    $resourceMetadata = $this->resourceMetadataFactory->create($attributes['resource_class']);
                    $outputMetadata = $resourceMetadata->getOperationAttribute($attributes, 'output', [
                        'class' => $attributes['resource_class'],
                    ], true);
                }

                $hasOutput = \array_key_exists('class', $outputMetadata) && null !== $outputMetadata['class'];
                if (!$hasOutput) {
                    break;
                }

                if ($this->isResourceClass($this->getObjectClass($controllerResult)) && $this->iriConverter) {
                    $request->attributes->set('_api_write_item_iri', $this->iriConverter->getIriFromItem($controllerResult));
                }

                break;
            case 'DELETE':
                $this->dataPersister instanceof DataPersisterInterface ? $this->dataPersister->remove($controllerResult, $attributes) : $this->dataPersister->process($controllerResult, $identifiers, $operation->getName(), $context);
                $event->setControllerResult(null);
                break;
        }
    }
}

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\EventListener;
15
16	use ApiPlatform\Api\IriConverterInterface;
17	use ApiPlatform\Core\Api\IriConverterInterface as LegacyIriConverterInterface;
18	use ApiPlatform\Core\Api\ResourceClassResolverInterface;
19	use ApiPlatform\Core\DataPersister\DataPersisterInterface;
20	use ApiPlatform\Core\Identifier\ContextAwareIdentifierConverterInterface;
21	use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
22	use ApiPlatform\Core\Metadata\Resource\ToggleableOperationAttributeTrait;
23	use ApiPlatform\Core\Util\RequestAttributesExtractor;
24	use ApiPlatform\Core\Util\ResourceClassInfoTrait;
25	use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
26	use ApiPlatform\State\ProcessorInterface;
27	use ApiPlatform\State\UriVariablesResolverTrait;
28	use ApiPlatform\Util\OperationRequestInitiatorTrait;
29	use Symfony\Component\HttpFoundation\Response;
30	use Symfony\Component\HttpKernel\Event\ViewEvent;
31
32	/**
33	* Bridges persistence and the API system.
34	*
35	* @author Kévin Dunglas <dunglas@gmail.com>
36	* @author Baptiste Meyer <baptiste.meyer@gmail.com>
37	*/
38	final class WriteListener
39	{
40	use OperationRequestInitiatorTrait;
41	use ResourceClassInfoTrait;
42	use ToggleableOperationAttributeTrait;
43
44	// TODO: 3.0 remove this trait
45	use UriVariablesResolverTrait;
46
47	public const OPERATION_ATTRIBUTE_KEY = 'write';
48
49	private $dataPersister;
50	private $iriConverter;
51
52	public function __construct($dataPersister, $iriConverter = null, $resourceMetadataFactory = null, ResourceClassResolverInterface $resourceClassResolver = null, ContextAwareIdentifierConverterInterface $identifierConverter = null)
53	{
54	if ($dataPersister instanceof DataPersisterInterface) {	36✔
55	trigger_deprecation('api-platform/core', '2.7', sprintf('Use an implementation of "%s" instead of "%s".', ProcessorInterface::class, DataPersisterInterface::class));	12✔
56	}
57	$this->dataPersister = $dataPersister;	36✔
58
59	if ($iriConverter instanceof LegacyIriConverterInterface) {	36✔
60	trigger_deprecation('api-platform/core', '2.7', sprintf('Use an implementation of "%s" instead of "%s".', IriConverterInterface::class, LegacyIriConverterInterface::class));	×
61	}
62
63	$this->iriConverter = $iriConverter;	36✔
64	if (!$resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface) {	36✔
65	trigger_deprecation('api-platform/core', '2.7', sprintf('Use "%s" instead of "%s".', ResourceMetadataCollectionFactoryInterface::class, ResourceMetadataFactoryInterface::class));	12✔
66	} else {
67	$this->resourceMetadataCollectionFactory = $resourceMetadataFactory;	24✔
68	}
69
70	$this->resourceMetadataFactory = $resourceMetadataFactory;	36✔
71	$this->resourceClassResolver = $resourceClassResolver;	36✔
72	$this->uriVariablesConverter = $identifierConverter;	36✔
73	}	36✔
74
75	/**
76	* Persists, updates or delete data return by the controller if applicable.
77	*/
78	public function onKernelView(ViewEvent $event): void
79	{
80	$controllerResult = $event->getControllerResult();	36✔
81	$request = $event->getRequest();	36✔
82
83	$operation = $this->initializeOperation($request);	36✔
84
85	if (
86	$controllerResult instanceof Response	36✔
87	\|\| $request->isMethodSafe()	36✔
88	\|\| !($attributes = RequestAttributesExtractor::extractAttributes($request))	36✔
89	) {
90	return;	23✔
91	}
92
93	if ($this->resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface &&	13✔
94	(!$operation \|\| !$operation->canWrite() \|\| !$attributes['persist'])	13✔
95	) {
96	return;	×
97	// TODO: 3.0 remove condition
98	}
99
100	if (
101	!$this->resourceMetadataFactory instanceof ResourceMetadataCollectionFactoryInterface &&	13✔
102	(!$attributes['persist']	9✔
103	\|\| $this->isOperationAttributeDisabled($attributes, self::OPERATION_ATTRIBUTE_KEY)	13✔
104	)) {
105	return;	2✔
106	}
107
108	if ($this->dataPersister instanceof DataPersisterInterface && !$this->dataPersister->supports($controllerResult, $attributes)) {	11✔
109	return;	1✔
110	}
111
112	$identifiers = $this->getOperationIdentifiers($operation, $request->attributes->all(), $attributes['resource_class']);	10✔
113	$context = $operation ? ['operation' => $operation, 'legacy_attributes' => $attributes + ['has_composite_identifier' => $operation->getCompositeIdentifier()]] : [];	10✔
114	if ($this->dataPersister instanceof ProcessorInterface && !$this->dataPersister->supports($controllerResult, $identifiers, $operation->getName(), $context)) {	10✔
115	return;	×
116	}
117
118	switch ($request->getMethod()) {	10✔
119	case 'PUT':	10✔
120	case 'PATCH':	9✔
121	case 'POST':	9✔
122	$persistResult = $this->dataPersister instanceof DataPersisterInterface ? $this->dataPersister->persist($controllerResult, $attributes) : $this->dataPersister->process($controllerResult, $identifiers, $operation->getName(), $context);	9✔
123
124	if ($this->dataPersister instanceof DataPersisterInterface && !\is_object($persistResult)) {	9✔
125	@trigger_error(sprintf('Not returning an object from %s::persist() is deprecated since API Platform 2.3 and will not be supported in API Platform 3.', DataPersisterInterface::class), \E_USER_DEPRECATED);	1✔
126	} elseif ($persistResult) {	8✔
127	$controllerResult = $persistResult;	8✔
128	$event->setControllerResult($controllerResult);	8✔
129	}
130
131	if ($controllerResult instanceof Response) {	9✔
132	break;	×
133	}
134
135	$outputMetadata = $operation && $operation->getOutput() ? $operation->getOutput() : ['class' => $attributes['resource_class']];	9✔
136	if ($this->resourceMetadataFactory instanceof ResourceMetadataFactoryInterface) {	9✔
137	$resourceMetadata = $this->resourceMetadataFactory->create($attributes['resource_class']);	1✔
138	$outputMetadata = $resourceMetadata->getOperationAttribute($attributes, 'output', [	1✔
139	'class' => $attributes['resource_class'],	1✔
140	], true);	1✔
141	}
142
143	$hasOutput = \array_key_exists('class', $outputMetadata) && null !== $outputMetadata['class'];	9✔
144	if (!$hasOutput) {	9✔
145	break;	1✔
146	}
147
148	if ($this->isResourceClass($this->getObjectClass($controllerResult)) && $this->iriConverter) {	8✔
149	$request->attributes->set('_api_write_item_iri', $this->iriConverter->getIriFromItem($controllerResult));	7✔
150	}
151
152	break;	8✔
153	case 'DELETE':	1✔
154	$this->dataPersister instanceof DataPersisterInterface ? $this->dataPersister->remove($controllerResult, $attributes) : $this->dataPersister->process($controllerResult, $identifiers, $operation->getName(), $context);	1✔
155	$event->setControllerResult(null);	1✔
156	break;	1✔
157	}
158	}	10✔
159	}

api-platform / core / #27673

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