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

77 lines
2.7 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).
*
* Copyright (C) 2019 - 2020 Jan Böhmer (https://github.com/jbtronics)
*
* 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
/**
* This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
2019-10-11 23:53:12 +02:00
*
2019-11-01 13:40:30 +01:00
* Copyright (C) 2019 Jan Böhmer (https://github.com/jbtronics)
2019-10-11 23:53:12 +02:00
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
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
{
protected $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 Only allow inline markdown codes like (*bold* or **italic**), not something like tables
*
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" data-markdown="%s">%s</div>',
htmlspecialchars($markdown),
$this->translator->trans('markdown.loading')
);
2019-10-11 23:53:12 +02:00
}
}