#27430

pending completion

Build # #27430

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/2b397608ed6a275bfa516c37179db25cb87f2cab">2b397608e<a href="https://github.com/api-platform/core/commit/2b397608ed6a275bfa516c37179db25cb87f2cab">">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/f52d6df05fbe3a6f19d67d9409b5d225adc91553">f52d6df05</a>">f52d6df05</a><a href="https://github.com/api-platform/core/commit/2b397608ed6a275bfa516c37179db25cb87f2cab"> into 978165808">978165808</a>

Run Details

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

9756 of 11678 relevant lines covered (83.54%)

14.76 hits per line

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

0.0

/src/Bridge/Doctrine/MongoDbOdm/Paginator.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\Bridge\Doctrine\MongoDbOdm;

use ApiPlatform\Core\DataProvider\PaginatorInterface;
use ApiPlatform\Core\Exception\InvalidArgumentException;
use Doctrine\ODM\MongoDB\Iterator\Iterator;
use Doctrine\ODM\MongoDB\UnitOfWork;

/**
 * Decorates the Doctrine MongoDB ODM paginator.
 *
 * @experimental
 *
 * @author Kévin Dunglas <dunglas@gmail.com>
 * @author Alan Poulain <contact@alanpoulain.eu>
 */
final class Paginator implements \IteratorAggregate, PaginatorInterface
{
    public const LIMIT_ZERO_MARKER_FIELD = '___';
    public const LIMIT_ZERO_MARKER = 'limit0';

    /**
     * @var Iterator
     */
    private $mongoDbOdmIterator;
    /**
     * @var array
     */
    private $pipeline;
    /**
     * @var UnitOfWork
     */
    private $unitOfWork;
    /**
     * @var string
     */
    private $resourceClass;

    /** @var \ArrayIterator */
    private $iterator;

    /**
     * @var int
     */
    private $firstResult;
    /**
     * @var int
     */
    private $maxResults;
    /**
     * @var int
     */
    private $totalItems;

    public function __construct(Iterator $mongoDbOdmIterator, UnitOfWork $unitOfWork, string $resourceClass, array $pipeline)
    {
        $this->mongoDbOdmIterator = $mongoDbOdmIterator;
        $this->unitOfWork = $unitOfWork;
        $this->resourceClass = $resourceClass;
        $this->pipeline = $pipeline;

        $resultsFacetInfo = $this->getFacetInfo('results');
        $this->getFacetInfo('count');

        /*
         * Since the {@see \MongoDB\Driver\Cursor} class does not expose information about
         * skip/limit parameters of the query, the values set in the facet stage are used instead.
         */
        $this->firstResult = $this->getStageInfo($resultsFacetInfo, '$skip');
        $this->maxResults = $this->hasLimitZeroStage($resultsFacetInfo) ? 0 : $this->getStageInfo($resultsFacetInfo, '$limit');
        $this->totalItems = $mongoDbOdmIterator->toArray()[0]['count'][0]['count'] ?? 0;
    }

    /**
     * {@inheritdoc}
     */
    public function getCurrentPage(): float
    {
        if (0 >= $this->maxResults) {
            return 1.;
        }

        return floor($this->firstResult / $this->maxResults) + 1.;
    }

    /**
     * {@inheritdoc}
     */
    public function getLastPage(): float
    {
        if (0 >= $this->maxResults) {
            return 1.;
        }

        return ceil($this->totalItems / $this->maxResults) ?: 1.;
    }

    /**
     * {@inheritdoc}
     */
    public function getItemsPerPage(): float
    {
        return (float) $this->maxResults;
    }

    /**
     * {@inheritdoc}
     */
    public function getTotalItems(): float
    {
        return (float) $this->totalItems;
    }

    /**
     * {@inheritdoc}
     */
    public function getIterator(): \Traversable
    {
        return $this->iterator ?? $this->iterator = new \ArrayIterator(array_map(function ($result) {
            return $this->unitOfWork->getOrCreateDocument($this->resourceClass, $result);
        }, $this->mongoDbOdmIterator->toArray()[0]['results']));
    }

    /**
     * {@inheritdoc}
     */
    public function count(): int
    {
        return \count($this->mongoDbOdmIterator->toArray()[0]['results']);
    }

    /**
     * @throws InvalidArgumentException
     */
    private function getFacetInfo(string $field): array
    {
        foreach ($this->pipeline as $indexStage => $infoStage) {
            if (\array_key_exists('$facet', $infoStage)) {
                if (!isset($this->pipeline[$indexStage]['$facet'][$field])) {
                    throw new InvalidArgumentException("\"$field\" facet was not applied to the aggregation pipeline.");
                }

                return $this->pipeline[$indexStage]['$facet'][$field];
            }
        }

        throw new InvalidArgumentException('$facet stage was not applied to the aggregation pipeline.');
    }

    /**
     * @throws InvalidArgumentException
     */
    private function getStageInfo(array $resultsFacetInfo, string $stage): int
    {
        foreach ($resultsFacetInfo as $resultFacetInfo) {
            if (isset($resultFacetInfo[$stage])) {
                return $resultFacetInfo[$stage];
            }
        }

        throw new InvalidArgumentException("$stage stage was not applied to the facet stage of the aggregation pipeline.");
    }

    private function hasLimitZeroStage(array $resultsFacetInfo): bool
    {
        foreach ($resultsFacetInfo as $resultFacetInfo) {
            if (self::LIMIT_ZERO_MARKER === ($resultFacetInfo['$match'][self::LIMIT_ZERO_MARKER_FIELD] ?? null)) {
                return true;
            }
        }

        return false;
    }
}

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\Bridge\Doctrine\MongoDbOdm;
15
16	use ApiPlatform\Core\DataProvider\PaginatorInterface;
17	use ApiPlatform\Core\Exception\InvalidArgumentException;
18	use Doctrine\ODM\MongoDB\Iterator\Iterator;
19	use Doctrine\ODM\MongoDB\UnitOfWork;
20
21	/**
22	* Decorates the Doctrine MongoDB ODM paginator.
23	*
24	* @experimental
25	*
26	* @author Kévin Dunglas <dunglas@gmail.com>
27	* @author Alan Poulain <contact@alanpoulain.eu>
28	*/
29	final class Paginator implements \IteratorAggregate, PaginatorInterface
30	{
31	public const LIMIT_ZERO_MARKER_FIELD = '___';
32	public const LIMIT_ZERO_MARKER = 'limit0';
33
34	/**
35	* @var Iterator
36	*/
37	private $mongoDbOdmIterator;
38	/**
39	* @var array
40	*/
41	private $pipeline;
42	/**
43	* @var UnitOfWork
44	*/
45	private $unitOfWork;
46	/**
47	* @var string
48	*/
49	private $resourceClass;
50
51	/** @var \ArrayIterator */
52	private $iterator;
53
54	/**
55	* @var int
56	*/
57	private $firstResult;
58	/**
59	* @var int
60	*/
61	private $maxResults;
62	/**
63	* @var int
64	*/
65	private $totalItems;
66
67	public function __construct(Iterator $mongoDbOdmIterator, UnitOfWork $unitOfWork, string $resourceClass, array $pipeline)
68	{
69	$this->mongoDbOdmIterator = $mongoDbOdmIterator;	×
70	$this->unitOfWork = $unitOfWork;	×
71	$this->resourceClass = $resourceClass;	×
72	$this->pipeline = $pipeline;	×
73
74	$resultsFacetInfo = $this->getFacetInfo('results');	×
75	$this->getFacetInfo('count');	×
76
77	/*
78	* Since the {@see \MongoDB\Driver\Cursor} class does not expose information about
79	* skip/limit parameters of the query, the values set in the facet stage are used instead.
80	*/
81	$this->firstResult = $this->getStageInfo($resultsFacetInfo, '$skip');	×
82	$this->maxResults = $this->hasLimitZeroStage($resultsFacetInfo) ? 0 : $this->getStageInfo($resultsFacetInfo, '$limit');	×
83	$this->totalItems = $mongoDbOdmIterator->toArray()[0]['count'][0]['count'] ?? 0;	×
84	}	×
85
86	/**
87	* {@inheritdoc}
88	*/
89	public function getCurrentPage(): float
90	{
91	if (0 >= $this->maxResults) {	×
92	return 1.;	×
93	}
94
95	return floor($this->firstResult / $this->maxResults) + 1.;	×
96	}
97
98	/**
99	* {@inheritdoc}
100	*/
101	public function getLastPage(): float
102	{
103	if (0 >= $this->maxResults) {	×
104	return 1.;	×
105	}
106
107	return ceil($this->totalItems / $this->maxResults) ?: 1.;	×
108	}
109
110	/**
111	* {@inheritdoc}
112	*/
113	public function getItemsPerPage(): float
114	{
115	return (float) $this->maxResults;	×
116	}
117
118	/**
119	* {@inheritdoc}
120	*/
121	public function getTotalItems(): float
122	{
123	return (float) $this->totalItems;	×
124	}
125
126	/**
127	* {@inheritdoc}
128	*/
129	public function getIterator(): \Traversable
130	{
131	return $this->iterator ?? $this->iterator = new \ArrayIterator(array_map(function ($result) {	×
132	return $this->unitOfWork->getOrCreateDocument($this->resourceClass, $result);	×
133	}, $this->mongoDbOdmIterator->toArray()[0]['results']));	×
134	}
135
136	/**
137	* {@inheritdoc}
138	*/
139	public function count(): int
140	{
141	return \count($this->mongoDbOdmIterator->toArray()[0]['results']);	×
142	}
143
144	/**
145	* @throws InvalidArgumentException
146	*/
147	private function getFacetInfo(string $field): array
148	{
149	foreach ($this->pipeline as $indexStage => $infoStage) {	×
150	if (\array_key_exists('$facet', $infoStage)) {	×
151	if (!isset($this->pipeline[$indexStage]['$facet'][$field])) {	×
152	throw new InvalidArgumentException("\"$field\" facet was not applied to the aggregation pipeline.");	×
153	}
154
155	return $this->pipeline[$indexStage]['$facet'][$field];	×
156	}
157	}
158
159	throw new InvalidArgumentException('$facet stage was not applied to the aggregation pipeline.');	×
160	}
161
162	/**
163	* @throws InvalidArgumentException
164	*/
165	private function getStageInfo(array $resultsFacetInfo, string $stage): int
166	{
167	foreach ($resultsFacetInfo as $resultFacetInfo) {	×
168	if (isset($resultFacetInfo[$stage])) {	×
169	return $resultFacetInfo[$stage];	×
170	}
171	}
172
173	throw new InvalidArgumentException("$stage stage was not applied to the facet stage of the aggregation pipeline.");	×
174	}
175
176	private function hasLimitZeroStage(array $resultsFacetInfo): bool
177	{
178	foreach ($resultsFacetInfo as $resultFacetInfo) {	×
179	if (self::LIMIT_ZERO_MARKER === ($resultFacetInfo['$match'][self::LIMIT_ZERO_MARKER_FIELD] ?? null)) {	×
180	return true;	×
181	}
182	}
183
184	return false;	×
185	}
186	}

api-platform / core / #27430

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