TelegramBot\Api\Types\ReplyKeyboardHide

Complexity

Total Complexity

5

Size/Duplication

Total Lines	78
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	isSelective()	0	3	1
A	setSelective()	0	3	1
A	isHideKeyboard()	0	3	1
A	setHideKeyboard()	0	3	1
A	__construct()	0	4	1

<?php

namespace TelegramBot\Api\Types;

use TelegramBot\Api\BaseType;

/**
 * @deprecated Use ReplyKeyboardRemove
 *
 * Class ReplyKeyboardHide
 * Upon receiving a message with this object, Telegram clients will hide the current custom keyboard
 * and display the default letter-keyboard. By default, custom keyboards are displayed
 * until a new keyboard is sent by a bot. An exception is made for one-time keyboards
 * that are hidden immediately after the user presses a button (see \TelegramBot\Api\Types\ReplyKeyboardMarkup).
 *
 * @package TelegramBot\Api\Types
 */
class ReplyKeyboardHide extends BaseType
{
    /**
     * {@inheritdoc}
     *
     * @var array
     */
    protected static $requiredParams = ['hide_keyboard'];

    /**
     * {@inheritdoc}
     *
     * @var array
     */
    protected static $map = [
        'hide_keyboard' => true,
        'selective' => true
    ];

    /**
     * Requests clients to hide the custom keyboard
     *
     * @var bool
     */
    protected $hideKeyboard;

    /**
     * Optional. Use this parameter if you want to show the keyboard to specific users only.
     * Targets:
     * 1) users that are @mentioned in the text of the Message object;
     * 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.
     *
     * @var bool|null
     */
    protected $selective;

    /**
     * @param bool $hideKeyboard
     * @param bool|null $selective
     */
    public function __construct($hideKeyboard = true, $selective = null)
    {
        $this->hideKeyboard = $hideKeyboard;
        $this->selective = $selective;
    }

    /**
     * @return bool
     */
    public function isHideKeyboard()
    {
        return $this->hideKeyboard;
    }

    /**
     * @param bool $hideKeyboard
     * @return void
     */
    public function setHideKeyboard($hideKeyboard)
    {
        $this->hideKeyboard = $hideKeyboard;
    }

    /**
     * @return bool|null
     */
    public function isSelective()
    {
        return $this->selective;
    }

    /**
     * @param bool $selective
     * @return void
     */
    public function setSelective($selective)
    {
        $this->selective = $selective;
    }
}