Skip to content

[stable20] Add Psalm type for the bootstrap registration context #23383

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kesselb merged 1 commit into from
Oct 12, 2020
Merged

[stable20] Add Psalm type for the bootstrap registration context #23383

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions lib/public/AppFramework/Bootstrap/IRegistrationContext.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,16 +53,18 @@ public function registerCapability(string $capability): void;
* 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\IPanel that
* will handle the implementation of a dashboard panel
* 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
*/
Expand All @@ -72,6 +74,7 @@ public function registerDashboardWidget(string $widgetClass): void;
*
* @param string $name
* @param callable $factory
* @psalm-param callable(\Psr\Container\ContainerInterface): mixed $factory
* @param bool $shared
*
* @return void
Expand All @@ -83,7 +86,9 @@ public function registerService(string $name, callable $factory, bool $shared =

/**
* @param string $alias
* @psalm-param string|class-string $alias
* @param string $target
* @psalm-param string|class-string $target
*
* @return void
* @see IContainer::registerAlias()
Expand All @@ -109,7 +114,9 @@ public function registerParameter(string $name, $value): void;
* This is equivalent to calling IEventDispatcher::addServiceListener
*
* @param string $event preferably the fully-qualified class name of the Event sub class to listen for
* @psalm-param string|class-string<\OCP\EventDispatcher\Event> $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> $listener fully qualified class name that can be built by the DI container
* @param int $priority
*
* @see IEventDispatcher::addServiceListener()
Expand All @@ -120,6 +127,7 @@ public function registerEventListener(string $event, string $listener, int $prio

/**
* @param string $class
* @psalm-param class-string<\OCP\AppFramework\Middleware> $class
*
* @return void
* @see IAppContainer::registerMiddleWare()
Expand All @@ -136,6 +144,7 @@ public function registerMiddleware(string $class): void;
* with you" in the Files app.
*
* @param string $class
* @psalm-param class-string<\OCP\Search\IProvider> $class
*
* @return void
*
Expand All @@ -149,6 +158,7 @@ public function registerSearchProvider(string $class): void;
* It is allowed to register more than one option per app.
*
* @param string $class
* @psalm-param class-string<\OCP\Authentication\IAlternativeLogin> $class
*
* @return void
*
Expand Down