xref: /webtrees/app/CommonMark/CensusTableExtension.php (revision 6f59525087dd4ee1d17c7375524d95ace7942861)
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\Environment\EnvironmentBuilderInterface;
23use League\CommonMark\Extension\ConfigurableExtensionInterface;
24use League\CommonMark\Extension\Table\TableExtension;
25use League\Config\ConfigurationBuilderInterface;
26
27/**
28 * Convert webtrees 1.x census-assistant markup into tables.
29 * Note that webtrees 2.0 generates markdown tables directly.
30 *
31 * .start_formatted_area.
32 * .b.HEADING1|.b.HEADING2|.b.HEADING3
33 * COL1|COL2|COL3
34 * COL1|COL2|COL3
35 * .end_formatted_area.
36 */
37class CensusTableExtension implements ConfigurableExtensionInterface
38{
39    // Keywords used to create the webtrees 1.x census-assistant notes.
40    public const CA_PREFIX = '.start_formatted_area.';
41    public const CA_SUFFIX = '.end_formatted_area.';
42    public const TH_PREFIX = '.b.';
43
44    /**
45     * The core TableExtension will already have configured tables.
46     *
47     * @param ConfigurationBuilderInterface $builder
48     */
49    public function configureSchema(ConfigurationBuilderInterface $builder): void
50    {
51    }
52
53    /**
54     * Assumes we have also registered the core TableExtension.
55     *
56     * @param EnvironmentBuilderInterface $environment
57     */
58    public function register(EnvironmentBuilderInterface $environment): void
59    {
60        $environment->addBlockStartParser(new CensusTableStartParser());
61    }
62}
63