phpbotgram

OwnedGiftRegular extends OwnedGift
in package

FinalYes

Describes a regular gift owned by a user or a chat.

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

Table of Contents

Properties

$bot  : Bot|null
$canBeUpgraded  : bool|null
$convertStarCount  : int|null
$entities  : array<string|int, mixed>|null
$gift  : Gift
$isPrivate  : bool|null
$isSaved  : bool|null
$isUpgradeSeparate  : bool|null
$ownedGiftId  : string|null
$prepaidUpgradeStarCount  : int|null
$sendDate  : int
$senderUser  : User|null
$text  : string|null
$type  : string
$uniqueGiftNumber  : int|null
$wasRefunded  : bool|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

$entities read-only

public array<string|int, mixed>|null $entities = null

$prepaidUpgradeStarCount read-only

public int|null $prepaidUpgradeStarCount = null

Methods

__construct()

public __construct(Gift $gift, int $sendDate[, string $type = 'regular' ][, string|null $ownedGiftId = null ][, User|null $senderUser = null ][, string|null $text = null ][, null|array<int, MessageEntity> $entities = null ][, bool|null $isPrivate = null ][, bool|null $isSaved = null ][, bool|null $canBeUpgraded = null ][, bool|null $wasRefunded = null ][, int|null $convertStarCount = null ][, int|null $prepaidUpgradeStarCount = null ][, bool|null $isUpgradeSeparate = null ][, int|null $uniqueGiftNumber = null ][, Bot|null $bot = null ]) : mixed
Parameters
$gift : Gift
$sendDate : int
$type : string = 'regular'
$ownedGiftId : string|null = null
$senderUser : User|null = null
$text : string|null = null
$entities : null|array<int, MessageEntity> = null
$isPrivate : bool|null = null
$isSaved : bool|null = null
$canBeUpgraded : bool|null = null
$wasRefunded : bool|null = null
$convertStarCount : int|null = null
$prepaidUpgradeStarCount : int|null = null
$isUpgradeSeparate : bool|null = null
$uniqueGiftNumber : 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