FilesExpand file tree

 develop

/

manager.php

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

147 lines (136 loc) · 2.94 KB

 develop

/

manager.php

Copy path

Top

File metadata and controls

• Code
• Blame

147 lines (136 loc) · 2.94 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

<?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\cron;

/**

* Cron manager class.

*

* Finds installed cron tasks, stores task objects, provides task selection.

*/

class manager

{

/**

* Set of \phpbb\cron\task\wrapper objects.

* Array holding all tasks that have been found.

*

* @var array

*/

protected $tasks = array();

protected $phpbb_root_path;

protected $php_ext;

/**

* Constructor. Loads all available tasks.

*

* @param array|\Traversable $tasks Provides an iterable set of task names

* @param string $phpbb_root_path Relative path to phpBB root

* @param string $php_ext PHP file extension

*/

public function __construct($tasks, $phpbb_root_path, $php_ext)

{

$this->phpbb_root_path = $phpbb_root_path;

$this->php_ext = $php_ext;

$this->load_tasks($tasks);

}

/**

* Loads tasks given by name, wraps them

* and puts them into $this->tasks.

*

* @param array|\Traversable $tasks Array of instances of \phpbb\cron\task\task

*

* @return null

*/

public function load_tasks($tasks)

{

foreach ($tasks as $task)

{

$this->tasks[] = $this->wrap_task($task);

}

}

/**

* Finds a task that is ready to run.

*

* If several tasks are ready, any one of them could be returned.

*

* If no tasks are ready, null is returned.

*

* @return \phpbb\cron\task\wrapper|null

*/

public function find_one_ready_task()

{

shuffle($this->tasks);

foreach ($this->tasks as $task)

{

if ($task->is_ready())

{

return $task;

}

}

return null;

}

/**

* Finds all tasks that are ready to run.

*

* @return array List of tasks which are ready to run (wrapped in \phpbb\cron\task\wrapper).

*/

public function find_all_ready_tasks()

{

$tasks = array();

foreach ($this->tasks as $task)

{

if ($task->is_ready())

{

$tasks[] = $task;

}

}

return $tasks;

}

/**

* Finds a task by name.

*

* If there is no task with the specified name, null is returned.

*

* Web runner uses this method to resolve names to tasks.

*

* @param string $name Name of the task to look up.

* @return \phpbb\cron\task\task A task corresponding to the given name, or null.

*/

public function find_task($name)

{

foreach ($this->tasks as $task)

{

if ($task->get_name() == $name)

{

return $task;

}

}

return null;

}

/**

* Find all tasks and return them.

*

* @return array List of all tasks.

*/

public function get_tasks()

{

return $this->tasks;

}

/**

* Wraps a task inside an instance of \phpbb\cron\task\wrapper.

*

* @param \phpbb\cron\task\task $task The task.

* @return \phpbb\cron\task\wrapper The wrapped task.

*/

public function wrap_task(\phpbb\cron\task\task $task)

{

return new \phpbb\cron\task\wrapper($task, $this->phpbb_root_path, $this->php_ext);

}

}