Game
extends Entity
in package
Class Game
This object represents a game. Use BotFather to create and edit games, their short names will act as unique identifiers.
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
- getAnimation() :
- getBotUsername() :
- getDescription() :
- getPhoto() : null|array<string|int, PhotoSize>
- Photo that will be displayed in the game message in chats.
- getProperty() : mixed
- Get a property from the current Entity
- getRawData() :
- getText() :
- getTextEntities() : null|array<string|int, MessageEntity>
- Optional. Special entities that appear in text, such as usernames, URLs, bot commands, etc.
- getTitle() :
- 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
- subEntities() : array<string|int, mixed>
- Get the list of the properties that are themselves Entities
- 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 —getAnimation()
public
getAnimation() :
Optional. Animation that will be displayed in the game message in chats. Upload via BotFather
Return values
—getBotUsername()
public
getBotUsername() :
Return the bot name passed to this entity
Return values
—getDescription()
public
getDescription() :
Description of the game
Return values
—getPhoto()
Photo that will be displayed in the game message in chats.
public
getPhoto() : null|array<string|int, PhotoSize>
This method overrides the default getPhoto method and returns a nice array of PhotoSize objects.
Return values
null|array<string|int, PhotoSize> —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 —getRawData()
public
getRawData() :
Get the raw data passed to this entity
Return values
—getText()
public
getText() :
Optional. Brief description of the game or high scores included in the game message. Can be automatically edited to include current high scores for the game when the bot calls setGameScore, or manually edited using editMessageText. 0-4096 characters.
Return values
—getTextEntities()
Optional. Special entities that appear in text, such as usernames, URLs, bot commands, etc.
public
getTextEntities() : null|array<string|int, MessageEntity>
This method overrides the default getTextEntities method and returns a nice array of MessageEntity objects.
Return values
null|array<string|int, MessageEntity> —getTitle()
public
getTitle() :
Title of the game
Return values
—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> —subEntities()
Get the list of the properties that are themselves Entities
protected
subEntities() : array<string|int, mixed>
Return values
array<string|int, mixed> —validate()
Perform any special entity validation
protected
validate() : mixed