[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\install;
  15  
  16  /**
  17   * Interface for installer modules
  18   *
  19   * An installer module is a task collection which executes installer tasks.
  20   */
  21  interface module_interface
  22  {
  23      /**
  24       * Checks if the execution of the module is essential to install phpBB or it can be skipped
  25       *
  26       * Note: Please note that all the non-essential modules have to implement check_requirements()
  27       * method.
  28       *
  29       * @return    bool    true if the module is essential, false otherwise
  30       */
  31  	public function is_essential();
  32  
  33      /**
  34       * Checks requirements for the tasks
  35       *
  36       * Note: Only need to be implemented for non-essential tasks, as essential tasks
  37       * requirements should be checked in the requirements install module.
  38       *
  39       * @return bool    true if the task's requirements are met
  40       */
  41  	public function check_requirements();
  42  
  43      /**
  44       * Executes the task
  45       *
  46       * @return    null
  47       */
  48  	public function run();
  49  
  50      /**
  51       * Returns the number of tasks in the module
  52       *
  53       * @return int
  54       */
  55  	public function get_step_count();
  56  
  57      /**
  58       * Returns an array to the correct navigation stage
  59       *
  60       * @return array
  61       */
  62  	public function get_navigation_stage_path();
  63  }