xref: /webtrees/app/CommonMark/CensusTableStartParser.php (revision 5966b7ff5aa7003fbc2931522a3e61c7a35cffec)
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\CommonMark;
21
22use League\CommonMark\Parser\Block\BlockStart;
23use League\CommonMark\Parser\Block\BlockStartParserInterface;
24use League\CommonMark\Parser\Cursor;
25use League\CommonMark\Parser\MarkdownParserStateInterface;
26
27/**
28 * Convert webtrees 1.x census-assistant markup into tables.
29 * Note that webtrees 2.0 generates markdown tables directly.
30 */
31class CensusTableStartParser implements BlockStartParserInterface
32{
33    /**
34     * @param Cursor                       $cursor
35     * @param MarkdownParserStateInterface $parserState
36     *
37     * @return BlockStart|null
38     */
39    public function tryStart(Cursor $cursor, MarkdownParserStateInterface $parserState): ?BlockStart
40    {
41        if ($cursor->getLine() === CensusTableExtension::CA_PREFIX) {
42            return BlockStart::of(new CensusTableContinueParser())
43                ->at($cursor);
44        }
45
46        return BlockStart::none();
47    }
48}
49