InputMediaDocument
extends InputMedia
in package
implements
InputPollMediaInterface
Represents a general file to be sent.
Source: https://core.telegram.org/bots/api#inputmediadocument
Table of Contents
Interfaces
- InputPollMediaInterface
- Marker interface for the {@see InputPollMedia} union.
Properties
- $bot : Bot|null
- $caption : string|null
- $captionEntities : array<string|int, mixed>|null
- $disableContentTypeDetection : bool|null
- $media : InputFile|string
- $parseMode : BotDefault|string|null
- $thumbnail : InputFile|null
- $type : string
Methods
- __construct() : mixed
- as_() : static
- Alias of withBot() for grep-translating aiogram code that uses obj.as_(bot).
- withBot() : static
- Returns a clone of $this with $bot rebound recursively. Walks every public property; nested `BotContextController` instances are rebound via their own `withBot`, arrays (including nested arrays of arbitrary depth — e.g.
Properties
$bot read-only
public
Bot|null
$bot
= null
$caption read-only
public
string|null
$caption
= null
$captionEntities read-only
public
array<string|int, mixed>|null
$captionEntities
= null
$disableContentTypeDetection read-only
public
bool|null
$disableContentTypeDetection
= null
$media read-only
public
InputFile|string
$media
$parseMode read-only
public
BotDefault|string|null
$parseMode
= new BotDefault('parse_mode')
$thumbnail read-only
public
InputFile|null
$thumbnail
= null
$type read-only
public
string
$type
= 'document'
Methods
__construct()
public
__construct(InputFile|string $media[, string $type = 'document' ][, InputFile|null $thumbnail = null ][, string|null $caption = null ][, BotDefault|string|null $parseMode = new BotDefault('parse_mode') ][, null|array<int, MessageEntity> $captionEntities = null ][, bool|null $disableContentTypeDetection = null ][, Bot|null $bot = null ]) : mixed
Parameters
- $media : InputFile|string
- $type : string = 'document'
- $thumbnail : InputFile|null = null
- $caption : string|null = null
- $parseMode : BotDefault|string|null = new BotDefault('parse_mode')
- $captionEntities : null|array<int, MessageEntity> = null
- $disableContentTypeDetection : bool|null = null
- $bot : Bot|null = null
as_()
Alias of withBot() for grep-translating aiogram code that uses obj.as_(bot).
public
as_(Bot|null $bot) : static
IMPORTANT: behaves DIFFERENTLY from upstream — upstream mutates self.bot in place and returns self. The PHP port can't mutate readonly, so this returns a clone. Callers must reassign: $msg = $msg->as($bot).
Parameters
- $bot : Bot|null
Return values
staticwithBot()
Returns a clone of $this with $bot rebound recursively. Walks every public property; nested `BotContextController` instances are rebound via their own `withBot`, arrays (including nested arrays of arbitrary depth — e.g.
public
withBot(Bot|null $bot) : static
list<list<KeyboardButton>>) are walked element-wise. Plain values
(scalars, DateTime, enums, InputFile etc.) pass through untouched.
Mirrors upstream pydantic model_validate(context={"bot": bot}) (aiogram
ContextController.as_/model_dump_json+model_validate).
Scope note: PHP 8.5 treats public readonly as effectively
public protected(set) readonly for clone-with — only code running with
a scope in the property's declaring class hierarchy (declaring class plus
its ancestors and descendants) can use clone($obj, ['x' => ...]) against
it. Because this method lives on BotContextController and every
TelegramObject/TelegramMethod subclass extends it, the walker's
clone($this, [...]) call legally rewrites subclass-declared readonly
slots like Message::$chat. External callers cannot use the same syntax
— they must funnel through this method.
Parameters
- $bot : Bot|null