phpbotgram

SendInvoice extends TelegramMethod
in package

FinalYes

Use this method to send invoices. On success, the sent Message is returned.

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

Tags
extends

Table of Contents

Constants

ApiMethod  : string = 'sendInvoice'
ReturnsType  : string = \Gruven\PhpBotGram\Types\Message::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

$allowPaidBroadcast  : bool|null
$bot  : Bot|null
$chatId  : int|string
$currency  : string
$description  : string
$directMessagesTopicId  : int|null
$disableNotification  : bool|null
$isFlexible  : bool|null
$maxTipAmount  : int|null
$messageEffectId  : string|null
$messageThreadId  : int|null
$needEmail  : bool|null
$needName  : bool|null
$needPhoneNumber  : bool|null
$needShippingAddress  : bool|null
$payload  : string
$photoHeight  : int|null
$photoSize  : int|null
$photoUrl  : string|null
$photoWidth  : int|null
$prices  : array<int, LabeledPrice>
$protectContent  : bool|BotDefault|null
$providerData  : string|null
$providerToken  : string|null
$replyMarkup  : InlineKeyboardMarkup|null
$replyParameters  : ReplyParameters|null
$sendEmailToProvider  : bool|null
$sendPhoneNumberToProvider  : bool|null
$startParameter  : string|null
$suggestedPostParameters  : SuggestedPostParameters|null
$suggestedTipAmounts  : array<int, int>
$title  : string

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\Message::class

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

Properties

$allowPaidBroadcast read-only

public bool|null $allowPaidBroadcast = null

$directMessagesTopicId read-only

public int|null $directMessagesTopicId = null

$disableNotification read-only

public bool|null $disableNotification = null

$isFlexible read-only

public bool|null $isFlexible = null

$maxTipAmount read-only

public int|null $maxTipAmount = null

$messageEffectId read-only

public string|null $messageEffectId = null

$messageThreadId read-only

public int|null $messageThreadId = null

$needEmail read-only

public bool|null $needEmail = null

$needName read-only

public bool|null $needName = null

$needPhoneNumber read-only

public bool|null $needPhoneNumber = null

$needShippingAddress read-only

public bool|null $needShippingAddress = null

$photoHeight read-only

public int|null $photoHeight = null

$photoSize read-only

public int|null $photoSize = null

$photoUrl read-only

public string|null $photoUrl = null

$photoWidth read-only

public int|null $photoWidth = null

$protectContent read-only

public bool|BotDefault|null $protectContent = new BotDefault('protect_content')

$providerData read-only

public string|null $providerData = null

$providerToken read-only

public string|null $providerToken = null

$sendEmailToProvider read-only

public bool|null $sendEmailToProvider = null

$sendPhoneNumberToProvider read-only

public bool|null $sendPhoneNumberToProvider = null

$startParameter read-only

public string|null $startParameter = null

$suggestedTipAmounts read-only

public array<int, int> $suggestedTipAmounts = null

Methods

__construct()

public __construct(int|string $chatId, string $title, string $description, string $payload, string $currency, array<string|int, mixed> $prices[, int|null $messageThreadId = null ][, int|null $directMessagesTopicId = null ][, string|null $providerToken = null ][, int|null $maxTipAmount = null ][, array<string|int, mixed>|null $suggestedTipAmounts = null ][, string|null $startParameter = null ][, string|null $providerData = null ][, string|null $photoUrl = null ][, int|null $photoSize = null ][, int|null $photoWidth = null ][, int|null $photoHeight = null ][, bool|null $needName = null ][, bool|null $needPhoneNumber = null ][, bool|null $needEmail = null ][, bool|null $needShippingAddress = null ][, bool|null $sendPhoneNumberToProvider = null ][, bool|null $sendEmailToProvider = null ][, bool|null $isFlexible = null ][, bool|null $disableNotification = null ][, bool|BotDefault|null $protectContent = new BotDefault('protect_content') ][, bool|null $allowPaidBroadcast = null ][, string|null $messageEffectId = null ][, SuggestedPostParameters|null $suggestedPostParameters = null ][, ReplyParameters|null $replyParameters = null ][, InlineKeyboardMarkup|null $replyMarkup = null ][, Bot|null $bot = null ]) : mixed
Parameters
$chatId : int|string
$title : string
$description : string
$payload : string
$currency : string
$prices : array<string|int, mixed>
$messageThreadId : int|null = null
$directMessagesTopicId : int|null = null
$providerToken : string|null = null
$maxTipAmount : int|null = null
$suggestedTipAmounts : array<string|int, mixed>|null = null
$startParameter : string|null = null
$providerData : string|null = null
$photoUrl : string|null = null
$photoSize : int|null = null
$photoWidth : int|null = null
$photoHeight : int|null = null
$needName : bool|null = null
$needPhoneNumber : bool|null = null
$needEmail : bool|null = null
$needShippingAddress : bool|null = null
$sendPhoneNumberToProvider : bool|null = null
$sendEmailToProvider : bool|null = null
$isFlexible : bool|null = null
$disableNotification : bool|null = null
$protectContent : bool|BotDefault|null = new BotDefault('protect_content')
$allowPaidBroadcast : bool|null = null
$messageEffectId : string|null = null
$suggestedPostParameters : SuggestedPostParameters|null = null
$replyParameters : ReplyParameters|null = null
$replyMarkup : InlineKeyboardMarkup|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