LinkPreviewOptions
extends TelegramObject
in package
Describes the options used for link preview generation.
Source: https://core.telegram.org/bots/api#linkpreviewoptions
Table of Contents
Properties
- $bot : Bot|null
- $isDisabled : bool|BotDefault|null
- $preferLargeMedia : bool|BotDefault|null
- $preferSmallMedia : bool|BotDefault|null
- $showAboveText : bool|BotDefault|null
- $url : string|null
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
$isDisabled read-only
public
bool|BotDefault|null
$isDisabled
= new BotDefault('link_preview_is_disabled')
$preferLargeMedia read-only
public
bool|BotDefault|null
$preferLargeMedia
= new BotDefault('link_preview_prefer_large_media')
$preferSmallMedia read-only
public
bool|BotDefault|null
$preferSmallMedia
= new BotDefault('link_preview_prefer_small_media')
$showAboveText read-only
public
bool|BotDefault|null
$showAboveText
= new BotDefault('link_preview_show_above_text')
$url read-only
public
string|null
$url
= null
Methods
__construct()
public
__construct([bool|BotDefault|null $isDisabled = new BotDefault('link_preview_is_disabled') ][, string|null $url = null ][, bool|BotDefault|null $preferSmallMedia = new BotDefault('link_preview_prefer_small_media') ][, bool|BotDefault|null $preferLargeMedia = new BotDefault('link_preview_prefer_large_media') ][, bool|BotDefault|null $showAboveText = new BotDefault('link_preview_show_above_text') ][, Bot|null $bot = null ]) : mixed
Parameters
- $isDisabled : bool|BotDefault|null = new BotDefault('link_preview_is_disabled')
- $url : string|null = null
- $preferSmallMedia : bool|BotDefault|null = new BotDefault('link_preview_prefer_small_media')
- $preferLargeMedia : bool|BotDefault|null = new BotDefault('link_preview_prefer_large_media')
- $showAboveText : bool|BotDefault|null = new BotDefault('link_preview_show_above_text')
- $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