wcfsetup/install/files/lib/system/package/plugin/IPackageInstallationPlugin.class.php

   1 <?php
   2 namespace wcf\system\package\plugin;
   3
   4 /**
   5  * Every PackageInstallationPlugin has to implement this interface.
   6  *
   7  * @author      Marcel Werk
   8  * @copyright   2001-2014 WoltLab GmbH
   9  * @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  10  * @package     com.woltlab.wcf
  11  * @subpackage  system.package.plugin
  12  * @category    Community Framework
  13  */
  14 interface IPackageInstallationPlugin {
  15         /**
  16          * Executes the installation of this plugin.
  17          */
  18         public function install();
  19
  20         /**
  21          * Executes the update of this plugin.
  22          */
  23         public function update();
  24
  25         /**
  26          * Returns true if the uninstallation of the given package should execute
  27          * this plugin.
  28          *
  29          * @return      boolean
  30          */
  31         public function hasUninstall();
  32
  33         /**
  34          * Executes the uninstallation of this plugin.
  35          */
  36         public function uninstall();
  37 }