Stricter typing and minor comment updates

Author: noplanman

README.md

@@ -70,7 +70,7 @@ the [Telegram Bot API](https://core.telegram.org/bots/api).
 You can create a keyboard by calling the static `make()` method on its class.
 
 After that you can chain methods to set additional fields that are available in the Bot API. This is done by calling the
-field name in camelCase. So instead of input_field_placeholder, you need to call `inputFieldPlaceholder()`.
+field name in camelCase. So instead of `input_field_placeholder`, you need to call `inputFieldPlaceholder()`.
 
 ```php
 ReplyKeyboardMarkup::make()
@@ -85,14 +85,14 @@ The Buttons are created in the same way:
 
 ```php
 KeyboardButton::make()
-    ->text('Text of Button')
+    ->text('Send my Contact')
     ->requestContact();
 ```
 
 As a shortcut, you can pass the mandatory `text` field as an argument to the static method `make()` like this:
 
 ```php
-KeyboardButton::make('Text of Button')
+KeyboardButton::make('Send my Location')
     ->requestLocation();
 ```
 
@@ -169,9 +169,7 @@ If you want to add a bunch of buttons that have each a row for themselves you ca
 ```php
 InlineKeyboardMarkup::make()
     ->stack([
-        InlineKeyboardButton::make('Login')->loginUrl([
-            'url' => 'https://example.com/login'
-        ]),
+        InlineKeyboardButton::make('Login')->loginUrl('https://example.com/login'),
         InlineKeyboardButton::make('Visit Homepage')->url('https://example.com')
     ]);
 ```

composer.json

@@ -27,9 +27,7 @@
         "ext-json": "*"
     },
     "scripts": {
-        "test": [
-            "vendor/bin/pest"
-        ]
+        "test": "vendor/bin/pest"
     },
     "config": {
         "allow-plugins": {

src/FluentEntity.php

@@ -4,12 +4,10 @@
 
 abstract class FluentEntity implements \JsonSerializable
 {
-    /**
-     * @var array $data
-     */
-    protected $data = [];
 
-    protected $defaults = [];
+    protected array $data = [];
+
+    protected array $defaults = [];
 
     public function __construct(array $data = [])
     {
@@ -30,7 +28,7 @@ public function __call($name, $arguments): self
         return $this;
     }
 
-    public function jsonSerialize(): mixed
+    public function jsonSerialize(): object
     {
         return (object) $this->data;
     }

src/ForceReply.php

@@ -9,11 +9,11 @@
 class ForceReply extends FluentEntity
 {
 
-    protected $data = [
+    protected array $data = [
         'force_reply' => true,
     ];
 
-    protected $defaults = [
+    protected array $defaults = [
         'selective' => true,
     ];
 

src/InlineKeyboard/InlineKeyboardButton.php

@@ -16,15 +16,15 @@
 class InlineKeyboardButton extends Button
 {
 
-    protected $defaults = [
+    protected array $defaults = [
         'pay' => true,
     ];
 
     public static function make(string $text = null): static
     {
         $data = [];
 
-        if ($text) {
+	    if ($text !== null) {
             $data['text'] = $text;
         }
 
@@ -33,7 +33,7 @@ public static function make(string $text = null): static
 
     public function loginUrl(array|string $login_url): self
     {
-        if (! is_array($login_url)) {
+        if (is_string($login_url)) {
             $login_url = [
                 'url' => $login_url
             ];

src/InlineKeyboard/InlineKeyboardMarkup.php

@@ -8,6 +8,6 @@
 class InlineKeyboardMarkup extends KeyboardMarkup
 {
 
-    protected static $keyboardFieldName = 'inline_keyboard';
+    protected static string $keyboardFieldName = 'inline_keyboard';
 
 }

src/KeyboardMarkup.php

@@ -10,9 +10,9 @@ abstract class KeyboardMarkup extends FluentEntity
      *
      * @var string
      */
-    protected static $keyboardFieldName = 'keyboard';
+    protected static string $keyboardFieldName = 'keyboard';
 
-    protected $currentRowIndex = 0;
+    protected int $currentRowIndex = 0;
 
     public function __construct(array $data = [])
     {
@@ -32,13 +32,13 @@ public function row(array $buttons = []): self
     {
         $keyboard = &$this->data[static::$keyboardFieldName];
 
-        // Last row is not empty
+        // Last row is not empty, add new row
         if (! empty($keyboard[$this->currentRowIndex])) {
             $keyboard[] = [];
             $this->currentRowIndex++;
         }
 
-        // argument is not empty
+        // Buttons have been passed, add them
         if (! empty($buttons)) {
             $keyboard[$this->currentRowIndex] = $buttons;
             $this->currentRowIndex++;
@@ -48,14 +48,13 @@ public function row(array $buttons = []): self
     }
 
     /**
-     * Adds buttons one per row to the keyboard.
+     * Adds buttons to the keyboard, one per row.
      *
      * @param  Button[]  $buttons
      * @return $this
      */
     public function stack(array $buttons): self
     {
-        // Every button gets its own row
         foreach ($buttons as $button) {
             $this->row([$button]);
         }

src/ReplyKeyboard/KeyboardButton.php

@@ -12,7 +12,8 @@
  */
 class KeyboardButton extends Button
 {
-    protected $defaults = [
+
+    protected array $defaults = [
         'request_contact'  => true,
         'request_location' => true,
         'request_poll'     => [],
@@ -22,7 +23,7 @@ public static function make(string $text = null): static
     {
         $data = [];
 
-        if ($text) {
+        if ($text !== null) {
             $data['text'] = $text;
         }
 

src/ReplyKeyboard/KeyboardButtonPollType.php

@@ -10,7 +10,7 @@
 class KeyboardButtonPollType extends Button
 {
 
-    protected $data = [];
+    protected array $data = [];
 
     public static function any(): static
     {

src/ReplyKeyboard/ReplyKeyboardMarkup.php

@@ -14,13 +14,12 @@
 class ReplyKeyboardMarkup extends KeyboardMarkup
 {
 
-    protected static $keyboardFieldName = 'keyboard';
+    protected static string $keyboardFieldName = 'keyboard';
 
-    protected $defaults = [
+    protected array $defaults = [
         'resize_keyboard'   => true,
         'one_time_keyboard' => true,
         'selective'         => true,
     ];
 
-
 }

src/ReplyKeyboardRemove.php

@@ -8,11 +8,11 @@
 class ReplyKeyboardRemove extends FluentEntity
 {
 
-    protected $data = [
+    protected array $data = [
         'remove_keyboard' => true,
     ];
 
-    protected $defaults = [
+    protected array $defaults = [
         'selective' => true,
     ];
 

src/helpers.php

@@ -3,7 +3,7 @@
 namespace PhpTelegramBot\FluentKeyboard;
 
 if (! function_exists('snake_case')) {
-    function snake_case($value)
+    function snake_case($value): string
     {
         return strtolower(preg_replace('/(.)(?=[A-Z])/u', '$1_', $value));
     }