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

Item

Класс-контроллер для обработки rest и ajax запросов.


Цепочка наследования

class Bitrix\Rpa\Controller\Item extends Bitrix\Rpa\Controller\Base

Методы

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

Но у этого класса есть некоторые методы, которые вызываются из php, они описаны ниже.

Метод Описание С версии
public function prepareItemData(\Bitrix\Rpa\Model\Item $item, array $params = []): array Метод возвращает структуру, аналогичную ответу на rpa.item.get.
  • $item - объект Item;
  • $params - набор булевых значений для управления отдаваемым набором данных:
    • $params['withTasks'] - по умолчанию true, в ответе будут данные о количестве заданий (tasksCounter) и участниках заданий (tasksFaces);
    • $params['withUsers'] - по умолчанию true, в ответе будут данные о пользователях, которые имели касание к элементу (users);
    • $params['withDisplay'] - по умолчанию false, в ответе будет ключ display с отрисованными значениями пользовательских полей;
    • $params['withPermissions'] - по умолчанию false, в ответе будут данные о разрешениях текущего пользователя (permissions).
public function prepareValue($value) Метод возвращает подготовленное к использованию в rest/ajax значение пользовательского поля.
public function getSortByPreviousItemId(\Bitrix\Rpa\Model\Item $item, int $userId, int $previousItemId = 0): int Возвращает индекс сортировки элемента $item для пользователя $userId при его перемещении после $previousItemId.


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

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

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

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

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