Base

Описание

Базовый класс компонентов модуля.

Чтобы не дублировать одни и те же фразы по разным файлам было принято решение собрать их в один файл, привязать к этому классу, и сделать отдельный метод для загрузки.

Во всех компонентах используется следующий жизненный цикл:

В методе executeComponent вызывается метод init, который производит инициализацию необходимых данных;
Если не хватает каких-то параметров, или есть какие-то ошибки, то они добавляются в errorCollection объекта;
После вызова init проверяется наличие ошибок в коллекции. Если они есть, то подключается шаблон компонента, дальнейшее выполнение прерывается;
В каждом шаблоне есть код, который проверяет наличие ошибок. Если они есть, то они выводятся, остальная часть шаблона не отрисовывается.

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

abstract class Bitrix\Rpa\Components\Base extends \CBitrixComponent implements Bitrix\Main\Errorable

Методы

Метод	Описание	С версии
`public static function getUsers(array $userIds): array`	Возвращает подготовленные данные о пользователях с идентификаторами из массива `$userIds`.
`public function addTopPanel(\CBitrixComponentTemplate $template)`	Добавляет верхнюю панель из компонента `$template`. Используется в `component_epilog.php` шаблона компонента `rpa.router`. Таким образом, панель есть на всех страницах модуля.
`public function addToolbar(\CBitrixComponentTemplate $template)`	Добавляет "второй" тулбар модуля `rpa` (компонент `rpa.toolbar`).
`public static function loadBaseLanguageMessages(): array`	Подключает общие языковые фразы модуля. Возвращает массив с этими фразами.

Защищенные методы

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

Метод	Описание	С версии
`protected function init(): void`	Метод выполняет инициализацию, если есть ошибки, они складываются в `$this->errorCollection`.
`protected function getTypeId(): ?int`	Метод должен возвращать идентификатор текущего процесса.
`protected function getTopPanelItems(): array`	Метод возвращает массив элементов для верхней панели.
`protected function getToolbarParameters(): array`	Метод возвращает массив с параметрами для передачи в `rpa.toolbar`. Массив должен иметь следующую структуру: [ 'typeId' => $this->getTypeId(), // идентификатор процесса 'buttons' => [], // кнопки для ui.toolbar 'filter' => [], // настройки фильтра для ui.toolbar 'views' => [], // настройки для переключателя отображения 'tasks' => 0, // счетчик заданий ];