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

Card
in

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

Class Card

Table of Contents

$title Заголовок элемента карточки. string|null
$desc Описание элемента карточки. string|null
$images Массив с изображениями или элементами карточки. \MM\bot\components\image\Image[]|null
$button Кнопки элемента карточки. Buttons
$isOne Определяет необходимость отображения 1 элемента карточки. bool
$isUsedGallery Использование галереи изображений. Передайте true, если хотите отобразить галерею из изображений. bool
$template Произвольных шаблон, который отобразится вместо стандартного. null
__construct() Card constructor. mixed
clear() Очищает все элементы карточки. mixed
add() Вставляет элемент в каточку|список. В случае успеха вернет true. bool
getCards() Получение всех элементов карточки. array
getCardsJson() Возвращает json строку со всеми элементами карточки. string

Properties

$title

Заголовок элемента карточки.

public string|null $title

$desc

Описание элемента карточки.

public string|null $desc

$images

Массив с изображениями или элементами карточки.

public \MM\bot\components\image\Image[]|null $images

$button

Кнопки элемента карточки.

public Buttons $button

$isOne

Определяет необходимость отображения 1 элемента карточки.

public bool $isOne
Передайте true, если необходимо отобразить только 1 элемент карточки

$isUsedGallery

Использование галереи изображений. Передайте true, если хотите отобразить галерею из изображений.

public bool $isUsedGallery = false

$template

Произвольных шаблон, который отобразится вместо стандартного.

public null $template = null
Рекомендуется использовать для smartApp, так как для него существует множество вариация для отображения карточек + есть списки При использовании переменной, Вы сами отвечаете за корректное отображение карточки.

Methods

__construct()

Card constructor.

public __construct( ) : mixed
Return values
mixed

clear()

Очищает все элементы карточки.

public clear( ) : mixed
Tags
api
Return values
mixed

add()

Вставляет элемент в каточку|список. В случае успеха вернет true.

public add( $image : string|null , $title : string [, $desc : string = ' ' ] [, $button : array|null = null ] ) : bool
Parameters
$image : string|null

Идентификатор или расположение изображения.

$title : string

Заголовок изображения.

$desc : string = ' '

Описание изображения.

$button : array|null = null

Кнопки, обрабатывающие команды при нажатии на элемент.

Tags
api
Return values
bool

getCards()

Получение всех элементов карточки.

public getCards( [ $userCard : TemplateCardTypes|null = null ] ) : array
Parameters
$userCard : TemplateCardTypes|null = null

Пользовательский класс для отображения каточки.

Tags
throws
api
Return values
array

getCardsJson()

Возвращает json строку со всеми элементами карточки.

public getCardsJson( $userCard : TemplateCardTypes|null ) : string
Parameters
$userCard : TemplateCardTypes|null

Пользовательский класс для отображения каточки.

Tags
throws
api
Return values
string

Search results