Описание класса Buttons

Buttons
in

bot

components

button

Класс отвечающий за отображение определенных кнопок, в зависимости от типа приложения.

Class Buttons

T_ALISA_BUTTONS	Кнопки в Алисе.	'alisa_btn'
T_ALISA_CARD_BUTTON	Кнопки в карточке Алисы.	'alisa_card_btn'
T_VK_BUTTONS	Кнопки в vk.	'vk_btn'
T_TELEGRAM_BUTTONS	Кнопки в Telegram.	'telegram_btn'
T_VIBER_BUTTONS	Кнопки в viber.	'viber_btn'
T_SMARTAPP_BUTTONS	Кнопки в Сбер SmartApp.	'smart-app_btn'
T_SMARTAPP_BUTTON_CARD	Кнопки в карточке Сбер SmartApp.	'smart-app_card_btn'
T_USER_APP_BUTTONS	Кнопки в пользовательском типе приложения.	'user_app_btn'
$buttons	Массив с различными кнопками.	\MM\bot\components\button\Button[]\|null
$btns	Массив из кнопок вида кнопка.	array\|string\|null
$links	Массив из кнопок вида ссылка.	array\|null
$type	Тип кнопок(кнопка в Алисе, кнопка в карточке Алисы, кнопка в Vk, кнопка в Telegram и тд).	string
__construct()	Buttons constructor.	mixed
clear()	Очистка всех кнопок.	void
add()	Добавить кнопку.	bool
addBtn()	Добавить кнопку типа кнопка.	bool
addLink()	Добавить кнопку типа сайджест.	bool
processing()	Дополнительная обработка второстепенных кнопок.	void
getButtons()	Возвращаем массив с кнопками для ответа пользователю.	array
getButtonJson()	Возвращаем json строку c кнопками.	string\|null

T_ALISA_BUTTONS

Кнопки в Алисе.


        
        mixed
        $T_ALISA_BUTTONS
        = 'alisa_btn'

T_ALISA_CARD_BUTTON

Кнопки в карточке Алисы.


        
        mixed
        $T_ALISA_CARD_BUTTON
        = 'alisa_card_btn'

T_VK_BUTTONS

Кнопки в vk.


        
        mixed
        $T_VK_BUTTONS
        = 'vk_btn'

T_TELEGRAM_BUTTONS

Кнопки в Telegram.


        
        mixed
        $T_TELEGRAM_BUTTONS
        = 'telegram_btn'

T_VIBER_BUTTONS

Кнопки в viber.


        
        mixed
        $T_VIBER_BUTTONS
        = 'viber_btn'

T_SMARTAPP_BUTTONS

Кнопки в Сбер SmartApp.


        
        mixed
        $T_SMARTAPP_BUTTONS
        = 'smart-app_btn'

T_SMARTAPP_BUTTON_CARD

Кнопки в карточке Сбер SmartApp.


        
        mixed
        $T_SMARTAPP_BUTTON_CARD
        = 'smart-app_card_btn'

T_USER_APP_BUTTONS

Кнопки в пользовательском типе приложения.


        
        mixed
        $T_USER_APP_BUTTONS
        = 'user_app_btn'

$buttons

Массив с различными кнопками.


        public
                \MM\bot\components\button\Button[]|null
        $buttons

$btns

Массив из кнопок вида кнопка.


        public
                array|string|null
        $btns

$links

Массив из кнопок вида ссылка.


        public
                array|null
        $links

$type

Тип кнопок(кнопка в Алисе, кнопка в карточке Алисы, кнопка в Vk, кнопка в Telegram и тд).


        public
                string
        $type

__construct()

Buttons constructor.


        public
                                __construct(
                )
        : mixed

Return values

mixed

clear()

Очистка всех кнопок.


        public
                                clear(
                )
        : void

add()

Добавить кнопку.


        protected
                                add(
                    
                            $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: True, если отображать кнопку как сайджест.
$options : array = []: Дополнительные параметры кнопки

Return values

bool

addBtn()

Добавить кнопку типа кнопка.


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

Parameters

$title : string: Текст в кнопке.
$url : string|null = '': Ссылка для перехода при нажатии на кнопку.
$payload : string|array|null = '': Произвольные данные, отправляемые при нажатии на кнопку.
$options : array = []: Дополнительные параметры кнопки

Return values

bool

addLink()

Добавить кнопку типа сайджест.


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

Parameters

$title : string: Текст в кнопке.
$url : string|null = '': Ссылка для перехода при нажатии на кнопку.
$payload : array|string|null = '': Произвольные данные, отправляемые при нажатии на кнопку.
$options : array = []: Дополнительные параметры кнопки

Return values

bool

processing()

Дополнительная обработка второстепенных кнопок.


        protected
                                processing(
                )
        : void

А именно обрабатываются массивы btn и link. После чего все значения вносятся в массив buttons.

getButtons()

Возвращаем массив с кнопками для ответа пользователю.


        public
                                getButtons(
                    
            [                $type :
                string|null
                 = null ]            
                    
            [,                 $userButton :
                TemplateButtonTypes|null
                 = null ]            
                )
        : array

Parameters

$type : string|null = null: Тип кнопки.
$userButton : TemplateButtonTypes|null = null: Класс с пользовательскими кнопками.

Return values

array

getButtonJson()

Возвращаем json строку c кнопками.


        public
                                getButtonJson(
                    
            [                $type :
                string|null
                 = null ]            
                    
            [,                 $userButton :
                TemplateButtonTypes|null
                 = null ]            
                )
        : string|null

Parameters

$type : string|null = null: Тип приложения.
$userButton : TemplateButtonTypes|null = null: Класс с пользовательскими кнопками.

Return values

string|null

Buttons in bot components button

Table of Contents

Constants

T_ALISA_BUTTONS

T_ALISA_CARD_BUTTON

T_VK_BUTTONS

T_TELEGRAM_BUTTONS

T_VIBER_BUTTONS

T_SMARTAPP_BUTTONS

T_SMARTAPP_BUTTON_CARD

T_USER_APP_BUTTONS

Properties

$buttons

$btns

$links

$type

Methods

__construct()

Return values

clear()

Tags

add()

Parameters

Tags

Return values

addBtn()

Parameters

Tags

Return values

addLink()

Parameters

Tags

Return values

processing()

getButtons()

Parameters

Tags

Return values

getButtonJson()

Parameters

Tags

Return values

Search results

Buttons
in

bot

components

button