xref: /webtrees/app/Statistics/Repository/Interfaces/GedcomRepositoryInterface.php (revision 4a52049613a3fd380896a97f74b94d45ccccc97c) 
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2019 webtrees development team
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16declare(strict_types=1);
17
18namespace Fisharebest\Webtrees\Statistics\Repository\Interfaces;
19
20/**
21 * A repository providing methods for GEDCOM related statistics.
22 */
23interface GedcomRepositoryInterface
24{
25    /**
26     * Get the name used for GEDCOM files and URLs.
27     *
28     * @return string
29     */
30    public function gedcomFilename(): string;
31
32    /**
33     * Get the internal ID number of the tree.
34     *
35     * @return int
36     */
37    public function gedcomId(): int;
38
39    /**
40     * Get the descriptive title of the tree.
41     *
42     * @return string
43     */
44    public function gedcomTitle(): string;
45
46    /**
47     * Get the software originally used to create the GEDCOM file.
48     *
49     * @return string
50     */
51    public function gedcomCreatedSoftware(): string;
52
53    /**
54     * Get the version of software which created the GEDCOM file.
55     *
56     * @return string
57     */
58    public function gedcomCreatedVersion(): string;
59
60    /**
61     * Get the date the GEDCOM file was created.
62     *
63     * @return string
64     */
65    public function gedcomDate(): string;
66
67    /**
68     * When was this tree last updated?
69     *
70     * @return string
71     */
72    public function gedcomUpdated(): string;
73
74    /**
75     * What is the significant individual from this tree?
76     *
77     * @return string
78     */
79    public function gedcomRootId(): string;
80}
81