OffsetPagination::renderButtons() - Code Metrics - Inspection of "Update OffsetPagination.php" - yiisoft/demo - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#561)

by Ross

created 2023-01-04 21:42 UTC

OffsetPagination::renderButtons() B

↳ Parent: OffsetPagination

Complexity

Conditions	11
Paths	80

Size

Total Lines	29
Code Lines	18

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	11
eloc	18
c	1
b	0
f	0
nc	80
nop	0
dl	0
loc	29
rs	7.3166

How to fix Complexity

<?php

declare(strict_types=1);

namespace App\Widget;

use Closure;
use Yiisoft\Data\Paginator\OffsetPaginator as Paginator;
filter:
    dependency_paths: ["lib/*"]
use Yiisoft\Html\Html;
filter:
    dependency_paths: ["lib/*"]
use Yiisoft\Yii\Bootstrap5\Widget;
filter:
    dependency_paths: ["lib/*"]

final class OffsetPagination extends Widget
{
    private array $options = [];

    private ?Closure $urlGenerator = null;
    private ?Paginator $paginator = null;
    private int $pagesCount;
    private int $currentPage;
    private array $pages;
    private bool $prepared;

    public function paginator(?Paginator $paginator): self
    {
        $this->paginator = $paginator;
        $this->prepared = false;

        return $this;
    }

    public function urlGenerator(Closure $generator): self
    {
        $this->urlGenerator = $generator;

        return $this;
    }

    public function isRequired(): bool
    {
        return $this->paginator === null ? false : $this->paginator->isRequired();
    }

    /**
     * The HTML attributes for the widget container tag. The following special options are recognized.
     *
     * {@see \Yiisoft\Html\Html::renderTagAttributes()} for details on how attributes are being rendered.
     */
    public function options(array $value): self
    {
        $this->options = $value;

        return $this;
    }

    protected function run(): string
    {
        if ($this->paginator === null) {
            return '';
        }
        if (!isset($this->options['id'])) {
            $this->options['id'] = "{$this->getId()}-post-card";
        }

        $this->initOptions();
        $this->prepareButtons();

        return implode("\n", [
            Html::openTag('nav', $this->options),
            Html::openTag('ul', ['class' => 'pagination']),
            $this->renderButtons(),
            Html::closeTag('ul'),
            Html::closeTag('nav'),
        ]);
    }

    protected function prepareButtons(): void
    {
        if ($this->prepared) {
            return;
        }
        $this->pagesCount = null!== $this->paginator ? $this->paginator->getTotalPages() : 0;
        $this->currentPage = null!== $this->paginator ? $this->paginator->getCurrentPage() : 0;
        if ($this->pagesCount > 9) {
            if ($this->currentPage <= 4) {
                $this->pages = [...range(1, 5), null, ...range($this->pagesCount - 2, $this->pagesCount)];
            } elseif ($this->pagesCount - $this->currentPage <= 4) {
                $this->pages = [1, 2, null, ...range($this->pagesCount - 5, $this->pagesCount)];
            } else {
                $this->pages = [
                    1,
                    2,
                    null,
                    $this->currentPage - 1,
                    $this->currentPage,
                    $this->currentPage + 1,
                    null,
                    $this->pagesCount - 1,
                    $this->pagesCount,
                ];
            }
        } else {
            $this->pages = range(1, $this->pagesCount);
        }
        $this->prepared = true;
    }

    protected function renderButtons(): string
    {
        $result = '';

        // `Previous` page
        $prevUrl = null!==$this->paginator && $this->paginator->isOnFirstPage() ? null : $this->getPageLink($this->currentPage - 1);
        $result .= Html::openTag('li', ['class' => $prevUrl === null ? 'page-item disabled' : 'page-item']);
        $result .= Html::a('Previous', $prevUrl, ['class' => 'page-link']);
        $result .= Html::closeTag('li');

        // Numeric buttons
        foreach ($this->pages as $page) {
            $isDisabled = $this->currentPage === $page || $page === null;
            $result .= Html::openTag('li', ['class' => $isDisabled ? 'page-item disabled' : 'page-item']);
            if ($page === null) {
                $result .= Html::span('…', ['class' => 'page-link']);
            } else {
                $result .= Html::a((string) $page, $this->getPageLink($page), ['class' => 'page-link']);
            }
            $result .= Html::closeTag('li');
        }

        // `Next` page
        $nextUrl = null!==$this->paginator && $this->paginator->isOnLastPage() ? null : $this->getPageLink($this->currentPage + 1);
        $result .= Html::openTag('li', ['class' => $nextUrl === null ? 'page-item disabled' : 'page-item']);
        $result .= Html::a('Next', $nextUrl, ['class' => 'page-link']);
        $result .= Html::closeTag('li');

        return $result;
    }

    protected function getPageLink(int $page): ?string
    {
        return $this->urlGenerator === null ? null : (string) ($this->urlGenerator)($page);
    }

    protected function initOptions(): void
    {
        Html::addCssClass($this->options, [
            'aria-label' => 'Page navigation',
        ]);
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace App\Widget;
6
7			use Closure;
8			use Yiisoft\Data\Paginator\OffsetPaginator as Paginator;
			0 ignored issues – show Bug introduced 2022-11-09 16:02 UTC by Report Bug Copy Issue Report The type `Yiisoft\Data\Paginator\OffsetPaginator` 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...
9			use Yiisoft\Html\Html;
			0 ignored issues – show Bug introduced 2022-11-09 16:02 UTC by Report Bug Copy Issue Report The type `Yiisoft\Html\Html` 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...
10			use Yiisoft\Yii\Bootstrap5\Widget;
			0 ignored issues – show Bug introduced 2022-11-09 16:02 UTC by Report Bug Copy Issue Report The type `Yiisoft\Yii\Bootstrap5\Widget` 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...
11
12			final class OffsetPagination extends Widget
13			{
14			private array $options = [];
15
16			private ?Closure $urlGenerator = null;
17			private ?Paginator $paginator = null;
18			private int $pagesCount;
19			private int $currentPage;
20			private array $pages;
21			private bool $prepared;
22
23			public function paginator(?Paginator $paginator): self
24			{
25			$this->paginator = $paginator;
26			$this->prepared = false;
27
28			return $this;
29			}
30
31			public function urlGenerator(Closure $generator): self
32			{
33			$this->urlGenerator = $generator;
34
35			return $this;
36			}
37
38			public function isRequired(): bool
39			{
40			return $this->paginator === null ? false : $this->paginator->isRequired();
41			}
42
43			/**
44			* The HTML attributes for the widget container tag. The following special options are recognized.
45			*
46			* {@see \Yiisoft\Html\Html::renderTagAttributes()} for details on how attributes are being rendered.
47			*/
48			public function options(array $value): self
49			{
50			$this->options = $value;
51
52			return $this;
53			}
54
55			protected function run(): string
56			{
57			if ($this->paginator === null) {
58			return '';
59			}
60			if (!isset($this->options['id'])) {
61			$this->options['id'] = "{$this->getId()}-post-card";
62			}
63
64			$this->initOptions();
65			$this->prepareButtons();
66
67			return implode("\n", [
68			Html::openTag('nav', $this->options),
69			Html::openTag('ul', ['class' => 'pagination']),
70			$this->renderButtons(),
71			Html::closeTag('ul'),
72			Html::closeTag('nav'),
73			]);
74			}
75
76			protected function prepareButtons(): void
77			{
78			if ($this->prepared) {
79			return;
80			}
81			$this->pagesCount = null!== $this->paginator ? $this->paginator->getTotalPages() : 0;
82			$this->currentPage = null!== $this->paginator ? $this->paginator->getCurrentPage() : 0;
83			if ($this->pagesCount > 9) {
84			if ($this->currentPage <= 4) {
85			$this->pages = [...range(1, 5), null, ...range($this->pagesCount - 2, $this->pagesCount)];
86			} elseif ($this->pagesCount - $this->currentPage <= 4) {
87			$this->pages = [1, 2, null, ...range($this->pagesCount - 5, $this->pagesCount)];
88			} else {
89			$this->pages = [
90			1,
91			2,
92			null,
93			$this->currentPage - 1,
94			$this->currentPage,
95			$this->currentPage + 1,
96			null,
97			$this->pagesCount - 1,
98			$this->pagesCount,
99			];
100			}
101			} else {
102			$this->pages = range(1, $this->pagesCount);
103			}
104			$this->prepared = true;
105			}
106
107			protected function renderButtons(): string
108			{
109			$result = '';
110
111			// `Previous` page
112			$prevUrl = null!==$this->paginator && $this->paginator->isOnFirstPage() ? null : $this->getPageLink($this->currentPage - 1);
113			$result .= Html::openTag('li', ['class' => $prevUrl === null ? 'page-item disabled' : 'page-item']);
114			$result .= Html::a('Previous', $prevUrl, ['class' => 'page-link']);
115			$result .= Html::closeTag('li');
116
117			// Numeric buttons
118			foreach ($this->pages as $page) {
119			$isDisabled = $this->currentPage === $page \|\| $page === null;
120			$result .= Html::openTag('li', ['class' => $isDisabled ? 'page-item disabled' : 'page-item']);
121			if ($page === null) {
122			$result .= Html::span('…', ['class' => 'page-link']);
123			} else {
124			$result .= Html::a((string) $page, $this->getPageLink($page), ['class' => 'page-link']);
125			}
126			$result .= Html::closeTag('li');
127			}
128
129			// `Next` page
130			$nextUrl = null!==$this->paginator && $this->paginator->isOnLastPage() ? null : $this->getPageLink($this->currentPage + 1);
131			$result .= Html::openTag('li', ['class' => $nextUrl === null ? 'page-item disabled' : 'page-item']);
132			$result .= Html::a('Next', $nextUrl, ['class' => 'page-link']);
133			$result .= Html::closeTag('li');
134
135			return $result;
136			}
137
138			protected function getPageLink(int $page): ?string
139			{
140			return $this->urlGenerator === null ? null : (string) ($this->urlGenerator)($page);
141			}
142
143			protected function initOptions(): void
144			{
145			Html::addCssClass($this->options, [
146			'aria-label' => 'Page navigation',
147			]);
148			}
149			}
150

yiisoft / demo

Pull Request — master (#561)

OffsetPagination::renderButtons() B

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like