DanySpin97 / PhpBotFramework

src/Entities/InlineQueryResults.php

Doc Comments +1 added lines, -1 removed lines

@@ -40,7 +40,7 @@
      * @param $reply_markup Inline keyboard object (Not JSON serialized, use getArray from InlineKeyboard class).
      * @param $parse_mode <i>Optional</i>. Formattation of the message.
      * @param $disable_web_preview <i>Optional</i>. Disables link previews for links in the sent message
-     * @return Id the the article added
+     * @return integer the the article added
      */
     public function newArticle($title, $message_text, $description = '', array $reply_markup = null, $parse_mode = 'HTML', $disable_web_preview = false) {
 

src/Utilities/BotState.php

Doc Comments +1 added lines, -1 removed lines

@@ -88,7 +88,7 @@
      * \brief Get current user status from redis and set it in status variable.
      * \details Throw exception if redis connection is missing.
      * @param $default_status <i>Optional</i>. The default status to return in case there is no status for the current user.
-     * @return The status for the current user, $default_status if missing.
+     * @return integer status for the current user, $default_status if missing.
      */
     public function getStatus(int $default_status = -1) : int {
 

src/Commands/CallbackCommand.php

Doc Comments +1 added lines, -1 removed lines

@@ -35,7 +35,7 @@
     /**
      * \brief (<i>Internal</i>) Process the callback query and check if it triggers a command of this type.
      * @param $callback_query Callback query to process.
-     * @return True if the callback query triggered a command.
+     * @return boolean if the callback query triggered a command.
      */
     protected function processCallbackCommand(array $callback_query) : bool {
 

src/Commands/MessageCommand.php

Doc Comments +1 added lines, -1 removed lines

@@ -37,7 +37,7 @@
     /**
      * \brief (<i>Internal</i>)Process a message checking if it trigger any MessageCommand.
      * @param $message Message to process.
-     * @return True if the message triggered any command.
+     * @return boolean if the message triggered any command.
      */
     protected function processMessageCommand(array $message) : bool {
 

src/Commands/MessageRegexCommand.php

Doc Comments +1 added lines, -1 removed lines

@@ -36,7 +36,7 @@
     /**
      * \brief (<i>Internal</i>) Process the message to check if it triggers a command of this type.
      * @param $message Message to process.
-     * @return True if the message triggered a command.
+     * @return boolean if the message triggered a command.
      */
     protected function processMessageRegexCommand(array $message) : bool {
 

src/Core/BaseBot.php

Doc Comments +1 added lines, -1 removed lines

@@ -148,7 +148,7 @@
      * \brief Dispatch each update to the right method (processMessage, processCallbackQuery, etc).
      * \details Set $chat_id for each update, $text, $data and $query are set for each update that contains them.
      * @param $update Reference to the update received.
-     * @return The id of the update processed.
+     * @return integer id of the update processed.
      */
     protected function processUpdate(array $update) : int {
 

src/Core/CoreBot.php

Doc Comments +1 added lines, -1 removed lines

@@ -385,7 +385,7 @@
      */
 
     /** \brief Core function to execute url request.
-     * @param $url The url to call using the curl session.
+     * @param string $url The url to call using the curl session.
      * @return Url response, false on error.
      */
     protected function exec_curl_request($url, $method = 'POST') {

src/Database/DatabaseHandler.php

Doc Comments +2 added lines, -2 removed lines

@@ -8,7 +8,7 @@ 
      * \details Provides a simpler way to initialize a database connection 
      *  and create a PDO instance.
      * @param $params Parameters for initialize connection.
-     * @return True on success.
+     * @return boolean on success.
      */
     public function connect($params) {
         try {
@@ -67,7 +67,7 @@ 
     /** \brief Add a user to the database.
      * \details Add a user to the database in Bot::$user_table table and Bot::$id_column column using Bot::$pdo connection.
      * @param $chat_id chat_id of the user to add.
-     * @return True on success.
+     * @return boolean on success.
      */
     public function addUser($chat_id) : bool {
 

src/Database/LongPolling.php

Doc Comments +2 added lines, -2 removed lines

@@ -14,7 +14,7 @@ 
      * \brief (<i>Internal</i>)Get first update offset in redis.
      * \details Called by getUpdatesRedis to get the offset saved in redis or to get it from telegram and save it in redis.
      * @param $offset_key Name of the variable where the offset is saved on Redis
-     * @return Id of the first update to process.
+     * @return integer of the first update to process.
      */
     protected function getUpdateOffsetRedis(string $offset_key) : int {
 
@@ -102,7 +102,7 @@ 
      * \details Called by getUpdatesDatabase to get the offset saved in database or to get it from telegram and save it in database.
      * @param $table_name Name of the table where offset is saved in the database
      * @param $column_name Name of the column where the offset is saved in the database
-     * @return Id of the first update to process.
+     * @return integer of the first update to process.
      */
     protected function getUpdateOffsetDatabase(string $table_name, string $column_name) : int {