Zabbix

<?php

/*

** Zabbix

** Copyright (C) 2001-2024 Zabbix SIA

**

** This program is free software; you can redistribute it and/or modify

** it under the terms of the GNU General Public License as published by

** the Free Software Foundation; either version 2 of the License, or

** (at your option) any later version.

**

** 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 General Public License for more details.

**

** You should have received a copy of the GNU General Public License

** along with this program; if not, write to the Free Software

** Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

**/

​

​

/**

 * Class containing methods for operations with widget iterators.

 */

abstract class CControllerWidgetIterator extends CControllerWidget {

​

    /**

     * @var array $iterator_validation_rules  Validation rules for input parameters of the iterator.

     */

    private static $iterator_validation_rules = [

        'page' => 'required|ge 1'

    ];

​

    public function __construct() {

        parent::__construct();

​

        $this->setValidationRules(self::$iterator_validation_rules);

    }

​

    /**

     * Set validation rules for input parameters.

     *

     * @param array $validation_rules  Validation rules for input parameters.

     *

     * @return object

     */

    protected function setValidationRules(array $validation_rules) {

        return parent::setValidationRules(array_merge(self::$iterator_validation_rules, $validation_rules));

    }

​

    /**

     * Get realistic page number for given number of child widgets.

     *

     * @param int $num_widgets  Number of child widgets.

     *

     * @return int  Page number.

     */

    protected function getIteratorPage($num_widgets) {

        return max(1, min((int) $this->getInput('page'), $this->getIteratorPageCount($num_widgets)));

    }

​

    /**

     * Get number of child widgets to show on a single page.