MessageEntity
extends MutableTelegramObject
in package
This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.
Source: https://core.telegram.org/bots/api#messageentity
Table of Contents
Properties
- $bot : Bot|null
- $customEmojiId : string|null
- $dateTimeFormat : string|null
- $language : string|null
- $length : int
- $offset : int
- $type : string
- $unixTime : int|null
- $url : string|null
- $user : User|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
$customEmojiId read-only
public
string|null
$customEmojiId
= null
$dateTimeFormat read-only
public
string|null
$dateTimeFormat
= null
$language read-only
public
string|null
$language
= null
$length read-only
public
int
$length
$offset read-only
public
int
$offset
$type read-only
public
string
$type
$unixTime read-only
public
int|null
$unixTime
= null
$url read-only
public
string|null
$url
= null
$user read-only
public
User|null
$user
= null
Methods
__construct()
public
__construct(string $type, int $offset, int $length[, string|null $url = null ][, User|null $user = null ][, string|null $language = null ][, string|null $customEmojiId = null ][, int|null $unixTime = null ][, string|null $dateTimeFormat = null ][, Bot|null $bot = null ]) : mixed
Parameters
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