TransactionPartnerUser
extends TransactionPartner
in package
Describes a transaction with a user.
Source: https://core.telegram.org/bots/api#transactionpartneruser
Table of Contents
Properties
- $affiliate : AffiliateInfo|null
- $bot : Bot|null
- $gift : Gift|null
- $invoicePayload : string|null
- $paidMedia : array<string|int, mixed>|null
- $paidMediaPayload : string|null
- $premiumSubscriptionDuration : int|null
- $subscriptionPeriod : int|null
- $transactionType : string
- $type : string
- $user : User
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
$affiliate read-only
public
AffiliateInfo|null
$affiliate
= null
$bot read-only
public
Bot|null
$bot
= null
$gift read-only
public
Gift|null
$gift
= null
$invoicePayload read-only
public
string|null
$invoicePayload
= null
$paidMedia read-only
public
array<string|int, mixed>|null
$paidMedia
= null
$paidMediaPayload read-only
public
string|null
$paidMediaPayload
= null
$premiumSubscriptionDuration read-only
public
int|null
$premiumSubscriptionDuration
= null
$subscriptionPeriod read-only
public
int|null
$subscriptionPeriod
= null
$transactionType read-only
public
string
$transactionType
$type read-only
public
string
$type
= 'user'
$user read-only
public
User
$user
Methods
__construct()
public
__construct(string $transactionType, User $user[, string $type = 'user' ][, AffiliateInfo|null $affiliate = null ][, string|null $invoicePayload = null ][, int|null $subscriptionPeriod = null ][, null|array<int, PaidMedia> $paidMedia = null ][, string|null $paidMediaPayload = null ][, Gift|null $gift = null ][, int|null $premiumSubscriptionDuration = null ][, Bot|null $bot = null ]) : mixed
Parameters
- $transactionType : string
- $user : User
- $type : string = 'user'
- $affiliate : AffiliateInfo|null = null
- $invoicePayload : string|null = null
- $subscriptionPeriod : int|null = null
- $paidMedia : null|array<int, PaidMedia> = null
- $paidMediaPayload : string|null = null
- $gift : Gift|null = null
- $premiumSubscriptionDuration : 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
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