Zabbix

<?php

/*

** Copyright (C) 2001-2025 Zabbix SIA

**

** This program is free software: you can redistribute it and/or modify it under the terms of

** the GNU Affero General Public License as published by the Free Software Foundation, version 3.

**

** This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;

** without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

** See the GNU Affero General Public License for more details.

**

** You should have received a copy of the GNU Affero General Public License along with this program.

** If not, see <https://www.gnu.org/licenses/>.

**/

​

​

/**

 * Class containing methods for operations with template groups.

 */

class CTemplateGroup extends CApiService {

​

    public const ACCESS_RULES = [

        'get' => ['min_user_type' => USER_TYPE_ZABBIX_USER],

        'create' => ['min_user_type' => USER_TYPE_SUPER_ADMIN],

        'update' => ['min_user_type' => USER_TYPE_ZABBIX_ADMIN],

        'delete' => ['min_user_type' => USER_TYPE_ZABBIX_ADMIN],

        'massadd' => ['min_user_type' => USER_TYPE_ZABBIX_ADMIN],

        'massupdate' => ['min_user_type' => USER_TYPE_ZABBIX_ADMIN],

        'massremove' => ['min_user_type' => USER_TYPE_ZABBIX_ADMIN],

        'propagate' => ['min_user_type' => USER_TYPE_SUPER_ADMIN]

    ];

​

    protected $tableName = 'hstgrp';

    protected $tableAlias = 'g';

    protected $sortColumns = ['groupid', 'name'];

​

    /**

     * Get template groups.

     *

     * @param array $options

     *

     * @return array|int

     */

    public function get(array $options) {

        $result = [];

​

        $output_fields = ['groupid', 'name', 'uuid'];

        $template_fields = ['templateid', 'host', 'name', 'description', 'uuid'];

​

        $api_input_rules = ['type' => API_OBJECT, 'fields' => [

            // filter

            'groupids' =>                           ['type' => API_IDS, 'flags' => API_ALLOW_NULL | API_NORMALIZE, 'default' => null],

            'templateids' =>                        ['type' => API_IDS, 'flags' => API_ALLOW_NULL | API_NORMALIZE, 'default' => null],

            'graphids' =>                           ['type' => API_IDS, 'flags' => API_ALLOW_NULL | API_NORMALIZE, 'default' => null],

            'triggerids' =>                         ['type' => API_IDS, 'flags' => API_ALLOW_NULL | API_NORMALIZE, 'default' => null],

            'with_templates' =>                     ['type' => API_BOOLEAN, 'default' => false],

            'with_items' =>                         ['type' => API_BOOLEAN, 'default' => false],

            'with_item_prototypes' =>               ['type' => API_BOOLEAN, 'default' => false],

            'with_simple_graph_items' =>            ['type' => API_BOOLEAN, 'default' => false],

            'with_simple_graph_item_prototypes' =>  ['type' => API_BOOLEAN, 'default' => false],

            'with_triggers' =>                      ['type' => API_BOOLEAN, 'default' => false],

            'with_httptests' =>                     ['type' => API_BOOLEAN, 'default' => false],

            'with_graphs' =>                        ['type' => API_BOOLEAN, 'default' => false],

            'with_graph_prototypes' =>              ['type' => API_BOOLEAN, 'default' => false],

            'filter' =>                             ['type' => API_FILTER, 'flags' => API_ALLOW_NULL, 'default' => null, 'fields' => ['groupid', 'name', 'uuid']],

            'search' =>                             ['type' => API_FILTER, 'flags' => API_ALLOW_NULL, 'default' => null, 'fields' => ['name']],

            'searchByAny' =>                        ['type' => API_BOOLEAN, 'default' => false],

            'startSearch' =>                        ['type' => API_BOOLEAN, 'default' => false],

            'excludeSearch' =>                      ['type' => API_BOOLEAN, 'default' => false],

            'searchWildcardsEnabled' =>             ['type' => API_BOOLEAN, 'default' => false],

            // output

            'output' =>                             ['type' => API_OUTPUT, 'in' => implode(',', $output_fields), 'default' => API_OUTPUT_EXTEND],

            'selectTemplates' =>                    ['type' => API_OUTPUT, 'flags' => API_ALLOW_NULL | API_ALLOW_COUNT, 'in' => implode(',', $template_fields), 'default' => null],

            'countOutput' =>                        ['type' => API_BOOLEAN, 'default' => false],

            // sort and limit

            'sortfield' =>                          ['type' => API_STRINGS_UTF8, 'flags' => API_NORMALIZE, 'in' => implode(',', $this->sortColumns), 'uniq' => true, 'default' => []],

            'sortorder' =>                          ['type' => API_SORTORDER, 'default' => []],

            'limit' =>                              ['type' => API_INT32, 'flags' => API_ALLOW_NULL, 'in' => '1:'.ZBX_MAX_INT32, 'default' => null],

            'limitSelects' =>                       ['type' => API_INT32, 'flags' => API_ALLOW_NULL, 'in' => '1:'.ZBX_MAX_INT32, 'default' => null],

            // flags

            'editable' =>                           ['type' => API_BOOLEAN, 'default' => false],

            'preservekeys' =>                       ['type' => API_BOOLEAN, 'default' => false],

            'nopermissions' =>                      ['type' => API_BOOLEAN, 'default' => false]

        ]];

​

        if (!CApiInputValidator::validate($api_input_rules, $options, '/', $error)) {

            self::exception(ZBX_API_ERROR_PARAMETERS, $error);

        }

​

        $sqlParts = [

            'select' => ['hstgrp' => 'g.groupid'],