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