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