Skip to content
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.

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

feat(dev-manual): Document global middleware registration #9588

Merged
merged 1 commit into from
Jan 26, 2023
Merged
Changes from all commits
Commits
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
37 changes: 37 additions & 0 deletions developer_manual/basics/middlewares.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,43 @@ The middleware can be registered in the app's ``Application`` class:

}

Global Middlewares
------------------

.. versionadded:: 26

Registered middlewares will only intercept requests of the same app by default. To make a middleware *global* and trigger for other apps' middlewares, add `true` as second argument of the ``registerMiddleware`` call:

.. code-block:: php
:caption: lib/AppInfo/Application.php
:emphasize-lines: 20

<?php

declare(strict_types=1);

namespace OCA\MyApp\AppInfo;

use OCA\MyApp\Middleware\MonitoringMiddleware;
use OCP\AppFramework\App;
use OCP\AppFramework\Bootstrap\IBootContext;
use OCP\AppFramework\Bootstrap\IBootstrap;
use OCP\AppFramework\Bootstrap\IRegistrationContext;

class Application extends App implements IBootstrap {

public function __construct() {
parent::__construct('myapp');
}

public function register(IRegistrationContext $context): void {
$context->registerMiddleware(MonitoringMiddleware::class, true);
}

public function boot(IBootContext $context): void {}

}

Dependency Injection Container Registration
-------------------------------------------

Expand Down