TelegramTypes ChatMember updates

src/Telegram/Methods/GetChatMember.php

@@ -1,6 +1,6 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 namespace unreal4u\TelegramAPI\Telegram\Methods;
 
@@ -11,9 +11,8 @@
 use unreal4u\TelegramAPI\Telegram\Types\ChatMember;
 
 /**
- * Use this method to get information about a member of a chat. Returns a ChatMember object on success
- *
- * Objects defined as-is july 2016
+ * Use this method to get information about a member of a chat. The method is only guaranteed to work for other users
+ * if the bot is an administrator in the chat. Returns a ChatMember object on success.
  *
  * @see https://core.telegram.org/bots/api#getchatmember
  */
@@ -22,7 +21,7 @@ class GetChatMember extends TelegramMethods
     /**
      * Unique identifier for the target chat or username of the target supergroup or channel (in the format
      * @channelusername)
-     * @var string
+     * @var int|string
      */
     public $chat_id = '';
 
@@ -34,7 +33,7 @@ class GetChatMember extends TelegramMethods
 
     public static function bindToObject(TelegramResponse $data, LoggerInterface $logger): TelegramTypes
     {
-        return new ChatMember($data->getResult(), $logger);
+        return ChatMember::create($data->getResult(), $logger);
     }
 
     public function getMandatoryFields(): array

src/Telegram/Types/Chat.php

@@ -15,6 +15,11 @@
  */
 class Chat extends TelegramTypes
 {
+    public const TYPE_PRIVATE = 'private';
+    public const TYPE_GROUP = 'group';
+    public const TYPE_SUPERGROUP = 'supergroup';
+    public const TYPE_CHANNEL = 'channel';
+
     /**
      * Unique identifier for this chat. This number may be greater than 32 bits and some programming languages may have
      * difficulty/silent defects in interpreting it. But it smaller than 52 bits, so a signed 64 bit integer or

src/Telegram/Types/ChatMember.php

@@ -1,10 +1,17 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 namespace unreal4u\TelegramAPI\Telegram\Types;
 
+use Psr\Log\LoggerInterface;
 use unreal4u\TelegramAPI\Abstracts\TelegramTypes;
+use unreal4u\TelegramAPI\Telegram\Types\ChatMember\ChatMemberAdministrator;
+use unreal4u\TelegramAPI\Telegram\Types\ChatMember\ChatMemberBanned;
+use unreal4u\TelegramAPI\Telegram\Types\ChatMember\ChatMemberLeft;
+use unreal4u\TelegramAPI\Telegram\Types\ChatMember\ChatMemberMember;
+use unreal4u\TelegramAPI\Telegram\Types\ChatMember\ChatMemberOwner;
+use unreal4u\TelegramAPI\Telegram\Types\ChatMember\ChatMemberRestricted;
 
 /**
  * This object contains information about one member of the chat
@@ -15,131 +22,27 @@
  */
 class ChatMember extends TelegramTypes
 {
+    private const CHILD_CLASS_REFERENCES = [
+        ChatMemberOwner::class,
+        ChatMemberAdministrator::class,
+        ChatMemberMember::class,
+        ChatMemberRestricted::class,
+        ChatMemberLeft::class,
+        ChatMemberBanned::class,
+    ];
+
     /**
      * Information about the user
      * @var User
      */
     public $user;
 
     /**
-     * The member's status in the chat. Can be "creator", "administrator", "member", "restricted", "left" or "kicked"
+     * The member's status in the chat. See childs of this class or API documentation for possible values.
      * @var string
      */
     public $status = '';
 
-    /**
-     * Optional. Owner and administrators only. Custom title for this user
-     * @var string
-     */
-    public $custom_title = '';
-
-    /**
-     * Optional. Owner and administrators only. True, if the user's presence in the chat is hidden
-     * @var bool
-     */
-    public $is_anonymous = false;
-
-    /**
-     * Optional. Restricted and kicked only. Date when restrictions will be lifted for this user, unix time
-     * @var int
-     */
-    public $until_date = 0;
-
-    /**
-     * Optional. Administrators only. True, if the bot is allowed to edit administrator privileges of that user
-     * @var bool
-     */
-    public $can_be_edited = false;
-
-    /**
-     * Optional. Administrators only. True, if the administrator can post in the channel, channels only
-     * @var bool
-     */
-    public $can_post_messages = false;
-
-    /**
-     * Optional. Administrators only. True, if the administrator can edit messages of other users, channels only
-     * @var bool
-     */
-    public $can_edit_messages = false;
-
-    /**
-     * Optional. Administrators only. True, if the administrator can delete messages of other users
-     * @var bool
-     */
-    public $can_delete_messages = false;
-
-    /**
-     * Optional. Administrators only. True, if the administrator can restrict, ban or unban chat members
-     * @var bool
-     */
-    public $can_restrict_members = false;
-
-    /**
-     * Optional. Administrators only. True, if the administrator can add new administrators with a subset of his own
-     * privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators
-     * that were appointed by the user)
-     * @var bool
-     */
-    public $can_promote_members = false;
-
-    /**
-     * Optional. Administrators only. True, if the administrator can change the chat title, photo and other settings
-     * @var bool
-     */
-    public $can_change_info = false;
-
-    /**
-     * Optional. Administrators only. True, if the administrator can invite new users to the chat
-     * @var bool
-     */
-    public $can_invite_users = false;
-
-    /**
-     * Optional. Administrators only. True, if the administrator can pin messages, supergroups only
-     * @var bool
-     */
-    public $can_pin_messages = false;
-
-    /**
-     * Optional. Restricted only. True, if the user is a member of the chat at the moment of the request
-     * @var bool
-     */
-    public $is_member = false;
-
-    /**
-     * Optional. Restricted only. True, if the user can send text messages, contacts, locations and venues
-     * @var bool
-     */
-    public $can_send_messages = false;
-
-    /**
-     * Optional. Restricted only. True, if the user can send audios, documents, photos, videos, video notes and voice
-     * notes, implies can_send_messages
-     * @var bool
-     */
-    public $can_send_media_messages = false;
-
-    /**
-     * Optional. Restricted only. True, if the user is allowed to send polls
-     * @var bool
-     */
-    public $can_send_polls = false;
-
-    /**
-     * Optional. Restricted only. True, if the user can send animations, games, stickers and use inline bots, implies
-     * can_send_media_messages
-     * @var bool
-     */
-    public $can_send_other_messages = false;
-
-    /**
-     * Optional. Restricted only. True, if user may add web page previews to his messages, implies
-     * can_send_media_messages
-     * @var bool
-     */
-    public $can_add_web_page_previews = false;
-
     public function mapSubObjects(string $key, array $data): TelegramTypes
     {
         switch ($key) {
@@ -149,4 +52,30 @@ public function mapSubObjects(string $key, array $data): TelegramTypes
 
         return parent::mapSubObjects($key, $data);
     }
+
+    /**
+     * Create specific ChatMember class based on 'status'. If there is no match,
+     */
+    public static function create(array $data, LoggerInterface $logger): ChatMember
+    {
+        $status = $data['status'] ?? null;
+
+        foreach (self::CHILD_CLASS_REFERENCES as $childClassReference) {
+            if ($status === $childClassReference::STATUS) {
+                return new $childClassReference($data, $logger);
+            }
+        }
+        $logger->error(sprintf(
+            'Unable to detect correct "%s" class based on status = "%s"! Maybe a recent Telegram Bot ' .
+            'API update? In any way, please submit an issue (bug report) at %s with this complete log line',
+            self::class,
+            $status ?? 'null',
+            'https://github.com/unreal4u/telegram-api/issues'
+        ), [
+            'object' => self::class,
+            'data' => $data,
+        ]);
+
+        return new ChatMember($data, $logger);
+    }
 }

src/Telegram/Types/ChatMember/ChatMemberAdministrator.php

@@ -0,0 +1,135 @@
+<?php
+
+declare(strict_types=1);
+
+namespace unreal4u\TelegramAPI\Telegram\Types\ChatMember;
+
+use unreal4u\TelegramAPI\Telegram\Types\ChatMember;
+
+/**
+ * Represents a chat member that has some additional privileges.
+ *
+ * @see https://core.telegram.org/bots/api#chatmemberadministrator
+ */
+class ChatMemberAdministrator extends ChatMember
+{
+    public const STATUS = 'administrator';
+
+    /**
+     * The member's status in the chat, always “administrator”
+     * @var string
+     */
+    public $status = self::STATUS;
+
+    /**
+     * True, if the bot is allowed to edit administrator privileges of that user
+     * @var bool
+     */
+    public $can_be_edited = false;
+
+    /**
+     * True, if the user's presence in the chat is hidden
+     * @var bool
+     */
+    public $is_anonymous = false;
+
+    /**
+     * True, if the administrator can access the chat event log, chat statistics, message statistics in channels, see
+     * channel members, see anonymous administrators in supergroups and ignore slow mode.
+     * Implied by any other administrator privilege
+     * @var bool
+     */
+    public $can_manage_chat = false;
+
+    /**
+     * True, if the administrator can delete messages of other users
+     * @var bool
+     */
+    public $can_delete_messages = false;
+
+    /**
+     * True, if the administrator can manage video chats
+     * @var bool
+     */
+    public $can_manage_video_chats = false;
+
+    /**
+     * @deprecated Use can_manage_video_chats instead (April 16, 2022 Bot API 6.0 https://core.telegram.org/bots/api-changelog#april-16-2022)
+     * @var bool
+     */
+    public $can_manage_voice_chats = false;
+
+    /**
+     * True, if the administrator can restrict, ban or unban chat members
+     * @var bool
+     */
+    public $can_restrict_members = false;
+
+    /**
+     * True, if the administrator can add new administrators with a subset of their own privileges or demote
+     * administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed
+     * by the user)
+     * @var bool
+     */
+    public $can_promote_members = false;
+
+    /**
+     * True, if the user is allowed to change the chat title, photo and other settings
+     * @var bool
+     */
+    public $can_change_info = false;
+
+    /**
+     * True, if the user is allowed to invite new users to the chat
+     * @var bool
+     */
+    public $can_invite_users = false;
+
+    /**
+     * Optional. True, if the administrator can post in the channel; channels only
+     * @var bool
+     */
+    public $can_post_messages = false;
+
+    /**
+     * Optional. True, if the administrator can edit messages of other users and can pin messages; channels only
+     * @var bool
+     */
+    public $can_edit_messages = false;
+
+    /**
+     * Optional. True, if the user is allowed to pin messages; groups and supergroups only
+     * @var bool
+     */
+    public $can_pin_messages = false;
+
+    /**
+     * Optional. True, if the administrator can post stories in the channel; channels only
+     * @var bool
+     */
+    public $can_post_stories = false;
+
+    /**
+     * Optional. True, if the administrator can edit stories posted by other users; channels only
+     * @var bool
+     */
+    public $can_edit_stories = false;
+
+    /**
+     * Optional. True, if the administrator can delete stories posted by other users; channels only
+     * @var bool
+     */
+    public $can_delete_stories = false;
+
+    /**
+     * Optional. True, if the user is allowed to create, rename, close, and reopen forum topics; supergroups only
+     * @var bool
+     */
+    public $can_manage_topics = false;
+
+    /**
+     * Optional. Custom title for this user
+     * @var string
+     */
+    public $custom_title;
+}