On this page

动作

动作负责模块的“业务逻辑”。一个动作通常由一个控制器和一个动作视图组成。

一个模块可以:

  • 调用Zabbix前端中已经定义的动作。
  • 使用自定义动作覆盖默认动作。
  • 定义全新的动作。

要使用某些自定义行为覆盖默认动作行为,请在模块配置中定义一个同名的动作。当调用该动作时,将执行模块的动作而不是默认的Zabbix动作。

动作文件应存储在actions文件夹中。这些动作需要在manifest.json中进行指定。

控制器

Action controller 工作流:

  1. 检查在 HTTP 请求中传递的所有参数是否有效:

    • 调用 controller 的 checkInput() 方法;
    • 使用 CNewValidator.php 中定义的验证规则;
    • 调用 validateInput() 方法。
  2. 检查用户权限。

  3. 根据传入的参数准备数据:如果 checkInput() 返回 true,Zabbix 会调用 controller 的 doAction() 方法。

  4. 为视图准备 $data 数组。使用 CControllerResponseDatasetResponse() 方法将响应存储到 $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 源代码 中查看可用 controller 类的完整列表。