nextcloud/lib/public/AppFramework/Bootstrap/IRegistrationContext.php

211 lines
6.0 KiB
PHP

<?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\Files\Template\ICustomTemplateProvider;
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 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;
/**
* Register a custom template provider class that is able to inject custom templates
* in addition to the user defined ones
*
* @param string $providerClass
* @psalm-param class-string<ICustomTemplateProvider> $providerClass
* @since 21.0.0
*/
public function registerTemplateProvider(string $providerClass): void;
}