Completed
Pull Request — master (#470)
by Claus
01:35
created

DescriptionViewHelper   A

Complexity

Total Complexity 1

Size/Duplication

Total Lines 9
Duplicated Lines 0 %

Coupling/Cohesion

Components 0
Dependencies 2

Importance

Changes 0
Metric Value
dl 0
loc 9
rs 10
c 0
b 0
f 0
wmc 1
lcom 0
cbo 2

1 Method

Rating   Name   Duplication   Size   Complexity  
A sequence() 0 4 1
1
<?php
2
declare(strict_types=1);
3
namespace TYPO3Fluid\Fluid\ViewHelpers;
4
5
/*
6
 * This file belongs to the package "TYPO3 Fluid".
7
 * See LICENSE.txt that was shipped with this package.
8
 */
9
10
use TYPO3Fluid\Fluid\Component\EmbeddedComponentInterface;
11
use TYPO3Fluid\Fluid\Component\SequencingComponentInterface;
12
use TYPO3Fluid\Fluid\Core\Parser\Sequencer;
13
use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;
14
15
/**
16
 * Template Description ViewHelper
17
 *
18
 * Allows defining a description for a component.
19
 *
20
 * Can be used inside any (named) Component such as a
21
 * section, or the root of a template file. Can then
22
 * be retrieved by documentation frameworks or design
23
 * systems as description for the template, section etc.
24
 *
25
 * Ignores nested Fluid code except for the closing tag
26
 * that ends the block.
27
 */
28
class DescriptionViewHelper extends AbstractViewHelper implements EmbeddedComponentInterface, SequencingComponentInterface
29
{
30
    protected $escapeOutput = false;
31
32
    public function sequence(Sequencer $sequencer, ?string $namespace, string $method): void
33
    {
34
        $sequencer->sequenceUntilClosingTagAndIgnoreNested($this, $namespace, $method);
35
    }
36
}
37