Merge pull request #152 from DJTommek/pr/bot-api-6.6-thumbnails-renaming

Bot API 6.6 Thumbnails renaming + other changes

Author: unreal4u

examples/send-audio.php

@@ -17,7 +17,7 @@
 $sendAudio->chat_id = A_USER_CHAT_ID;
 $sendAudio->audio = new InputFile('binary-test-data/ICQ-uh-oh.mp3');
 $sendAudio->title = 'The famous ICQ new message alert';
-$sendAudio->thumb = new InputFile(__DIR__ . '/binary-test-data/logo-php7-telegram-bot-api-thumbnail.jpg');
+$sendAudio->thumbnail = new InputFile(__DIR__ . '/binary-test-data/logo-php7-telegram-bot-api-thumbnail.jpg');
 
 $promise = $tgLog->performApiRequest($sendAudio);
 

examples/send-document.php

@@ -18,7 +18,7 @@
 $sendDocument = new SendDocument();
 $sendDocument->chat_id = A_USER_CHAT_ID;
 $sendDocument->document = new InputFile(__FILE__);
-$sendDocument->thumb = new InputFile(__DIR__ . '/binary-test-data/logo-php7-telegram-bot-api-thumbnail.jpg');
+$sendDocument->thumbnail = new InputFile(__DIR__ . '/binary-test-data/logo-php7-telegram-bot-api-thumbnail.jpg');
 
 $promise = $tgLog->performApiRequest($sendDocument);
 
@@ -37,7 +37,7 @@ function ($response) use ($tgLog, $loop) {
 
         // Load uploaded thumbnail and generate URL to download using bot token
         $getFileThumb = new GetFile();
-        $getFileThumb->file_id = $response->document->thumb->file_id;
+        $getFileThumb->file_id = $response->document->thumbnail->file_id;
         $fileThumb = await($tgLog->performApiRequest($getFileThumb), $loop);
         var_dump('Thumbnail url: ' . $tgLog->fileUrl($fileThumb));
     },

src/Telegram/Methods/SendAnimation.php

@@ -59,6 +59,12 @@ class SendAnimation extends TelegramMethods
      * if the thumbnail was uploaded using multipart/form-data under <file_attach_name>
      * @var string|InputFile
      */
+    public $thumbnail;
+
+    /**
+     * @deprecated Use $thumbnail instead (Bot API 6.6, March 9, 2023 https://core.telegram.org/bots/api-changelog#march-9-2023)
+     * @var string|InputFile
+     */
     public $thumb;
 
     /**

src/Telegram/Methods/SendAudio.php

@@ -49,6 +49,12 @@ class SendAudio extends TelegramMethods
      * uploaded using multipart/form-data under <file_attach_name>.
      * @var string|InputFile
      */
+    public $thumbnail;
+
+    /**
+     * @deprecated Use $thumbnail instead (Bot API 6.6, March 9, 2023 https://core.telegram.org/bots/api-changelog#march-9-2023)
+     * @var string|InputFile
+     */
     public $thumb;
 
     /**
@@ -126,6 +132,7 @@ public function getLocalFiles(): Generator
     {
         yield from [
             'audio' => $this->audio,
+            'thumbnail' => $this->thumbnail,
             'thumb' => $this->thumb,
         ];
     }

src/Telegram/Methods/SendDocument.php

@@ -1,6 +1,6 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 namespace unreal4u\TelegramAPI\Telegram\Methods;
 
@@ -9,7 +9,6 @@
 use unreal4u\TelegramAPI\Abstracts\TelegramMethods;
 use unreal4u\TelegramAPI\Telegram\Types\Custom\InputFile;
 use unreal4u\TelegramAPI\Telegram\Types\Custom\MessageEntityArray;
-use unreal4u\TelegramAPI\Telegram\Types\MessageEntity;
 
 /**
  * Use this method to send general files. On success, the sent Message is returned. Bots can currently send files of any
@@ -44,6 +43,12 @@ class SendDocument extends TelegramMethods
      * uploaded using multipart/form-data under <file_attach_name>.
      * @var string|InputFile
      */
+    public $thumbnail;
+
+    /**
+     * @deprecated Use $thumbnail instead (Bot API 6.6, March 9, 2023 https://core.telegram.org/bots/api-changelog#march-9-2023)
+     * @var string|InputFile
+     */
     public $thumb;
 
     /**
@@ -108,13 +113,16 @@ public function getMandatoryFields(): array
 
     public function hasLocalFiles(): bool
     {
-        return $this->document instanceof InputFile || $this->thumb instanceof InputFile;
+        return $this->document instanceof InputFile
+            || $this->thumbnail instanceof InputFile
+            || $this->thumb instanceof InputFile;
     }
 
     public function getLocalFiles(): Generator
     {
         yield from [
             'document' => $this->document,
+            'thumbnail' => $this->thumbnail,
             'thumb' => $this->thumb,
         ];
     }

src/Telegram/Methods/SendMessage.php

@@ -1,11 +1,11 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 namespace unreal4u\TelegramAPI\Telegram\Methods;
 
-use unreal4u\TelegramAPI\Abstracts\TelegramMethods;
 use unreal4u\TelegramAPI\Abstracts\KeyboardMethods;
+use unreal4u\TelegramAPI\Abstracts\TelegramMethods;
 
 /**
  * Object that resembles a message object in Telegram
@@ -22,6 +22,12 @@ class SendMessage extends TelegramMethods
      */
     public $chat_id = '';
 
+    /**
+     * Optional. Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
+     * @var int
+     */
+    public $message_thread_id = 0;
+
     /**
      * Text of the message to be sent
      * @var string
@@ -51,17 +57,24 @@ class SendMessage extends TelegramMethods
     public $disable_notification = false;
 
     /**
-     * Optional. Pass True if the message should be sent even if the specified replied-to message is not found
+     * Optional. Protects the contents of the sent message from forwarding and saving
+     *
      * @var bool
      */
-    public $allow_sending_without_reply = false;
+    public $protect_content = false;
 
     /**
      * Optional. If the message is a reply, ID of the original message
      * @var int
      */
     public $reply_to_message_id = 0;
 
+    /**
+     * Optional. Pass True if the message should be sent even if the specified replied-to message is not found
+     * @var bool
+     */
+    public $allow_sending_without_reply = false;
+
     /**
      * Optional. Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to
      * hide keyboard or to force a reply from the user

src/Telegram/Methods/SendVideo.php

@@ -57,6 +57,12 @@ class SendVideo extends TelegramMethods
      *
      * @var InputFile
      */
+    public $thumbnail;
+
+    /**
+     * @deprecated Use $thumbnail instead (Bot API 6.6, March 9, 2023 https://core.telegram.org/bots/api-changelog#march-9-2023)
+     * @var InputFile
+     */
     public $thumb;
 
     /**

src/Telegram/Methods/SetStickerSetThumb.php

@@ -1,71 +1,13 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 namespace unreal4u\TelegramAPI\Telegram\Methods;
 
-use Generator;
-use Psr\Log\LoggerInterface;
-use unreal4u\TelegramAPI\Abstracts\TelegramMethods;
-use unreal4u\TelegramAPI\Abstracts\TelegramTypes;
-use unreal4u\TelegramAPI\InternalFunctionality\TelegramResponse;
-use unreal4u\TelegramAPI\Telegram\Types\Custom\InputFile;
-use unreal4u\TelegramAPI\Telegram\Types\Custom\ResultBoolean;
-
 /**
- * Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for animated sticker sets only.
- * Returns True on success.
- *
- * Objects defined as-is June 2020, Bot API v4.9
- *
- * @see https://core.telegram.org/bots/api#setstickersetthumb
+ * @deprecated Use directly SetStickerSetThumbnail instead (Bot API 6.6, March 9, 2023)
+ * @see https://core.telegram.org/bots/api-changelog#march-9-2023
  */
-class SetStickerSetThumb extends TelegramMethods
+class SetStickerSetThumb extends SetStickerSetThumbnail
 {
-    /**
-     * Sticker set name
-     * @var string
-     */
-    public $name;
-
-    /**
-     * User identifier of the sticker set owner
-     * @var int
-     */
-    public $user_id;
-
-    /**
-     * A PNG image with the thumbnail, must be up to 128 kilobytes in size and have width and height exactly 100px, or a
-     * TGS animation with the thumbnail up to 32 kilobytes in size; see
-     * https://core.telegram.org/animated_stickers#technical-requirements for animated sticker technical requirements.
-     * Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a
-     * String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More info on
-     * Sending Files ». Animated sticker set thumbnail can't be uploaded via HTTP URL.
-     *
-     * @var InputFile|string
-     */
-    public $thumb;
-
-    public static function bindToObject(TelegramResponse $data, LoggerInterface $logger): TelegramTypes
-    {
-        return new ResultBoolean($data->getResultBoolean(), $logger);
-    }
-
-    public function getMandatoryFields(): array
-    {
-        return [
-            'name',
-            'user_id',
-        ];
-    }
-
-    public function hasLocalFiles(): bool
-    {
-        return $this->thumb instanceof InputFile;
-    }
-
-    public function getLocalFiles(): Generator
-    {
-        yield 'thumb' => $this->thumb;
-    }
 }

src/Telegram/Methods/SetStickerSetThumbnail.php

@@ -0,0 +1,80 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace unreal4u\TelegramAPI\Telegram\Methods;
+
+use Generator;
+use Psr\Log\LoggerInterface;
+use unreal4u\TelegramAPI\Abstracts\TelegramMethods;
+use unreal4u\TelegramAPI\Abstracts\TelegramTypes;
+use unreal4u\TelegramAPI\InternalFunctionality\TelegramResponse;
+use unreal4u\TelegramAPI\Telegram\Types\Custom\InputFile;
+use unreal4u\TelegramAPI\Telegram\Types\Custom\ResultBoolean;
+
+/**
+ * Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for animated sticker sets only.
+ * Returns True on success.
+ *
+ * Objects defined as-is June 2020, Bot API v4.9
+ *
+ * @see https://core.telegram.org/bots/api#setstickersetthumb
+ */
+class SetStickerSetThumbnail extends TelegramMethods
+{
+    /**
+     * Sticker set name
+     * @var string
+     */
+    public $name;
+
+    /**
+     * User identifier of the sticker set owner
+     * @var int
+     */
+    public $user_id;
+
+    /**
+     * A PNG image with the thumbnail, must be up to 128 kilobytes in size and have width and height exactly 100px, or a
+     * TGS animation with the thumbnail up to 32 kilobytes in size; see
+     * https://core.telegram.org/animated_stickers#technical-requirements for animated sticker technical requirements.
+     * Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a
+     * String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More info on
+     * Sending Files ». Animated sticker set thumbnail can't be uploaded via HTTP URL.
+     *
+     * @var InputFile|string
+     */
+    public $thumbnail;
+
+    /**
+     * @deprecated Use $thumbnail instead (Bot API 6.6, March 9, 2023 https://core.telegram.org/bots/api-changelog#march-9-2023)
+     * @var InputFile|string
+     */
+    public $thumb;
+
+    public static function bindToObject(TelegramResponse $data, LoggerInterface $logger): TelegramTypes
+    {
+        return new ResultBoolean($data->getResultBoolean(), $logger);
+    }
+
+    public function getMandatoryFields(): array
+    {
+        return [
+            'name',
+            'user_id',
+        ];
+    }
+
+    public function hasLocalFiles(): bool
+    {
+        return $this->thumbnail instanceof InputFile || $this->thumb instanceof InputFile;
+    }
+
+    public function getLocalFiles(): Generator
+    {
+        yield from [
+            'thumbnail' => $this->thumbnail,
+            'thumb' => $this->thumb,
+        ];
+    }
+}

src/Telegram/Types/Animation.php

@@ -51,6 +51,12 @@ class Animation extends TelegramTypes
      * Optional. Animation thumbnail as defined by sender
      * @var PhotoSize
      */
+    public $thumbnail;
+
+    /**
+     * @deprecated Use $thumbnail instead (Bot API 6.6, March 9, 2023 https://core.telegram.org/bots/api-changelog#march-9-2023)
+     * @var PhotoSize
+     */
     public $thumb;
 
     /**
@@ -74,6 +80,7 @@ class Animation extends TelegramTypes
     protected function mapSubObjects(string $key, array $data): TelegramTypes
     {
         switch ($key) {
+            case 'thumbnail':
             case 'thumb':
                 return new PhotoSize($data, $this->logger);
         }