ItemSortTable
Описание и методы
Класс-таблет для работы с таблицей пользовательской сортировки элементов в канбане.
Цепочка наследования
Является наследником класса Bitrix\Main\ORM\Data\DataManager.
Методы
| Метод | Описание | С версии |
|---|---|---|
public static function setSortForItem(Item $item, int $userId, int $sort): ORM\Data\Result |
Если для элемента задана сортировка, она будет обновлена. Если записи нет, она будет создана. Возвращает ORM\Data\Result. |
|
public static function removeForItem(int $typeId, int $itemId): Result |
Удаляет все записи из таблицы, связанные с элементом $itemId процесса $typeId. Возвращает объект Bitrix\Main\Result. |
|
public static function removeByTypeId(int $typeId): Result |
Удаляет все записи из таблицы, связанные с процессом $typeId. Возвращает объект Bitrix\Main\Result. |
|
public static function getSort(int $userId, Type $type, int $stageId, int $previousItemId = null, bool $isResort = true): int |
Возвращает индекс сортировки для элемента, учитывая его положение в стадии.
Внутри он пересортирует элементы на стадии, если произошла коллизия. Использовать осторожно, т.к. внутри выполняются запросы. |
|
public static function fillItemsSortInStageBeforeItem(int $userId, Item $beforeItem): void |
Заполняет индекс сортировки у элементов перед $beforeItem для пользователя $userId. |
|
public static function getMaxSort(int $userId, Stage $stage): int |
Возвращает максимальный индекс сортировки для пользователя $userId в стадии $stage. |
|
public static function getItemReferenceField(Type $type): Reference |
Возвращает объект Bitrix\Main\ORM\Fields\Relations\Reference для связи с конкретной таблицей элементов процесса $typeId. |
Поля таблицы
| Поле | Описание | Тип | Обяз. |
|---|---|---|---|
| ID | Идентификатор | Int | Да |
| USER_ID | Идентификатор пользователя. | Int | Да |
| TYPE_ID | Идентификатор процесса. | Int | Да |
| ITEM_ID | Идентификатор элемента. | Int | Да |
| SORT | Индекс сортировки. | Int | Да |
© «Битрикс», 2001-2024, «1С-Битрикс», 2024
Пользовательские комментарии
Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.Для этого нужно всего лишь авторизоваться на сайте
Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.
Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.