unreal4u\TelegramAPI\Telegram\Methods\RestrictChatMember

Complexity

Total Complexity

2

Size/Duplication

Total Lines	60
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	3

Test Coverage

Coverage

0%

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	bindToObject()	0	4	1
A	getMandatoryFields()	0	7	1

<?php

declare(strict_types = 1);

namespace unreal4u\TelegramAPI\Telegram\Methods;

use Psr\Log\LoggerInterface;
use unreal4u\TelegramAPI\Abstracts\TelegramMethods;
use unreal4u\TelegramAPI\Abstracts\TelegramTypes;
use unreal4u\TelegramAPI\InternalFunctionality\TelegramRawData;
use unreal4u\TelegramAPI\Telegram\Types\Custom\ResultBoolean;

/**
 * Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to
 * work and must have the appropriate admin rights. Pass True for all boolean parameters to lift restrictions from a
 * user. Returns True on success
 *
 * Objects defined as-is july 2017
 *
 * @see https://core.telegram.org/bots/api#restrictchatmember
 */
class RestrictChatMember extends TelegramMethods
{
    /**
     * Unique identifier for the target chat or username of the target supergroup or channel (in the format
     * @channelusername)
     * @var string
     */
    public $chat_id = '';

    /**
     * Unique identifier of the target user
     * @var int
     */
    public $user_id = 0;

    /**
     * Date when restrictions will be lifted for the user, unix time. If user is restricted for more than 366 days or
     * less than 30 seconds from the current time, they are considered to be restricted forever
     * @var int
     */
    public $until_date = 0;

    /**
     * Pass True, if the user can send text messages, contacts, locations and venues
     * @var bool
     */
    public $can_send_messages = false;

    /**
     * Pass 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;

    /**
     * Pass 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;

    /**
     * Pass True, if the user may add web page previews to their messages, implies can_send_media_messages
     * @var bool
     */
    public $can_add_web_page_previews = false;

    public static function bindToObject(TelegramRawData $data, LoggerInterface $logger): TelegramTypes
    {
        return new ResultBoolean($data->getResultBoolean(), $logger);
    }

    public function getMandatoryFields(): array
    {
        return [
            'chat_id',
            'user_id',
        ];
    }
}