Added \TgBotLib\Objects > KeyboardButton

This commit is contained in:
Netkas 2023-02-12 23:01:23 -05:00
parent 7e33111a05
commit e14dbb30bc

View file

@ -0,0 +1,162 @@
<?php
/** @noinspection PhpMissingFieldTypeInspection */
namespace TgBotLib\Objects;
use TgBotLib\Interfaces\ObjectTypeInterface;
class KeyboardButton implements ObjectTypeInterface
{
/**
* @var string
*/
private $text;
/**
* @var KeyboardButtonRequestUser|null
*/
private $request_user;
/**
* @var KeyboardButtonRequestChat|null
*/
private $request_chat;
/**
* @var bool
*/
private $request_contact;
/**
* @var bool
*/
private $request_location;
/**
* @var KeyboardButtonPollType|null
*/
private $request_poll;
/**
* @var WebAppInfo|null
*/
private $web_app;
/**
* Text of the button. If none of the optional fields are used, it will be sent as a message when the
* button is pressed
*
* @return string
*/
public function getText(): string
{
return $this->text;
}
/**
* Optional. If specified, pressing the button will open a list of suitable users. Tapping on any user will
* send their identifier to the bot in a “user_shared” service message. Available in private chats only.
*
* @return KeyboardButtonRequestUser|null
*/
public function getRequestUser(): ?KeyboardButtonRequestUser
{
return $this->request_user;
}
/**
* Optional. If specified, pressing the button will open a list of suitable chats. Tapping on a chat will send
* its identifier to the bot in a “chat_shared” service message. Available in private chats only.
*
* @return KeyboardButtonRequestChat|null
*/
public function getRequestChat(): ?KeyboardButtonRequestChat
{
return $this->request_chat;
}
/**
* Optional. If True, the user's phone number will be sent as a contact when the button is pressed.
* Available in private chats only.
*
* @return bool
*/
public function isRequestContact(): bool
{
return $this->request_contact;
}
/**
* Optional. If True, the user's current location will be sent when the button is pressed.
* Available in private chats only.
*
* @return bool
*/
public function isRequestLocation(): bool
{
return $this->request_location;
}
/**
* 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.
*
* @return KeyboardButtonPollType|null
*/
public function getRequestPoll(): ?KeyboardButtonPollType
{
return $this->request_poll;
}
/**
* 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.
*
* @see https://core.telegram.org/bots/webapps
* @return WebAppInfo|null
*/
public function getWebApp(): ?WebAppInfo
{
return $this->web_app;
}
/**
* Returns an array representation of the object
*
* @return array
*/
public function toArray(): array
{
return [
'text' => $this->text,
'request_user' => ($this->request_user instanceof KeyboardButtonRequestUser) ? $this->request_user->toArray() : null,
'request_chat' => ($this->request_chat instanceof KeyboardButtonRequestChat) ? $this->request_chat->toArray() : null,
'request_contact' => $this->request_contact,
'request_location' => $this->request_location,
'request_poll' => ($this->request_poll instanceof KeyboardButtonPollType) ? $this->request_poll->toArray() : null,
'web_app' => ($this->web_app instanceof WebAppInfo) ? $this->web_app->toArray() : null,
];
}
/**
* Constructs object from an array representation
*
* @param array $data
* @return ObjectTypeInterface
*/
public static function fromArray(array $data): ObjectTypeInterface
{
$object = new self();
$object->text = $data['text'];
$object->request_user = isset($data['request_user']) ? KeyboardButtonRequestUser::fromArray($data['request_user']) : null;
$object->request_chat = isset($data['request_chat']) ? KeyboardButtonRequestChat::fromArray($data['request_chat']) : null;
$object->request_contact = $data['request_contact'];
$object->request_location = $data['request_location'];
$object->request_poll = isset($data['request_poll']) ? KeyboardButtonPollType::fromArray($data['request_poll']) : null;
$object->web_app = isset($data['web_app']) ? WebAppInfo::fromArray($data['web_app']) : null;
return $object;
}
}