TYPO3 v11: View helper to get inherited page property

revision c2cbb27b97162b8bfdccbfd60884f256d3e32ebd

raw

Page/InheritedPropertyViewHelper.php

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
<?php
 
declare(strict_types=1);
 
namespace Vendor\MyExtension\ViewHelpers\Page;
 
use TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;
 
/**
 * Get a page row property, inherited up through the rootline.
 *
 * When a value is NULL or an empty string "", then the parent page's
 * value is used.
 *
 * The column must be in the rootline already.
 * This can be configured via TYPO3_CONF_VARS[FE][addRootLineFields].
 */
class InheritedPropertyViewHelper extends AbstractViewHelper
{
    protected $escapeOutput = false;
 
    public function initializeArguments(): void
    {
        $this->registerArgument(
            'column',
            'string',
            'Page row column name',
            true,
        );
        $this->registerArgument(
            'default',
            'string',
            'Fallback value when all pages have an empty value',
            true,
        );
    }
 
    public function render(): mixed
    {
        $column = $this->arguments['column'];
        $rootLine = $this->getRootLine();
 
        foreach ($rootLine as $pageRow) {
            if (!array_key_exists($column, $pageRow)) {
                throw new \OutOfRangeException(
                    'Column is not part of the rootline: ' . $column,
                    1758882723
                );
            }
 
            if ($pageRow[$column] !== null && $pageRow[$column] !== '') {
                return $pageRow[$column];
            }
        }
 
        return $this->arguments['default'];
    }
 
    protected function getRootLine(): array
    {
        return $this->getFrontendController()->rootLine;
    }
 
    protected function getFrontendController(): TypoScriptFrontendController
    {
        return $GLOBALS['TSFE'];
    }
}
 
raw

z-template.html

1
2
3
4
<f:if condition="{myextension:page.inheritedProperty(column:'tx_mysocial_show_comments',default:1)}">
    <!-- show comments -->
</f:if>
 

History