Longman\TelegramBot\Entities\Update

Complexity

Total Complexity

6

Size/Duplication

Total Lines	69
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

76.19%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	subEntities()	0	14	1
A	getUpdateType()	0	12	3
A	getUpdateContent()	0	12	2

<?php
/**
 * This file is part of the TelegramBot package.
 *
 * (c) Avtandil Kikabidze aka LONGMAN <akalongman@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Longman\TelegramBot\Entities;

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

/**
 * 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
 */
class Update extends Entity
{
    const TYPE_MESSAGE = 'message';
    const TYPE_EDITED_MESSAGE = 'edited_message';
    const TYPE_CHANNEL_POST = 'channel_post';
    const TYPE_EDITED_CHANNEL_POST = 'edited_channel_post';
    const TYPE_INLINE_QUERY = 'inline_query';
    const TYPE_CHOSEN_INLINE_QUERY = 'chosen_inline_result';
    const TYPE_CALLBACK_QUERY = 'callback_query';
    const TYPE_SHIPPING_QUERY = 'shipping_query';
    const TYPE_PRE_CHECKOUT_QUERY = 'pre_checkout_query';

    /**
     * {@inheritdoc}
     */
    protected function subEntities()
    {
        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_QUERY => ChosenInlineResult::class,
            self::TYPE_CALLBACK_QUERY      => CallbackQuery::class,
            self::TYPE_SHIPPING_QUERY      => ShippingQuery::class,
            self::TYPE_PRE_CHECKOUT_QUERY  => PreCheckoutQuery::class,
        ];
    }

    /**
     * Get the update type based on the set properties
     *
     * @return string|null
     */
    public function getUpdateType()
    {
        $types = array_keys($this->subEntities());

        foreach ($types as $type) {
            if ($this->getProperty($type)) {
                return $type;
            }
        }

        return null;
    }

    /**
     * Get update content
     *
     * @return \Longman\TelegramBot\Entities\CallbackQuery
     *         |\Longman\TelegramBot\Entities\ChosenInlineResult
     *         |\Longman\TelegramBot\Entities\InlineQuery
     *         |\Longman\TelegramBot\Entities\Message
     */
    public function getUpdateContent()
    {
        if ($update_type = $this->getUpdateType()) {
            // Instead of just getting the property as an array,
            // use the __call method to get the correct Entity object.
            $method = 'get' . str_replace('_', '', ucwords($update_type, '_'));

            return $this->$method();
        }

        return null;
    }
}