На странице

Действия

Действия отвечают за 'бизнес-логику' модуля. Действие обычно состоит из controller и action view.

Модуль может:

  • Вызвать действия, которые уже определены в веб-интерфейсе Zabbix.
  • Переопределить действия по умолчанию настраиваемыми действиями.
  • Определить совершенно новые действия.

Чтобы переопределить поведение действия по умолчанию некоторым пользовательским поведением, определите действие с тем же именем в конфигурации модуля. При вызове действия вместо действия Zabbix по умолчанию будет выполнено действие модуля.

Файлы действий должны храниться в папке actions. Действия необходимо указать в файле manifest.json.

Контроллер

Рабочий процесс контроллера действия:

  1. Проверить, что все параметры, переданные в HTTP-запросе, являются допустимыми:

    • Вызвать метод контроллера checkInput();
    • Использовать правила валидации, определенные в CNewValidator.php;
    • Вызвать метод validateInput().
  2. Проверить права пользователя.

  3. Подготовить данные в соответствии с переданными параметрами: если checkInput() возвращает true, Zabbix вызывает метод контроллера doAction().

  4. Подготовить массив $data для представления. Используйте CControllerResponseData и метод setResponse() для сохранения ответа в массиве $data.

Пример:

/**
 * Validate input parameters.
 *
 * @return bool
 */
protected function checkInput(): bool {
    $ret = $this->validateInput([
        'status' => 'in '.implode(',', [HOST_STATUS_MONITORED, HOST_STATUS_NOT_MONITORED])
    ]);

    if (!$ret) {
        $this->setResponse(new CControllerResponseFatal());
    }

    return $ret;
}

/**
 * Check user permissions.
 *
 * @return bool
 */
protected function checkPermissions() {
    return $this->getUserType() >= USER_TYPE_ZABBIX_ADMIN;
}

/**
 * Execute action and generate response object.
 */
protected function do Action(): void {
    $data = [ 
        'hosts_count' => API::Host()->get([
            'countOutput' => true,
            'filter' => [
                'status' => $this->getInput('status')
            ]
        ]) 
    ];

    $this->setResponse(new CControllerResponseData($data));
}

Полный список доступных классов контроллеров в Zabbix можно посмотреть в исходном коде.