ModifyPageLayoutContentEvent.php 2.39 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
<?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\Backend\Controller\Event;

use Psr\Http\Message\ServerRequestInterface;
use TYPO3\CMS\Backend\Template\ModuleTemplate;

/**
 * Listeners to this Event will be able to modify the header and footer content of the page module
 */
final class ModifyPageLayoutContentEvent
{
    private ServerRequestInterface $request;
    private ModuleTemplate $moduleTemplate;
    private string $headerContent = '';
    private string $footerContent = '';

    public function __construct(ServerRequestInterface $request, ModuleTemplate $moduleTemplate)
    {
        $this->request = $request;
        $this->moduleTemplate = $moduleTemplate;
    }

    public function getRequest(): ServerRequestInterface
    {
        return $this->request;
    }

    public function getModuleTemplate(): ModuleTemplate
    {
        return $this->moduleTemplate;
    }

    /**
     * Set content for the header. Can also be used to e.g. reorder existing content.
     * IMPORTANT: This overwrites existing content from previous listeners!
     */
    public function setHeaderContent(string $content): void
    {
        $this->headerContent = $content;
    }

    /**
     * Add additional content to the header
     */
    public function addHeaderContent(string $content): void
    {
        $this->headerContent .= $content;
    }

    public function getHeaderContent(): string
    {
        return $this->headerContent;
    }

    /**
     * Set content for the footer. Can also be used to e.g. reorder existing content.
     * IMPORTANT: This overwrites existing content from previous listeners!
     */
    public function setFooterContent(string $content): void
    {
        $this->footerContent = $content;
    }

    /**
     * Add additional content to the footer
     */
    public function addFooterContent(string $content): void
    {
        $this->footerContent .= $content;
    }

    public function getFooterContent(): string
    {
        return $this->footerContent;
    }
}