Add Paginator interface for commands that use the inline keyboard paginator.

Author: noplanman

src/Entities/InlineKeyboard.php

@@ -21,7 +21,7 @@ class InlineKeyboard extends Keyboard
      * Get an inline pagination keyboard.
      *
      * - $callback_data is an ID for the CallbackqueryCommand, to know where the request comes from.
-     * It must contain a '%d' placeholder for the page number. If no placeholder is found, the ID is automatically appended with '_page_%d'
+     * The ID is automatically appended with '_page_%d' to filter out the selected page number.
      *
      * - $labels allows for custom button labels, using '%d' placeholders.
      * Default:
@@ -46,9 +46,7 @@ class InlineKeyboard extends Keyboard
      */
     public static function getPagination($callback_data, $current_page, $max_pages, array $labels = [])
     {
-        if (strpos($callback_data, '%d') === false) {
-            $callback_data .= '_page_%d';
-        }
+        $callback_data .= '_page_%d';
 
         // Merge labels with defaults.
         $labels = array_merge([
@@ -99,4 +97,16 @@ public static function getPagination($callback_data, $current_page, $max_pages,
 
         return new InlineKeyboard($buttons);
     }
+
+    /**
+     * Extract the page number from the passed callback data.
+     *
+     * @param string $callback_data
+     *
+     * @return int
+     */
+    public static function getPageFromCallbackData($callback_data)
+    {
+        return (int) preg_replace('/.*_page_(\d+)$/', '$1', $callback_data);
+    }
 }

src/Entities/InlineKeyboardPaginator.php

@@ -0,0 +1,39 @@
+<?php
+/**
+ * This file is part of the TelegramBot package.
+ *
+ * (c) Avtandil Kikabidze aka LONGMAN <akalongman@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Longman\TelegramBot\Entities;
+
+interface InlineKeyboardPaginator
+{
+    /**
+     * A unique identifier for the callback query.
+     *
+     * @return string
+     */
+    public static function getCallbackDataId();
+
+    /**
+     * Get the output for the currently selected page.
+     *
+     * @param int $current_page
+     *
+     * @return string
+     */
+    public static function getOutput($current_page);
+
+    /**
+     * Get the pagination for the current page.
+     *
+     * @param int $current_page
+     *
+     * @return InlineKeyboard
+     */
+    public static function getPagination($current_page);
+}

tests/unit/Entities/InlineKeyboardTest.php

@@ -153,27 +153,24 @@ public function testInlineKeyboardAddRows()
     public function testInlineKeyboardPagination()
     {
         // Should get '_page_%d' appended to it.
-        $callback_data = 'pagination_callback';
+        $callback_data = 'cbdata';
 
         // current
         $keyboard = InlineKeyboard::getPagination($callback_data, 1, 1);
         KeyboardTest::assertAllButtonPropertiesEqual([
             ['· 1 ·'],
         ], 'text', $keyboard);
         KeyboardTest::assertAllButtonPropertiesEqual([
-            ['pagination_callback_page_1'],
+            ['cbdata_page_1'],
         ], 'callback_data', $keyboard);
 
-        // Shorter custom callback data.
-        $callback_data = 'p%d';
-
         // current, next, last
         $keyboard = InlineKeyboard::getPagination($callback_data, 1, 10);
         KeyboardTest::assertAllButtonPropertiesEqual([
             ['· 1 ·', '2 ›', '10 »'],
         ], 'text', $keyboard);
         KeyboardTest::assertAllButtonPropertiesEqual([
-            ['p1', 'p2', 'p10'],
+            ['cbdata_page_1', 'cbdata_page_2', 'cbdata_page_10'],
         ], 'callback_data', $keyboard);
 
         // first, previous, current, next, last
@@ -182,7 +179,7 @@ public function testInlineKeyboardPagination()
             ['« 1', '‹ 4', '· 5 ·', '6 ›', '10 »'],
         ], 'text', $keyboard);
         KeyboardTest::assertAllButtonPropertiesEqual([
-            ['p1', 'p4', 'p5', 'p6', 'p10'],
+            ['cbdata_page_1', 'cbdata_page_4', 'cbdata_page_5', 'cbdata_page_6', 'cbdata_page_10'],
         ], 'callback_data', $keyboard);
 
         // first, previous, current, last
@@ -191,7 +188,7 @@ public function testInlineKeyboardPagination()
             ['« 1', '‹ 8', '· 9 ·', '10 »'],
         ], 'text', $keyboard);
         KeyboardTest::assertAllButtonPropertiesEqual([
-            ['p1', 'p8', 'p9', 'p10'],
+            ['cbdata_page_1', 'cbdata_page_8', 'cbdata_page_9', 'cbdata_page_10'],
         ], 'callback_data', $keyboard);
 
         // first, previous, current
@@ -200,7 +197,7 @@ public function testInlineKeyboardPagination()
             ['« 1', '‹ 9', '· 10 ·'],
         ], 'text', $keyboard);
         KeyboardTest::assertAllButtonPropertiesEqual([
-            ['p1', 'p9', 'p10'],
+            ['cbdata_page_1', 'cbdata_page_9', 'cbdata_page_10'],
         ], 'callback_data', $keyboard);
 
         // custom labels
@@ -216,7 +213,7 @@ public function testInlineKeyboardPagination()
             ['first 1', 'previous 4', 'cur 5 rent', '6 next', '10 last'],
         ], 'text', $keyboard);
         KeyboardTest::assertAllButtonPropertiesEqual([
-            ['p1', 'p4', 'p5', 'p6', 'p10'],
+            ['cbdata_page_1', 'cbdata_page_4', 'cbdata_page_5', 'cbdata_page_6', 'cbdata_page_10'],
         ], 'callback_data', $keyboard);
     }
 }