DanySpin97 / PhpBotFramework

src/Core/Bot.php

Doc Comments +4 added lines, -4 removed lines

@@ -81,7 +81,7 @@ 
 
     /**
      * \brief Get the text of the message, if set (for updates of type "message").
-     * @return Text of the message, empty string if not set.
+     * @return string of the message, empty string if not set.
      */
     public function getMessageText() : string {
 
@@ -97,7 +97,7 @@ 
 
     /**
      * \brief Get the data of callback query, if set (for updates of type "callback_query").
-     * @return Data of the callback query, empty string if not set.
+     * @return string of the callback query, empty string if not set.
      */
     public function getCallbackData() : string {
 
@@ -113,7 +113,7 @@ 
 
     /**
      * \brief Get the query received from the inline query (for updates of type "inline_query").
-     * @return The query sent by the user, throw exception if the current update is not an inline query.
+     * @return string query sent by the user, throw exception if the current update is not an inline query.
      */
     public function getInlineQuery() : string {
 
@@ -169,7 +169,7 @@ 
      * \details Set $chat_id for each update, $text, $data and $query are set for each update that contains them.
      * It also calls commands for each updates, before process methods.
      * @param $update Reference to the update received.
-     * @return The id of the update processed.
+     * @return integer id of the update processed.
      */
     public function processUpdate(array $update) : int {
 

src/Core/CoreBot.php

Doc Comments +2 added lines, -2 removed lines

@@ -543,7 +543,7 @@ 
      * - <code>record_audio</code> or <code>upload_audio</code> for audio files
      * - <code>upload_document</code> for general files
      * - <code>find_location</code> for location data
-     * @return True on success.
+     * @return boolean on success.
      */
     public function sendChatAction(string $action) : bool {
 
@@ -726,7 +726,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) {

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/Utilities/DatabaseHandler.php

Doc Comments +1 added lines, -1 removed lines

@@ -19,7 +19,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/Utilities/Localization.php

Doc Comments +1 added lines, -1 removed lines

@@ -86,7 +86,7 @@
      * It also change $language parameter of the bot to the language returned.
      * @param $default_language <i>Optional</i>. Default language to return in case of errors.
      * @param $expiring_time <i>Optional</i>. Set the expiring time for the language on redis each time it is took from the sql database.
-     * @return Language for the current user, $default_language on errors.
+     * @return string for the current user, $default_language on errors.
      */
     public function getLanguageRedis($default_language = 'en', $expiring_time = '86400') : string {