docs: update events chapter

Author: brotkrueml

Documentation/Events/Index.rst

@@ -4,9 +4,9 @@
 
 .. _events:
 
-=============
-PSR-14 events
-=============
+============
+PSR-14 event
+============
 
 Target group: **Developers**
 
@@ -16,8 +16,6 @@ if you are not familiar with PSR-14 events.
 RateLimitExceededEvent
 ======================
 
-.. versionadded:: 1.2.0
-
 This event is dispatched when the rate limit for a form has been exceeded. This
 way you can create an event listener which notifies you about the exceeded
 limit: add a log entry, send an email, inform a third-party system, etc.
@@ -38,60 +36,12 @@ provides the following methods:
    Returns the configured :ref:`policy <options-policy>`.
 
 :php:`->getRequest(): \Psr\Http\Message\ServerRequestInterface`
-   .. versionadded:: 1.3.0
-
    Returns the :ref:`PSR-7 request object <t3coreapi:typo3-request>`.
 
 Example
 -------
 
 This example adds an entry to the TYPO3 log:
 
-.. code-block:: php
+.. literalinclude:: _FormRateLimitExceededLogger.php
    :caption: EXT:your_extension/Classes/EventListener/FormRateLimitExceededLogger.php
-
-   <?php
-
-   declare(strict_types=1);
-
-   namespace YourVendor\YourExtension\EventListener;
-
-   use Brotkrueml\FormRateLimit\Event\RateLimitExceededEvent;
-   use Psr\Log\LoggerInterface;
-
-   final class FormRateLimitExceededLogger
-   {
-       private LoggerInterface $logger;
-
-       public function __construct(LoggerInterface $logger)
-       {
-           $this->logger = $logger;
-       }
-
-       public function __invoke(RateLimitExceededEvent $event): void
-       {
-           $this->logger->warning(
-               'The form with identifier "{formIdentifier}" was sent more than {limit} times within {interval}',
-               [
-                   'formIdentifier' => $event->getFormIdentifier(),
-                   'limit' => $event->getLimit(),
-                   'interval' => $event->getInterval()
-               ]
-           );
-       }
-   }
-
-Registration of the event listener:
-
-.. code-block:: yaml
-   :caption: EXT:your_extension/Configuration/Services.yaml
-
-   services:
-      # Place here the default dependency injection configuration
-
-     YourVendor\YourExtension\EventListener\FormRateLimitExceededLogger:
-       tags:
-         - name: event.listener
-           identifier: 'yourFormRateLimitExceededLogger'
-
-Read :ref:`how to configure dependency injection in extensions <t3coreapi:dependency-injection-in-extensions>`.

Documentation/Events/_FormRateLimitExceededLogger.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the "form_rate_limit" extension for TYPO3 CMS.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ */
+
+namespace YourVendor\YourExtension\EventListener;
+
+use Brotkrueml\FormRateLimit\Event\RateLimitExceededEvent;
+use Psr\Log\LoggerInterface;
+use TYPO3\CMS\Core\Attribute\AsEventListener;
+
+#[AsEventListener(
+    identifier: 'your-extension/form-rate-limit-exceeded-logger',
+)]
+final readonly class FormRateLimitExceededLogger
+{
+    public function __construct(
+        private LoggerInterface $logger,
+    ) {}
+
+    public function __invoke(RateLimitExceededEvent $event): void
+    {
+        $this->logger->warning(
+            'The form with identifier "{formIdentifier}" was sent more than {limit} times within {interval}',
+            [
+                'formIdentifier' => $event->getFormIdentifier(),
+                'limit' => $event->getLimit(),
+                'interval' => $event->getInterval(),
+            ],
+        );
+    }
+}

Makefile

@@ -29,9 +29,11 @@ cs-check: cs-php-check ## Only check coding standards
 
 cs-php: vendor ## Check and fix PHP coding standards
 	.Build/bin/ecs check --fix
+	.Build/bin/ecs check --fix --config=ecs.docs.php
 
 cs-php-check: vendor ## Only check PHP coding standards
 	.Build/bin/ecs check
+	.Build/bin/ecs check --config=ecs.docs.php
 
 docs: ## Render documentation
 	docker run --rm --pull always -v "$(shell pwd)":/project -t ghcr.io/typo3-documentation/render-guides:latest --config=Documentation

ecs.docs.php

@@ -0,0 +1,26 @@
+<?php
+
+declare (strict_types=1);
+
+use PhpCsFixer\Fixer\Comment\HeaderCommentFixer;
+use Symplify\EasyCodingStandard\Config\ECSConfig;
+
+return static function (ECSConfig $config): void {
+    $header = <<<HEADER
+This file is part of the "form_rate_limit" extension for TYPO3 CMS.
+
+For the full copyright and license information, please read the
+LICENSE.txt file that was distributed with this source code.
+HEADER;
+
+    $config->import(__DIR__ . '/.Build/vendor/brotkrueml/coding-standards/config/common.php');
+
+    $config->paths([
+        __DIR__ . '/Documentation',
+    ]);
+    $config->ruleWithConfiguration(HeaderCommentFixer::class, [
+        'comment_type' => 'comment',
+        'header' => $header,
+        'separate' => 'both',
+    ]);
+};