#25639

pending completion

Build # #25639

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/60e55ad4a32eadae4c60bc3bb2500c5850e7b351">60e55ad4a<a href="https://github.com/api-platform/core/commit/60e55ad4a32eadae4c60bc3bb2500c5850e7b351">">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/ff60de751e0f6713eef834c36e0e733bd2341231">ff60de751</a>">ff60de751</a><a href="https://github.com/api-platform/core/commit/60e55ad4a32eadae4c60bc3bb2500c5850e7b351"> into 9ccf57835">9ccf57835</a>

Run Details

62 of 62 new or added lines in 13 files covered. (100.0%)

6801 of 11726 relevant lines covered (58.0%)

71.69 hits per line

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

95.35

/src/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\Core\Api\IriConverterInterface;
use ApiPlatform\Core\Api\ResourceClassResolverInterface;
use ApiPlatform\Core\DataPersister\DataPersisterInterface;
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
use ApiPlatform\Core\Metadata\Resource\ToggleableOperationAttributeTrait;
use ApiPlatform\Core\Util\RequestAttributesExtractor;
use ApiPlatform\Core\Util\ResourceClassInfoTrait;
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 ResourceClassInfoTrait;
    use ToggleableOperationAttributeTrait;

    public const OPERATION_ATTRIBUTE_KEY = 'write';

    private $dataPersister;
    private $iriConverter;

    public function __construct(DataPersisterInterface $dataPersister, IriConverterInterface $iriConverter = null, ResourceMetadataFactoryInterface $resourceMetadataFactory = null, ResourceClassResolverInterface $resourceClassResolver = null)
    {
        $this->dataPersister = $dataPersister;
        $this->iriConverter = $iriConverter;
        $this->resourceMetadataFactory = $resourceMetadataFactory;
        $this->resourceClassResolver = $resourceClassResolver;
    }

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

        if (
            $controllerResult instanceof Response
            || $request->isMethodSafe()
            || !($attributes = RequestAttributesExtractor::extractAttributes($request))
            || !$attributes['persist']
            || $this->isOperationAttributeDisabled($attributes, self::OPERATION_ATTRIBUTE_KEY)
        ) {
            return;
        }

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

        switch ($request->getMethod()) {
            case 'PUT':
            case 'PATCH':
            case 'POST':
                $persistResult = $this->dataPersister->persist($controllerResult, $attributes);

                if (!\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);
                } else {
                    $controllerResult = $persistResult;
                    $event->setControllerResult($controllerResult);
                }

                if ($controllerResult instanceof Response) {
                    break;
                }

                $hasOutput = true;
                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->iriConverter instanceof IriConverterInterface && $this->isResourceClass($this->getObjectClass($controllerResult))) {
                    $request->attributes->set('_api_write_item_iri', $this->iriConverter->getIriFromItem($controllerResult));
                }

                break;
            case 'DELETE':
                $this->dataPersister->remove($controllerResult, $attributes);
                $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\Core\Api\IriConverterInterface;
17	use ApiPlatform\Core\Api\ResourceClassResolverInterface;
18	use ApiPlatform\Core\DataPersister\DataPersisterInterface;
19	use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
20	use ApiPlatform\Core\Metadata\Resource\ToggleableOperationAttributeTrait;
21	use ApiPlatform\Core\Util\RequestAttributesExtractor;
22	use ApiPlatform\Core\Util\ResourceClassInfoTrait;
23	use Symfony\Component\HttpFoundation\Response;
24	use Symfony\Component\HttpKernel\Event\ViewEvent;
25
26	/**
27	* Bridges persistence and the API system.
28	*
29	* @author Kévin Dunglas <dunglas@gmail.com>
30	* @author Baptiste Meyer <baptiste.meyer@gmail.com>
31	*/
32	final class WriteListener
33	{
34	use ResourceClassInfoTrait;
35	use ToggleableOperationAttributeTrait;
36
37	public const OPERATION_ATTRIBUTE_KEY = 'write';
38
39	private $dataPersister;
40	private $iriConverter;
41
42	public function __construct(DataPersisterInterface $dataPersister, IriConverterInterface $iriConverter = null, ResourceMetadataFactoryInterface $resourceMetadataFactory = null, ResourceClassResolverInterface $resourceClassResolver = null)
43	{
44	$this->dataPersister = $dataPersister;	405✔
45	$this->iriConverter = $iriConverter;	405✔
46	$this->resourceMetadataFactory = $resourceMetadataFactory;	405✔
47	$this->resourceClassResolver = $resourceClassResolver;	405✔
48	}	405✔
49
50	/**
51	* Persists, updates or delete data return by the controller if applicable.
52	*/
53	public function onKernelView(ViewEvent $event): void
54	{
55	$controllerResult = $event->getControllerResult();	405✔
56	$request = $event->getRequest();	405✔
57
58	if (
59	$controllerResult instanceof Response	405✔
60	\|\| $request->isMethodSafe()	405✔
61	\|\| !($attributes = RequestAttributesExtractor::extractAttributes($request))	405✔
62	\|\| !$attributes['persist']	405✔
63	\|\| $this->isOperationAttributeDisabled($attributes, self::OPERATION_ATTRIBUTE_KEY)	405✔
64	) {
65	return;	275✔
66	}
67
68	if (!$this->dataPersister->supports($controllerResult, $attributes)) {	133✔
69	return;	×
70	}
71
72	switch ($request->getMethod()) {	133✔
73	case 'PUT':	133✔
74	case 'PATCH':	109✔
75	case 'POST':	105✔
76	$persistResult = $this->dataPersister->persist($controllerResult, $attributes);	122✔
77
78	if (!\is_object($persistResult)) {	121✔
79	@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);	×
80	} else {
81	$controllerResult = $persistResult;	121✔
82	$event->setControllerResult($controllerResult);	121✔
83	}
84
85	if ($controllerResult instanceof Response) {	121✔
86	break;	1✔
87	}
88
89	$hasOutput = true;	120✔
90	if ($this->resourceMetadataFactory instanceof ResourceMetadataFactoryInterface) {	120✔
91	$resourceMetadata = $this->resourceMetadataFactory->create($attributes['resource_class']);	120✔
92	$outputMetadata = $resourceMetadata->getOperationAttribute($attributes, 'output', [	120✔
93	'class' => $attributes['resource_class'],	120✔
94	], true);	120✔
95
96	$hasOutput = \array_key_exists('class', $outputMetadata) && null !== $outputMetadata['class'];	120✔
97	}
98
99	if (!$hasOutput) {	120✔
100	break;	1✔
101	}
102
103	if ($this->iriConverter instanceof IriConverterInterface && $this->isResourceClass($this->getObjectClass($controllerResult))) {	119✔
104	$request->attributes->set('_api_write_item_iri', $this->iriConverter->getIriFromItem($controllerResult));	118✔
105	}
106
107	break;	119✔
108	case 'DELETE':	11✔
109	$this->dataPersister->remove($controllerResult, $attributes);	11✔
110	$event->setControllerResult(null);	11✔
111	break;	11✔
112	}
113	}	132✔
114	}

api-platform / core / #25639

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