TelegramBot\Entities\Update

Complexity

Total Complexity

5

Size/Duplication

Total Lines	66
Duplicated Lines	0 %

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getUpdateType()	0	9	3
A	getUpdateTypes()	0	3	1
A	subEntities()	0	18	1

<?php


namespace TelegramBot\Entities;

use TelegramBot\Entities\Payments\PreCheckoutQuery;
use TelegramBot\Entities\Payments\ShippingQuery;
use TelegramBot\Entity;

/**
 * Class Update
 *
 * @link https://core.telegram.org/bots/api#update
 *
 * @method int                getUpdateId()             The update's unique identifier. Update identifiers start from a certain positive number and increase sequentially. This ID becomes especially handy if you’re using Webhooks, since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of order.
 * @method Message            getMessage()              Optional. New incoming message of any kind — text, photo, sticker, etc.
 * @method Message            getEditedMessage()        Optional. New version of a message that is known to the bot and was edited
 * @method Message            getChannelPost()          Optional. New post in the channel, can be any kind — text, photo, sticker, etc.
 * @method Message            getEditedChannelPost()    Optional. New version of a post in the channel that is known to the bot and was edited
 * @method InlineQuery        getInlineQuery()          Optional. New incoming inline query
 * @method ChosenInlineResult getChosenInlineResult()   Optional. The result of an inline query that was chosen by a user and sent to their chat partner.
 * @method CallbackQuery      getCallbackQuery()        Optional. New incoming callback query
 * @method ShippingQuery      getShippingQuery()        Optional. New incoming shipping query. Only for invoices with flexible price
 * @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.
 * @method ChatJoinRequest    getChatJoinRequest()      Optional. A request to join the chat has been sent. The bot must have the can_invite_users administrator right in the chat to receive these updates.
 * @method WebAppData         getWebAppData()           Optional. The data from WebApp
 */
class Update extends Entity
{

    public const TYPE_MESSAGE = 'message';
    public const TYPE_EDITED_MESSAGE = 'edited_message';
    public const TYPE_CHANNEL_POST = 'channel_post';
    public const TYPE_EDITED_CHANNEL_POST = 'edited_channel_post';
    public const TYPE_INLINE_QUERY = 'inline_query';
    public const TYPE_CHOSEN_INLINE_RESULT = 'chosen_inline_result';
    public const TYPE_CALLBACK_QUERY = 'callback_query';
    public const TYPE_SHIPPING_QUERY = 'shipping_query';
    public const TYPE_PRE_CHECKOUT_QUERY = 'pre_checkout_query';
    public const TYPE_POLL = 'poll';
    public const TYPE_POLL_ANSWER = 'poll_answer';
    public const TYPE_MY_CHAT_MEMBER = 'my_chat_member';
    public const TYPE_CHAT_MEMBER = 'chat_member';
    public const TYPE_CHAT_JOIN_REQUEST = 'chat_join_request';
    public const TYPE_WEB_DATA = 'web_app_data';

    /**
     * Get the update type based on the set properties
     *
     * @return string|null
     */
    public function getUpdateType(): ?string
    {
        foreach (self::getUpdateTypes() as $type) {
            if ($this->getProperty($type)) {
                return $type;
            }
        }

        return null;
    }

    /**
     * Get the list of all available update types
     *
     * @return string[]
     */
    public static function getUpdateTypes(): array
    {
        return array_keys((new self([]))->subEntities());
    }

    /**
     * {@inheritdoc}
     */
    protected function subEntities(): array
    {
        return [
            self::TYPE_MESSAGE => Message::class,
            self::TYPE_EDITED_MESSAGE => EditedMessage::class,
            self::TYPE_CHANNEL_POST => ChannelPost::class,
            self::TYPE_EDITED_CHANNEL_POST => EditedChannelPost::class,
            self::TYPE_INLINE_QUERY => InlineQuery::class,
            self::TYPE_CHOSEN_INLINE_RESULT => ChosenInlineResult::class,
            self::TYPE_CALLBACK_QUERY => CallbackQuery::class,
            self::TYPE_SHIPPING_QUERY => ShippingQuery::class,
            self::TYPE_PRE_CHECKOUT_QUERY => PreCheckoutQuery::class,
            self::TYPE_POLL => Poll::class,
            self::TYPE_POLL_ANSWER => PollAnswer::class,
            self::TYPE_MY_CHAT_MEMBER => ChatMemberUpdated::class,
            self::TYPE_CHAT_MEMBER => ChatMemberUpdated::class,
            self::TYPE_CHAT_JOIN_REQUEST => ChatJoinRequest::class,
            self::TYPE_WEB_DATA => WebAppData::class,
        ];
    }

}