xref: /webtrees/app/Statistics/Repository/Interfaces/GedcomRepositoryInterface.php (revision 2978efea0c934a7f830579d20c3e8661e837b748) 
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\Statistics\Repository\Interfaces;
21
22/**
23 * A repository providing methods for GEDCOM related statistics.
24 */
25interface GedcomRepositoryInterface
26{
27    /**
28     * Get the name used for GEDCOM files and URLs.
29     *
30     * @return string
31     */
32    public function gedcomFilename(): string;
33
34    /**
35     * Get the internal ID number of the tree.
36     *
37     * @return int
38     */
39    public function gedcomId(): int;
40
41    /**
42     * Get the descriptive title of the tree.
43     *
44     * @return string
45     */
46    public function gedcomTitle(): string;
47
48    /**
49     * Get the software originally used to create the GEDCOM file.
50     *
51     * @return string
52     */
53    public function gedcomCreatedSoftware(): string;
54
55    /**
56     * Get the version of software which created the GEDCOM file.
57     *
58     * @return string
59     */
60    public function gedcomCreatedVersion(): string;
61
62    /**
63     * Get the date the GEDCOM file was created.
64     *
65     * @return string
66     */
67    public function gedcomDate(): string;
68
69    /**
70     * When was this tree last updated?
71     *
72     * @return string
73     */
74    public function gedcomUpdated(): string;
75
76    /**
77     * What is the significant individual from this tree?
78     *
79     * @return string
80     */
81    public function gedcomRootId(): string;
82}
83