phpbotgram

GetChatGifts extends TelegramMethod
in package

FinalYes

Returns the gifts owned by a chat. Returns OwnedGifts on success.

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

Tags
extends

Table of Contents

Constants

ApiMethod  : string = 'getChatGifts'
ReturnsType  : string = \Gruven\PhpBotGram\Types\OwnedGifts::class
Subclasses override with either: - a `class-string<TelegramObject>` (e.g. Message::class) for object returns - a scalar type name ('bool', 'int', 'string') for primitive returns - 'list:<inner>' for array returns

Properties

$bot  : Bot|null
$chatId  : int|string
$excludeFromBlockchain  : bool|null
$excludeLimitedNonUpgradable  : bool|null
$excludeLimitedUpgradable  : bool|null
$excludeSaved  : bool|null
$excludeUnique  : bool|null
$excludeUnlimited  : bool|null
$excludeUnsaved  : bool|null
$limit  : int|null
$offset  : string|null
$sortByPrice  : bool|null

Methods

__construct()  : mixed
as_()  : static
Alias of withBot() for grep-translating aiogram code that uses obj.as_(bot).
bindBot()  : static
Returns a clone bound to $bot. Used by hand-authored shortcut methods (Message::answer, etc.) so the chained ->emit() picks up the bot without an explicit argument.
emit()  : TReturn
Emit this method via the bound bot (or the explicitly-passed 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.

Constants

ReturnsType

Subclasses override with either: - a `class-string<TelegramObject>` (e.g. Message::class) for object returns - a scalar type name ('bool', 'int', 'string') for primitive returns - 'list:<inner>' for array returns

public string ReturnsType = \Gruven\PhpBotGram\Types\OwnedGifts::class

Stays '' on the abstract base — Phase 2 codegen sets it per concrete method.

Properties

$excludeFromBlockchain read-only

public bool|null $excludeFromBlockchain = null

$excludeLimitedNonUpgradable read-only

public bool|null $excludeLimitedNonUpgradable = null

$excludeLimitedUpgradable read-only

public bool|null $excludeLimitedUpgradable = null

$excludeSaved read-only

public bool|null $excludeSaved = null

$excludeUnique read-only

public bool|null $excludeUnique = null

$excludeUnlimited read-only

public bool|null $excludeUnlimited = null

$excludeUnsaved read-only

public bool|null $excludeUnsaved = null

$sortByPrice read-only

public bool|null $sortByPrice = null

Methods

__construct()

public __construct(int|string $chatId[, bool|null $excludeUnsaved = null ][, bool|null $excludeSaved = null ][, bool|null $excludeUnlimited = null ][, bool|null $excludeLimitedUpgradable = null ][, bool|null $excludeLimitedNonUpgradable = null ][, bool|null $excludeFromBlockchain = null ][, bool|null $excludeUnique = null ][, bool|null $sortByPrice = null ][, string|null $offset = null ][, int|null $limit = null ][, Bot|null $bot = null ]) : mixed
Parameters
$chatId : int|string
$excludeUnsaved : bool|null = null
$excludeSaved : bool|null = null
$excludeUnlimited : bool|null = null
$excludeLimitedUpgradable : bool|null = null
$excludeLimitedNonUpgradable : bool|null = null
$excludeFromBlockchain : bool|null = null
$excludeUnique : bool|null = null
$sortByPrice : bool|null = null
$offset : string|null = null
$limit : 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

bindBot()

Returns a clone bound to $bot. Used by hand-authored shortcut methods (Message::answer, etc.) so the chained ->emit() picks up the bot without an explicit argument.

public bindBot(Bot|null $bot) : static
Parameters
$bot : Bot|null
Return values
static

emit()

Emit this method via the bound bot (or the explicitly-passed bot).

public emit([Bot|null $bot = null ]) : TReturn

Mirrors upstream methods/base.py:81-93 (await + emit).

Parameters
$bot : Bot|null = null
Return values
TReturn

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