Merge pull request #9317 from nextcloud/backport/9310/stable25

[stable25] Document CriticalActionPerformedEvent
This commit is contained in:
Joas Schilling 2022-11-09 14:03:42 +01:00 committed by GitHub
commit 07bccf1401
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -41,3 +41,25 @@ the app ID.
use function OCP\Log\logger;
logger('calendar')->warning('look, no dependency injection');
Admin audit logging
-------------------
If you want to log things less for system administration but for compliance reasons, e.g. who accessed which file,
who changed the password of an item or made it public, the
`admin audit log <https://docs.nextcloud.com/server/stable/admin_manual/configuration_server/logging_configuration.html#admin-audit-log>`_
is the correct place.
You can easily add a log by simply emitting an ``OCP\Log\Audit\CriticalActionPerformedEvent`` event:
.. code-block:: php
<?php
$dispatcher = \OCP\Server::get(\OCP\EventDispatcher\IEventDispatcher::class);
$event = new \OCP\Log\Audit\CriticalActionPerformedEvent(
'My critical action for app %s',
['name' => 'My App ID']
);
$dispatcher->dispatchTyped($event);