Allow custom labels for all button types, not only current.

noplanman · noplanman · commit 8f7196300c37 · 2017-05-07T22:13:28.000+02:00
diff --git a/src/InlineKeyboardPagination.php b/src/InlineKeyboardPagination.php
@@ -42,9 +42,16 @@ class InlineKeyboardPagination implements InlineKeyboardPaginator
     private $command;
 
     /**
-     * @var string
+     * @var array
      */
-    private $wrap_selected_button = '« #VALUE# »';
+    private $labels = [
+        'default'  => '%d',
+        'first'    => '« %d',
+        'previous' => '‹ %d',
+        'current'  => '· %d ·',
+        'next'     => '%d ›',
+        'last'     => '%d »',
+    ];
 
     /**
      * @inheritdoc
@@ -61,15 +68,21 @@ public function setMaxButtons(int $max_buttons = 5): InlineKeyboardPagination
     }
 
     /**
-     * @inheritdoc
-     * @throws InlineKeyboardPaginationException
+     * @return array
      */
-    public function setWrapSelectedButton(string $wrap_selected_button = '« #VALUE# »'): InlineKeyboardPagination
+    public function getLabels(): array
     {
-        if (false === strpos($wrap_selected_button, '/#VALUE#/')) {
-            throw new InlineKeyboardPaginationException('Invalid selected button wrapper');
-        }
-        $this->wrap_selected_button = $wrap_selected_button;
+        return $this->labels;
+    }
+
+    /**
+     * @param array $labels
+     *
+     * @return InlineKeyboardPagination
+     */
+    public function setLabels($labels): InlineKeyboardPagination
+    {
+        $this->labels = array_merge($this->labels, $labels);
 
         return $this;
     }
@@ -128,7 +141,7 @@ public function setItemsPerPage($items_per_page): InlineKeyboardPagination
      * @inheritdoc
      * @throws InlineKeyboardPaginationException
      */
-    public function __construct(array $items, string $command = 'pagination', int $selected_page = 1, int $items_per_page = 3)
+    public function __construct(array $items, string $command = 'pagination', int $selected_page = 1, int $items_per_page = 5)
     {
         $this->number_of_pages = $this->countTheNumberOfPage(count($items), $items_per_page);
 
@@ -143,15 +156,15 @@ public function __construct(array $items, string $command = 'pagination', int $s
      * @inheritdoc
      * @throws InlineKeyboardPaginationException
      */
-    public function paginate(int $selected_page = null): array
+    public function getPagination(int $selected_page = null): array
     {
         if ($selected_page !== null) {
             $this->setSelectedPage($selected_page);
         }
 
         return [
             'items'    => $this->getPreparedItems(),
-            'keyboard' => $this->generateKeyboard(),
+            'keyboard' => [$this->generateKeyboard()],
         ];
     }
 
@@ -163,22 +176,49 @@ protected function generateKeyboard(): array
         $buttons = [];
 
         if ($this->number_of_pages > $this->max_buttons) {
-            $buttons[] = $this->generateButton(1);
+            $buttons[1] = $this->generateButton(1);
 
             $range = $this->generateRange();
-
             for ($i = $range['from']; $i < $range['to']; $i++) {
-                $buttons[] = $this->generateButton($i);
+                $buttons[$i] = $this->generateButton($i);
             }
 
-            $buttons[] = $this->generateButton($this->number_of_pages);
+            $buttons[$this->number_of_pages] = $this->generateButton($this->number_of_pages);
         } else {
             for ($i = 1; $i <= $this->number_of_pages; $i++) {
-                $buttons[] = $this->generateButton($i);
+                $buttons[$i] = $this->generateButton($i);
+            }
+        }
+
+        // Set the correct labels.
+        foreach ($buttons as $page => &$button) {
+            $in_first_block = $this->selected_page <= 3 && $page <= 3;
+            $in_last_block  = $this->selected_page >= $this->number_of_pages - 2 && $page >= $this->number_of_pages - 2;
+
+            $label_key = 'next';
+            if ($page === $this->selected_page) {
+                $label_key = 'current';
+            } elseif ($in_first_block || $in_last_block) {
+                $label_key = 'default';
+            } elseif ($page === 1) {
+                $label_key = 'first';
+            } elseif ($page === $this->number_of_pages) {
+                $label_key = 'last';
+            } elseif ($page < $this->selected_page) {
+                $label_key = 'previous';
+            }
+
+            $label = $this->labels[$label_key];
+
+            if ($label === '' || $label === null) {
+                $button = null;
+                continue;
             }
+
+            $button['text'] = sprintf($label, $page);
         }
 
-        return $buttons;
+        return array_filter($buttons);
     }
 
     /**
@@ -217,16 +257,9 @@ protected function generateRange(): array
      */
     protected function generateButton(int $next_page): array
     {
-        $label        = "$next_page";
-        $callbackData = $this->generateCallbackData($next_page);
-
-        if ($next_page === $this->selected_page) {
-            $label = str_replace('#VALUE#', $label, $this->wrap_selected_button);
-        }
-
         return [
-            'text'          => $label,
-            'callback_data' => $callbackData,
+            'text'          => "$next_page",
+            'callback_data' => $this->generateCallbackData($next_page),
         ];
     }
 
diff --git a/src/InlineKeyboardPaginator.php b/src/InlineKeyboardPaginator.php
@@ -10,20 +10,21 @@
 interface InlineKeyboardPaginator
 {
     /**
-     * @param int $max_buttons
+     * InlineKeyboardPaginator constructor.
      *
-     * @return InlineKeyboardPagination
+     * @param array  $items
+     * @param string $command
+     * @param int    $selected_page
+     * @param int    $items_per_page
      */
-    public function setMaxButtons(int $max_buttons = 5): InlineKeyboardPagination;
+    public function __construct(array $items, string $command, int $selected_page, int $items_per_page);
 
     /**
-     * >#VALUE#<, <#VALUE#>, |#VALUE#| etc...
-     *
-     * @param string $wrap_selected_button
+     * @param int $max_buttons
      *
      * @return InlineKeyboardPagination
      */
-    public function setWrapSelectedButton(string $wrap_selected_button = '« #VALUE# »'): InlineKeyboardPagination;
+    public function setMaxButtons(int $max_buttons = 5): InlineKeyboardPagination;
 
     /**
      * @param string $command
@@ -39,20 +40,10 @@ public function setCommand(string $command = 'pagination'): InlineKeyboardPagina
      */
     public function setSelectedPage(int $selected_page): InlineKeyboardPagination;
 
-    /**
-     * InlineKeyboardPaginator constructor.
-     *
-     * @param array  $items
-     * @param string $command
-     * @param int    $selected_page
-     * @param int    $items_per_page
-     */
-    public function __construct(array $items, string $command, int $selected_page, int $items_per_page);
-
     /**
      * @param int $selected_page
      *
      * @return array
      */
-    public function paginate(int $selected_page = null): array;
+    public function getPagination(int $selected_page = null): array;
 }
diff --git a/tests/InlineKeyboardPaginationTest.php b/tests/InlineKeyboardPaginationTest.php
@@ -45,13 +45,13 @@ public function testValidConstructor()
     {
         $ikp = new InlineKeyboardPagination($this->items, $this->command, $this->selected_page, $this->items_per_page);
 
-        $data = $ikp->paginate();
+        $data = $ikp->getPagination();
 
         $this->assertCount($this->items_per_page, $data['items']);
         $this->assertArrayHasKey('keyboard', $data);
-        $this->assertArrayHasKey(0, $data['keyboard']);
-        $this->assertArrayHasKey('text', $data['keyboard'][0]);
-        $this->assertStringStartsWith($this->command, $data['keyboard'][0]['callback_data']);
+        $this->assertArrayHasKey(1, $data['keyboard'][0]);
+        $this->assertArrayHasKey('text', $data['keyboard'][0][1]);
+        $this->assertStringStartsWith($this->command, $data['keyboard'][0][1]['callback_data']);
     }
 
     /**
@@ -60,17 +60,17 @@ public function testValidConstructor()
     public function testInvalidConstructor()
     {
         $ikp = new InlineKeyboardPagination($this->items, $this->command, 10000, $this->items_per_page);
-        $ikp->paginate();
+        $ikp->getPagination();
     }
 
-    public function testValidPaginate()
+    public function testValidPagination()
     {
         $ikp = new InlineKeyboardPagination($this->items, $this->command, $this->selected_page, $this->items_per_page);
 
         $length = (int) ceil(count($this->items) / $this->items_per_page);
 
         for ($i = 1; $i < $length; $i++) {
-            $ikp->paginate($i);
+            $ikp->getPagination($i);
         }
 
         $this->assertTrue(true);
@@ -79,14 +79,14 @@ public function testValidPaginate()
     /**
      * @expectedException \TelegramBot\InlineKeyboardPagination\Exceptions\InlineKeyboardPaginationException
      */
-    public function testInvalidPaginate()
+    public function testInvalidPagination()
     {
         $ikp = new InlineKeyboardPagination($this->items, $this->command, $this->selected_page, $this->items_per_page);
 
         $length = (int) ceil(count($this->items) / $this->items_per_page) + 1;
 
         for ($i = $length; $i < $length * 2; $i++) {
-            $ikp->paginate($i);
+            $ikp->getPagination($i);
         }
     }
 
@@ -97,7 +97,7 @@ public function testInvalidMaxButtons()
     {
         $ikp = new InlineKeyboardPagination(range(1, 240));
         $ikp->setMaxButtons(2);
-        $ikp->paginate();
+        $ikp->getPagination();
     }
 
     /**
@@ -107,16 +107,118 @@ public function testInvalidSelectedPage()
     {
         $ikp = new InlineKeyboardPagination(range(1, 240));
         $ikp->setSelectedPage(-5);
-        $ikp->paginate();
+        $ikp->getPagination();
     }
 
-    /**
-     * @expectedException \TelegramBot\InlineKeyboardPagination\Exceptions\InlineKeyboardPaginationException
-     */
-    public function testInvalidWrapSelectedButton()
+
+    public function testButtonLabels()
     {
-        $ikp = new InlineKeyboardPagination(range(1, 240));
-        $ikp->setWrapSelectedButton('$sdlfk$');
-        $ikp->paginate();
+        $cbdata  = '%s?currentPage=%d&nextPage=%d';
+        $command = 'cbdata';
+        $ikp1    = new InlineKeyboardPagination(range(1, 1), $command);
+        $ikp10   = new InlineKeyboardPagination(range(1, 50), $command);
+
+        // current
+        $keyboard = $ikp1->getPagination(1)['keyboard'];
+        self::assertAllButtonPropertiesEqual([
+            ['· 1 ·'],
+        ], 'text', $keyboard);
+        self::assertAllButtonPropertiesEqual([
+            [
+                sprintf($cbdata, $command, 1, 1),
+            ],
+        ], 'callback_data', $keyboard);
+
+        // first, previous, current, next, last
+        $keyboard = $ikp10->getPagination(5)['keyboard'];
+        self::assertAllButtonPropertiesEqual([
+            ['« 1', '‹ 4', '· 5 ·', '6 ›', '10 »'],
+        ], 'text', $keyboard);
+        self::assertAllButtonPropertiesEqual([
+            [
+                sprintf($cbdata, $command, 5, 1),
+                sprintf($cbdata, $command, 5, 4),
+                sprintf($cbdata, $command, 5, 5),
+                sprintf($cbdata, $command, 5, 6),
+                sprintf($cbdata, $command, 5, 10),
+            ],
+        ], 'callback_data', $keyboard);
+
+        // first, previous, current, last
+        $keyboard = $ikp10->getPagination(9)['keyboard'];
+        self::assertAllButtonPropertiesEqual([
+            ['« 1', '‹ 7', '8', '· 9 ·', '10'],
+        ], 'text', $keyboard);
+        self::assertAllButtonPropertiesEqual([
+            [
+                sprintf($cbdata, $command, 9, 1),
+                sprintf($cbdata, $command, 9, 7),
+                sprintf($cbdata, $command, 9, 8),
+                sprintf($cbdata, $command, 9, 9),
+                sprintf($cbdata, $command, 9, 10),
+            ],
+        ], 'callback_data', $keyboard);
+
+        // first, previous, current
+        $keyboard = $ikp10->getPagination(10)['keyboard'];
+        self::assertAllButtonPropertiesEqual([
+            ['« 1', '‹ 7', '8', '9', '· 10 ·'],
+        ], 'text', $keyboard);
+        self::assertAllButtonPropertiesEqual([
+            [
+                sprintf($cbdata, $command, 10, 1),
+                sprintf($cbdata, $command, 10, 7),
+                sprintf($cbdata, $command, 10, 8),
+                sprintf($cbdata, $command, 10, 9),
+                sprintf($cbdata, $command, 10, 10),
+            ],
+        ], 'callback_data', $keyboard);
+
+        // custom labels, skipping some buttons
+        // first, previous, current, next, last
+        $ikp10->setLabels([
+            'first'    => '',
+            'previous' => 'previous %d',
+            'current'  => null,
+            'next'     => '%d next',
+            'last'     => 'last',
+        ]);
+        $keyboard = $ikp10->getPagination(5)['keyboard'];
+        self::assertAllButtonPropertiesEqual([
+            ['previous 4', '6 next', 'last'],
+        ], 'text', $keyboard);
+        self::assertAllButtonPropertiesEqual([
+            [
+                sprintf($cbdata, $command, 5, 4),
+                sprintf($cbdata, $command, 5, 6),
+                sprintf($cbdata, $command, 5, 10),
+            ],
+        ], 'callback_data', $keyboard);
+    }
+
+    public static function assertButtonPropertiesEqual($value, $property, $keyboard, $row, $column, $message = '')
+    {
+        $row_raw    = array_values($keyboard)[$row];
+        $column_raw = array_values($row_raw)[$column];
+
+        self::assertSame($value, $column_raw[$property], $message);
+    }
+
+    public static function assertRowButtonPropertiesEqual(array $values, $property, $keyboard, $row, $message = '')
+    {
+        $column = 0;
+        foreach ($values as $value) {
+            self::assertButtonPropertiesEqual($value, $property, $keyboard, $row, $column++, $message);
+        }
+        self::assertCount(count(array_values($keyboard)[$row]), $values);
+    }
+
+    public static function assertAllButtonPropertiesEqual(array $all_values, $property, $keyboard, $message = '')
+    {
+        $row = 0;
+        foreach ($all_values as $values) {
+            self::assertRowButtonPropertiesEqual($values, $property, $keyboard, $row++, $message);
+        }
+        self::assertCount(count($keyboard), $all_values);
     }
 }
