Documentation

InlineQueryResultPhoto extends InlineEntity
in package
implements InlineQueryResult

Class InlineQueryResultPhoto

Tags
link
$data = [ 'id' => '', 'photo_url' => '', 'thumb_url' => '', 'photo_width' => 30, 'photo_height' => 30, 'title' => '', 'description' => '', 'caption' => '', 'reply_markup' => , 'input_message_content' => , ];

Interfaces, Classes and Traits

InlineQueryResult

Table of Contents

__call()  : mixed|null
Return the variable for the called getter or magically set properties dynamically.
__construct()  : mixed
InlineQueryResultPhoto constructor
__toString()  : string
Perform to string
escapeMarkdown()  : string
Escape markdown special characters
getBotUsername()  :
getCaption()  :
getDescription()  :
getId()  :
getInputMessageContent()  :
getPhotoHeight()  :
getPhotoUrl()  :
getPhotoWidth()  :
getProperty()  : mixed
Get a property from the current Entity
getRawData()  :
getReplyMarkup()  :
getThumbUrl()  :
getTitle()  :
getType()  :
setCaption()  :
setDescription()  :
setId()  :
setInputMessageContent()  :
setPhotoHeight()  :
setPhotoUrl()  :
setPhotoWidth()  :
setReplyMarkup()  :
setThumbUrl()  :
setTitle()  :
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
$method :
$args :
Return values
mixed|null —

__construct()

InlineQueryResultPhoto constructor

public __construct([array<string|int, mixed> $data = [] ]) : mixed
Parameters
$data : array<string|int, mixed> = []
Tags
throws
TelegramException
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
—

getCaption()

public getCaption() :

Optional. Caption of the photo to be sent, 0-200 characters

Return values
—

getDescription()

public getDescription() :

Optional. Short description of the result

Return values
—

getInputMessageContent()

public getInputMessageContent() :

Optional. Content of the message to be sent instead of the photo

Return values
—

getPhotoUrl()

public getPhotoUrl() :

A valid URL of the photo. Photo must be in jpeg format. Photo size must not exceed 5MB

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
—

setCaption()

public setCaption(string $caption) :

Optional. Caption of the photo to be sent, 0-200 characters

Parameters
$caption : string
Return values
—

setDescription()

public setDescription(string $description) :

Optional. Short description of the result

Parameters
$description : string
Return values
—

setId()

public setId(string $id) :

Unique identifier for this result, 1-64 bytes

Parameters
$id : string
Return values
—

setPhotoHeight()

public setPhotoHeight(int $photo_height) :

Optional. Height of the photo

Parameters
$photo_height : int
Return values
—

setPhotoUrl()

public setPhotoUrl(string $photo_url) :

A valid URL of the photo. Photo must be in jpeg format. Photo size must not exceed 5MB

Parameters
$photo_url : string
Return values
—

setPhotoWidth()

public setPhotoWidth(int $photo_width) :

Optional. Width of the photo

Parameters
$photo_width : int
Return values
—

setThumbUrl()

public setThumbUrl(string $thumb_url) :

URL of the thumbnail for the photo

Parameters
$thumb_url : string
Return values
—

setTitle()

public setTitle(string $title) :

Optional. Title for the result

Parameters
$title : 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
Tags
throws
TelegramException
Return values
mixed —

Search results