[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3  *
   4  * This file is part of the phpBB Forum Software package.
   5  *
   6  * @copyright (c) phpBB Limited <https://www.phpbb.com>
   7  * @license GNU General Public License, version 2 (GPL-2.0)
   8  *
   9  * For full copyright and license information, please see
  10  * the docs/CREDITS.txt file.
  11  *
  12  */
  13  
  14  namespace phpbb\extension;
  15  
  16  /**
  17  * The interface extension meta classes have to implement to run custom code
  18  * on enable/disable/purge.
  19  */
  20  interface extension_interface
  21  {
  22      /**
  23      * Indicate whether or not the extension can be enabled.
  24      *
  25      * @return bool|array    True if extension is enableable, array of reasons
  26      *                        if not, false for generic reason.
  27      */
  28  	public function is_enableable();
  29  
  30      /**
  31      * enable_step is executed on enabling an extension until it returns false.
  32      *
  33      * Calls to this function can be made in subsequent requests, when the
  34      * function is invoked through a webserver with a too low max_execution_time.
  35      *
  36      * @param    mixed    $old_state    The return value of the previous call
  37      *                                of this method, or false on the first call
  38      * @return    mixed                Returns false after last step, otherwise
  39      *                                temporary state which is passed as an
  40      *                                argument to the next step
  41      */
  42  	public function enable_step($old_state);
  43  
  44      /**
  45      * Disables the extension.
  46      *
  47      * Calls to this function can be made in subsequent requests, when the
  48      * function is invoked through a webserver with a too low max_execution_time.
  49      *
  50      * @param    mixed    $old_state    The return value of the previous call
  51      *                                of this method, or false on the first call
  52      * @return    mixed                Returns false after last step, otherwise
  53      *                                temporary state which is passed as an
  54      *                                argument to the next step
  55      */
  56  	public function disable_step($old_state);
  57  
  58      /**
  59      * purge_step is executed on purging an extension until it returns false.
  60      *
  61      * Calls to this function can be made in subsequent requests, when the
  62      * function is invoked through a webserver with a too low max_execution_time.
  63      *
  64      * @param    mixed    $old_state    The return value of the previous call
  65      *                                of this method, or false on the first call
  66      * @return    mixed                Returns false after last step, otherwise
  67      *                                temporary state which is passed as an
  68      *                                argument to the next step
  69      */
  70  	public function purge_step($old_state);
  71  }