Part-DB.Part-DB-server/src/Services/MarkdownParser.php

58 lines
2 KiB
PHP
Raw Normal View History

2019-10-11 23:53:12 +02:00
<?php
2020-02-22 18:14:36 +01:00
/**
* This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
*
2022-11-29 22:28:53 +01:00
* Copyright (C) 2019 - 2022 Jan Böhmer (https://github.com/jbtronics)
2020-02-22 18:14:36 +01:00
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
2020-01-05 15:46:58 +01:00
declare(strict_types=1);
2019-10-11 23:53:12 +02:00
namespace App\Services;
use Symfony\Contracts\Translation\TranslatorInterface;
2019-10-11 23:53:12 +02:00
/**
* This class allows you to convert markdown text to HTML.
*/
class MarkdownParser
{
2022-09-18 22:59:31 +02:00
protected TranslatorInterface $translator;
2019-10-11 23:53:12 +02:00
public function __construct(TranslatorInterface $translator)
2019-10-11 23:53:12 +02:00
{
$this->translator = $translator;
2019-10-11 23:53:12 +02:00
}
/**
* Mark the markdown for rendering.
* The rendering of markdown is done on client side.
*
2020-01-04 20:24:09 +01:00
* @param string $markdown the markdown text that should be parsed to html
* @param bool $inline_mode When true, p blocks will have no margins behind them
*
2020-01-04 20:24:09 +01:00
* @return string the markdown in a version that can be parsed on client side
2019-10-11 23:53:12 +02:00
*/
public function markForRendering(string $markdown, bool $inline_mode = false): string
2019-10-11 23:53:12 +02:00
{
return sprintf(
'<div class="markdown %s" data-markdown="%s" data-controller="common--markdown">%s</div>',
$inline_mode ? 'markdown-inline' : '', //Add class if inline mode is enabled, to prevent margin after p
htmlspecialchars($markdown),
$this->translator->trans('markdown.loading')
);
2019-10-11 23:53:12 +02:00
}
}