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

Item

Описание

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

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

  • getStageId(): int
  • setStageId(int $stageId): void
  • getPreviousStageId(): int
  • setPreviousStageId(int $previousStageId): void
  • getCreatedBy(): int
  • setCreatedBy(int $userId): void
  • getUpdatedBy(): ?int
  • setUpdatedBy(int $userId): void
  • getMovedBy(): ?int
  • setMovedBy(int $userId): void
  • getCreatedTime(): Bitrix\Main\Type\DateTime
  • setCreatedTime(Bitrix\Main\Type\DateTime $dateTime): void
  • getUpdatedTime(): ?Bitrix\Main\Type\DateTime
  • setUpdatedTime(Bitrix\Main\Type\DateTime $dateTime): void
  • getMovedTime(): ?Bitrix\Main\Type\DateTime
  • setMovedTime(Bitrix\Main\Type\DateTime $dateTime): void

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

Bitrix\Rpa\Model\Item extends Bitrix\Main\UserField\Internal\Item

Методы

Ниже представлен набор собственных методов класса.

Метод Описание С версии
public function getType(): Type Возвращает объект Bitrix\Rpa\Model\Type - объект для работы с процессом элемента.
public function getStage(): ?Stage Возвращает объект Bitrix\Rpa\Model\Stage - объект для работы со стадией элемента.

Метод может не вернуть объект стадии, если она не существует.

Надо иметь в виду, что метод возвращает стадию элемента, которая могла быть изменена в рантайме.

public function getPreviousStage(): ?Stage Возвращает объект Bitrix\Rpa\Model\Stage для предыдущей стадии элемента.

Работает аналогично getStage()

public function getName(): string Возвращает строку-название элемента.

Если в процессе есть поле для названия, то значение берется оттуда. Если поля нет или значение не заполнено, то название формируется автоматически

Имя поля для названия формируется по шаблону UF_RPA_ + ID процесса + NAME

public function isEmptyUserFieldValue($fieldName): bool Возвращает true, если у поля с кодом $fieldName нет значения.
public function getChangedUserFieldNames(): array Возвращает массив кодов пользовательских полей, значения которых изменены.
public function getUserIds(): array Возвращает массив уникальных ид пользователей из полей CREATED_BY, UPDATED_BY, MOVED_BY. Если там один и тот же пользователь, то результат будет следующим:

$userId = $item->getCreatedBy(); // 10

$users = $item->getUserIds();
/*$users = [
	10 => 10,
];*/
public function isValueChanged(string $fieldName): bool Возвращает true, если значение поля с кодом $fieldName было изменено.


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