FootnoteContainerRenderer::getXmlTagName()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 1

Importance

Changes 0
Metric Value
eloc 1
dl 0
loc 3
ccs 2
cts 2
cp 1
rs 10
c 0
b 0
f 0
cc 1
nc 1
nop 1
crap 1
1
<?php
2
3
/*
4
 * This file is part of the league/commonmark package.
5
 *
6
 * (c) Colin O'Dell <[email protected]>
7
 * (c) Rezo Zero / Ambroise Maupate
8
 *
9
 * For the full copyright and license information, please view the LICENSE
10
 * file that was distributed with this source code.
11
 */
12
13
declare(strict_types=1);
14
15
namespace League\CommonMark\Extension\Footnote\Renderer;
16
17
use League\CommonMark\Extension\Footnote\Node\FootnoteContainer;
18
use League\CommonMark\Node\Node;
19
use League\CommonMark\Renderer\ChildNodeRendererInterface;
20
use League\CommonMark\Renderer\NodeRendererInterface;
21
use League\CommonMark\Util\HtmlElement;
22
use League\CommonMark\Xml\XmlNodeRendererInterface;
23
use League\Config\ConfigurationAwareInterface;
24
use League\Config\ConfigurationInterface;
25
26
final class FootnoteContainerRenderer implements NodeRendererInterface, XmlNodeRendererInterface, ConfigurationAwareInterface
27
{
28
    private ConfigurationInterface $config;
29
30
    /**
31
     * @param FootnoteContainer $node
32
     *
33
     * {@inheritDoc}
34
     *
35
     * @psalm-suppress MoreSpecificImplementedParamType
36
     */
37 76
    public function render(Node $node, ChildNodeRendererInterface $childRenderer): \Stringable
38
    {
39 76
        FootnoteContainer::assertInstanceOf($node);
40
41 76
        $attrs = $node->data->getData('attributes');
42
43 76
        $attrs->append('class', $this->config->get('footnote/container_class'));
44 76
        $attrs->set('role', 'doc-endnotes');
45
46 76
        $contents = new HtmlElement('ol', [], $childRenderer->renderNodes($node->children()));
47 76
        if ($this->config->get('footnote/container_add_hr')) {
48 70
            $contents = [new HtmlElement('hr', [], null, true), $contents];
49
        }
50
51 76
        return new HtmlElement('div', $attrs->export(), $contents);
52
    }
53
54 102
    public function setConfiguration(ConfigurationInterface $configuration): void
55
    {
56 102
        $this->config = $configuration;
57
    }
58
59 18
    public function getXmlTagName(Node $node): string
60
    {
61 18
        return 'footnote_container';
62
    }
63
64
    /**
65
     * @return array<string, scalar>
66
     */
67 18
    public function getXmlAttributes(Node $node): array
68
    {
69 18
        return [];
70
    }
71
}
72