Added new animation related properties and methods.

Author: noplanman

README.md

@@ -364,7 +364,7 @@ $result = Request::sendPhoto([
 ]);
 ```
 
-*sendAudio*, *sendDocument*, *sendSticker*, *sendVideo*, *sendVoice* and *sendVideoNote* all work in the same way, just check the [API documentation](https://core.telegram.org/bots/api#sendphoto) for the exact usage.
+*sendAudio*, *sendDocument*, *sendAnimation*, *sendSticker*, *sendVideo*, *sendVoice* and *sendVideoNote* all work in the same way, just check the [API documentation](https://core.telegram.org/bots/api#sendphoto) for the exact usage.
 See the [*ImageCommand.php*][ImageCommand.php] for a full example.
 
 #### Send Chat Action

src/DB.php

@@ -829,15 +829,15 @@ public static function insertMessageRequest(Message $message)
                 (
                     `id`, `user_id`, `chat_id`, `date`, `forward_from`, `forward_from_chat`, `forward_from_message_id`,
                     `forward_date`, `reply_to_chat`, `reply_to_message`, `media_group_id`, `text`, `entities`, `audio`, `document`,
-                    `game`, `photo`, `sticker`, `video`, `voice`, `video_note`, `caption`, `contact`,
+                    `animation`, `game`, `photo`, `sticker`, `video`, `voice`, `video_note`, `caption`, `contact`,
                     `location`, `venue`, `new_chat_members`, `left_chat_member`,
                     `new_chat_title`,`new_chat_photo`, `delete_chat_photo`, `group_chat_created`,
                     `supergroup_chat_created`, `channel_chat_created`,
                     `migrate_from_chat_id`, `migrate_to_chat_id`, `pinned_message`, `connected_website`
                 ) VALUES (
                     :message_id, :user_id, :chat_id, :date, :forward_from, :forward_from_chat, :forward_from_message_id,
                     :forward_date, :reply_to_chat, :reply_to_message, :media_group_id, :text, :entities, :audio, :document,
-                    :game, :photo, :sticker, :video, :voice, :video_note, :caption, :contact,
+                    :animation, :game, :photo, :sticker, :video, :voice, :video_note, :caption, :contact,
                     :location, :venue, :new_chat_members, :left_chat_member,
                     :new_chat_title, :new_chat_photo, :delete_chat_photo, :group_chat_created,
                     :supergroup_chat_created, :channel_chat_created,
@@ -881,6 +881,7 @@ public static function insertMessageRequest(Message $message)
             $sth->bindValue(':entities', $t = self::entitiesArrayToJson($message->getEntities(), null));
             $sth->bindValue(':audio', $message->getAudio());
             $sth->bindValue(':document', $message->getDocument());
+            $sth->bindValue(':animation', $message->getAnimation());
             $sth->bindValue(':game', $message->getGame());
             $sth->bindValue(':photo', $t = self::entitiesArrayToJson($message->getPhoto(), null));
             $sth->bindValue(':sticker', $message->getSticker());

src/Entities/Games/Animation.php src/Entities/Animation.phpsrc/Entities/Games/Animation.php renamed to src/Entities/Animation.php

@@ -8,9 +8,7 @@
  * file that was distributed with this source code.
  */
 
-namespace Longman\TelegramBot\Entities\Games;
-
-use Longman\TelegramBot\Entities\Entity;
+namespace Longman\TelegramBot\Entities;
 
 /**
  * Class Animation
@@ -20,6 +18,9 @@
  * @link https://core.telegram.org/bots/api#animation
  *
  * @method string    getFileId()   Unique file identifier
+ * @method int       getWidth()    Video width as defined by sender
+ * @method int       getHeight()   Video height as defined by sender
+ * @method int       getDuration() Duration of the video in seconds as defined by sender
  * @method PhotoSize getThumb()    Optional. Animation thumbnail as defined by sender
  * @method string    getFileName() Optional. Original animation filename as defined by sender
  * @method string    getMimeType() Optional. MIME type of the file as defined by sender

src/Entities/Message.php

@@ -34,6 +34,7 @@
  * @method string            getAuthorSignature()       Optional. Signature of the post author for messages in channels
  * @method Audio             getAudio()                 Optional. Message is an audio file, information about the file
  * @method Document          getDocument()              Optional. Message is a general file, information about the file
+ * @method Animation         getAnimation()             Optional. Message is an animation, information about the animation. For backward compatibility, when this field is set, the document field will also be set
  * @method Game              getGame()                  Optional. Message is a game, information about the game.
  * @method Sticker           getSticker()               Optional. Message is a sticker, information about the sticker
  * @method Video             getVideo()                 Optional. Message is a video, information about the video
@@ -73,6 +74,7 @@ protected function subEntities()
             'caption_entities'   => MessageEntity::class,
             'audio'              => Audio::class,
             'document'           => Document::class,
+            'animation'          => Animation::class,
             'game'               => Game::class,
             'photo'              => PhotoSize::class,
             'sticker'            => Sticker::class,
@@ -280,6 +282,8 @@ public function getType()
             'text',
             'audio',
             'document',
+            'animation',
+            'game',
             'photo',
             'sticker',
             'video',

src/Request.php

@@ -31,6 +31,7 @@
  * @method static ServerResponse sendDocument(array $data)            Use this method to send general files. On success, the sent Message is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.
  * @method static ServerResponse sendSticker(array $data)             Use this method to send .webp stickers. On success, the sent Message is returned.
  * @method static ServerResponse sendVideo(array $data)               Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.
+ * @method static ServerResponse sendAnimation(array $data)           Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent Message is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future.
  * @method static ServerResponse sendVoice(array $data)               Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .ogg file encoded with OPUS (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.
  * @method static ServerResponse sendVideoNote(array $data)           Use this method to send video messages. On success, the sent Message is returned.
  * @method static ServerResponse sendMediaGroup(array $data)          Use this method to send a group of photos or videos as an album. On success, an array of the sent Messages is returned.
@@ -145,6 +146,7 @@ class Request
         'sendDocument',
         'sendSticker',
         'sendVideo',
+        'sendAnimation',
         'sendVoice',
         'sendVideoNote',
         'sendMediaGroup',
@@ -668,6 +670,7 @@ private static function limitTelegramRequests($action, array $data = [])
                 'sendDocument',
                 'sendSticker',
                 'sendVideo',
+                'sendAnimation',
                 'sendVoice',
                 'sendVideoNote',
                 'sendMediaGroup',

structure.sql

@@ -81,6 +81,7 @@ CREATE TABLE IF NOT EXISTS `message` (
   `entities` TEXT COMMENT 'For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text',
   `audio` TEXT COMMENT 'Audio object. Message is an audio file, information about the file',
   `document` TEXT COMMENT 'Document object. Message is a general file, information about the file',
+  `animation` TEXT COMMENT 'Optional. Message is an animation, information about the animation',
   `game` TEXT COMMENT 'Game object. Message is a game, information about the game',
   `photo` TEXT COMMENT 'Array of PhotoSize objects. Message is a photo, available sizes of the photo',
   `sticker` TEXT COMMENT 'Sticker object. Message is a sticker, information about the sticker',

utils/db-schema-update/0.54.0-unreleased.sql

@@ -0,0 +1 @@
+ALTER TABLE `message` ADD COLUMN `animation` TEXT NULL COMMENT 'Optional. Message is an animation, information about the animation' AFTER `document`;