TYPO3 v15 dev-main snapshot ()

Classes/Event/ModifyRenderedContentAreaEvent.php

@@ -0,0 +1,59 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+namespace TYPO3\CMS\Fluid\Event;
+
+use Psr\Http\Message\ServerRequestInterface;
+use TYPO3\CMS\Core\Page\ContentArea;
+
+/**
+ * Event to modify the rendered content area output.
+ * This can be used to alter the final HTML of a content area,
+ * for example to render a debug wrapper around it.
+ */
+final class ModifyRenderedContentAreaEvent
+{
+    public function __construct(
+        private string $renderedContentArea,
+        private readonly ContentArea $contentArea,
+        private readonly ServerRequestInterface $request,
+    ) {}
+
+    public function getRenderedContentArea(): string
+    {
+        return $this->renderedContentArea;
+    }
+
+    /**
+     * Set the rendered content area's HTML.
+     * Make sure to return escaped content if necessary.
+     */
+    public function setRenderedContentArea(string $renderedContentArea): void
+    {
+        $this->renderedContentArea = $renderedContentArea;
+    }
+
+    public function getContentArea(): ContentArea
+    {
+        return $this->contentArea;
+    }
+
+    public function getRequest(): ServerRequestInterface
+    {
+        return $this->request;
+    }
+}