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