librenms/LibreNMS/Interfaces/ValidationGroup.php

<?php
/**
 * ValidationGroup.php
 *
 * An interface for validation groups, this will be run by Validator.
 *
 * 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 3 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, see <http://www.gnu.org/licenses/>.
 *
 * @link       http://librenms.org
 * @copyright  2017 Tony Murray
 * @author     Tony Murray <murraytony@gmail.com>
 */

namespace LibreNMS\Interfaces;

use LibreNMS\Validator;

interface ValidationGroup
{
    /**
     * Validate this module.
     * To return ValidationResults, call ok, warn, fail, or result methods on the $validator
     *
     * @param Validator $validator
     */
    public function validate(Validator $validator);

    /**
     * Returns if this test should be run by default or not.
     *
     * @return bool
     */
    public function isDefault();

    /**
     * Returns true if this group has been run
     *
     * @return bool
     */
    public function isCompleted();

    /**
     * Mark this group as completed
     *
     * @return void
     */
    public function markCompleted();
}