nextcloud / server

lib/public/AppFramework/Bootstrap/IRegistrationContext.php

Indentation +155 added lines, -155 removed lines

@@ -41,159 +41,159 @@
  */
 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 The higher this value, the earlier an event
-	 *                      listener will be triggered in the chain (defaults to 0)
-	 *
-	 * @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;
-
-	/**
-	 * Register a well known protocol handler
-	 *
-	 * It is allowed to register more than one handler per app.
-	 *
-	 * @param string $class
-	 * @psalm-param class-string<\OCP\Http\WellKnown\IHandler> $class
-	 *
-	 * @return void
-	 *
-	 * @since 21.0.0
-	 */
-	public function registerWellKnownHandler(string $class): void;
+    /**
+     * @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 The higher this value, the earlier an event
+     *                      listener will be triggered in the chain (defaults to 0)
+     *
+     * @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;
+
+    /**
+     * Register a well known protocol handler
+     *
+     * It is allowed to register more than one handler per app.
+     *
+     * @param string $class
+     * @psalm-param class-string<\OCP\Http\WellKnown\IHandler> $class
+     *
+     * @return void
+     *
+     * @since 21.0.0
+     */
+    public function registerWellKnownHandler(string $class): void;
 }

lib/public/EventDispatcher/IEventDispatcher.php

Indentation +56 added lines, -56 removed lines

@@ -34,64 +34,64 @@
  */
 interface IEventDispatcher {
 
-	/**
-	 * @template T of \OCP\EventDispatcher\Event
-	 * @param string $eventName preferably the fully-qualified class name of the Event sub class
-	 * @psalm-param string|class-string<T> $eventName preferably the fully-qualified class name of the Event sub class
-	 * @param callable $listener the object that is invoked when a matching event is dispatched
-	 * @psalm-param callable(T):void $listener
-	 * @param int $priority The higher this value, the earlier an event
-	 *                      listener will be triggered in the chain (defaults to 0)
-	 *
-	 * @since 17.0.0
-	 */
-	public function addListener(string $eventName, callable $listener, int $priority = 0): void;
+    /**
+     * @template T of \OCP\EventDispatcher\Event
+     * @param string $eventName preferably the fully-qualified class name of the Event sub class
+     * @psalm-param string|class-string<T> $eventName preferably the fully-qualified class name of the Event sub class
+     * @param callable $listener the object that is invoked when a matching event is dispatched
+     * @psalm-param callable(T):void $listener
+     * @param int $priority The higher this value, the earlier an event
+     *                      listener will be triggered in the chain (defaults to 0)
+     *
+     * @since 17.0.0
+     */
+    public function addListener(string $eventName, callable $listener, int $priority = 0): void;
 
-	/**
-	 * @template T of \OCP\EventDispatcher\Event
-	 * @param string $eventName preferably the fully-qualified class name of the Event sub class
-	 * @psalm-param string|class-string<T> $eventName preferably the fully-qualified class name of the Event sub class
-	 * @param callable $listener the object that is invoked when a matching event is dispatched
-	 * @psalm-param callable(T):void $listener
-	 *
-	 * @since 19.0.0
-	 */
-	public function removeListener(string $eventName, callable $listener): void;
+    /**
+     * @template T of \OCP\EventDispatcher\Event
+     * @param string $eventName preferably the fully-qualified class name of the Event sub class
+     * @psalm-param string|class-string<T> $eventName preferably the fully-qualified class name of the Event sub class
+     * @param callable $listener the object that is invoked when a matching event is dispatched
+     * @psalm-param callable(T):void $listener
+     *
+     * @since 19.0.0
+     */
+    public function removeListener(string $eventName, callable $listener): void;
 
-	/**
-	 * @template T of \OCP\EventDispatcher\Event
-	 * @param string $eventName preferably the fully-qualified class name of the Event sub class to listen for
-	 * @psalm-param string|class-string<T> $eventName preferably the fully-qualified class name of the Event sub class to listen for
-	 * @param string $className 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>> $className fully qualified class name that can be built by the DI container
-	 * @param int $priority The higher this value, the earlier an event
-	 *                      listener will be triggered in the chain (defaults to 0)
-	 *
-	 * @since 17.0.0
-	 */
-	public function addServiceListener(string $eventName, string $className, int $priority = 0): void;
+    /**
+     * @template T of \OCP\EventDispatcher\Event
+     * @param string $eventName preferably the fully-qualified class name of the Event sub class to listen for
+     * @psalm-param string|class-string<T> $eventName preferably the fully-qualified class name of the Event sub class to listen for
+     * @param string $className 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>> $className fully qualified class name that can be built by the DI container
+     * @param int $priority The higher this value, the earlier an event
+     *                      listener will be triggered in the chain (defaults to 0)
+     *
+     * @since 17.0.0
+     */
+    public function addServiceListener(string $eventName, string $className, int $priority = 0): void;
 
-	/**
-	 * @template T of \OCP\EventDispatcher\Event
-	 * @param string $eventName
-	 * @psalm-param string|class-string<T> $eventName
-	 * @param Event $event
-	 * @psalm-param T $event
-	 *
-	 * @since 17.0.0
-	 * @deprecated 21.0.0 use \OCP\EventDispatcher\IEventDispatcher::dispatchTyped
-	 */
-	public function dispatch(string $eventName, Event $event): void;
+    /**
+     * @template T of \OCP\EventDispatcher\Event
+     * @param string $eventName
+     * @psalm-param string|class-string<T> $eventName
+     * @param Event $event
+     * @psalm-param T $event
+     *
+     * @since 17.0.0
+     * @deprecated 21.0.0 use \OCP\EventDispatcher\IEventDispatcher::dispatchTyped
+     */
+    public function dispatch(string $eventName, Event $event): void;
 
-	/**
-	 * Dispatch a typed event
-	 *
-	 * Only use this with subclasses of ``\OCP\EventDispatcher\Event``.
-	 * The object's class will determine the event name.
-	 *
-	 * @param Event $event
-	 *
-	 * @since 18.0.0
-	 */
-	public function dispatchTyped(Event $event): void;
+    /**
+     * Dispatch a typed event
+     *
+     * Only use this with subclasses of ``\OCP\EventDispatcher\Event``.
+     * The object's class will determine the event name.
+     *
+     * @param Event $event
+     *
+     * @since 18.0.0
+     */
+    public function dispatchTyped(Event $event): void;
 }