179 lines
No EOL
5.7 KiB
PHP
179 lines
No EOL
5.7 KiB
PHP
<?php
|
|
|
|
|
|
namespace TgBotLib\Objects\InputMedia;
|
|
|
|
use TgBotLib\Enums\Types\ParseMode;
|
|
use TgBotLib\Interfaces\ObjectTypeInterface;
|
|
use TgBotLib\Objects\InputMedia;
|
|
use TgBotLib\Objects\MessageEntity;
|
|
|
|
class InputMediaVideo extends InputMedia implements ObjectTypeInterface
|
|
{
|
|
private string $media;
|
|
private ?string $thumb;
|
|
private ?string $caption;
|
|
private ?ParseMode $parse_mode;
|
|
/**
|
|
* @var MessageEntity[]|null
|
|
*/
|
|
private ?array $caption_entities;
|
|
private ?int $width;
|
|
private ?int $height;
|
|
private ?string $duration;
|
|
private bool $supports_streaming;
|
|
private bool $has_spoiler;
|
|
|
|
/**
|
|
* File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP
|
|
* URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one
|
|
* using multipart/form-data under <file_attach_name> name.
|
|
*
|
|
* @see https://core.telegram.org/bots/api#sending-files
|
|
* @return string
|
|
*/
|
|
public function getMedia(): string
|
|
{
|
|
return $this->media;
|
|
}
|
|
|
|
/**
|
|
* Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported
|
|
* server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and
|
|
* height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't
|
|
* be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the
|
|
* thumbnail was uploaded using multipart/form-data under <file_attach_name>.
|
|
*
|
|
* @see https://core.telegram.org/bots/api#sending-files
|
|
* @return string|null
|
|
*/
|
|
public function getThumb(): ?string
|
|
{
|
|
return $this->thumb;
|
|
}
|
|
|
|
/**
|
|
* 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 https://core.telegram.org/bots/api#formatting-options
|
|
* @return ParseMode|null
|
|
*/
|
|
public function getParseMode(): ?ParseMode
|
|
{
|
|
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 getWidth(): ?int
|
|
{
|
|
return $this->width;
|
|
}
|
|
|
|
/**
|
|
* Optional. Video height
|
|
*
|
|
* @return int|null
|
|
*/
|
|
public function getHeight(): ?int
|
|
{
|
|
return $this->height;
|
|
}
|
|
|
|
/**
|
|
* Optional. Video duration in seconds
|
|
*
|
|
* @return int|null
|
|
*/
|
|
public function getDuration(): ?int
|
|
{
|
|
return $this->duration;
|
|
}
|
|
|
|
/**
|
|
* Optional. Pass True if the uploaded video is suitable for streaming
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function supportsStreaming(): bool
|
|
{
|
|
return $this->supports_streaming;
|
|
}
|
|
|
|
/**
|
|
* Optional. Pass True if the video needs to be covered with a spoiler animation
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function hasSpoiler(): bool
|
|
{
|
|
return $this->has_spoiler;
|
|
}
|
|
|
|
/**
|
|
* Returns an array representation of the object.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function toArray(): array
|
|
{
|
|
return [
|
|
'type' => $this->type->value,
|
|
'media' => $this->media,
|
|
'thumb' => $this->thumb,
|
|
'caption' => $this->caption,
|
|
'parse_mode' => $this->parse_mode->value,
|
|
'caption_entities' => array_map(fn(MessageEntity $item) => $item->toArray(), $this->caption_entities),
|
|
'width' => $this->width,
|
|
'height' => $this->height,
|
|
'duration' => $this->duration,
|
|
'supports_streaming' => $this->supports_streaming,
|
|
'has_spoiler' => $this->has_spoiler,
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public static function fromArray(?array $data): InputMediaVideo
|
|
{
|
|
$object = new InputMediaVideo();
|
|
|
|
$object->type = $data['type'] ?? null;
|
|
$object->media = $data['media'] ?? null;
|
|
$object->thumb = $data['thumb'] ?? null;
|
|
$object->caption = $data['caption'] ?? null;
|
|
$object->parse_mode = $data['parse_mode'] ?? null;
|
|
$object->caption_entities = isset($data['caption_entities']) ? array_map(fn(array $items) => MessageEntity::fromArray($items), $data['caption_entities'] ?? []) : null;
|
|
$object->width = $data['width'] ?? null;
|
|
$object->height = $data['height'] ?? null;
|
|
$object->duration = $data['duration'] ?? null;
|
|
$object->supports_streaming = $data['supports_streaming'] ?? false;
|
|
$object->has_spoiler = $data['has_spoiler'] ?? false;
|
|
|
|
return $object;
|
|
}
|
|
} |