phpbotgram

Gift extends TelegramObject
in package

FinalYes

This object represents a gift that can be sent by the bot.

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

Table of Contents

Properties

$background  : GiftBackground|null
$bot  : Bot|null
$hasColors  : bool|null
$id  : string
$isPremium  : bool|null
$personalRemainingCount  : int|null
$personalTotalCount  : int|null
$publisherChat  : Chat|null
$remainingCount  : int|null
$starCount  : int
$sticker  : Sticker
$totalCount  : int|null
$uniqueGiftVariantCount  : int|null
$upgradeStarCount  : int|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

$hasColors read-only

public bool|null $hasColors = null

$id read-only

public string $id

$isPremium read-only

public bool|null $isPremium = null

$personalRemainingCount read-only

public int|null $personalRemainingCount = null

$personalTotalCount read-only

public int|null $personalTotalCount = null

$publisherChat read-only

public Chat|null $publisherChat = null

$remainingCount read-only

public int|null $remainingCount = null

$starCount read-only

public int $starCount

$totalCount read-only

public int|null $totalCount = null

$uniqueGiftVariantCount read-only

public int|null $uniqueGiftVariantCount = null

$upgradeStarCount read-only

public int|null $upgradeStarCount = null

Methods

__construct()

public __construct(string $id, Sticker $sticker, int $starCount[, int|null $upgradeStarCount = null ][, bool|null $isPremium = null ][, bool|null $hasColors = null ][, int|null $totalCount = null ][, int|null $remainingCount = null ][, int|null $personalTotalCount = null ][, int|null $personalRemainingCount = null ][, GiftBackground|null $background = null ][, int|null $uniqueGiftVariantCount = null ][, Chat|null $publisherChat = null ][, Bot|null $bot = null ]) : mixed
Parameters
$id : string
$sticker : Sticker
$starCount : int
$upgradeStarCount : int|null = null
$isPremium : bool|null = null
$hasColors : bool|null = null
$totalCount : int|null = null
$remainingCount : int|null = null
$personalTotalCount : int|null = null
$personalRemainingCount : int|null = null
$background : GiftBackground|null = null
$uniqueGiftVariantCount : int|null = null
$publisherChat : Chat|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