TgBotApi\BotApiBase\Method\GetUpdatesMethod

Complexity

Total Complexity

2

Size/Duplication

Total Lines	61
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	create()	0	8	2

<?php

declare(strict_types=1);

namespace TgBotApi\BotApiBase\Method;

use TgBotApi\BotApiBase\Method\Interfaces\HasUpdateTypeVariableInterface;
use TgBotApi\BotApiBase\Method\Interfaces\MethodInterface;
use TgBotApi\BotApiBase\Method\Traits\FillFromArrayTrait;

/**
 * Class GetUpdatesMethod.
 *
 * @see https://core.telegram.org/bots/api#getupdates
 */
class GetUpdatesMethod implements HasUpdateTypeVariableInterface, MethodInterface
{
    use FillFromArrayTrait;

    /**
     * Optional. Identifier of the first update to be returned.
     * Must be greater by one than the highest among the identifiers of previously received updates.
     * By default, updates starting with the earliest unconfirmed update are returned.
     * An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id.
     * The negative offset can be specified to retrieve updates starting from -offset update
     * from the end of the updates queue. All previous updates will forgotten.
     *
     * @var int|null
     */
    public $offset;

    /**
     * Optional. Limits the number of updates to be retrieved. Values between 1—100 are accepted. Defaults to 100.
     *
     * @var int|null
     */
    public $limit;

    /**
     * Optional. Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling.
     * Should be positive, short polling should be used for testing purposes only.
     *
     * @var int|null
     */
    public $timeout;

    /**
     * Optional. List the types of updates you want your bot to receive.
     * For example, specify [“message”, “edited_channel_post”, “callback_query”]
     * to only receive updates of these types.
     * See Update for a complete list of available update types.
     * Specify an empty list to receive all updates regardless of type (default).
     * If not specified, the previous setting will be used.
     *
     * Please note that this parameter doesn't affect updates created before the call to the getUpdates,
     * so unwanted updates may be received for a short period of time.
     *
     * @var string[]|null
     */
    public $allowedUpdates;

    /**
     * @param array|null $data
     *
     * @throws \TgBotApi\BotApiBase\Exception\BadArgumentException
     *
     * @return GetUpdatesMethod
     */
    public static function create(array $data = null): GetUpdatesMethod
    {
        $instance = new static();
        if ($data) {
            $instance->fill($data);
        }

        return $instance;
    }
}