InlineKeyboardPagination::generateButton() - Code Metrics - Inspection of "Merge pull request #12 from php-telegram-bot/10-im..." - php-telegram-bot/inline-keyboard-pagination - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 5f0532...125a75 )

by Armando

created 2021-07-10 15:11 UTC

InlineKeyboardPagination::generateButton() A

↳ Parent: InlineKeyboardPagination

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
eloc	3
c	2
b	0
f	0
dl	0
loc	5
rs	10
cc	1
nc	1
nop	1

<?php

namespace TelegramBot\InlineKeyboardPagination;

use TelegramBot\InlineKeyboardPagination\Exceptions\InlineKeyboardPaginationException;

/**
 * Class InlineKeyboardPagination
 *
 * @package TelegramBot\InlineKeyboardPagination
 */
class InlineKeyboardPagination implements InlineKeyboardPaginator
{
    private array $items;
    private int $itemsPerPage;
    private int $selectedPage;
    private int $maxButtons = 5;
    private bool $forceButtonCount = false;
    private string $command;
    private string $callbackDataFormat = 'command={COMMAND}&oldPage={OLD_PAGE}&newPage={NEW_PAGE}';
    private array $labels = [
        'default'  => '%d',
        'first'    => '« %d',
        'previous' => '‹ %d',
        'current'  => '· %d ·',
        'next'     => '%d ›',
        'last'     => '%d »',
    ];

    /**
     * @param int  $maxButtons
     * @param bool $forceButtonCount
     *
     * @return $this
     * @throws InlineKeyboardPaginationException
     */
    public function setMaxButtons(int $maxButtons = 5, bool $forceButtonCount = false): InlineKeyboardPagination
    {
        if ($maxButtons < 5 || $maxButtons > 8) {
            throw InlineKeyboardPaginationException::invalidMaxButtons();
        }

        $this->maxButtons       = $maxButtons;
        $this->forceButtonCount = $forceButtonCount;

        return $this;
    }

    /**
     * Get the current callback format.
     *
     * @return string
     */
    public function getCallbackDataFormat(): string
    {
        return $this->callbackDataFormat;
    }

    /**
     * Set the callback_data format.
     *
     * @param string $callbackDataFormat
     *
     * @return InlineKeyboardPagination
     */
    public function setCallbackDataFormat(string $callbackDataFormat): InlineKeyboardPagination
    {
        $this->callbackDataFormat = $callbackDataFormat;

        return $this;
    }

    /**
     * Return list of keyboard button labels.
     *
     * @return array
     */
    public function getLabels(): array
    {
        return $this->labels;
    }

    /**
     * Set the keyboard button labels.
     *
     * @param array $labels
     *
     * @return InlineKeyboardPagination
     */
    public function setLabels(array $labels): InlineKeyboardPagination
    {
        $this->labels = $labels;

        return $this;
    }

    /**
     * @inheritdoc
     */
    public function setCommand(string $command = 'pagination'): InlineKeyboardPagination
    {
        $this->command = $command;

        return $this;
    }

    /**
     * @inheritdoc
     * @throws InlineKeyboardPaginationException
     */
    public function setSelectedPage(int $selectedPage): InlineKeyboardPagination
    {
        $numberOfPages = $this->getNumberOfPages();
        if ($selectedPage < 1 || $selectedPage > $numberOfPages) {
            throw InlineKeyboardPaginationException::pageMustBeBetween(1, $numberOfPages);
        }

        $this->selectedPage = $selectedPage;

        return $this;
    }

    /**
     * Get the number of items shown per page.
     *
     * @return int
     */
    public function getItemsPerPage(): int
    {
        return $this->itemsPerPage;
    }

    /**
     * Set how many items should be shown per page.
     *
     * @param int $itemsPerPage
     *
     * @return InlineKeyboardPagination
     * @throws InlineKeyboardPaginationException
     */
    public function setItemsPerPage(int $itemsPerPage): InlineKeyboardPagination
    {
        if ($itemsPerPage <= 0) {
            throw InlineKeyboardPaginationException::invalidItemsPerPage();
        }

        $this->itemsPerPage = $itemsPerPage;

        return $this;
    }

    /**
     * Set the items for the pagination.
     *
     * @param array $items
     *
     * @return InlineKeyboardPagination
     * @throws InlineKeyboardPaginationException
     */
    public function setItems(array $items): InlineKeyboardPagination
    {
        if (empty($items)) {
            throw InlineKeyboardPaginationException::noItems();
        }

        $this->items = $items;

        return $this;
    }

    /**
     * Calculate and return the number of pages.
     *
     * @return int
     */
    public function getNumberOfPages(): int
    {
        return (int) ceil(count($this->items) / $this->itemsPerPage);
    }

    /**
     * TelegramBotPagination constructor.
     *
     * @inheritdoc
     * @throws InlineKeyboardPaginationException
     */
    public function __construct(
        array $items,
        string $command = 'pagination',
        int $selectedPage = 1,
        int $itemsPerPage = 5
    ) {
        $this->setCommand($command);
        $this->setItemsPerPage($itemsPerPage);
        $this->setItems($items);
        $this->setSelectedPage($selectedPage);
    }

    /**
     * @inheritdoc
     * @throws InlineKeyboardPaginationException
     */
    public function getPagination(int $selectedPage = null): array
    {
        if ($selectedPage !== null) {
            $this->setSelectedPage($selectedPage);
        }

        return [
            'items'    => $this->getPreparedItems(),
            'keyboard' => $this->generateKeyboard(),
        ];
    }

    /**
     * Generate the keyboard with the correctly labelled buttons.
     *
     * @return array
     */
    protected function generateKeyboard(): array
    {
        $buttons = $this->generateButtons();
        $buttons = $this->applyButtonLabels($buttons);

        return array_values(array_filter($buttons));
    }

    /**
     * Generate all buttons for this inline keyboard.
     *
     * @return array
     */
    protected function generateButtons(): array
    {
        $numberOfPages = $this->getNumberOfPages();

        $range = ['from' => 2, 'to' => $numberOfPages - 1];

        if ($numberOfPages > $this->maxButtons) {
            $range = $this->generateRange();
        }

        $buttons[1] = $this->generateButton(1);

        for ($i = $range['from']; $i <= $range['to']; $i++) {
            $buttons[$i] = $this->generateButton($i);
        }
        $buttons[$numberOfPages] = $this->generateButton($numberOfPages);

        return $buttons;
    }

    /**
     * Apply correct text labels to the keyboard buttons.
     *
     * @param array $buttons
     *
     * @return array
     */
    protected function applyButtonLabels(array $buttons): array
    {
        $numberOfPages = $this->getNumberOfPages();

        foreach ($buttons as $page => &$button) {
            $inFirstBlock = max($this->selectedPage, $page) <= 3;
            $inLastBlock  = min($this->selectedPage, $page) >= $numberOfPages - 2;

            $labelKey = 'next';
            if ($page === $this->selectedPage) {
                $labelKey = 'current';
            } elseif ($inFirstBlock || $inLastBlock) {
                $labelKey = 'default';
            } elseif ($page === 1) {
                $labelKey = 'first';
            } elseif ($page === $numberOfPages) {
                $labelKey = 'last';
            } elseif ($page < $this->selectedPage) {
                $labelKey = 'previous';
            }

            $label = $this->labels[$labelKey] ?? '';

            // Remove button for undefined labels.
            if ($label === '') {
                $button = null;
                continue;
            }

            $button['text'] = sprintf($label, $page);
        }

        return $buttons;
    }

    /**
     * Get the range of intermediate buttons for the keyboard.
     *
     * @return array
     */
    protected function generateRange(): array
    {
        $numberOfIntermediateButtons = $this->maxButtons - 2; // Minus first and last buttons.
        $numberOfPages               = $this->getNumberOfPages();

        $from = $this->selectedPage - 1;
        $to   = $this->selectedPage + 1;

        if ($this->selectedPage === 1) {
            $from = 2;
            $to   = $this->maxButtons - 1;
        } elseif ($this->selectedPage === $numberOfPages) {
            $from = $numberOfPages - $numberOfIntermediateButtons;
            $to   = $numberOfPages - 1;
        } elseif ($this->selectedPage === 3) {
            // Special case because this button is in the center of a flexible pagination.
            $to += $numberOfIntermediateButtons - 3;
        } elseif ($this->selectedPage < 3) {
            // First half.
            $from = $this->selectedPage;
            $to   = $this->selectedPage + $numberOfIntermediateButtons - 1;
        } elseif (($numberOfPages - $this->selectedPage) < 3) {
            // Last half.
            $from = $numberOfPages - $numberOfIntermediateButtons;
            $to   = $numberOfPages - 1;
        } elseif ($this->forceButtonCount) {
            $from = (int) max(2, $this->selectedPage - floor($numberOfIntermediateButtons / 2));
            $to   = $from + $numberOfIntermediateButtons - 1;
        }

        return compact('from', 'to');
    }

    /**
     * Generate the button for the passed page.
     *
     * @param int $page
     *
     * @return array
     */
    protected function generateButton(int $page): array
    {
        return [
            'text'          => $page,
            'callback_data' => $this->generateCallbackData($page),
        ];
    }

    /**
     * Generate the callback data for the passed page.
     *
     * @param int $page
     *
     * @return string
     */
    protected function generateCallbackData(int $page): string
    {
        return str_replace(
            ['{COMMAND}', '{OLD_PAGE}', '{NEW_PAGE}'],
            [$this->command, $this->selectedPage, $page],
            $this->callbackDataFormat
        );
    }

    /**
     * Get the prepared items for the selected page.
     *
     * @return array
     */
    protected function getPreparedItems(): array
    {
        return array_slice($this->items, $this->getOffset(), $this->itemsPerPage);
    }

    /**
     * Get the items offset for the selected page.
     *
     * @return int
     */
    protected function getOffset(): int
    {
        return $this->itemsPerPage * ($this->selectedPage - 1);
    }

    /**
     * Get the parameters from the callback query.
     *
     * @todo Possibly make it work for custom formats too?
     *
     * @param string $data
     *
     * @return array
     */
    public static function getParametersFromCallbackData(string $data): array
    {
        parse_str($data, $params);

        return $params;
    }
}


1			<?php
2
3			namespace TelegramBot\InlineKeyboardPagination;
4
5			use TelegramBot\InlineKeyboardPagination\Exceptions\InlineKeyboardPaginationException;
6
7			/**
8			* Class InlineKeyboardPagination
9			*
10			* @package TelegramBot\InlineKeyboardPagination
11			*/
12			class InlineKeyboardPagination implements InlineKeyboardPaginator
13			{
14			private array $items;
15			private int $itemsPerPage;
16			private int $selectedPage;
17			private int $maxButtons = 5;
18			private bool $forceButtonCount = false;
19			private string $command;
20			private string $callbackDataFormat = 'command={COMMAND}&oldPage={OLD_PAGE}&newPage={NEW_PAGE}';
21			private array $labels = [
22			'default' => '%d',
23			'first' => '« %d',
24			'previous' => '‹ %d',
25			'current' => '· %d ·',
26			'next' => '%d ›',
27			'last' => '%d »',
28			];
29
30			/**
31			* @param int $maxButtons
32			* @param bool $forceButtonCount
33			*
34			* @return $this
35			* @throws InlineKeyboardPaginationException
36			*/
37			public function setMaxButtons(int $maxButtons = 5, bool $forceButtonCount = false): InlineKeyboardPagination
38			{
39			if ($maxButtons < 5 \|\| $maxButtons > 8) {
40			throw InlineKeyboardPaginationException::invalidMaxButtons();
41			}
42
43			$this->maxButtons = $maxButtons;
44			$this->forceButtonCount = $forceButtonCount;
45
46			return $this;
47			}
48
49			/**
50			* Get the current callback format.
51			*
52			* @return string
53			*/
54			public function getCallbackDataFormat(): string
55			{
56			return $this->callbackDataFormat;
57			}
58
59			/**
60			* Set the callback_data format.
61			*
62			* @param string $callbackDataFormat
63			*
64			* @return InlineKeyboardPagination
65			*/
66			public function setCallbackDataFormat(string $callbackDataFormat): InlineKeyboardPagination
67			{
68			$this->callbackDataFormat = $callbackDataFormat;
69
70			return $this;
71			}
72
73			/**
74			* Return list of keyboard button labels.
75			*
76			* @return array
77			*/
78			public function getLabels(): array
79			{
80			return $this->labels;
81			}
82
83			/**
84			* Set the keyboard button labels.
85			*
86			* @param array $labels
87			*
88			* @return InlineKeyboardPagination
89			*/
90			public function setLabels(array $labels): InlineKeyboardPagination
91			{
92			$this->labels = $labels;
93
94			return $this;
95			}
96
97			/**
98			* @inheritdoc
99			*/
100			public function setCommand(string $command = 'pagination'): InlineKeyboardPagination
101			{
102			$this->command = $command;
103
104			return $this;
105			}
106
107			/**
108			* @inheritdoc
109			* @throws InlineKeyboardPaginationException
110			*/
111			public function setSelectedPage(int $selectedPage): InlineKeyboardPagination
112			{
113			$numberOfPages = $this->getNumberOfPages();
114			if ($selectedPage < 1 \|\| $selectedPage > $numberOfPages) {
115			throw InlineKeyboardPaginationException::pageMustBeBetween(1, $numberOfPages);
116			}
117
118			$this->selectedPage = $selectedPage;
119
120			return $this;
121			}
122
123			/**
124			* Get the number of items shown per page.
125			*
126			* @return int
127			*/
128			public function getItemsPerPage(): int
129			{
130			return $this->itemsPerPage;
131			}
132
133			/**
134			* Set how many items should be shown per page.
135			*
136			* @param int $itemsPerPage
137			*
138			* @return InlineKeyboardPagination
139			* @throws InlineKeyboardPaginationException
140			*/
141			public function setItemsPerPage(int $itemsPerPage): InlineKeyboardPagination
142			{
143			if ($itemsPerPage <= 0) {
144			throw InlineKeyboardPaginationException::invalidItemsPerPage();
145			}
146
147			$this->itemsPerPage = $itemsPerPage;
148
149			return $this;
150			}
151
152			/**
153			* Set the items for the pagination.
154			*
155			* @param array $items
156			*
157			* @return InlineKeyboardPagination
158			* @throws InlineKeyboardPaginationException
159			*/
160			public function setItems(array $items): InlineKeyboardPagination
161			{
162			if (empty($items)) {
163			throw InlineKeyboardPaginationException::noItems();
164			}
165
166			$this->items = $items;
167
168			return $this;
169			}
170
171			/**
172			* Calculate and return the number of pages.
173			*
174			* @return int
175			*/
176			public function getNumberOfPages(): int
177			{
178			return (int) ceil(count($this->items) / $this->itemsPerPage);
179			}
180
181			/**
182			* TelegramBotPagination constructor.
183			*
184			* @inheritdoc
185			* @throws InlineKeyboardPaginationException
186			*/
187			public function __construct(
188			array $items,
189			string $command = 'pagination',
190			int $selectedPage = 1,
191			int $itemsPerPage = 5
192			) {
193			$this->setCommand($command);
194			$this->setItemsPerPage($itemsPerPage);
195			$this->setItems($items);
196			$this->setSelectedPage($selectedPage);
197			}
198
199			/**
200			* @inheritdoc
201			* @throws InlineKeyboardPaginationException
202			*/
203			public function getPagination(int $selectedPage = null): array
204			{
205			if ($selectedPage !== null) {
206			$this->setSelectedPage($selectedPage);
207			}
208
209			return [
210			'items' => $this->getPreparedItems(),
211			'keyboard' => $this->generateKeyboard(),
212			];
213			}
214
215			/**
216			* Generate the keyboard with the correctly labelled buttons.
217			*
218			* @return array
219			*/
220			protected function generateKeyboard(): array
221			{
222			$buttons = $this->generateButtons();
223			$buttons = $this->applyButtonLabels($buttons);
224
225			return array_values(array_filter($buttons));
226			}
227
228			/**
229			* Generate all buttons for this inline keyboard.
230			*
231			* @return array
232			*/
233			protected function generateButtons(): array
234			{
235			$numberOfPages = $this->getNumberOfPages();
236
237			$range = ['from' => 2, 'to' => $numberOfPages - 1];
238
239			if ($numberOfPages > $this->maxButtons) {
240			$range = $this->generateRange();
241			}
242
243			$buttons[1] = $this->generateButton(1);
			0 ignored issues – show Comprehensibility Best Practice introduced 2021-07-10 15:06 UTC by Report Bug Copy Issue Report `$buttons` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$buttons = array();` before regardless. Loading history...
244			for ($i = $range['from']; $i <= $range['to']; $i++) {
245			$buttons[$i] = $this->generateButton($i);
246			}
247			$buttons[$numberOfPages] = $this->generateButton($numberOfPages);
248
249			return $buttons;
250			}
251
252			/**
253			* Apply correct text labels to the keyboard buttons.
254			*
255			* @param array $buttons
256			*
257			* @return array
258			*/
259			protected function applyButtonLabels(array $buttons): array
260			{
261			$numberOfPages = $this->getNumberOfPages();
262
263			foreach ($buttons as $page => &$button) {
264			$inFirstBlock = max($this->selectedPage, $page) <= 3;
265			$inLastBlock = min($this->selectedPage, $page) >= $numberOfPages - 2;
266
267			$labelKey = 'next';
268			if ($page === $this->selectedPage) {
269			$labelKey = 'current';
270			} elseif ($inFirstBlock \|\| $inLastBlock) {
271			$labelKey = 'default';
272			} elseif ($page === 1) {
273			$labelKey = 'first';
274			} elseif ($page === $numberOfPages) {
275			$labelKey = 'last';
276			} elseif ($page < $this->selectedPage) {
277			$labelKey = 'previous';
278			}
279
280			$label = $this->labels[$labelKey] ?? '';
281
282			// Remove button for undefined labels.
283			if ($label === '') {
284			$button = null;
285			continue;
286			}
287
288			$button['text'] = sprintf($label, $page);
289			}
290
291			return $buttons;
292			}
293
294			/**
295			* Get the range of intermediate buttons for the keyboard.
296			*
297			* @return array
298			*/
299			protected function generateRange(): array
300			{
301			$numberOfIntermediateButtons = $this->maxButtons - 2; // Minus first and last buttons.
302			$numberOfPages = $this->getNumberOfPages();
303
304			$from = $this->selectedPage - 1;
305			$to = $this->selectedPage + 1;
306
307			if ($this->selectedPage === 1) {
308			$from = 2;
309			$to = $this->maxButtons - 1;
310			} elseif ($this->selectedPage === $numberOfPages) {
311			$from = $numberOfPages - $numberOfIntermediateButtons;
312			$to = $numberOfPages - 1;
313			} elseif ($this->selectedPage === 3) {
314			// Special case because this button is in the center of a flexible pagination.
315			$to += $numberOfIntermediateButtons - 3;
316			} elseif ($this->selectedPage < 3) {
317			// First half.
318			$from = $this->selectedPage;
319			$to = $this->selectedPage + $numberOfIntermediateButtons - 1;
320			} elseif (($numberOfPages - $this->selectedPage) < 3) {
321			// Last half.
322			$from = $numberOfPages - $numberOfIntermediateButtons;
323			$to = $numberOfPages - 1;
324			} elseif ($this->forceButtonCount) {
325			$from = (int) max(2, $this->selectedPage - floor($numberOfIntermediateButtons / 2));
326			$to = $from + $numberOfIntermediateButtons - 1;
327			}
328
329			return compact('from', 'to');
330			}
331
332			/**
333			* Generate the button for the passed page.
334			*
335			* @param int $page
336			*
337			* @return array
338			*/
339			protected function generateButton(int $page): array
340			{
341			return [
342			'text' => $page,
343			'callback_data' => $this->generateCallbackData($page),
344			];
345			}
346
347			/**
348			* Generate the callback data for the passed page.
349			*
350			* @param int $page
351			*
352			* @return string
353			*/
354			protected function generateCallbackData(int $page): string
355			{
356			return str_replace(
357			['{COMMAND}', '{OLD_PAGE}', '{NEW_PAGE}'],
358			[$this->command, $this->selectedPage, $page],
359			$this->callbackDataFormat
360			);
361			}
362
363			/**
364			* Get the prepared items for the selected page.
365			*
366			* @return array
367			*/
368			protected function getPreparedItems(): array
369			{
370			return array_slice($this->items, $this->getOffset(), $this->itemsPerPage);
371			}
372
373			/**
374			* Get the items offset for the selected page.
375			*
376			* @return int
377			*/
378			protected function getOffset(): int
379			{
380			return $this->itemsPerPage * ($this->selectedPage - 1);
381			}
382
383			/**
384			* Get the parameters from the callback query.
385			*
386			* @todo Possibly make it work for custom formats too?
387			*
388			* @param string $data
389			*
390			* @return array
391			*/
392			public static function getParametersFromCallbackData(string $data): array
393			{
394			parse_str($data, $params);
395
396			return $params;
397			}
398			}
399

php-telegram-bot / inline-keyboard-pagination

Push — develop ( 5f0532...125a75 )

InlineKeyboardPagination::generateButton() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like