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

Type

ORM-объект для работы с процессом.

Имеет набор геттеров-сеттеров для системных полей.

Является наследником базового класса.

Процесс хранит внутри себя коллекцию связанных с ним стадий. Если в каком-то месте необходимо получить ту или иную стадию, или все сразу, лучше использовать геттеры этого класса


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

class Type extends Bitrix\Main\UserField\Internal\Type implements Bitrix\Rpa\Permission\Containable

Методы

Метод Описание С версии
public function getStages(): EO_Stage_Collection Возвращает коллекцию стадий процесса.

Стадии в коллекции отсортированы по индексу сортировки, но в конце всегда идёт сначала успешная стадия, а за ней все провальные.

Рекомендуется использовать этот метод для получения стадий процесса везде. Делает запрос к базе данных только один раз.

public function getStage(int $stageId): ?Stage Возвращает стадию по её $stageId. Рекомендуется использовать этот метод для получения стадии процесса везде.
public function resortStages(): Type Выполняет пересортировку стадий в коллекции стадий этого процесса. Этот метод надо использовать, если сортировка была изменена.

Возвращает $this

public function getFirstStage(): ?Stage Возвращает первую стадию процесса.
public function getSuccessStage(): ?Stage Возвращает успешную стадию процесса.
public function getFailStages(): EO_Stage_Collection Возвращает коллекцию провальных стадий процесса.
public function getFinalStages(): EO_Stage_Collection Возвращает коллекцию финальных стадий процесса.
public function createStage(): Stage Создает новый объект стадии.
public function createItem(): Item Создает новый объект элемента.
public function getItem(int $itemId): ?Item Возвращает элемент по его $itemId.
public function getItems(array $parameters = []): Collection Возвращает коллекцию элементов. $parameters - стандартный для getList набор параметров.
public function getItemsCount(array $filter = []): int Возвращает количество элементов процесса для фильтра $filter.
public function getItemUserFieldsEntityId(): string Возвращает строковый идентификатор пользовательских полей элементов процесса.
public function getUserFieldCollection(): UserFieldCollection Возвращает коллекцию настроек пользовательских полей [link=]с видимостями[/link], которые привязаны ко всему процессу.
public function getItemUfNameFieldName(): string Возвращает код пользовательского поля, в котором хранится заголовок элемента.


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

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

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

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

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