forked from phpbb-extensions/autogroups
/
ext.php
135 lines (113 loc) · 3.46 KB
/
ext.php
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
<?php
/**
*
* Auto Groups extension for the phpBB Forum Software package.
*
* @copyright (c) 2014 phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
*/
namespace phpbb\autogroups;
/**
* This ext class is optional and can be omitted if left empty.
* However you can add special (un)installation commands in the
* methods enable_step(), disable_step() and purge_step(). As it is,
* these methods are defined in \phpbb\extension\base, which this
* class extends, but you can overwrite them to give special
* instructions for those cases.
*/
class ext extends \phpbb\extension\base
{
/**
* Overwrite enable_step to enable Auto Groups notifications
* before any included migrations are installed.
*
* @param mixed $old_state State returned by previous call of this method
* @return mixed Returns false after last step, otherwise temporary state
* @access public
*/
public function enable_step($old_state)
{
switch ($old_state)
{
case '': // Empty means nothing has run yet
// Enable Auto Groups notifications
return $this->notification_handler('enable', array(
'phpbb.autogroups.notification.type.group_added',
'phpbb.autogroups.notification.type.group_removed',
));
break;
default:
// Run parent enable step method
return parent::enable_step($old_state);
break;
}
}
/**
* Overwrite disable_step to disable Auto Groups notifications
* before the extension is disabled.
*
* @param mixed $old_state State returned by previous call of this method
* @return mixed Returns false after last step, otherwise temporary state
* @access public
*/
public function disable_step($old_state)
{
switch ($old_state)
{
case '': // Empty means nothing has run yet
// Disable Auto Groups notifications
return $this->notification_handler('disable', array(
'phpbb.autogroups.notification.type.group_added',
'phpbb.autogroups.notification.type.group_removed',
));
break;
default:
// Run parent disable step method
return parent::disable_step($old_state);
break;
}
}
/**
* Overwrite purge_step to purge Auto Groups notifications before
* any included and installed migrations are reverted.
*
* @param mixed $old_state State returned by previous call of this method
* @return mixed Returns false after last step, otherwise temporary state
* @access public
*/
public function purge_step($old_state)
{
switch ($old_state)
{
case '': // Empty means nothing has run yet
// Purge Auto Groups notifications
return $this->notification_handler('purge', array(
'phpbb.autogroups.notification.type.group_added',
'phpbb.autogroups.notification.type.group_removed',
));
break;
default:
// Run parent purge step method
return parent::purge_step($old_state);
break;
}
}
/**
* Notification handler to call notification enable/disable/purge steps
*
* @param string $step The step (enable, disable, purge)
* @param array $notification_types The notification type names
* @return string Return notifications as temporary state
* @access protected
*/
protected function notification_handler($step, $notification_types)
{
$phpbb_notifications = $this->container->get('notification_manager');
foreach ($notification_types as $notification_type)
{
call_user_func(array($phpbb_notifications, $step . '_notifications'), $notification_type);
}
return 'notifications';
}
}