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 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 
<?php
/* --------------------------------------------------------------
   ModuleCenterModuleInterface.inc.php 2017-09-28
   Gambio GmbH
   http://www.gambio.de
   Copyright (c) 2017 Gambio GmbH
   Released under the GNU General Public License (Version 2)
   [http://www.gnu.org/licenses/gpl-2.0.html]
   --------------------------------------------------------------
*/

/**
 * Interface ModuleCenterModuleInterface
 * 
 * @category   System
 * @package    Modules
 * @subpackage Interfaces
 */
interface ModuleCenterModuleInterface
{
    /**
     * Installs the module
     */
    public function install();


    /**
     * Uninstalls the module
     */
    public function uninstall();


    /**
     * Returns true, if the module is installed. Otherwise false is returned.
     * 
     * @return bool
     */
    public function isInstalled();
    
    
    /**
     * Returns true, if the module should be displayed in module center.
     * 
     * @return bool
     */
    public function isVisible();
    
    
    /**
     * Returns the name of the module
     * 
     * @return string
     */
    public function getName();

    
    /**
     * Returns the title of the module
     *
     * @return string
     */
    public function getTitle();

    
    /**
     * Returns the description of the module
     * 
     * @return string
     */
    public function getDescription();

    
    /**
     * Returns the sort order of the module
     * 
     * @return int
     */
    public function getSortOrder();
}