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

Stage

ORM-объект для работы со стадией.

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


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

class Bitrix\Rpa\Model\Stage extends Bitrix\Main\Rpa\Midel\EO_Stage implements Bitrix\Rpa\Permission\Containable

Методы

Метод Описание С версии
public function getType(): Type Возвращает объект Bitrix\Rpa\Model\Type, к которому привязана эта стадия.
public function getUserFieldCollection(): UserFieldCollection Возвращает объект Bitrix\Rpa\UserField\UserFieldCollection У этого объекта уже будут установлены настройки видимости текущей стадии.
public function getPermissions(bool $isFromCache = true): array Возвращает массив записей о правах доступа для этой стадии.
public function getFieldSettings(bool $isFromCache = true): array Возвращает массив записей о настройках видимости для этой стадии.
public function getPossibleNextStageIds(bool $isFromCache = false): array Возвращает массив ID стадий, в которые можно сдвинуть элемент из этой стадии. Сейчас эта настройка не используется, пользователь может двигать из любой стадии в любую.
public function getItems(array $parameters = []): Collection Возвращает коллекцию элементов, которые находятся по этой стадии. $parameters - стандартный набор настроек для getList() таблета.
public function getUserSortedItems(array $parameters = [], int $userId = null): Collection Возвращает коллекцию элементов, которые находятся на этой стадии. Элементы в коллекции отсортированы согласно пользовательской сортировке для пользователя $userId.

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

$parameters - стандартный набор настроек для getList() таблета

public function getItemsCount(): int Возвращает число элементов, которые привязаны к этой стадии.
public function isFirst(): bool Возвращает true, если эта стадия первая.
public function isSuccess(): bool Возвращает true, если эта стадия успешная.
public function isFail(): bool Возвращает true, если эта стадия провальная.
public function isFinal(): bool Возвращает true, если эта стадия имеет семантику успеха или провала.


© «Битрикс», 2001-2024, «1С-Битрикс», 2024