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 22/** 23 * Create a unique identifier. 24 */ 25interface IdFactoryInterface 26{ 27 /** 28 * @return string 29 */ 30 public function uuid(): string; 31 32 /** 33 * An identifier for use in CSS/HTML 34 * 35 * @param string $prefix 36 * 37 * @return string 38 */ 39 public function id(string $prefix = 'id-'): string; 40 41 /** 42 * A value for _UID fields, as created by PAF 43 * 44 * @return string 45 */ 46 public function pafUid(): string; 47 48 /** 49 * @param string $uid exactly 32 hex characters 50 * 51 * @return string 52 */ 53 public function pafUidChecksum(string $uid): string; 54} 55