AnyPagination::getIterator() - Code Metrics - Inspection of "Merge branch 'release/2.0.0'" - cerbero90/lazy-json-pages - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( f80fe6...515bb9 )

by Andrea Marco

created 2024-09-10 23:55 UTC

AnyPagination::getIterator() A

↳ Parent: AnyPagination

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	2

Importance

Changes

Metric	Value
cc	2
eloc	2
nc	2
nop	0
dl	0
loc	6
ccs	3
cts	3
cp	1
crap	2
rs	10
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace Cerbero\LazyJsonPages\Paginations;

use Cerbero\LazyJsonPages\Exceptions\UnsupportedPaginationException;
use Traversable;

/**
 * The aggregator of supported paginations.
 */
class AnyPagination extends Pagination
{
    /**
     * The supported paginations.
     *
     * @var class-string<Pagination>[]

     */
    protected array $supportedPaginations = [
        CursorAwarePagination::class,
        CustomPagination::class,
filter:
    dependency_paths: ["lib/*"]
        LastPageAwarePagination::class,
        LinkHeaderAwarePagination::class,
        TotalItemsAwarePagination::class,
        TotalPagesAwarePagination::class,
    ];

    /**
     * Yield the paginated items.
     *
     * @return Traversable<int, mixed>
     * @throws UnsupportedPaginationException
     */
    public function getIterator(): Traversable
    {
        // yield only items and not indexes to ensure incremental indexes
        // otherwise the actual indexes always start from 0 on every page
        foreach ($this->matchingPagination() as $item) {
            yield $item;
        }
    }

    /**
     * Retrieve the pagination matching with the configuration.
     */
    protected function matchingPagination(): Pagination
    {
        foreach ($this->supportedPaginations as $class) {
            $pagination = new $class($this->source, $this->client, $this->config);

            if ($pagination->matches()) {
                return $pagination;
            }
        }

        throw new UnsupportedPaginationException($this->config);
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Cerbero\LazyJsonPages\Paginations;
6
7		use Cerbero\LazyJsonPages\Exceptions\UnsupportedPaginationException;
8		use Traversable;
9
10		/**
11		* The aggregator of supported paginations.
12		*/
13		class AnyPagination extends Pagination
14		{
15		/**
16		* The supported paginations.
17		*
18		* @var class-string<Pagination>[]
		0 ignored issues – show Documentation Bug introduced 2024-02-12 06:27 UTC by Report Bug Copy Issue Report The doc comment `class-string<Pagination>[]` at position `0` could not be parsed: Unknown type name 'class-string' at position 0 in class-string<Pagination>[]. Loading history...
19		*/
20		protected array $supportedPaginations = [
21		CursorAwarePagination::class,
22		CustomPagination::class,
		0 ignored issues – show Bug introduced 2024-02-12 06:27 UTC by Report Bug Copy Issue Report The type `Cerbero\LazyJsonPages\Paginations\CustomPagination` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
23		LastPageAwarePagination::class,
24		LinkHeaderAwarePagination::class,
25		TotalItemsAwarePagination::class,
26		TotalPagesAwarePagination::class,
27		];
28
29		/**
30		* Yield the paginated items.
31		*
32		* @return Traversable<int, mixed>
33		* @throws UnsupportedPaginationException
34		*/
35	50	public function getIterator(): Traversable
36		{
37		// yield only items and not indexes to ensure incremental indexes
38		// otherwise the actual indexes always start from 0 on every page
39	50	foreach ($this->matchingPagination() as $item) {
40	43	yield $item;
41		}
42		}
43
44		/**
45		* Retrieve the pagination matching with the configuration.
46		*/
47	50	protected function matchingPagination(): Pagination
48		{
49	50	foreach ($this->supportedPaginations as $class) {
50	50	$pagination = new $class($this->source, $this->client, $this->config);
51
52	50	if ($pagination->matches()) {
53	49	return $pagination;
54		}
55		}
56
57	1	throw new UnsupportedPaginationException($this->config);
58		}
59		}
60

cerbero90 / lazy-json-pages

Push — master ( f80fe6...515bb9 )

AnyPagination::getIterator() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like