blob: d388e072557cc903273fa44941ecfe624ec75bbf (
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
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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
<?php
declare(strict_types=1);
/**
* @copyright 2020 Christoph Wurst <christoph@winzerhof-wurst.at>
*
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
* @author Joas Schilling <coding@schilljs.com>
* @author Julius Härtl <jus@bitgrid.net>
* @author Roeland Jago Douma <roeland@famdouma.nl>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCP\AppFramework\Bootstrap;
use OCP\AppFramework\IAppContainer;
use OCP\EventDispatcher\IEventDispatcher;
use OCP\IContainer;
/**
* The context object passed to IBootstrap::register
*
* @since 20.0.0
* @see IBootstrap::register()
*/
interface IRegistrationContext {
/**
* @param string $capability
* @see IAppContainer::registerCapability
*
* @since 20.0.0
*/
public function registerCapability(string $capability): void;
/**
* Register an implementation of \OCP\Support\CrashReport\IReporter that
* will receive unhandled exceptions and throwables
*
* @param string $reporterClass
* @psalm-param class-string<\OCP\Support\CrashReport\IReporter> $reporterClass
* @return void
* @since 20.0.0
*/
public function registerCrashReporter(string $reporterClass): void;
/**
* Register an implementation of \OCP\Dashboard\IWidget that
* will handle the implementation of a dashboard widget
*
* @param string $widgetClass
* @psalm-param class-string<\OCP\Dashboard\IWidget> $widgetClass
* @return void
* @since 20.0.0
*/
public function registerDashboardWidget(string $widgetClass): void;
/**
* Register a service
*
* @param string $name
* @param callable $factory
* @psalm-param callable(\Psr\Container\ContainerInterface): mixed $factory
* @param bool $shared
*
* @return void
* @see IContainer::registerService()
*
* @since 20.0.0
*/
public function registerService(string $name, callable $factory, bool $shared = true): void;
/**
* @param string $alias
* @psalm-param string|class-string $alias
* @param string $target
* @psalm-param string|class-string $target
*
* @return void
* @see IContainer::registerAlias()
*
* @since 20.0.0
*/
public function registerServiceAlias(string $alias, string $target): void;
/**
* @param string $name
* @param mixed $value
*
* @return void
* @see IContainer::registerParameter()
*
* @since 20.0.0
*/
public function registerParameter(string $name, $value): void;
/**
* Register a service listener
*
* This is equivalent to calling IEventDispatcher::addServiceListener
*
* @template T of \OCP\EventDispatcher\Event
* @param string $event preferably the fully-qualified class name of the Event sub class to listen for
* @psalm-param string|class-string<T> $event preferably the fully-qualified class name of the Event sub class to listen for
* @param string $listener fully qualified class name (or ::class notation) of a \OCP\EventDispatcher\IEventListener that can be built by the DI container
* @psalm-param class-string<\OCP\EventDispatcher\IEventListener<T>> $listener fully qualified class name that can be built by the DI container
* @param int $priority
*
* @see IEventDispatcher::addServiceListener()
*
* @since 20.0.0
*/
public function registerEventListener(string $event, string $listener, int $priority = 0): void;
/**
* @param string $class
* @psalm-param class-string<\OCP\AppFramework\Middleware> $class
*
* @return void
* @see IAppContainer::registerMiddleWare()
*
* @since 20.0.0
*/
public function registerMiddleware(string $class): void;
/**
* Register a search provider for the unified search
*
* It is allowed to register more than one provider per app as the search
* results can go into distinct sections, e.g. "Files" and "Files shared
* with you" in the Files app.
*
* @param string $class
* @psalm-param class-string<\OCP\Search\IProvider> $class
*
* @return void
*
* @since 20.0.0
*/
public function registerSearchProvider(string $class): void;
/**
* Register an alternative login option
*
* It is allowed to register more than one option per app.
*
* @param string $class
* @psalm-param class-string<\OCP\Authentication\IAlternativeLogin> $class
*
* @return void
*
* @since 20.0.0
*/
public function registerAlternativeLogin(string $class): void;
/**
* Register an initialstate provider
*
* It is allowed to register more than one provider per app.
*
* @param string $class
* @psalm-param class-string<\OCP\AppFramework\Services\InitialStateProvider> $class
*
* @return void
*
* @since 21.0.0
*/
public function registerInitialStateProvider(string $class): void;
}
|
