File phpboost/module/ModuleSetup.class.php

 1:  2:  3:  4:  5:  6:  7:  8:  9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 

<?php
/**
 * @package     PHPBoost
 * @subpackage  Module
 * @copyright   &copy; 2005-2019 PHPBoost
 * @license     https://www.gnu.org/licenses/gpl-3.0.html GNU/GPL-3.0
 * @author      Loic ROUCHON <horn@phpboost.com>
 * @version     PHPBoost 5.2 - last update: 2014 12 22
 * @since       PHPBoost 2.0 - 2009 01 14
*/

interface ModuleSetup
{
    /**
     * Returns a validation result containing environment errors
     * @return ValidationResult a validation result containing environment errors
     */
    function check_environment();

    /**
     * Install the module
     */
    function install();

    /**
     * Uninstall the module
     * @return string error if module uninstall failled
     */
    function uninstall();

    /**
     * Upgrade the module
     * @return version upgrading
     */
    function upgrade($installed_version);
}
?>