InlineQueryResultArticle
extends InlineEntity
in package
implements
InlineQueryResult
Class InlineQueryResultArticle
Tags
Interfaces, Classes and Traits
Table of Contents
- __call() : mixed|null
- Return the variable for the called getter or magically set properties dynamically.
- __construct() : mixed
- InlineQueryResultArticle constructor
- __toString() : string
- Perform to string
- escapeMarkdown() : string
- Escape markdown special characters
- getBotUsername() :
- getDescription() :
- getHideUrl() :
- getId() :
- getInputMessageContent() :
- getProperty() : mixed
- Get a property from the current Entity
- getRawData() :
- getReplyMarkup() :
- getThumbHeight() :
- getThumbUrl() :
- getThumbWidth() :
- getTitle() :
- getType() :
- getUrl() :
- setDescription() :
- setHideUrl() :
- setId() :
- setInputMessageContent() :
- setReplyMarkup() :
- setThumbHeight() :
- setThumbUrl() :
- setThumbWidth() :
- setTitle() :
- setUrl() :
- 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()
InlineQueryResultArticle constructor
public
__construct([array<string|int, mixed> $data = [] ]) : mixed
Parameters
- $data : array<string|int, mixed> = []
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
—getDescription()
public
getDescription() :
Optional. Short description of the result
Return values
—getHideUrl()
public
getHideUrl() :
Optional. Pass True, if you don't want the URL to be shown in the message
Return values
—getId()
public
getId() :
Unique identifier for this result, 1-64 Bytes
Return values
—getInputMessageContent()
public
getInputMessageContent() :
Content of the message to be sent
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 —getRawData()
public
getRawData() :
Get the raw data passed to this entity
Return values
—getReplyMarkup()
public
getReplyMarkup() :
Optional. Inline keyboard attached to the message
Return values
—getThumbHeight()
public
getThumbHeight() :
Optional. Thumbnail height
Return values
—getThumbUrl()
public
getThumbUrl() :
Optional. Url of the thumbnail for the result
Return values
—getThumbWidth()
public
getThumbWidth() :
Optional. Thumbnail width
Return values
—getTitle()
public
getTitle() :
Title of the result
Return values
—getType()
public
getType() :
Type of the result, must be article
Return values
—getUrl()
public
getUrl() :
Optional. URL of the result
Return values
—setDescription()
public
setDescription(string $description) :
Optional. Short description of the result
Parameters
- $description : string
Return values
—setHideUrl()
public
setHideUrl(bool $hide_url) :
Optional. Pass True, if you don't want the URL to be shown in the message
Parameters
- $hide_url : bool
Return values
—setId()
public
setId(string $id) :
Unique identifier for this result, 1-64 Bytes
Parameters
- $id : string
Return values
—setInputMessageContent()
public
setInputMessageContent(InputMessageContent $input_message_content) :
Content of the message to be sent
Parameters
- $input_message_content : InputMessageContent
Return values
—setReplyMarkup()
public
setReplyMarkup(InlineKeyboard $reply_markup) :
Optional. Inline keyboard attached to the message
Parameters
- $reply_markup : InlineKeyboard
Return values
—setThumbHeight()
public
setThumbHeight(int $thumb_height) :
Optional. Thumbnail height
Parameters
- $thumb_height : int
Return values
—setThumbUrl()
public
setThumbUrl(string $thumb_url) :
Optional. Url of the thumbnail for the result
Parameters
- $thumb_url : string
Return values
—setThumbWidth()
public
setThumbWidth(int $thumb_width) :
Optional. Thumbnail width
Parameters
- $thumb_width : int
Return values
—setTitle()
public
setTitle(string $title) :
Title of the result
Parameters
- $title : string
Return values
—setUrl()
public
setUrl(string $url) :
Optional. URL of the result
Parameters
- $url : string
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