[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
  26      */
  27  	public function is_enableable();
  28  
  29      /**
  30      * enable_step is executed on enabling an extension until it returns false.
  31      *
  32      * Calls to this function can be made in subsequent requests, when the
  33      * function is invoked through a webserver with a too low max_execution_time.
  34      *
  35      * @param    mixed    $old_state    The return value of the previous call
  36      *                                of this method, or false on the first call
  37      * @return    mixed                Returns false after last step, otherwise
  38      *                                temporary state which is passed as an
  39      *                                argument to the next step
  40      */
  41  	public function enable_step($old_state);
  42  
  43      /**
  44      * Disables the extension.
  45      *
  46      * Calls to this function can be made in subsequent requests, when the
  47      * function is invoked through a webserver with a too low max_execution_time.
  48      *
  49      * @param    mixed    $old_state    The return value of the previous call
  50      *                                of this method, or false on the first call
  51      * @return    mixed                Returns false after last step, otherwise
  52      *                                temporary state which is passed as an
  53      *                                argument to the next step
  54      */
  55  	public function disable_step($old_state);
  56  
  57      /**
  58      * purge_step is executed on purging an extension until it returns false.
  59      *
  60      * Calls to this function can be made in subsequent requests, when the
  61      * function is invoked through a webserver with a too low max_execution_time.
  62      *
  63      * @param    mixed    $old_state    The return value of the previous call
  64      *                                of this method, or false on the first call
  65      * @return    mixed                Returns false after last step, otherwise
  66      *                                temporary state which is passed as an
  67      *                                argument to the next step
  68      */
  69  	public function purge_step($old_state);
  70  }