Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
100.00% covered (success)
100.00%
8 / 8
100.00% covered (success)
100.00%
1 / 1
CRAP
100.00% covered (success)
100.00%
1 / 1
Footnote
100.00% covered (success)
100.00%
8 / 8
100.00% covered (success)
100.00%
1 / 1
2
100.00% covered (success)
100.00%
1 / 1
 write
100.00% covered (success)
100.00%
8 / 8
100.00% covered (success)
100.00%
1 / 1
2
1<?php
2
3/**
4 * This file is part of PHPWord - A pure PHP library for reading and writing
5 * word processing documents.
6 *
7 * PHPWord is free software distributed under the terms of the GNU Lesser
8 * General Public License version 3 as published by the Free Software Foundation.
9 *
10 * For the full copyright and license information, please read the LICENSE
11 * file that was distributed with this source code. For the full list of
12 * contributors, visit https://github.com/PHPOffice/PHPWord/contributors.
13 *
14 * @see         https://github.com/PHPOffice/PHPWord
15 *
16 * @license     http://www.gnu.org/licenses/lgpl.txt LGPL version 3
17 */
18
19namespace PhpOffice\PhpWord\Writer\HTML\Element;
20
21/**
22 * Footnote element HTML writer.
23 *
24 * @since 0.10.0
25 */
26class Footnote extends AbstractElement
27{
28    /**
29     * Note type footnote|endnote.
30     *
31     * @var string
32     */
33    protected $noteType = 'footnote';
34
35    /**
36     * Write footnote/endnote marks; The actual content is written in parent writer (HTML).
37     *
38     * @return string
39     */
40    public function write()
41    {
42        if (!$this->element instanceof \PhpOffice\PhpWord\Element\Footnote) {
43            return '';
44        }
45        /** @var \PhpOffice\PhpWord\Writer\HTML $parentWriter Type hint */
46        $parentWriter = $this->parentWriter;
47
48        $noteId = count($parentWriter->getNotes()) + 1;
49        $noteMark = $this->noteType . '-' . $this->element->getRelationId();
50        $content = "<a name=\"{$noteMark}\"><a href=\"#note-{$noteId}\" class=\"NoteRef\"><sup>{$noteId}</sup></a>";
51
52        $parentWriter->addNote($noteId, $noteMark);
53
54        return $content;
55    }
56}