Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
100.00% covered (success)
100.00%
2 / 2
100.00% covered (success)
100.00%
2 / 2
CRAP
100.00% covered (success)
100.00%
1 / 1
Markdown
100.00% covered (success)
100.00%
2 / 2
100.00% covered (success)
100.00%
2 / 2
2
100.00% covered (success)
100.00%
1 / 1
 __construct
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 __invoke
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
1<?php
2
3/**
4 * Class Markdown
5 *
6 * PHP version 8
7 *
8 * Copyright (C) Moravian Library 2020.
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2,
12 * as published by the Free Software Foundation.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
22 *
23 * @category VuFind
24 * @package  VuFind\View\Helper\Root
25 * @author   Josef Moravec <moravec@mzk.cz>
26 * @license  https://opensource.org/licenses/gpl-2.0.php GNU General Public License
27 * @link     https://knihovny.cz Main Page
28 */
29
30namespace VuFind\View\Helper\Root;
31
32use Laminas\View\Helper\AbstractHelper;
33use League\CommonMark\ConverterInterface;
34use League\CommonMark\Output\RenderedContentInterface;
35
36/**
37 * Helper for transforming markdown to html
38 *
39 * @category VuFind
40 * @package  View_Helpers
41 * @author   Josef Moravec <moravec@mzk.cz>
42 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
43 * @link     https://vufind.org/wiki/development Wiki
44 */
45class Markdown extends AbstractHelper
46{
47    /**
48     * Markdown converter
49     *
50     * @var ConverterInterface
51     */
52    protected $converter;
53
54    /**
55     * Markdown constructor.
56     *
57     * @param ConverterInterface $converter Markdown converter
58     */
59    public function __construct(ConverterInterface $converter)
60    {
61        $this->converter = $converter;
62    }
63
64    /**
65     * Converts markdown to html
66     *
67     * @param string $markdown Markdown formatted text
68     *
69     * @return RenderedContentInterface
70     */
71    public function __invoke(string $markdown)
72    {
73        return $this->converter->convert($markdown);
74    }
75}