Merge pull request #385 from bernard-ng/master

add support for forum topic (Bot API 6.3)

Author: iGusev

src/BotApi.php

@@ -19,7 +19,7 @@ class Animation extends BaseType implements TypeInterface
      *
      * @var array
      */
-    static protected $requiredParams = ['file_id', 'width', 'height', 'duration'];
+    static protected $requiredParams = ['file_id', 'file_unique_id', 'width', 'height', 'duration'];
 
     /**
      * {@inheritdoc}
@@ -28,6 +28,7 @@ class Animation extends BaseType implements TypeInterface
      */
     static protected $map = [
         'file_id' => true,
+        'file_unique_id' => true,
         'width' => true,
         'height' => true,
         'duration' => true,

src/Types/Animation.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace TelegramBot\Api\Types;
+
+abstract class ArrayOfSticker
+{
+    public static function fromResponse($data)
+    {
+        $arrayOfStickers = [];
+        foreach ($data as $sticker) {
+            $arrayOfStickers[] = Sticker::fromResponse($sticker);
+        }
+
+        return $arrayOfStickers;
+    }
+}

src/Types/ArrayOfSticker.php

@@ -19,7 +19,7 @@ class Audio extends BaseType implements TypeInterface
      *
      * @var array
      */
-    static protected $requiredParams = ['file_id', 'duration'];
+    static protected $requiredParams = ['file_id', 'file_unique_id', 'duration'];
 
     /**
      * {@inheritdoc}
@@ -28,6 +28,7 @@ class Audio extends BaseType implements TypeInterface
      */
     static protected $map = [
         'file_id' => true,
+        'file_unique_id' => true,
         'duration' => true,
         'performer' => true,
         'title' => true,
@@ -77,6 +78,13 @@ class Audio extends BaseType implements TypeInterface
      */
     protected $fileSize;
 
+    /**
+     * Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
+     *
+     * @var string
+     */
+    protected $fileUniqueId;
+
     /**
      * @return int
      */
@@ -184,4 +192,20 @@ public function setMimeType($mimeType)
     {
         $this->mimeType = $mimeType;
     }
+
+    /**
+     * @return string
+     */
+    public function getFileUniqueId()
+    {
+        return $this->fileUniqueId;
+    }
+
+    /**
+     * @param string $fileUniqueId
+     */
+    public function setFileUniqueId($fileUniqueId)
+    {
+        $this->fileUniqueId = $fileUniqueId;
+    }
 }

src/Types/Audio.php

@@ -37,7 +37,16 @@ class Chat extends BaseType implements TypeInterface
         'sticker_set_name' => true,
         'can_set_sticker_set' => true,
         'linked_chat_id' => true,
-        'location' => ChatLocation::class
+        'location' => ChatLocation::class,
+        'join_to_send_messages' => true,
+        'join_by_request' => true,
+        'message_auto_delete_time' => true,
+        'has_protected_content' => true,
+        'is_forum' => true,
+        'active_usernames' => true,
+        'emoji_status_custom_emoji_id' => true,
+        'has_private_forwards' => true,
+        'has_restricted_voice_and_video_messages' => true,
     ];
 
     /**
@@ -163,6 +172,74 @@ class Chat extends BaseType implements TypeInterface
      */
     protected $location;
 
+    /**
+     * Optional. True, if users need to join the supergroup before they can send messages. Returned only in getChat.
+     *
+     * @var bool
+     */
+    protected $joinToSendMessages;
+
+    /**
+     * Optional. True, if all users directly joining the supergroup need to be approved by supergroup administrators. Returned only in getChat.
+     *
+     * @var bool
+     */
+    protected $joinByRequest;
+
+    /**
+     * Optional. Time after which all messages sent to the chat will be automatically deleted; in seconds. Returned
+     * only in getChat.
+     *
+     * @var int
+     */
+    protected $messageAutoDeleteTime;
+
+    /**
+     * 	Optional. True, if messages from the chat can't be forwarded to other chats. Returned only in getChat.
+     *
+     * @var bool
+     */
+    protected $hasProtectedContent;
+
+    /**
+     * Optional. True, if the supergroup chat is a forum (has topics enabled)
+     *
+     * @var bool
+     */
+    protected $isForum;
+
+    /**
+     * Optional. If non-empty, the list of all active chat usernames;
+     * for private chats, supergroups and channels. Returned only in getChat.
+     *
+     * @var array[]
+     */
+    protected $activeUsernames;
+
+    /**
+     * Optional. Custom emoji identifier of emoji status of the other party in a private chat. Returned only in getChat.
+     *
+     * @var string
+     */
+    protected $emojiStatusCustomEmojiId;
+
+    /**
+     * Optional. True, if privacy settings of the other party in the private chat allows
+     * to use tg://user?id=<user_id> links only in chats with the user.
+     * Returned only in getChat.
+     *
+     * @var bool
+     */
+    protected $hasPrivateForwards;
+
+    /**
+     * Optional. True, if the privacy settings of the other party restrict sending voice and video note messages in the private chat.
+     * Returned only in getChat.
+     *
+     * @var bool
+     */
+    protected $hasRestrictedVoiceAndVideoMessages;
+
     /**
      * @return int|string
      */
@@ -396,7 +473,7 @@ public function setStickerSetName($stickerSetName)
     /**
      * @return bool
      */
-    public function isCanSetStickerSet()
+    public function getCanSetStickerSet()
     {
         return $this->canSetStickerSet;
     }
@@ -440,4 +517,148 @@ public function setLocation($location)
     {
         $this->location = $location;
     }
+
+    /**
+     * @return bool
+     */
+    public function getJoinToSendMessages()
+    {
+        return $this->joinToSendMessages;
+    }
+
+    /**
+     * @param bool $joinToSendMessages
+     */
+    public function setJoinToSendMessages($joinToSendMessages)
+    {
+        $this->joinToSendMessages = $joinToSendMessages;
+    }
+
+    /**
+     * @return bool
+     */
+    public function getJoinByRequest()
+    {
+        return $this->joinByRequest;
+    }
+
+    /**
+     * @param bool $joinByRequest
+     */
+    public function setJoinByRequest($joinByRequest)
+    {
+        $this->joinByRequest = $joinByRequest;
+    }
+
+    /**
+     * @return int
+     */
+    public function getMessageAutoDeleteTime()
+    {
+        return $this->messageAutoDeleteTime;
+    }
+
+    /**
+     * @param int $messageAutoDeleteTime
+     */
+    public function setMessageAutoDeleteTime($messageAutoDeleteTime)
+    {
+        $this->messageAutoDeleteTime = $messageAutoDeleteTime;
+    }
+
+    /**
+     * @return bool
+     */
+    public function getHasProtectedContent()
+    {
+        return $this->hasProtectedContent;
+    }
+
+    /**
+     * @param bool $hasProtectedContent
+     */
+    public function setHasProtectedContent($hasProtectedContent)
+    {
+        $this->hasProtectedContent = $hasProtectedContent;
+    }
+
+    /**
+     * @return bool
+     */
+    public function getIsForum()
+    {
+        return $this->isForum;
+    }
+
+    /**
+     * @param bool $isForum
+     */
+    public function setIsForum($isForum)
+    {
+        $this->isForum = $isForum;
+    }
+
+    /**
+     * @return array
+     */
+    public function getActiveUsernames()
+    {
+        return $this->activeUsernames;
+    }
+
+    /**
+     * @param array $activeUsernames
+     */
+    public function setActiveUsernames($activeUsernames)
+    {
+        $this->activeUsernames = $activeUsernames;
+    }
+
+    /**
+     * @return bool
+     */
+    public function getEmojiStatusCustomEmojiId()
+    {
+        return $this->emojiStatusCustomEmojiId;
+    }
+
+    /**
+     * @param bool $emojiStatusCustomEmojiId
+     */
+    public function setEmojiStatusCustomEmojiId($emojiStatusCustomEmojiId)
+    {
+        $this->emojiStatusCustomEmojiId = $emojiStatusCustomEmojiId;
+    }
+
+    /**
+     * @return bool
+     */
+    public function getHasPrivateForwards()
+    {
+        return $this->hasPrivateForwards;
+    }
+
+    /**
+     * @param bool $hasPrivateForwards
+     */
+    public function setHasPrivateForwards($hasPrivateForwards)
+    {
+        $this->hasPrivateForwards = $hasPrivateForwards;
+    }
+
+    /**
+     * @return bool
+     */
+    public function getHasRestrictedVoiceAndVideoMessages()
+    {
+        return $this->hasRestrictedVoiceAndVideoMessages;
+    }
+
+    /**
+     * @param bool $hasRestrictedVoiceAndVideoMessages
+     */
+    public function setHasRestrictedVoiceAndVideoMessages($hasRestrictedVoiceAndVideoMessages)
+    {
+        $this->hasRestrictedVoiceAndVideoMessages = $hasRestrictedVoiceAndVideoMessages;
+    }
 }