From 41c1d0fc4c661875df866f941a0b12f7b49f9a9b Mon Sep 17 00:00:00 2001 From: Netkas Date: Sun, 23 Apr 2023 18:58:24 -0400 Subject: [PATCH] Added object `\TgBotLib\Objects\Telegram\InlineQueryResult\InlineQueryResultVideo`, see [InlineQueryResultVideo](https://core.telegram.org/bots/api#inlinequeryresultvideo) for more information. https://git.n64.cc/nosial/libs/tgbot/-/issues/3 --- CHANGELOG.md | 1 + .../InlineQueryResultVideo.php | 303 ++++++++++++++++++ 2 files changed, 304 insertions(+) create mode 100644 src/TgBotLib/Objects/Telegram/InlineQueryResult/InlineQueryResultVideo.php diff --git a/CHANGELOG.md b/CHANGELOG.md index 4ac8f18..2b3c24d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -23,6 +23,7 @@ input objects for methods that require input objects. * Added abstract class `\TgBotLib\Abstracts\ThumbnailMimeType` to represent the mime type of thumbnail, photo, or a file / sticker thumbnail. * Added object `\TgBotLib\Objects\Telegram\InlineQueryResult\InlineQueryResultMpeg4Gif`, see [InlineQueryResultMpeg4Gif](https://core.telegram.org/bots/api#inlinequeryresultmpeg4gif) for more information. * Added field `via_chat_folder_invite_link` to `\TgBotLib\Objects\Telegram\ChatMemberUpdated` to represent the invite link, which was used by the user to join the chat; for joining by invite link events only. + * Added object `\TgBotLib\Objects\Telegram\InlineQueryResult\InlineQueryResultVideo`, see [InlineQueryResultVideo](https://core.telegram.org/bots/api#inlinequeryresultvideo) for more information. ### Changed * Refactored InputMessageContent types to its own namespace so InputMessageContent can always return the correct InputMessageContent object type when calling `fromArray()` diff --git a/src/TgBotLib/Objects/Telegram/InlineQueryResult/InlineQueryResultVideo.php b/src/TgBotLib/Objects/Telegram/InlineQueryResult/InlineQueryResultVideo.php new file mode 100644 index 0000000..d273538 --- /dev/null +++ b/src/TgBotLib/Objects/Telegram/InlineQueryResult/InlineQueryResultVideo.php @@ -0,0 +1,303 @@ +type; + } + + /** + * Unique identifier for this result, 1-64 bytes + * + * @return string + */ + public function getId(): string + { + return $this->id; + } + + /** + * A valid URL for the embedded video player or video file + * + * @return string + */ + public function getVideoUrl(): string + { + return $this->video_url; + } + + /** + * MIME type of the content of the video URL, “text/html” or “video/mp4” + * + * @return string + */ + public function getMimeType(): string + { + return $this->mime_type; + } + + /** + * URL of the thumbnail (JPEG only) for the video + * + * @return string + */ + public function getThumbnailUrl(): string + { + return $this->thumbnail_url; + } + + /** + * Title for the result + * + * @return string + */ + public function getTitle(): string + { + return $this->title; + } + + /** + * Optional. Caption of the video to be sent, 0-1024 characters after entities parsing + * + * @return string|null + */ + public function getCaption(): ?string + { + return $this->caption; + } + + /** + * Optional. Mode for parsing entities in the video caption. See formatting options for more details. + * + * @return string|null + */ + public function getParseMode(): ?string + { + return $this->parse_mode; + } + + /** + * Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode + * + * @return MessageEntity[]|null + */ + public function getCaptionEntities(): ?array + { + return $this->caption_entities; + } + + /** + * Optional. Video width + * + * @return int|null + */ + public function getVideoWidth(): ?int + { + return $this->video_width; + } + + /** + * Optional. Video height + * + * @return int|null + */ + public function getVideoHeight(): ?int + { + return $this->video_height; + } + + /** + * Optional. Video duration in seconds + * + * @return int|null + */ + public function getVideoDuration(): ?int + { + return $this->video_duration; + } + + /** + * Optional. Short description of the result + * + * @return string|null + */ + public function getDescription(): ?string + { + return $this->description; + } + + /** + * Optional. Inline keyboard attached to the message + * + * @return InlineKeyboardMarkup|null + */ + public function getReplyMarkup(): ?InlineKeyboardMarkup + { + return $this->reply_markup; + } + + /** + * Optional. Content of the message to be sent instead of the video. This field is required if + * InlineQueryResultVideo is used to send an HTML-page as a result (e.g., a YouTube video). + * + * @return InputContactMessageContent|InputInvoiceMessageContent|InputLocationMessageContent|InputTextMessageContent|InputVenueMessageContent|null + */ + public function getInputMessageContent(): InputVenueMessageContent|InputTextMessageContent|InputContactMessageContent|InputLocationMessageContent|InputInvoiceMessageContent|null + { + return $this->input_message_content; + } + + /** + * Returns an array representation of the object + * + * @return array + */ + public function toArray(): array + { + return [ + 'type' => $this->type, + 'id' => $this->id, + 'video_url' => $this->video_url, + 'mime_type' => $this->mime_type, + 'thumbnail_url' => $this->thumbnail_url, + 'title' => $this->title, + 'caption' => $this->caption, + 'parse_mode' => $this->parse_mode, + 'caption_entities' => ($this->caption_entities ?? null) ? array_map(function (MessageEntity $item) { + return $item->toArray(); + }, $this->caption_entities) : null, + 'video_width' => $this->video_width, + 'video_height' => $this->video_height, + 'video_duration' => $this->video_duration, + 'description' => $this->description, + 'reply_markup' => ($this->reply_markup ?? null) ? $this->reply_markup->toArray() : null, + 'input_message_content' => $this->input_message_content, + ]; + } + + /** + * Constructs object from an array representation + * + * @param array $data + * @return ObjectTypeInterface + */ + public static function fromArray(array $data): ObjectTypeInterface + { + $object = new self(); + + $object->type = $data['type'] ?? null; + $object->id = $data['id'] ?? null; + $object->video_url = $data['video_url'] ?? null; + $object->mime_type = $data['mime_type'] ?? null; + $object->thumbnail_url = $data['thumbnail_url'] ?? null; + $object->title = $data['title'] ?? null; + $object->caption = $data['caption'] ?? null; + $object->parse_mode = $data['parse_mode'] ?? null; + $object->caption_entities = isset($data['caption_entities']) ? array_map(function ($item) { + return MessageEntity::fromArray($item); + }, $data['caption_entities']) : null; + $object->video_width = $data['video_width'] ?? null; + $object->video_height = $data['video_height'] ?? null; + $object->video_duration = $data['video_duration'] ?? null; + $object->description = $data['description'] ?? null; + $object->reply_markup = isset($data['reply_markup']) ? InlineKeyboardMarkup::fromArray($data['reply_markup']) : null; + $object->input_message_content = isset($data['input_message_content']) ? InputMessageContent::fromArray($data['input_message_content']) : null; + + return $object; + } + } \ No newline at end of file