#24948

pending completion

Build # #24948

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/7d6f4a028c2a3a576169f812c11c3c6a67aa31cb">7d6f4a028<a href="https://github.com/api-platform/core/commit/7d6f4a028c2a3a576169f812c11c3c6a67aa31cb">">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/8f9087fcd8bbcc5c40d45fdde112d06f8a89cf4f">8f9087fcd</a>">8f9087fcd</a><a href="https://github.com/api-platform/core/commit/7d6f4a028c2a3a576169f812c11c3c6a67aa31cb"> into 3137ed00f">3137ed00f</a>

Run Details

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

6205 of 11153 relevant lines covered (55.64%)

67.3 hits per line

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

90.91

/src/Serializer/SerializerContextBuilder.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\Serializer;

use ApiPlatform\Core\Api\OperationType;
use ApiPlatform\Core\Exception\RuntimeException;
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
use ApiPlatform\Core\Swagger\Serializer\DocumentationNormalizer;
use ApiPlatform\Core\Util\RequestAttributesExtractor;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Serializer\Encoder\CsvEncoder;

/**
 * {@inheritdoc}
 *
 * @author Kévin Dunglas <dunglas@gmail.com>
 */
final class SerializerContextBuilder implements SerializerContextBuilderInterface
{
    private $resourceMetadataFactory;

    public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFactory)
    {
        $this->resourceMetadataFactory = $resourceMetadataFactory;
    }

    /**
     * {@inheritdoc}
     */
    public function createFromRequest(Request $request, bool $normalization, array $attributes = null): array
    {
        if (null === $attributes && !$attributes = RequestAttributesExtractor::extractAttributes($request)) {
            throw new RuntimeException('Request attributes are not valid.');
        }

        $resourceMetadata = $this->resourceMetadataFactory->create($attributes['resource_class']);
        $key = $normalization ? 'normalization_context' : 'denormalization_context';
        if (isset($attributes['collection_operation_name'])) {
            $operationKey = 'collection_operation_name';
            $operationType = OperationType::COLLECTION;
        } elseif (isset($attributes['item_operation_name'])) {
            $operationKey = 'item_operation_name';
            $operationType = OperationType::ITEM;
        } else {
            $operationKey = 'subresource_operation_name';
            $operationType = OperationType::SUBRESOURCE;
        }

        $context = $resourceMetadata->getTypedOperationAttribute($operationType, $attributes[$operationKey], $key, [], true);
        $context['operation_type'] = $operationType;
        $context[$operationKey] = $attributes[$operationKey];

        if (!$normalization) {
            if (!isset($context['api_allow_update'])) {
                $context['api_allow_update'] = \in_array($request->getMethod(), ['PUT', 'PATCH'], true);
            }

            if ('csv' === $request->getContentType()) {
                $context[CsvEncoder::AS_COLLECTION_KEY] = false;
            }
        }

        $context['resource_class'] = $attributes['resource_class'];
        $context['input'] = $resourceMetadata->getTypedOperationAttribute($operationType, $attributes[$operationKey], 'input', null, true);
        $context['output'] = $resourceMetadata->getTypedOperationAttribute($operationType, $attributes[$operationKey], 'output', null, true);
        $context['request_uri'] = $request->getRequestUri();
        $context['uri'] = $request->getUri();

        if (isset($attributes['subresource_context'])) {
            $context['subresource_identifiers'] = [];

            foreach ($attributes['subresource_context']['identifiers'] as $key => [$id, $resourceClass]) {
                if (!isset($context['subresource_resources'][$resourceClass])) {
                    $context['subresource_resources'][$resourceClass] = [];
                }

                $context['subresource_identifiers'][$id] = $context['subresource_resources'][$resourceClass][$id] = $request->attributes->get($id);
            }
        }

        if (isset($attributes['subresource_property'])) {
            $context['subresource_property'] = $attributes['subresource_property'];
            $context['subresource_resource_class'] = $attributes['subresource_resource_class'] ?? null;
        }

        unset($context[DocumentationNormalizer::SWAGGER_DEFINITION_NAME]);

        if (isset($context['skip_null_values'])) {
            return $context;
        }

        foreach ($resourceMetadata->getItemOperations() as $operation) {
            if ('PATCH' === ($operation['method'] ?? '') && \in_array('application/merge-patch+json', $operation['input_formats']['json'] ?? [], true)) {
                $context['skip_null_values'] = true;

                break;
            }
        }

        return $context;
    }
}

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\Serializer;
15
16	use ApiPlatform\Core\Api\OperationType;
17	use ApiPlatform\Core\Exception\RuntimeException;
18	use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
19	use ApiPlatform\Core\Swagger\Serializer\DocumentationNormalizer;
20	use ApiPlatform\Core\Util\RequestAttributesExtractor;
21	use Symfony\Component\HttpFoundation\Request;
22	use Symfony\Component\Serializer\Encoder\CsvEncoder;
23
24	/**
25	* {@inheritdoc}
26	*
27	* @author Kévin Dunglas <dunglas@gmail.com>
28	*/
29	final class SerializerContextBuilder implements SerializerContextBuilderInterface
30	{
31	private $resourceMetadataFactory;
32
33	public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFactory)
34	{
35	$this->resourceMetadataFactory = $resourceMetadataFactory;	524✔
36	}	524✔
37
38	/**
39	* {@inheritdoc}
40	*/
41	public function createFromRequest(Request $request, bool $normalization, array $attributes = null): array
42	{
43	if (null === $attributes && !$attributes = RequestAttributesExtractor::extractAttributes($request)) {	407✔
44	throw new RuntimeException('Request attributes are not valid.');	×
45	}
46
47	$resourceMetadata = $this->resourceMetadataFactory->create($attributes['resource_class']);	407✔
48	$key = $normalization ? 'normalization_context' : 'denormalization_context';	407✔
49	if (isset($attributes['collection_operation_name'])) {	407✔
50	$operationKey = 'collection_operation_name';	286✔
51	$operationType = OperationType::COLLECTION;	286✔
52	} elseif (isset($attributes['item_operation_name'])) {	129✔
53	$operationKey = 'item_operation_name';	117✔
54	$operationType = OperationType::ITEM;	117✔
55	} else {
56	$operationKey = 'subresource_operation_name';	12✔
57	$operationType = OperationType::SUBRESOURCE;	12✔
58	}
59
60	$context = $resourceMetadata->getTypedOperationAttribute($operationType, $attributes[$operationKey], $key, [], true);	407✔
61	$context['operation_type'] = $operationType;	407✔
62	$context[$operationKey] = $attributes[$operationKey];	407✔
63
64	if (!$normalization) {	407✔
65	if (!isset($context['api_allow_update'])) {	142✔
66	$context['api_allow_update'] = \in_array($request->getMethod(), ['PUT', 'PATCH'], true);	142✔
67	}
68
69	if ('csv' === $request->getContentType()) {	142✔
70	$context[CsvEncoder::AS_COLLECTION_KEY] = false;	1✔
71	}
72	}
73
74	$context['resource_class'] = $attributes['resource_class'];	407✔
75	$context['input'] = $resourceMetadata->getTypedOperationAttribute($operationType, $attributes[$operationKey], 'input', null, true);	407✔
76	$context['output'] = $resourceMetadata->getTypedOperationAttribute($operationType, $attributes[$operationKey], 'output', null, true);	407✔
77	$context['request_uri'] = $request->getRequestUri();	407✔
78	$context['uri'] = $request->getUri();	407✔
79
80	if (isset($attributes['subresource_context'])) {	407✔
81	$context['subresource_identifiers'] = [];	12✔
82
83	foreach ($attributes['subresource_context']['identifiers'] as $key => [$id, $resourceClass]) {	12✔
84	if (!isset($context['subresource_resources'][$resourceClass])) {	12✔
85	$context['subresource_resources'][$resourceClass] = [];	12✔
86	}
87
88	$context['subresource_identifiers'][$id] = $context['subresource_resources'][$resourceClass][$id] = $request->attributes->get($id);	12✔
89	}
90	}
91
92	if (isset($attributes['subresource_property'])) {	407✔
93	$context['subresource_property'] = $attributes['subresource_property'];	×
94	$context['subresource_resource_class'] = $attributes['subresource_resource_class'] ?? null;	×
95	}
96
97	unset($context[DocumentationNormalizer::SWAGGER_DEFINITION_NAME]);	407✔
98
99	if (isset($context['skip_null_values'])) {	407✔
100	return $context;	×
101	}
102
103	foreach ($resourceMetadata->getItemOperations() as $operation) {	407✔
104	if ('PATCH' === ($operation['method'] ?? '') && \in_array('application/merge-patch+json', $operation['input_formats']['json'] ?? [], true)) {	407✔
105	$context['skip_null_values'] = true;	3✔
106
107	break;	3✔
108	}
109	}
110
111	return $context;	407✔
112	}
113	}

api-platform / core / #24948

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