Класс Item

Класс представляет элемент диалога.

Конструктор

__construct(array $options)

$options — массив опций элемента. Определяется структурой ItemOptions:

id: string | int
Идентификатор элемента. Обязательный параметр.

entityId: string
Идентификатор сущности. Обязательный параметр.

entityType: string
Тип сущности.

tabs: string | string[]
Идентификатор или массив идентификаторов вкладок, в которых отобразится элемент. Если привязка к вкладке не указана, элемент все равно можно будет найти через поиск.

title: string | TextNodeOptions
Заголовок элемента. Определяется либо строкой, либо структурой TextNodeOptions.
Если значение не задано, элемент будет выведен с пустым заголовком.

Структура TextNodeOptions позволяет определить текстовый контент и его тип.
```
$textNodeOptions = ['text' => 'контент', 'type' => 'контента'];
```
- text: string — текстовый контент
- type: 'text' | 'html' — тип контента.

subtitle: string | TextNodeOptions
Подзаголовок элемента. Определяется либо строкой, либо структурой TextNodeOptions.
Если значение не задано, подзаголовок будет искаться в настройках сущности.

supertitle: string | TextNodeOptions
Надзаголовок элемента. Определяется либо строкой, либо структурой TextNodeOptions.
Если значение не задано, надзаголовок будет искаться в настройках сущности.

caption: string | TextNodeOptions
Подпись элемента. Определяется либо строкой, либо структурой TextNodeOptions.
Если значение не задано, подпись будет искаться в настройках сущности.

captionOptions: array
Дополнительные настройки подписи элемента. Определяются массивом, ключи которого совпадают со структурой CaptionOptions.

Если значение не задано, настройки будут искаться в настройках сущности.

avatar: string
Аватар элемента. Указывается либо путь к изображению, либо файл в формате Data URL.
Если значение не задано, аватар будет искаться в настройках сущности.

avatarOptions: array
Дополнительные настройки аватара элемента.
Определяются массивом, ключи которого совпадают со структурой AvatarOptions.
Если значение не задано, настройки будут искаться в настройках сущности.

textColor: string
Цвет текста заголовка.
Если значение не задано, цвет текста будет искаться в настройках сущности.

link: string
Адрес ссылки "подробнее".
Если значение не задано, адрес ссылки будет искаться в настройках сущности.

linkTitle: string
Заголовок ссылки "подробнее".
Если значение не задано, заголовок ссылки будет искаться в настройках сущности.

badges: array
Массив бейджей элемента. Каждый бейдж определяется массивом, ключи которого совпадают со структурой ItemBadgeOptions.
Если значение не задано, бейджи будут искаться в настройках сущности.

badgesOptions: array
Дополнительные настройки для блока с бейджами. Определяются массивом, ключи которого совпадают со структурой BadgesOptions.

selected: bool
Если задано значение true, такой элемент будет добавлен в диалог как выбранный. По умолчанию false.

searchable: bool
Если задано значение false, такой элемент не будет найден в поиске. По умолчанию true.

saveable: bool
Если задано значение false, такой элемент не будет сохраняться для вкладки "Последние". По умолчанию true.

deselectable: bool
Если задано значение false, то у такого элемента нельзя будет снять выбор. По умолчанию true.

hidden: bool
Флаг, обозначающий скрытый элемент.

sort: int
Индекс сортировки элемента, по которому сортируются элементы на вкладке "Последние", а также в результатах поиска. По умолчанию не задан.

availableInRecentTab: bool
Если установлено значение false, элемент не будет показан на вкладке "Последние".

customData: array
Произвольные дополнительные данные элемента.

nodeOptions: array
Дополнительные настройки для DOM-узла элемента. Определяются массивом, ключи которого совпадают со структурой ItemNodeOptions.

tagOptions: array
Настройки отображения элемента в виджете TagSelector. Определяются массивом, ключи которого совпадают со структурой TagOptions.
Если значение не задано, настройки будут искаться в настройках сущности.

children: array
Массив дочерних элементов. Используется для создания древовидной структуры. Каждый элемент массива определяется структурой ItemOptions.

Методы

Метод	Описание	С версии
getId(): string \| number	Возвращает идентификатор элемента.
getEntityId(): string	Возвращает идентификатор сущности.
getEntityType(): ?string	Возвращает тип сущности.
setEntityType(string $type): self	Устанавливает тип сущности.
getTitle(): string	Возвращает заголовок элемента. Если заголовок не задан, вернет пустую строку.
setTitle($title): self	Устанавливает заголовок элемента. Заголовок определяется либо строкой, либо структурой TextNodeOptions.
getSubtitle(): ?string	Возвращает подзаголовок элемента.
setSubtitle($subtitle): self	Устанавливает подзаголовок элемента. Подзаголовок определяется либо строкой, либо структурой TextNodeOptions.
getSupertitle(): ?string	Возвращает надзаголовок элемента.
setSupertitle($supertitle): self	Устанавливает надзаголовок элемента. Надзаголовок определяется либо строкой, либо структурой TextNodeOptions.
getCaption(): ?string	Возвращает подпись элемента.
setCaption($caption): self	Устанавливает подпись элемента. Подпись определяется либо строкой, либо структурой TextNodeOptions.
setCaptionOptions(array $captionOptions)	Устанавливает дополнительные настройки подписи элемента. `$captionOptions` — массив, ключи которого совпадают со структурой CaptionOptions.
getCaptionOptions(): Dictionary	Возвращает коллекцию с настройками подписи элемента.
getAvatar(): ?string	Возвращает аватар элемента.
setAvatar(?string $avatar): self	Устанавливает аватар элемента. Указывается либо путь к изображению, либо файл в формате Data URL.
getAvatarOptions(): Dictionary	Возвращает настройки для аватара элемента.	21.600.0
setAvatarOptions(array $avatarOptions): self	Устанавливает дополнительные настройки для аватара элемента. `avatarOptions` — массив, ключи которого совпадают со структурой AvatarOptions.	21.600.0
getTextColor(): ?string	Возвращает цвет текста заголовка.
setTextColor(?string $textColor): self	Устанавливает цвет текста заголовка.
getLink(): ?string	Возвращает заголовок ссылки "подробнее".
setLink(?string $link): self	Устанавливает адрес ссылки "подробнее".
getLinkTitle(): ?string	Возвращает заголовок ссылки "подробнее".
setLinkTitle($linkTitle): self	Устанавливает заголовок ссылки "подробнее". Заголовок определяется либо строкой, либо структурой TextNodeOptions.
getBadges(): ?array	Возвращает массив бейджей.
addBadges(array $badges): self	Добавляет бейджи элемента. `$badges` — массив бейджей. Каждый элемент определяется массивом, ключи которого совпадают со структурой ItemBadgeOptions.
setBadges(array $badges): self	Устанавливает бейджи элемента. `$badges` — массив бейджей. Каждый элемент определяется массивом, ключи которого совпадают со структурой ItemBadgeOptions.
setBadgesOptions(array $badgesOptions): self	Устанавливает дополнительные настройки для блока с бейджами. `$badgesOptions` — массив, ключи которого совпадают со структурой BadgesOptions.
getBadgesOptions(): Dictionary	Возвращает коллекцию настроек для блока с бейджами.
getTabs(): array	Возвращает массив идентификаторов вкладок.
addTab($tabId): self	Добавляет элемент на вкладку.
getChildren(): ItemCollection	Возвращает коллекцию потомков элемента.
addChildren(array $children): self	Добавляет дочерние элементы. Каждый элемент массива определяется структурой ItemOptions.
addChild(Item $item): self	Добавляет дочерний элемент (объект класса `Item`).
setNodeOptions(array $nodeOptions): self	Устанавливает настройки для DOM-узла элемента. `$nodeOptions` — массив настроек, ключи которого совпадают со структурой ItemNodeOptions.
getNodeOptions(): Dictionary	Возвращает коллекцию настроек для DOM-узла элемента.
setTagOptions(array $nodeOptions): self	Устанавливает настройки отображения элемента в виджете `TagSelector`. `$nodeOptions` — определяются массивом, ключи которого совпадают со структурой TagOptions.
getTagOptions(): Dictionary	Возвращает коллекцию настроек отображения элемента в виджете `TagSelector`.
isSelected(): bool	Возвращает `true`, если элемент выбран.
setSelected(bool $flag = true): self	Устанавливает или отменяет статус "выбран" у элемента.
isSearchable(): bool	Возвращает `true`, если элемент участвует в поиске.
setSearchable(bool $flag = true): self	Устанавливает или отменяет участие элемента в поиске.
isSaveable(): bool	Возвращает `true`, если выбор элемента запоминается для вкладки "Последние".
setSaveable(bool $flag = true): self	Устанавливает или отменяет запоминание выбора элемента для вкладки "Последние".
isDeselectable(): bool	Возвращает `true`, если у элемента можно отменить выбор.
setDeselectable(bool $flag = true): self	Устанавливает или отменяет возможность снять выбор с элемента.
isHidden(): bool	Возвращает `true`, если элемент скрытый.
setHidden(bool $flag = true): self	Устанавливает или отменяет статус "скрытый" у элемента.
isAvailableInRecentTab(): bool	Возвращает `false`, если элемент не должен отображаться на вкладке "Последние".
setAvailableInRecentTab(bool $flag = true): self	Устанавливает видимость элемента на вкладке "Последние".
setCustomData(array $customData): self	Устанавливает коллекцию дополнительных данных элемента.
getCustomData(): Dictionary	Возвращает коллекцию дополнительных данных элемента.
setSort(?int $sort): self	Устанавливает сортировку элемента.
getSort(): ?int	Возвращает сортировку элемента.