アクション

アクションは、モジュールの'ビジネスロジック'を担当します。アクションは通常、コントローラーアクションビューで構成されます。

モジュールは次の操作を実行できます。

  • Zabbixフロントエンドで既に定義されているアクションを呼び出す。
  • デフォルトのアクションをカスタムアクションで上書きする。
  • まったく新しいアクションを定義する。

デフォルトのアクション動作をカスタム動作で上書きするには、モジュール設定で同じ名前のアクションを定義します。 アクションが呼び出されると、デフォルトのZabbixアクションの代わりにモジュールアクションが実行されます。

アクションファイルはactionsフォルダーに保存する必要があります。アクションはmanifest.jsonで指定する必要があります。

コントローラー

アクションコントローラーのワークフロー:

  1. HTTPリクエストで渡されたすべてのパラメータが有効であることを確認します:

    • コントローラーの checkInput() メソッドを呼び出します。
    • CNewValidator.php で定義されたバリデーションルールを使用します。
    • validateInput() メソッドを呼び出します。
  2. ユーザー権限を確認します。

  3. 渡されたパラメータに従ってデータを準備します: checkInput() が true を返した場合、Zabbix はコントローラーの doAction() メソッドを呼び出します。

  4. ビュー用の $data 配列を準備します。レスポンスを $data 配列に格納するには、CControllerResponseDatasetResponse() メソッドを使用します。

例:

/**
 * 入力パラメータを検証します。
 *
 * @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;
}

/**
 * ユーザー権限を確認します。
 *
 * @return bool
 */
protected function checkPermissions() {
    return $this->getUserType() >= USER_TYPE_ZABBIX_ADMIN;
}

/**
 * アクションを実行し、レスポンスオブジェクトを生成します。
 */
protected function do Action(): void {
    $data = [ 
        'hosts_count' => API::Host()->get([
            'countOutput' => true,
            'filter' => [
                'status' => $this->getInput('status')
            ]
        ]) 
    ];

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

利用可能なコントローラークラスの完全な一覧は、Zabbix のソースコードで確認できます。