#27562

pending completion

Build # #27562

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/6ff6b7d523236864651904120636f871bc424508">6ff6b7d52<a href="https://github.com/api-platform/core/commit/6ff6b7d523236864651904120636f871bc424508">">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/fdbd75a7f6c70e0c1c54c73eb903072bf08473d3">fdbd75a7f</a>">fdbd75a7f</a><a href="https://github.com/api-platform/core/commit/6ff6b7d523236864651904120636f871bc424508"> into 4f363fc51">4f363fc51</a>

Run Details

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

7558 of 12215 relevant lines covered (61.87%)

84.09 hits per line

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

96.97

/src/Serializer/AbstractCollectionNormalizer.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\ResourceClassResolverInterface;
use ApiPlatform\Core\DataProvider\PaginatorInterface;
use ApiPlatform\Core\DataProvider\PartialPaginatorInterface;
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
use Symfony\Component\Serializer\Normalizer\AbstractObjectNormalizer;
use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerAwareTrait;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;

/**
 * Base collection normalizer.
 *
 * @author Baptiste Meyer <baptiste.meyer@gmail.com>
 */
abstract class AbstractCollectionNormalizer implements NormalizerInterface, NormalizerAwareInterface, CacheableSupportsMethodInterface
{
    use ContextTrait {
        initContext as protected;
    }
    use NormalizerAwareTrait;

    /**
     * This constant must be overridden in the child class.
     */
    public const FORMAT = 'to-override';

    protected $resourceClassResolver;
    protected $pageParameterName;
    protected $resourceMetadataFactory;

    public function __construct(ResourceClassResolverInterface $resourceClassResolver, string $pageParameterName, ResourceMetadataFactoryInterface $resourceMetadataFactory = null)
    {
        $this->resourceClassResolver = $resourceClassResolver;
        $this->pageParameterName = $pageParameterName;
        $this->resourceMetadataFactory = $resourceMetadataFactory;
    }

    /**
     * {@inheritdoc}
     */
    public function supportsNormalization($data, $format = null)
    {
        return static::FORMAT === $format && is_iterable($data);
    }

    /**
     * {@inheritdoc}
     */
    public function hasCacheableSupportsMethod(): bool
    {
        return true;
    }

    /**
     * {@inheritdoc}
     *
     * @param iterable $object
     */
    public function normalize($object, $format = null, array $context = [])
    {
        if (!isset($context['resource_class']) || isset($context['api_sub_level'])) {
            if (($context[AbstractObjectNormalizer::PRESERVE_EMPTY_OBJECTS] ?? false) && $object instanceof \Countable && 0 === $object->count()) {
                return $object;
            }
            return $this->normalizeRawCollection($object, $format, $context);
        }

        $resourceClass = $this->resourceClassResolver->getResourceClass($object, $context['resource_class']);
        $context = $this->initContext($resourceClass, $context);
        $data = [];

        return array_merge_recursive(
            $data,
            $this->getPaginationData($object, $context),
            $this->getItemsData($object, $format, $context)
        );
    }

    /**
     * Normalizes a raw collection (not API resources).
     *
     * @param string|null $format
     */
    protected function normalizeRawCollection($object, $format = null, array $context = []): array
    {
        $data = [];
        foreach ($object as $index => $obj) {
            $data[$index] = $this->normalizer->normalize($obj, $format, $context);
        }

        return $data;
    }

    /**
     * Gets the pagination configuration.
     *
     * @param iterable $object
     */
    protected function getPaginationConfig($object, array $context = []): array
    {
        $currentPage = $lastPage = $itemsPerPage = $pageTotalItems = $totalItems = null;
        $paginated = $paginator = false;

        if ($object instanceof PartialPaginatorInterface) {
            $paginated = $paginator = true;
            if ($object instanceof PaginatorInterface) {
                $paginated = 1. !== $lastPage = $object->getLastPage();
                $totalItems = $object->getTotalItems();
            } else {
                $pageTotalItems = (float) \count($object);
            }

            $currentPage = $object->getCurrentPage();
            $itemsPerPage = $object->getItemsPerPage();
        } elseif (\is_array($object) || $object instanceof \Countable) {
            $totalItems = \count($object);
        }

        return [$paginator, $paginated, $currentPage, $itemsPerPage, $lastPage, $pageTotalItems, $totalItems];
    }

    /**
     * Gets the pagination data.
     *
     * @param iterable $object
     */
    abstract protected function getPaginationData($object, array $context = []): array;

    /**
     * Gets items data.
     *
     * @param iterable $object
     */
    abstract protected function getItemsData($object, string $format = null, array $context = []): array;
}

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\ResourceClassResolverInterface;
17	use ApiPlatform\Core\DataProvider\PaginatorInterface;
18	use ApiPlatform\Core\DataProvider\PartialPaginatorInterface;
19	use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
20	use Symfony\Component\Serializer\Normalizer\AbstractObjectNormalizer;
21	use Symfony\Component\Serializer\Normalizer\CacheableSupportsMethodInterface;
22	use Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface;
23	use Symfony\Component\Serializer\Normalizer\NormalizerAwareTrait;
24	use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
25
26	/**
27	* Base collection normalizer.
28	*
29	* @author Baptiste Meyer <baptiste.meyer@gmail.com>
30	*/
31	abstract class AbstractCollectionNormalizer implements NormalizerInterface, NormalizerAwareInterface, CacheableSupportsMethodInterface
32	{
33	use ContextTrait {
34	initContext as protected;
35	}
36	use NormalizerAwareTrait;
37
38	/**
39	* This constant must be overridden in the child class.
40	*/
41	public const FORMAT = 'to-override';
42
43	protected $resourceClassResolver;
44	protected $pageParameterName;
45	protected $resourceMetadataFactory;
46
47	public function __construct(ResourceClassResolverInterface $resourceClassResolver, string $pageParameterName, ResourceMetadataFactoryInterface $resourceMetadataFactory = null)
48	{
49	$this->resourceClassResolver = $resourceClassResolver;	666✔
50	$this->pageParameterName = $pageParameterName;	666✔
51	$this->resourceMetadataFactory = $resourceMetadataFactory;	666✔
52	}	666✔
53
54	/**
55	* {@inheritdoc}
56	*/
57	public function supportsNormalization($data, $format = null)
58	{
59	return static::FORMAT === $format && is_iterable($data);	542✔
60	}
61
62	/**
63	* {@inheritdoc}
64	*/
65	public function hasCacheableSupportsMethod(): bool
66	{
67	return true;	542✔
68	}
69
70	/**
71	* {@inheritdoc}
72	*
73	* @param iterable $object
74	*/
75	public function normalize($object, $format = null, array $context = [])
76	{
77	if (!isset($context['resource_class']) \|\| isset($context['api_sub_level'])) {	53✔
78	if (($context[AbstractObjectNormalizer::PRESERVE_EMPTY_OBJECTS] ?? false) && $object instanceof \Countable && 0 === $object->count()) {	33✔
79	return $object;	×
80	}
81	return $this->normalizeRawCollection($object, $format, $context);	33✔
82	}
83
84	$resourceClass = $this->resourceClassResolver->getResourceClass($object, $context['resource_class']);	40✔
85	$context = $this->initContext($resourceClass, $context);	40✔
86	$data = [];	40✔
87
88	return array_merge_recursive(	40✔
89	$data,
90	$this->getPaginationData($object, $context),	40✔
91	$this->getItemsData($object, $format, $context)	40✔
92	);
93	}
94
95	/**
96	* Normalizes a raw collection (not API resources).
97	*
98	* @param string\|null $format
99	*/
100	protected function normalizeRawCollection($object, $format = null, array $context = []): array
101	{
102	$data = [];	33✔
103	foreach ($object as $index => $obj) {	33✔
104	$data[$index] = $this->normalizer->normalize($obj, $format, $context);	5✔
105	}
106
107	return $data;	33✔
108	}
109
110	/**
111	* Gets the pagination configuration.
112	*
113	* @param iterable $object
114	*/
115	protected function getPaginationConfig($object, array $context = []): array
116	{
117	$currentPage = $lastPage = $itemsPerPage = $pageTotalItems = $totalItems = null;	40✔
118	$paginated = $paginator = false;	40✔
119
120	if ($object instanceof PartialPaginatorInterface) {	40✔
121	$paginated = $paginator = true;	39✔
122	if ($object instanceof PaginatorInterface) {	39✔
123	$paginated = 1. !== $lastPage = $object->getLastPage();	38✔
124	$totalItems = $object->getTotalItems();	38✔
125	} else {
126	$pageTotalItems = (float) \count($object);	1✔
127	}
128
129	$currentPage = $object->getCurrentPage();	39✔
130	$itemsPerPage = $object->getItemsPerPage();	39✔
131	} elseif (\is_array($object) \|\| $object instanceof \Countable) {	1✔
132	$totalItems = \count($object);	1✔
133	}
134
135	return [$paginator, $paginated, $currentPage, $itemsPerPage, $lastPage, $pageTotalItems, $totalItems];	40✔
136	}
137
138	/**
139	* Gets the pagination data.
140	*
141	* @param iterable $object
142	*/
143	abstract protected function getPaginationData($object, array $context = []): array;
144
145	/**
146	* Gets items data.
147	*
148	* @param iterable $object
149	*/
150	abstract protected function getItemsData($object, string $format = null, array $context = []): array;
151	}

api-platform / core / #27562

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