#24950

pending completion

Build # #24950

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%)

5663 of 11449 relevant lines covered (49.46%)

55.46 hits per line

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

93.33

/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 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;

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

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

api-platform / core / #24950

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