TelegramBot\Entities\KeyboardButton

Complexity

Total Complexity

10

Size/Duplication

Total Lines	80
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	make()	0	3	1
A	couldBe()	0	3	1
A	subEntities()	0	5	1
A	WebApp()	0	5	1
A	validate()	0	4	2
A	__construct()	0	7	2
A	__call()	0	7	2

<?php


namespace TelegramBot\Entities;

use TelegramBot\Entity;
use TelegramBot\Exception\TelegramException;

/**
 * Class KeyboardButton
 *
 * This object represents one button of the reply keyboard. For simple text buttons String can be used instead of this object to specify text of the button. Optional fields request_contact, request_location, and request_poll are mutually exclusive.
 *
 * @link https://core.telegram.org/bots/api#keyboardbutton
 *
 * @property bool $request_contact
 * @property bool $request_location
 * @property KeyboardButtonPollType $request_poll
 * @property WebAppInfo $web_app
 *
 *
 * @method string                 getText()            	Text of the button. If none of the optional fields are used, it will be sent to the bot as a message when the button is pressed
 * @method bool                   getRequestContact()  	Optional. If True, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only
 * @method bool                   getRequestLocation() 	Optional. If True, the user's current location will be sent when the button is pressed. Available in private chats only
 * @method KeyboardButtonPollType getRequestPoll()     	Optional. If specified, the user will be asked to create a poll and send it to the bot when the button is pressed. Available in private chats only
 * @method WebAppInfo             getWebApp()          	Optional. If specified, the described Web App will be launched when the button is pressed. The Web App will be able to send a “web_app_data” service message. Available in private chats only.
 *
 * @method $this setText(string $text)                                	Text of the button. If none of the optional fields are used, it will be sent to the bot as a message when the button is pressed
 * @method $this setRequestContact(bool $request_contact)             	Optional. If True, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only
 * @method $this setRequestLocation(bool $request_location)           	Optional. If True, the user's current location will be sent when the button is pressed. Available in private chats only
 * @method $this setRequestPoll(KeyboardButtonPollType $request_poll) 	Optional. If specified, the user will be asked to create a poll and send it to the bot when the button is pressed. Available in private chats only
 * @method $this setWebApp(WebAppInfo $web_app)                       	Optional. If specified, the described Web App will be launched when the button is pressed. The Web App will be able to send a “web_app_data” service message. Available in private chats only.
 */
class KeyboardButton extends Entity
{

	/**
	 * @param array|string $data
	 */
	public function __construct($data)
	{
		if (is_string($data)) {
			$data = ['text' => $data];
		}

		parent::__construct($data);
	}

	/**
	 * Creates instance of KeyboardButton
	 *
	 * @param string $string
	 * @return KeyboardButton
	 */
	public static function make(string $string): KeyboardButton
	{
		return new self($string);
	}

	/**
	 * @param string $url
	 * @return $this
	 */
	public function WebApp(string $url): KeyboardButton
	{
		$this->raw_data['web_app'] = new WebAppInfo(['url' => $url]);

		return $this;
	}

	/**
	 * @inheritDoc
	 */
	protected function subEntities(): array
	{
		return [
			'request_poll' => KeyboardButtonPollType::class,
			'web_app' => WebAppInfo::class,
		];
	}

	/**
	 * Check if the passed data array could be a KeyboardButton.
	 *
	 * @param array $data
	 *
	 * @return bool
	 */
	public static function couldBe(array $data): bool
	{
		return array_key_exists('text', $data);
	}

	/**
	 * {@inheritdoc}
	 */
	protected function validate(): void
	{
		if ($this->getProperty('text', '') === '') {
			throw new TelegramException('You must add some text to the button!');
		}
	}

	/**
	 * {@inheritdoc}
	 */
	public function __call(string $name, array $arguments): mixed
	{
		if (in_array($name, ['setRequestContact', 'setRequestLocation', 'setRequestPoll', 'setWebApp'], true)) {
			unset($this->request_contact, $this->request_location, $this->request_poll, $this->web_app);
		}

		return parent::__call($name, $arguments);
	}

}