diff --git a/CHANGELOG.md b/CHANGELOG.md index 1ec669d..9a4db30 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -19,6 +19,7 @@ input objects for methods that require input objects. * Added new exception class `NotImplementedException` to represent the case when a method is not implemented yet or the method is not applicable to the current object. * Added object `\TgBotLib\Objects\Telegram\InlineQueryResult\InlineQueryResultArticle`, see [InlineQueryResultArticle](https://core.telegram.org/bots/api#inlinequeryresultarticle) for more information. * Added object `\TgBotLib\Objects\Telegram\InlineQueryResult\InlineQueryResultPhoto`, see [InlineQueryResultPhoto](https://core.telegram.org/bots/api#inlinequeryresultphoto) for more information. + * Added object `\TgBotLib\Objects\Telegram\InlineQueryResult\InlineQueryResultGif`, see [InlineQueryResultGif](https://core.telegram.org/bots/api#inlinequeryresultgif) 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/InlineQueryResultGif.php b/src/TgBotLib/Objects/Telegram/InlineQueryResult/InlineQueryResultGif.php new file mode 100644 index 0000000..5840569 --- /dev/null +++ b/src/TgBotLib/Objects/Telegram/InlineQueryResult/InlineQueryResultGif.php @@ -0,0 +1,336 @@ +type; + } + + /** + * Unique identifier for this result, 1-64 bytes + * + * @return string + */ + public function getId(): string + { + return $this->id; + } + + /** + * A valid URL for the GIF file. File size must not exceed 1MB + * + * @return string + */ + public function getGifUrl(): string + { + return $this->gif_url; + } + + /** + * Optional. Width of the GIF + * + * @return int|null + */ + public function getGifWidth(): ?int + { + return $this->gif_width; + } + + /** + * Optional. Height of the GIF + * + * @return int|null + */ + public function getGifHeight(): ?int + { + return $this->gif_height; + } + + /** + * Optional. Duration of the GIF in seconds + * + * @return int|null + */ + public function getGifDuration(): ?int + { + return $this->gif_duration; + } + + /** + * URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result + * + * @return string|null + */ + public function getThumbnailUrl(): ?string + { + return $this->thumbnail_url; + } + + /** + * Optional. MIME type of the thumbnail, must be one of “image/jpeg”, “image/gif”, or “video/mp4”. Defaults to “image/jpeg” + * + * @return string|null + */ + public function getThumbnailMimeType(): ?string + { + return $this->thumbnail_mime_type; + } + + /** + * Optional. Title for the result + * + * @return string|null + */ + public function getTitle(): ?string + { + return $this->title; + } + + /** + * Optional. Caption of the GIF file 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 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. 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 GIF animation + * + * @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 ?? null, + 'id' => $this->id ?? null, + 'gif_url' => $this->gif_url ?? null, + 'gif_width' => $this->gif_width ?? null, + 'gif_height' => $this->gif_height ?? null, + 'gif_duration' => $this->gif_duration ?? null, + 'thumbnail_url' => $this->thumbnail_url ?? null, + 'thumbnail_mime_type' => $this->thumbnail_mime_type ?? null, + 'title' => $this->title ?? null, + 'caption' => $this->caption ?? null, + 'parse_mode' => $this->parse_mode ?? null, + 'caption_entities' => (function (array $captionEntities) + { + $result = []; + foreach($captionEntities as $captionEntity) + { + $result[] = $captionEntity->toArray(); + } + return $result; + + })($this->caption_entities ?? []), + 'reply_markup' => (function (InlineKeyboardMarkup|null $replyMarkup) + { + if($replyMarkup !== null) + { + return $replyMarkup->toArray(); + } + + return null; + })($this->reply_markup ?? null), + 'input_message_content' => (function (ObjectTypeInterface|null $inputMessageContent) + { + if($inputMessageContent !== null) + { + return $inputMessageContent->toArray(); + } + + return null; + + })($this->input_message_content ?? null), + ]; + } + + /** + * 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->gif_url = $data['gif_url'] ?? null; + $object->gif_width = $data['gif_width'] ?? null; + $object->gif_height = $data['gif_height'] ?? null; + $object->gif_duration = $data['gif_duration'] ?? null; + $object->thumbnail_url = $data['thumbnail_url'] ?? null; + $object->thumbnail_mime_type = $data['thumbnail_mime_type'] ?? null; + $object->title = $data['title'] ?? null; + $object->caption = $data['caption'] ?? null; + $object->parse_mode = $data['parse_mode'] ?? null; + $object->caption_entities = (function (array $captionEntities) + { + $result = []; + foreach($captionEntities as $captionEntity) + { + $result[] = MessageEntity::fromArray($captionEntity); + } + return $result; + + })($data['caption_entities'] ?? []); + $object->reply_markup = (function (array|null $replyMarkup) + { + if($replyMarkup !== null) + { + return InlineKeyboardMarkup::fromArray($replyMarkup); + } + + return null; + })($data['reply_markup'] ?? null); + $object->input_message_content = (function (array|null $inputMessageContent) + { + if($inputMessageContent !== null) + { + return InputVenueMessageContent::fromArray($inputMessageContent); + } + + return null; + + })($data['input_message_content'] ?? null); + + return $object; + } + } \ No newline at end of file