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