Zabbix

<?php declare(strict_types = 0);

/*

** 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/>.

**/

​

​

namespace Widgets\SvgGraph\Includes;

​

use API,

    CApiInputValidator;

​

use Zabbix\Widgets\CWidgetField;

​

/**

 * Class for data set widget field used in Graph widget configuration Data set tab.

 */

class CWidgetFieldDataSet extends CWidgetField {

​

    public const DEFAULT_VIEW = CWidgetFieldDataSetView::class;

    public const DEFAULT_VALUE = [];

​

    public const DATASET_TYPE_SINGLE_ITEM = 0;

    public const DATASET_TYPE_PATTERN_ITEM = 1;

​

    // Predefined colors for data-sets in JSON format. Each next data set takes next sequential value from palette.

    public const DEFAULT_COLOR_PALETTE = [

        'FF465C', 'FFD54F', '0EC9AC', '524BBC', 'ED1248', 'D1E754', '2AB5FF', '385CC7', 'EC1594', 'BAE37D',

        '6AC8FF', 'EE2B29', '3CA20D', '6F4BBC', '00A1FF', 'F3601B', '1CAE59', '45CFDB', '894BBC', '6D6D6D'

    ];

​

    // First color from the default color palette.

    private const DEFAULT_COLOR = 'FF465C';

​

    public function __construct(string $name, ?string $label = null) {

        parent::__construct($name, $label);

​

        $this

            ->setDefault(self::DEFAULT_VALUE)

            ->setValidationRules(['type' => API_OBJECTS, 'fields' => [

                'dataset_type'          => ['type' => API_INT32, 'in' => implode(',', [self::DATASET_TYPE_SINGLE_ITEM, self::DATASET_TYPE_PATTERN_ITEM])],

                'hosts'                 => ['type' => API_STRINGS_UTF8],

                'items'                 => ['type' => API_STRINGS_UTF8],

                'itemids'               => ['type' => API_IDS],

                'references'            => ['type' => API_STRINGS_UTF8],

                'color'                 => ['type' => API_COLOR, 'flags' => API_REQUIRED | API_NOT_EMPTY],

                'type'                  => ['type' => API_INT32, 'flags' => API_REQUIRED, 'in' => implode(',', [SVG_GRAPH_TYPE_LINE, SVG_GRAPH_TYPE_POINTS, SVG_GRAPH_TYPE_STAIRCASE, SVG_GRAPH_TYPE_BAR])],

                'stacked'               => ['type' => API_INT32, 'flags' => API_REQUIRED, 'in' => implode(',', [SVG_GRAPH_STACKED_OFF, SVG_GRAPH_STACKED_ON])],

                'width'                 => ['type' => API_INT32, 'in' => '0:10'],

                'pointsize'             => ['type' => API_INT32, 'in' => '1:10'],

                'transparency'          => ['type' => API_INT32, 'flags' => API_REQUIRED, 'in' => '0:10'],

                'fill'                  => ['type' => API_INT32, 'in' => '0:10'],

                'missingdatafunc'       => ['type' => API_INT32, 'in' => implode(',', [SVG_GRAPH_MISSING_DATA_NONE, SVG_GRAPH_MISSING_DATA_CONNECTED, SVG_GRAPH_MISSING_DATA_TREAT_AS_ZERO, SVG_GRAPH_MISSING_DATA_LAST_KNOWN])],

                'axisy'                 => ['type' => API_INT32, 'flags' => API_REQUIRED, 'in' => implode(',', [GRAPH_YAXIS_SIDE_LEFT, GRAPH_YAXIS_SIDE_RIGHT])],

                'timeshift'             => ['type' => API_TIME_UNIT, 'flags' => API_REQUIRED, 'in' => implode(':', [ZBX_MIN_TIMESHIFT, ZBX_MAX_TIMESHIFT])],

                'aggregate_function'    => ['type' => API_INT32, 'flags' => API_REQUIRED, 'in' => implode(',', [AGGREGATE_NONE, AGGREGATE_MIN, AGGREGATE_MAX, AGGREGATE_AVG, AGGREGATE_COUNT, AGGREGATE_SUM, AGGREGATE_FIRST, AGGREGATE_LAST])],

                'aggregate_interval'    => ['type' => API_MULTIPLE, 'rules' => [

                    ['if' => ['field' => 'aggregate_function', 'in' => implode(',', [AGGREGATE_MIN, AGGREGATE_MAX, AGGREGATE_AVG, AGGREGATE_COUNT, AGGREGATE_SUM, AGGREGATE_FIRST, AGGREGATE_LAST])],

                        'type' => API_TIME_UNIT, 'flags' => API_REQUIRED | API_NOT_EMPTY | API_TIME_UNIT_WITH_YEAR, 'in' => implode(':', [1, ZBX_MAX_TIMESHIFT])],

                    ['else' => true, 'type' => API_STRING_UTF8, 'in' => GRAPH_AGGREGATE_DEFAULT_INTERVAL]

                ]],

                'aggregate_grouping'    => ['type' => API_INT32, 'in' => implode(',', [GRAPH_AGGREGATE_BY_ITEM, GRAPH_AGGREGATE_BY_DATASET])],

                'approximation'         => ['type' => API_INT32, 'in' => implode(',', [APPROXIMATION_MIN, APPROXIMATION_AVG, APPROXIMATION_MAX, APPROXIMATION_ALL])],

                'data_set_label'        => ['type' => API_STRING_UTF8, 'length' => 255]

            ]]);

    }

​

    public function setValue($value): self {

        $data_sets = [];

​

        foreach ((array) $value as $data_set) {

            $data_sets[] = $data_set + self::getDefaults();

        }

​

        return parent::setValue($data_sets);

    }

​

    public static function getDefaults(): array {

        return [

            'dataset_type' => self::DATASET_TYPE_PATTERN_ITEM,

            'hosts' => [],

            'items' => [],