TelegramBot\Api\Types\ForceReply

Complexity

Total Complexity

7

Size/Duplication

Total Lines	105
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	setInputFieldPlaceholder()	0	3	1
A	isForceReply()	0	3	1
A	isSelective()	0	3	1
A	setForceReply()	0	3	1
A	setSelective()	0	3	1
A	getInputFieldPlaceholder()	0	3	1
A	__construct()	0	5	1

<?php

namespace TelegramBot\Api\Types;

use TelegramBot\Api\BaseType;

/**
 * Class ForceReply
 * Upon receiving a message with this object, Telegram clients will display a reply interface to the user
 * (act as if the user has selected the bot‘s message and tapped ’Reply').This can be extremely useful
 * if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode.
 *
 * @package TelegramBot\Api\Types
 */
class ForceReply extends BaseType
{
    /**
     * {@inheritdoc}
     *
     * @var array
     */
    protected static $requiredParams = ['force_reply'];

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

    /**
     * Shows reply interface to the user, as if they manually selected the bot‘s message and tapped ’Reply'
     *
     * @var bool
     */
    protected $forceReply;

    /**
     * The placeholder to be shown in the input field when the reply is active; 1-64 characters
     *
     * @var string|null
     */
    protected $inputFieldPlaceholder;

    /**
     * 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 $forceReply
     * @param bool|null $selective
     * @param string|null $inputFieldPlaceholder
     */
    public function __construct($forceReply = true, $selective = null, $inputFieldPlaceholder = null)
    {
        $this->forceReply = $forceReply;
        $this->selective = $selective;
        $this->inputFieldPlaceholder = $inputFieldPlaceholder;
    }

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

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

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

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

    /**
     * @param string|null $inputFieldPlaceholder
     * @return void
     */
    public function setInputFieldPlaceholder($inputFieldPlaceholder)
    {
        $this->inputFieldPlaceholder = $inputFieldPlaceholder;
    }

    /**
     * @return string|null
     */
    public function getInputFieldPlaceholder()
    {
        return $this->inputFieldPlaceholder;
    }
}