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

Driver

Класс-синглтон. Хранит в себе инстансы других объектов, кеш данных о процессах, обработчики событий.

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

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

Методы

Метод Описание С версии
public static function getInstance(): Driver Возвращает инстанс объекта.
public function getFactory(): Factory Возвращает инстанс Bitrix\Rpa\Factory.
public function getUserId(): int Возвращает идентификатор текущего пользователя. Если он не найден (код выполняется на агенте), то вернет 0.
public function getType(int $typeId): ?Type Возвращает процесс по его ид $typeId.

Рекомендуется использовать именно этот метод, когда нужно получить объект процесса. Т.к. данные о процессе кешируются и загружаются из базы данных только один раз.

public function getUserPermissions(int $userId = null): UserPermissions Возвращает инстанс разрешений пользователя с ид $userId.

Если $userId пустой, то он будет получен из $this->getUserId().

public function getUrlManager(): UrlManager Возвращает инстанс менеджера адресов.
public function getDirector(): Director Возвращает инстанс менеджера сценариев.
public function getTaskManager(): ?TaskManager Возвращает менеджер автоматизации, если она доступна.
public function getPullManager(): PullManager Возвращает инстанс менеджера пушей.
public function isAutomationEnabled(): bool Возвращает true, если автоматизация доступна (установлен модуль bizproc).
public function deleteAllData(): Result Удаляет все элементы, стадии и процессы. Вызывается при удалении модуля.

Этот метод нужен, чтобы были корректно удалены связанные данные, в особенности, файлы из диска и b_file.



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

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

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

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

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