xref: /webtrees/app/Contracts/RepositoryFactoryInterface.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\Contracts;
21
22use Closure;
23use Fisharebest\Webtrees\Repository;
24use Fisharebest\Webtrees\Tree;
25
26/**
27 * Make a Repository object.
28 */
29interface RepositoryFactoryInterface extends GedcomRecordFactoryInterface
30{
31    /**
32     * Create a repository.
33     */
34    public function make(string $xref, Tree $tree, string|null $gedcom = null): Repository|null;
35
36    /**
37     * Create a source from a row in the database.
38     *
39     * @param Tree $tree
40     *
41     * @return Closure(object):Repository
42     */
43    public function mapper(Tree $tree): Closure;
44
45    /**
46     * Create a source from raw GEDCOM data.
47     *
48     * @param string      $xref
49     * @param string      $gedcom  an empty string for new/pending records
50     * @param string|null $pending null for a record with no pending edits,
51     *                             empty string for records with pending deletions
52     * @param Tree        $tree
53     *
54     * @return Repository
55     */
56    public function new(string $xref, string $gedcom, string|null $pending, Tree $tree): Repository;
57}
58