xref: /webtrees/app/Contracts/MarkdownFactoryInterface.php (revision d4ec5ec0fe611c85b1d77527db3e9becde7e473d) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2021 webtrees development team
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <https://www.gnu.org/licenses/>.
16 */
17
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees\Contracts;
21
22use Fisharebest\Webtrees\Tree;
23
24/**
25 * Create a markdown converter.
26 */
27interface MarkdownFactoryInterface
28{
29    /**
30     * @param string    $markdown
31     * @param Tree|null $tree
32     *
33     * @return string
34     */
35    public function autolink(string $markdown, Tree $tree = null): string;
36
37    /**
38     * @param string    $markdown
39     * @param Tree|null $tree
40     *
41     * @return string
42     */
43    public function markdown(string $markdown, Tree $tree = null): string;
44}
45