phpbotgram

Sticker extends TelegramObject
in package

FinalYes

This object represents a sticker.

Source: https://core.telegram.org/bots/api#sticker

Table of Contents

Properties

$bot  : Bot|null
$customEmojiId  : string|null
$emoji  : string|null
$fileId  : string
$fileSize  : int|null
$fileUniqueId  : string
$height  : int
$isAnimated  : bool
$isVideo  : bool
$maskPosition  : MaskPosition|null
$needsRepainting  : bool|null
$premiumAnimation  : File|null
$setName  : string|null
$thumbnail  : PhotoSize|null
$type  : string
$width  : int

Methods

__construct()  : mixed
as_()  : static
Alias of withBot() for grep-translating aiogram code that uses obj.as_(bot).
deleteFromSet()  : DeleteStickerFromSet
setPositionInSet()  : SetStickerPositionInSet
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

$customEmojiId read-only

public string|null $customEmojiId = null

$emoji read-only

public string|null $emoji = null

$fileId read-only

public string $fileId

$fileSize read-only

public int|null $fileSize = null

$fileUniqueId read-only

public string $fileUniqueId

$height read-only

public int $height

$isAnimated read-only

public bool $isAnimated

$isVideo read-only

public bool $isVideo

$needsRepainting read-only

public bool|null $needsRepainting = null

$premiumAnimation read-only

public File|null $premiumAnimation = null

$setName read-only

public string|null $setName = null

Methods

__construct()

public __construct(string $fileId, string $fileUniqueId, string $type, int $width, int $height, bool $isAnimated, bool $isVideo[, PhotoSize|null $thumbnail = null ][, string|null $emoji = null ][, string|null $setName = null ][, File|null $premiumAnimation = null ][, MaskPosition|null $maskPosition = null ][, string|null $customEmojiId = null ][, bool|null $needsRepainting = null ][, int|null $fileSize = null ][, Bot|null $bot = null ]) : mixed
Parameters
$fileId : string
$fileUniqueId : string
$type : string
$width : int
$height : int
$isAnimated : bool
$isVideo : bool
$thumbnail : PhotoSize|null = null
$emoji : string|null = null
$setName : string|null = null
$premiumAnimation : File|null = null
$maskPosition : MaskPosition|null = null
$customEmojiId : string|null = null
$needsRepainting : bool|null = null
$fileSize : int|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
static

withBot()

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
Return values
static
On this page

Search results