Documentation

InputLocationMessageContent extends InlineEntity
in package
implements InputMessageContent

Class InputLocationMessageContent

Tags
link
$data = [ 'latitude' => 36.0338, 'longitude' => 71.8601, 'live_period' => 900, ];

Interfaces, Classes and Traits

InputMessageContent

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()  :
getLatitude()  :
getLivePeriod()  :
getLongitude()  :
getProperty()  : mixed
Get a property from the current Entity
getRawData()  :
setLatitude()  :
setLivePeriod()  :
setLongitude()  :
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()

Entity constructor.

public __construct(array<string|int, mixed> $data[, string $bot_username = '' ]) : mixed
Parameters
$data : array<string|int, mixed>
$bot_username : string = ''
Tags
todo

Get rid of the $bot_username, it shouldn't be here!

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
—

getLivePeriod()

public getLivePeriod() :

Optional. Period in seconds for which the location can be updated, should be between 60 and 86400.

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
—

setLatitude()

public setLatitude(float $latitude) :

Latitude of the location in degrees

Parameters
$latitude : float
Return values
—

setLivePeriod()

public setLivePeriod(int $live_period) :

Optional. Period in seconds for which the location can be updated, should be between 60 and 86400.

Parameters
$live_period : int
Return values
—

setLongitude()

public setLongitude(float $longitude) :

Longitude of the location in degrees

Parameters
$longitude : float
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