Minor docblock fixes caught by Scrutinizer.

php-telegram-bot · Sep 17, 2017 · b51917b · b51917b
1 parent 597fcd2
commit b51917b
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 10 deletions.
diff --git a/src/ConversationDB.php b/src/ConversationDB.php
@@ -29,9 +29,9 @@ public static function initializeConversation()
     /**
      * Select a conversation from the DB
      *
-     * @param string $user_id
-     * @param string $chat_id
-     * @param bool   $limit
+     * @param string   $user_id
+     * @param string   $chat_id
+     * @param int|null $limit
      *
      * @return array|bool
      * @throws TelegramException

diff --git a/src/Entities/Message.php b/src/Entities/Message.php
@@ -32,7 +32,7 @@
  * @method Sticker      getSticker()               Optional. Message is a sticker, information about the sticker
  * @method Video        getVideo()                 Optional. Message is a video, information about the video
  * @method Voice        getVoice()                 Optional. Message is a voice message, information about the file
- * @method Video Note   getVideoNote()             Optional. Message is a video note message, information about the video
+ * @method VideoNote    getVideoNote()             Optional. Message is a video note message, information about the video
  * @method string       getCaption()               Optional. Caption for the document, photo or video, 0-200 characters
  * @method Contact      getContact()               Optional. Message is a shared contact, information about the contact
  * @method Location     getLocation()              Optional. Message is a shared location, information about the location
@@ -173,7 +173,7 @@ public function getFullCommand()
     /**
      * Get command
      *
-     * @return bool|string
+     * @return string|null
      */
     public function getCommand()
     {
@@ -199,7 +199,7 @@ public function getCommand()
             return $split_cmd[0];
         }
 
-        return false;
+        return null;
     }
 
     /**

diff --git a/src/Request.php b/src/Request.php
@@ -110,7 +110,7 @@ class Request
     /**
      * Request limiter's interval between checks
      *
-     * @var boolean
+     * @var float
      */
     private static $limiter_interval;
 
@@ -598,12 +598,12 @@ public static function sendToActiveChats(
     /**
      * Enable request limiter
      *
-     * @param boolean $value
+     * @param boolean $enable
      * @param array   $options
      *
      * @throws \Longman\TelegramBot\Exception\TelegramException
      */
-    public static function setLimiter($value = true, array $options = [])
+    public static function setLimiter($enable = true, array $options = [])
     {
         if (DB::isDbConnected()) {
             $options_default = [
@@ -617,7 +617,7 @@ public static function setLimiter($value = true, array $options = [])
             }
 
             self::$limiter_interval = $options['interval'];
-            self::$limiter_enabled  = $value;
+            self::$limiter_enabled  = $enable;
         }
     }