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