2023-02-13 14:26:51 -05:00
|
|
|
<?php
|
|
|
|
|
|
|
|
|
2024-10-02 00:18:12 -04:00
|
|
|
namespace TgBotLib\Objects;
|
2023-02-13 14:26:51 -05:00
|
|
|
|
|
|
|
use TgBotLib\Interfaces\ObjectTypeInterface;
|
|
|
|
|
|
|
|
class CallbackQuery implements ObjectTypeInterface
|
|
|
|
{
|
2024-10-04 12:14:23 -04:00
|
|
|
private string $id;
|
|
|
|
private User $from;
|
|
|
|
private ?Message $message;
|
|
|
|
private ?string $inline_message_id;
|
|
|
|
private string $chat_instance;
|
|
|
|
private ?string $data;
|
|
|
|
private ?string $game_short_name;
|
2023-02-13 14:26:51 -05:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Unique identifier for this query
|
|
|
|
*
|
|
|
|
* @return string
|
|
|
|
*/
|
|
|
|
public function getId(): string
|
|
|
|
{
|
|
|
|
return $this->id;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Sender
|
|
|
|
*
|
|
|
|
* @return User
|
|
|
|
*/
|
|
|
|
public function getFrom(): User
|
|
|
|
{
|
|
|
|
return $this->from;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Optional. Message with the callback button that originated the query. Note that message content and message
|
|
|
|
* date will not be available if the message is too old
|
|
|
|
*
|
|
|
|
* @return Message|null
|
|
|
|
*/
|
|
|
|
public function getMessage(): ?Message
|
|
|
|
{
|
|
|
|
return $this->message;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Optional. Identifier of the message sent via the bot in inline mode, that originated the query.
|
|
|
|
*
|
|
|
|
* @return string|null
|
|
|
|
*/
|
|
|
|
public function getInlineMessageId(): ?string
|
|
|
|
{
|
|
|
|
return $this->inline_message_id;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent.
|
|
|
|
* Useful for high scores in games.
|
|
|
|
*
|
|
|
|
* @see https://core.telegram.org/bots/api#games
|
|
|
|
* @return string
|
|
|
|
*/
|
|
|
|
public function getChatInstance(): string
|
|
|
|
{
|
|
|
|
return $this->chat_instance;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Optional. Data associated with the callback button. Be aware that the message originated the query
|
|
|
|
* can contain no callback buttons with this data.
|
|
|
|
*
|
|
|
|
* @return string|null
|
|
|
|
*/
|
|
|
|
public function getData(): ?string
|
|
|
|
{
|
|
|
|
return $this->data;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Optional. Short name of a Game to be returned, serves as the unique identifier for the game
|
|
|
|
*
|
|
|
|
* @see https://core.telegram.org/bots/api#games
|
|
|
|
* @return string|null
|
|
|
|
*/
|
|
|
|
public function getGameShortName(): ?string
|
|
|
|
{
|
|
|
|
return $this->game_short_name;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2024-10-04 12:14:23 -04:00
|
|
|
* @inheritDoc
|
2023-02-13 14:26:51 -05:00
|
|
|
*/
|
|
|
|
public function toArray(): array
|
|
|
|
{
|
|
|
|
return [
|
|
|
|
'id' => $this->id,
|
2024-10-04 12:14:23 -04:00
|
|
|
'from' => $this->from?->toArray(),
|
|
|
|
'message' => $this->message?->toArray(),
|
2023-02-13 14:26:51 -05:00
|
|
|
'inline_message_id' => $this->inline_message_id,
|
|
|
|
'chat_instance' => $this->chat_instance,
|
|
|
|
'data' => $this->data,
|
|
|
|
'game_short_name' => $this->game_short_name,
|
|
|
|
];
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2024-10-04 12:14:23 -04:00
|
|
|
* @inheritDoc
|
2023-02-13 14:26:51 -05:00
|
|
|
*/
|
2024-10-04 12:14:23 -04:00
|
|
|
public static function fromArray(?array $data): ?CallbackQuery
|
2023-02-13 14:26:51 -05:00
|
|
|
{
|
2024-10-04 12:14:23 -04:00
|
|
|
if($data === null)
|
|
|
|
{
|
|
|
|
return null;
|
|
|
|
}
|
2023-02-13 14:26:51 -05:00
|
|
|
|
2024-10-04 12:14:23 -04:00
|
|
|
$object = new self();
|
2023-02-14 17:35:16 -05:00
|
|
|
$object->id = $data['id'] ?? null;
|
2023-02-13 14:26:51 -05:00
|
|
|
$object->from = isset($data['from']) ? User::fromArray($data['from']) : null;
|
|
|
|
$object->message = isset($data['message']) ? Message::fromArray($data['message']) : null;
|
|
|
|
$object->inline_message_id = $data['inline_message_id'] ?? null;
|
2023-02-14 17:35:16 -05:00
|
|
|
$object->chat_instance = $data['chat_instance'] ?? null;
|
2023-02-13 14:26:51 -05:00
|
|
|
$object->data = $data['data'] ?? null;
|
|
|
|
$object->game_short_name = $data['game_short_name'] ?? null;
|
|
|
|
|
|
|
|
return $object;
|
|
|
|
}
|
|
|
|
}
|