Документация для разработчиков
Темная тема

Класс ItemCollection

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

Объект коллекции создается автоматически и доступен в провайдере данных через метод $dialog->getItemCollection().

Для добавления элементов в диалог используйте методы $dialog->addItem() или $dialog->addItems() класса Dialog.

Также эту коллекцию возвращают статические методы Dialog::getItems и Dialog::getSelectedItems.

Метод Описание С версии
add(Item $item): bool Добавляет элемент (объект класса Item) в коллекцию.
Для добавления элементов в провайдере данных необходимо использовать методы $dialog->addItem() или $dialog->addItems().
get(string $entityId, string|int $itemId): ?Item Возвращает элемент коллекции по указанным идентификаторам сущности и элемента.
has(Item $item): bool Возвращает true, если указанным элемент присутствует в коллекции.
getAll(): array Возвращает массив всех элементов.
count(): int Возвращает количество элементов коллекции.
getEntityItems(string $entityId): array Возвращает массив элементов указанной сущности.
toJsObject(): string Возвращает JavaScript представление коллекции. Может использоваться для передачи данных коллекции из PHP в JavaScript.
toArray(): array Возвращает элементы коллекции в виде массивов данных.

Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2024, «1С-Битрикс», 2024
Наверх