Описание класса Button | Universal Bot

Button
in

Class Button

Table of Contents

B_LINK false
B_BTN true
VK_COLOR_PRIMARY 'primary'
VK_COLOR_SECONDARY 'secondary'
VK_COLOR_NEGATIVE 'negative'
VK_COLOR_POSITIVE 'positive'
VK_TYPE_TEXT 'text'
VK_TYPE_LINK 'open_link'
VK_TYPE_LOCATION 'location'
VK_TYPE_PAY 'vkpay'
VK_TYPE_APPS 'open_app'
$type Тип кнопки. string|null
$title Текст в кнопке. string|null
$url Ссылка для перехода при нажатии кнопки. string|null
$payload Произвольные данные, отправляемые при нажатии на кнопку. string|array
$hide Определяет отображение кнопки как сайджеста. bool
$options Дополнительные параметры кнопки. array
__construct() Button constructor. mixed
init() Инициализация кнопки. bool
initLink() Инициализация кнопки в виде сайджеста(ссылки под текстом). bool
initBtn() Инициализация кнопки в виде кнопки. bool

Constants

VK_COLOR_PRIMARY

mixed $VK_COLOR_PRIMARY = 'primary'

VK_COLOR_SECONDARY

mixed $VK_COLOR_SECONDARY = 'secondary'

VK_COLOR_NEGATIVE

mixed $VK_COLOR_NEGATIVE = 'negative'

VK_COLOR_POSITIVE

mixed $VK_COLOR_POSITIVE = 'positive'

VK_TYPE_TEXT

mixed $VK_TYPE_TEXT = 'text'

VK_TYPE_LINK

mixed $VK_TYPE_LINK = 'open_link'

VK_TYPE_LOCATION

mixed $VK_TYPE_LOCATION = 'location'

VK_TYPE_PAY

mixed $VK_TYPE_PAY = 'vkpay'

VK_TYPE_APPS

mixed $VK_TYPE_APPS = 'open_app'

Properties

$type

Тип кнопки.

public string|null $type

$title

Текст в кнопке.

public string|null $title

$url

Ссылка для перехода при нажатии кнопки.

public string|null $url

$payload

Произвольные данные, отправляемые при нажатии на кнопку.

public string|array $payload

$hide

Определяет отображение кнопки как сайджеста.

public bool $hide

$options

Дополнительные параметры кнопки.

public array $options
[ string _group: Задается в том случае, если нужно объединить кнопку в группу. Дополнительные опции для кнопки. ]

Methods

__construct()

Button constructor.

public __construct( ) : mixed
Return values
mixed

init()

Инициализация кнопки.

private init( $title : string , $url : string|null , $payload : string|array|null , $hide : bool|null [, $options : array = [] ] ) : bool
Parameters
$title : string

Текст в кнопке.

$url : string|null

Ссылка для перехода, при нажатии на кнопку.

$payload : string|array|null

Произвольные данные, отправляемые при нажатии на кнопку.

$hide : bool|null

Определяет отображение кнопки как сайджеста.

$options : array = []

Дополнительные параметры кнопки.

Tags
see

Описание опции options

Return values
bool

initLink()

Инициализация кнопки в виде сайджеста(ссылки под текстом).

public initLink( $title : string [, $url : string|null = '' ] [, $payload : string|array|null = null ] [, $options : array = [] ] ) : bool
Parameters
$title : string

Текст в кнопке.

$url : string|null = ''

Ссылка для перехода, при нажатии на кнопку.

$payload : string|array|null = null

Произвольные данные, отправляемые при нажатии на кнопку.

$options : array = []

Дополнительные параметры кнопки

Tags
see

Описание опции options

api
Return values
bool

initBtn()

Инициализация кнопки в виде кнопки.

public initBtn( $title : string [, $url : string|null = '' ] [, $payload : string|array|null = null ] [, $options : array = [] ] ) : bool
Parameters
$title : string

Текст в кнопке.

$url : string|null = ''

Ссылка для перехода, при нажатии на кнопку.

$payload : string|array|null = null

Произвольные данные, отправляемые при нажатии на кнопку.

$options : array = []

Дополнительные параметры кнопки

Tags
see

Описание опции options

api
Return values
bool

Search results