Merge pull request #1188 from massadm/chat_member

Added updates about member status changes in chats

Author: noplanman

src/Entities/ChatInviteLink.php

@@ -0,0 +1,39 @@
+<?php
+
+/**
+ * This file is part of the TelegramBot package.
+ *
+ * (c) Avtandil Kikabidze aka LONGMAN <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Longman\TelegramBot\Entities;
+
+/**
+ * Class ChatInviteLink
+ *
+ * Represents an invite link for a chat
+ *
+ * @link https://core.telegram.org/bots/api#chatinvitelink
+ *
+ * @method string  GetInviteLink()       The invite link. If the link was created by another chat administrator, then the second part of the link will be replaced with “…”
+ * @method User    getCreator()          Creator of the link
+ * @method bool    getIsPrimary()        True, if the link is primary
+ * @method bool    getIsRevoked()        True, if the link is revoked
+ * @method int     getExpireDate()       Optional. Point in time (Unix timestamp) when the link will expire or has been expired
+ * @method int     getMemberLimit()      Optional. Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999
+ */
+class ChatInviteLink extends Entity
+{
+    /**
+     * {@inheritdoc}
+     */
+    protected function subEntities(): array
+    {
+        return [
+            'creator' => User::class
+        ];
+    }
+}

src/Entities/ChatMemberUpdated.php

@@ -0,0 +1,43 @@
+<?php
+
+/**
+ * This file is part of the TelegramBot package.
+ *
+ * (c) Avtandil Kikabidze aka LONGMAN <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Longman\TelegramBot\Entities;
+
+/**
+ * Class ChatMemberUpdated
+ *
+ * Represents changes in the status of a chat member
+ *
+ * @link https://core.telegram.org/bots/api#chatmemberupdated
+ *
+ * @method Chat            getChat()              Chat the user belongs to
+ * @method User            getUser()              Performer of the action, which resulted in the change
+ * @method int             getDate()              Date the change was done in Unix time
+ * @method ChatMember      getOldChatMember()     Previous information about the chat member
+ * @method ChatMember      getNewChatMember()     New information about the chat member
+ * @method ChatInviteLink  getInviteLink()        Optional. Chat invite link, which was used by the user to join the chat; for joining by invite link events only.
+ */
+class ChatMemberUpdated extends Entity
+{
+    /**
+     * {@inheritdoc}
+     */
+    protected function subEntities(): array
+    {
+        return [
+            'chat'              => Chat::class,
+            'from'              => User::class,
+            'old_chat_member'   => ChatMember::class,
+            'new_chat_member'   => ChatMember::class,
+            'invite_link'       => ChatInviteLink::class,
+        ];
+    }
+}

src/Entities/Update.php

@@ -31,6 +31,8 @@
  * @method PreCheckoutQuery    getPreCheckoutQuery()   Optional. New incoming pre-checkout query. Contains full information about checkout
  * @method Poll                getPoll()               Optional. New poll state. Bots receive only updates about polls, which are sent or stopped by the bot
  * @method PollAnswer          getPollAnswer()         Optional. A user changed their answer in a non-anonymous poll. Bots receive new votes only in polls that were sent by the bot itself.
+ * @method ChatMemberUpdated   getMyChatMember()       Optional. The bot's chat member status was updated in a chat. For private chats, this update is received only when the bot is blocked or unblocked by the user.
+ * @method ChatMemberUpdated   getChatMember()         Optional. A chat member's status was updated in a chat. The bot must be an administrator in the chat and must explicitly specify “chat_member” in the list of allowed_updates to receive these updates.
  */
 class Update extends Entity
 {
@@ -51,6 +53,8 @@ protected function subEntities(): array
             'pre_checkout_query'   => PreCheckoutQuery::class,
             'poll'                 => Poll::class,
             'poll_answer'          => PollAnswer::class,
+            'my_chat_member'       => ChatMemberUpdated::class,
+            'chat_member'          => ChatMemberUpdated::class,
         ];
     }