[ Index ]

PHP Cross Reference of phpBB-3.3.14-deutsch

title

Body

[close]

/phpbb/install/ -> module_interface.php (summary)

This file is part of the phpBB Forum Software package.

Copyright: (c) phpBB Limited
License: GNU General Public License, version 2 (GPL-2.0)
File Size: 63 lines (1 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

module_interface:: (5 methods):
  is_essential()
  check_requirements()
  run()
  get_step_count()
  get_navigation_stage_path()


Interface: module_interface  - X-Ref

Interface for installer modules

An installer module is a task collection which executes installer tasks.
is_essential()   X-Ref
Checks if the execution of the module is essential to install phpBB or it can be skipped

Note: Please note that all the non-essential modules have to implement check_requirements()
method.

return: bool    true if the module is essential, false otherwise

check_requirements()   X-Ref
Checks requirements for the tasks

Note: Only need to be implemented for non-essential tasks, as essential tasks
requirements should be checked in the requirements install module.

return: bool    true if the task's requirements are met

run()   X-Ref
Executes the task

return: null

get_step_count()   X-Ref
Returns the number of tasks in the module

return: int

get_navigation_stage_path()   X-Ref
Returns an array to the correct navigation stage

return: array



Generated: Mon Nov 25 19:05:08 2024 Cross-referenced by PHPXref 0.7.1