SuccessfulPayment
extends Entity
in package
Class SuccessfulPayment
This object contains basic information about a successful payment.
Tags
Table of Contents
- __call() : mixed|null
- Return the variable for the called getter or magically set properties dynamically.
- __construct() : mixed
- Entity constructor.
- __toString() : string
- Perform to string
- escapeMarkdown() : string
- Escape markdown special characters
- getBotUsername() :
- getCurrency() :
- getInvoicePayload() :
- getOrderInfo() :
- getProperty() : mixed
- Get a property from the current Entity
- getProviderPaymentChargeId() :
- getRawData() :
- getShippingOptionId() :
- getTelegramPaymentChargeId() :
- getTotalAmount() :
- subEntities() : array<string|int, mixed>
- Get the list of the properties that are themselves Entities
- toJson() : string
- Perform to json
- tryMention() : string|null
- Try to mention the user
- assignMemberVariables() : mixed
- Helper to set member variables
- makePrettyObjectArray() : array<string|int, mixed>
- Return an array of nice objects from an array of object arrays
- validate() : mixed
- Perform any special entity validation
Methods
__call()
Return the variable for the called getter or magically set properties dynamically.
public
__call( $method, $args) : mixed|null
Parameters
Return values
mixed|null —__construct()
Entity constructor.
public
__construct(array<string|int, mixed> $data[, string $bot_username = '' ]) : mixed
Parameters
- $data : array<string|int, mixed>
- $bot_username : string = ''
Tags
Return values
mixed —__toString()
Perform to string
public
__toString() : string
Return values
string —escapeMarkdown()
Escape markdown special characters
public
escapeMarkdown(string $string) : string
Parameters
- $string : string
Return values
string —getBotUsername()
public
getBotUsername() :
Return the bot name passed to this entity
Return values
—getCurrency()
public
getCurrency() :
Three-letter ISO 4217 currency code
Return values
—getInvoicePayload()
public
getInvoicePayload() :
Bot specified invoice payload
Return values
—getOrderInfo()
public
getOrderInfo() :
Optional. Order info provided by the user
Return values
—getProperty()
Get a property from the current Entity
public
getProperty(mixed $property[, mixed $default = null ]) : mixed
Parameters
- $property : mixed
- $default : mixed = null
Return values
mixed —getProviderPaymentChargeId()
public
getProviderPaymentChargeId() :
Provider payment identifier
Return values
—getRawData()
public
getRawData() :
Get the raw data passed to this entity
Return values
—getShippingOptionId()
public
getShippingOptionId() :
Optional. Identifier of the shipping option chosen by the user
Return values
—getTelegramPaymentChargeId()
public
getTelegramPaymentChargeId() :
Telegram payment identifier
Return values
—getTotalAmount()
public
getTotalAmount() :
Total price in the smallest units of the currency (integer, not float/double).
Return values
—subEntities()
Get the list of the properties that are themselves Entities
public
subEntities() : array<string|int, mixed>
Return values
array<string|int, mixed> —toJson()
Perform to json
public
toJson() : string
Return values
string —tryMention()
Try to mention the user
public
tryMention([bool $escape_markdown = false ]) : string|null
Mention the user with the username otherwise print first and last name if the $escape_markdown argument is true special characters are escaped from the output
Parameters
- $escape_markdown : bool = false
Return values
string|null —assignMemberVariables()
Helper to set member variables
protected
assignMemberVariables(array<string|int, mixed> $data) : mixed
Parameters
- $data : array<string|int, mixed>
Return values
mixed —makePrettyObjectArray()
Return an array of nice objects from an array of object arrays
protected
makePrettyObjectArray(string $class, string $property) : array<string|int, mixed>
This method is used to generate pretty object arrays mainly for PhotoSize and Entities object arrays.
Parameters
- $class : string
- $property : string
Return values
array<string|int, mixed> —validate()
Perform any special entity validation
protected
validate() : mixed