PHP Class Longman\TelegramBot\Entities\Keyboard

Inheritance: extends Entity

Public Methods

Method	Description
__construct ( $data = [] )
addRow ( )	Create a new row in keyboard and add buttons.
forceReply ( array $data = [] ) : Keyboard	Display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply').
getKeyboardButtonClass ( ) : KeyboardButton \| InlineKeyboardButton	Get the proper keyboard button class for this keyboard.
getKeyboardType ( ) : string	Get the type of keyboard, either "inline_keyboard" or "keyboard".
isInlineKeyboard ( ) : boolean	If this keyboard is an inline keyboard.
remove ( array $data = [] ) : Keyboard	Remove the current custom keyboard and display the default letter-keyboard.

Method	Description
createFromParams ( ) : array	If no explicit keyboard is passed, try to create one from the parameters.
parseButton ( array \| string \| KeyboardButton $button ) : KeyboardButton \| null	Parse a given button to the correct KeyboardButton object type.
parseRow ( array $row ) : array	Parse a given row to the correct array format.
validate ( )

public __construct ( $data = [] )

Create a new row in keyboard and add buttons.

public addRow ( )

If no explicit keyboard is passed, try to create one from the parameters.

protected createFromParams ( ) : array
return	array

Display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply').

public static forceReply ( array $data = [] ) : Keyboard
$data	array
return	Keyboard

Get the proper keyboard button class for this keyboard.

public getKeyboardButtonClass ( ) : KeyboardButton \| InlineKeyboardButton
return	KeyboardButton \| InlineKeyboardButton

Get the type of keyboard, either "inline_keyboard" or "keyboard".

public getKeyboardType ( ) : string
return	string

If this keyboard is an inline keyboard.

public isInlineKeyboard ( ) : boolean
return	boolean

Parse a given button to the correct KeyboardButton object type.

protected parseButton ( array \| string \| KeyboardButton $button ) : KeyboardButton \| null
$button	array \| string \| KeyboardButton
return	KeyboardButton \| null

Parse a given row to the correct array format.

protected parseRow ( array $row ) : array
$row	array
return	array

Remove the current custom keyboard and display the default letter-keyboard.

public static remove ( array $data = [] ) : Keyboard
$data	array
return	Keyboard

protected validate ( )

protected parseButton ( array \| string \| KeyboardButton $button ) : KeyboardButton \| null
$button	array \| string \| KeyboardButton
return	KeyboardButton \| null