blob: 794cb164827f56727e48b3e41c63347a68a3ea91 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
|
<?php
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/
namespace phpbb\install;
/**
* Interface for installer tasks
*/
interface task_interface
{
/**
* Returns the number of steps the task contains
*
* This is a helper method to provide a better progress bar for the front-end.
*
* @return int The number of steps that the task contains
*/
static public function get_step_count();
/**
* Checks if the task 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 task is essential, false otherwise
*/
public function is_essential();
/**
* 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
*/
public function check_requirements();
/**
* Executes the task
*/
public function run();
/**
* Returns the language key of the name of the task
*
* @return string
*/
public function get_task_lang_name();
}
|
