blob: 74ab98efcd012821965fae25408f0c3afed73d8a (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
<?php
/**
* webtrees: online genealogy
* Copyright (C) 2025 webtrees development team
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace Fisharebest\Webtrees\Factories;
use Fisharebest\Webtrees\Contracts\IdFactoryInterface;
use Ramsey\Uuid\Exception\RandomSourceException;
use Ramsey\Uuid\Uuid;
use function hexdec;
use function sprintf;
use function str_split;
use function strtoupper;
/**
* Create a unique identifier.
*/
class IdFactory implements IdFactoryInterface
{
/**
* @return string
*/
public function uuid(): string
{
try {
return strtolower(Uuid::uuid4()->toString());
} catch (RandomSourceException) {
// uuid4() can fail if there is insufficient entropy in the system.
return '';
}
}
/**
* An identifier for use in CSS/HTML
*
* @param string $prefix
*
* @return string
*/
public function id(string $prefix = 'id-'): string
{
return $prefix . $this->uuid();
}
/**
* A value for _UID fields, as created by PAF
*
* @return string
*/
public function pafUid(): string
{
$uid = strtoupper(strtr($this->uuid(), ['-' => '']));
if ($uid === '') {
return '';
}
return $uid . $this->pafUidChecksum($uid);
}
/**
* Based on the C implementation in "GEDCOM Unique Identifiers" by Gordon Clarke, dated 2007-06-08
*/
public function pafUidChecksum(string $uid): string
{
$checksum_a = 0; // a sum of the bytes
$checksum_b = 0; // a sum of the incremental values of $checksum_a
foreach (str_split($uid, 2) as $byte) {
$checksum_a += hexdec($byte);
$checksum_b += $checksum_a;
}
return sprintf('%02X%02X', $checksum_a & 0xff, $checksum_b & 0xff);
}
}
|