Home
About
Blog
Products
Forum
Support
Contact
Sunbelt Computer Software
PL/B Language Development and Support
Home
About
Blog
Products
Forum
Support
Contact
uid/Uuid.php at 8.2 · symfony/uid · GitHub
Skip to content
Navigation Menu
Sign in
Products
Platform
GitHub
Repository hosting, code review, and collaboration
Copilot
AI coding agent for tasks, projects and automated work
Build & Ship
Actions
CI/CD and automation
Code Quality
Quality analysis, fixes, and enforcement
Codespaces
Cloud development environments
Secure
Code Security
Vulnerability detection and remediation
Secret Protection
Secret scanning and leak prevention
All Features
Developers
Learn
Documentation
Training
Certifications
Build
Build with Copilot
Customize Copilot
Integrations
Explore
Trending repos
GitHub Sponsors
Events
Changelog
Changelog
Your source for the latest features, improvements, and fixes across GitHub products, all in one place.
Businesses
By Stage
Enterprises
Team
Startups
Nonprofits
By Industry
Healthcare
Financial services
Manufacturing
Government
See all industries
Evaluate GitHub
Why GitHub
Customer Stories
Business insights
Trust Center
Add-ons
GitHub Advanced Security
Enterprise-grade code security
Copilot for business
Enterprise-grade AI features
Premium Support
Enterprise-grade 24/7 support
Resources
Learn & Connect
Documentation
Resource center
Blog
Events & webinars
Community Forum
Customer Stories
Integrations
Support
Customer support
Training
GitHub Status
Company
About
Partners
Changelog
GitHub Universe
GitHub Universe
The event for developers, by developers — talks, workshops, and what’s next for GitHub.
Pricing
Search
/
Sign in
Sign up
Appearance settings
You signed in with another tab or window.
Reload
to refresh your session.
You signed out in another tab or window.
Reload
to refresh your session.
You switched accounts on another tab or window.
Reload
to refresh your session.
Dismiss alert
{{ message }}
symfony
uid
Repository navigation
Code
Security and quality
Insights
More
items
Files
Expand file tree
8.2
Breadcrumbs
uid
/
Uuid.php
Copy path
Blame
More file actions
Blame
More file actions
Latest commit
History
History
History
226 lines (186 loc) · 7.28 KB
8.2
Breadcrumbs
uid
/
Uuid.php
Copy path
Top
File metadata and controls
Code
Blame
226 lines (186 loc) · 7.28 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
<?php
/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace
Symfony
\
Component
\
Uid
;
use
Symfony
\
Component
\
Uid
\
Exception
\
InvalidArgumentException
;
/**
* @author Grégoire Pineau <lyrixx@lyrixx.info>
*
* @see https://datatracker.ietf.org/doc/html/rfc9562/#section-6.6 for details about namespaces
*/
class
Uuid
extends
AbstractUid
{
public
const
NAMESPACE_DNS
=
'
6ba7b810-9dad-11d1-80b4-00c04fd430c8
'
;
public
const
NAMESPACE_URL
=
'
6ba7b811-9dad-11d1-80b4-00c04fd430c8
'
;
public
const
NAMESPACE_OID
=
'
6ba7b812-9dad-11d1-80b4-00c04fd430c8
'
;
public
const
NAMESPACE_X500
=
'
6ba7b814-9dad-11d1-80b4-00c04fd430c8
'
;
public
const
FORMAT_BINARY
=
1
;
public
const
FORMAT_BASE_32
=
1
<<
1
;
public
const
FORMAT_BASE_58
=
1
<<
2
;
public
const
FORMAT_RFC_4122
=
1
<<
3
;
public
const
FORMAT_RFC_9562
=
self
::
FORMAT_RFC_4122
;
public
const
FORMAT_ALL
= -
1
;
protected
const
TYPE
=
0
;
protected
const
NIL
=
'
00000000-0000-0000-0000-000000000000
'
;
protected
const
MAX
=
'
ffffffff-ffff-ffff-ffff-ffffffffffff
'
;
public
function
__construct
(
string
$
uuid
,
bool
$
checkVariant
=
false
)
{
$
type
=
preg_match
(
'
{^[0-9a-f]{8}(?:-[0-9a-f]{4}){3}-[0-9a-f]{12}$}Di
'
,
$
uuid
) ? (
int
)
$
uuid
[
14
] :
false
;
if
(
false
===
$
type
|| (
static
::
TYPE
?:
$
type
) !==
$
type
) {
throw
new
InvalidArgumentException
(
\sprintf
(
'
Invalid UUID%s.
'
,
static
::
TYPE
?
'
v
'
.
static
::
TYPE
:
''
),
$
uuid
);
}
$
this
->
uid
=
strtolower
(
$
uuid
);
if
(
$
checkVariant
&& !
\in_array
(
$
this
->
uid
[
19
], [
'
8
'
,
'
9
'
,
'
a
'
,
'
b
'
],
true
)) {
throw
new
InvalidArgumentException
(
\sprintf
(
'
Invalid UUID%s.
'
,
static
::
TYPE
?
'
v
'
.
static
::
TYPE
:
''
),
$
uuid
);
}
}
public
static
function
fromString
(
string
$
uuid
):
static
{
if
(
36
!==
\strlen
(
$
uuid
)) {
$
uuid
=
self
::
transformToRfc9562
(
$
uuid
,
self
::
FORMAT_ALL
);
}
if
(
__CLASS__
!==
static
::class ||
36
!==
\strlen
(
$
uuid
)) {
return
new
static
(
$
uuid
);
}
if
(!
\in_array
(
$
uuid
[
19
], [
'
8
'
,
'
9
'
,
'
a
'
,
'
b
'
,
'
A
'
,
'
B
'
],
true
)) {
if
(
self
::
NIL
===
$
uuid
) {
return
new
NilUuid
();
}
if
(
self
::
MAX
===
strtr
(
$
uuid
,
'
F
'
,
'
f
'
)) {
return
new
MaxUuid
();
}
return
new
self
(
$
uuid
);
}
return
match
((
int
)
$
uuid
[
14
]) {
UuidV1::
TYPE
=>
new
UuidV1
(
$
uuid
),
UuidV3::
TYPE
=>
new
UuidV3
(
$
uuid
),
UuidV4::
TYPE
=>
new
UuidV4
(
$
uuid
),
UuidV5::
TYPE
=>
new
UuidV5
(
$
uuid
),
UuidV6::
TYPE
=>
new
UuidV6
(
$
uuid
),
UuidV7::
TYPE
=>
new
UuidV7
(
$
uuid
),
UuidV8::
TYPE
=>
new
UuidV8
(
$
uuid
),
default
=>
new
self
(
$
uuid
),
};
}
final
public
static
function
v1
():
UuidV1
{
return
new
UuidV1
();
}
final
public
static
function
v3
(
self
$
namespace
,
string
$
name
):
UuidV3
{
// don't use uuid_generate_md5(), some versions are buggy
$
uuid
=
md5
(
hex2bin
(
str_replace
(
'
-
'
,
''
,
$
namespace
->
uid
)).
$
name
,
true
);
return
new
UuidV3
(
self
::
format
(
$
uuid
,
'
-3
'
));
}
final
public
static
function
v4
():
UuidV4
{
return
new
UuidV4
();
}
final
public
static
function
v5
(
self
$
namespace
,
string
$
name
):
UuidV5
{
// don't use uuid_generate_sha1(), some versions are buggy
$
uuid
=
substr
(
sha1
(
hex2bin
(
str_replace
(
'
-
'
,
''
,
$
namespace
->
uid
)).
$
name
,
true
),
0
,
16
);
return
new
UuidV5
(
self
::
format
(
$
uuid
,
'
-5
'
));
}
final
public
static
function
v6
():
UuidV6
{
return
new
UuidV6
();
}
final
public
static
function
v7
():
UuidV7
{
return
new
UuidV7
();
}
final
public
static
function
v8
(
string
$
uuid
):
UuidV8
{
return
new
UuidV8
(
$
uuid
);
}
/**
* @param int-mask-of<Uuid::FORMAT_*> $format
*/
public
static
function
isValid
(
string
$
uuid
,
int
$
format
=
self
::
FORMAT_RFC_9562
):
bool
{
if
(
36
===
\strlen
(
$
uuid
) && !(
$
format
&
self
::
FORMAT_RFC_9562
)) {
return
false
;
}
if
(
false
===
$
uuid
=
self
::
transformToRfc9562
(
$
uuid
,
$
format
)) {
return
false
;
}
if
(
self
::
NIL
===
$
uuid
&&
\in_array
(
static
::class, [
__CLASS__
, NilUuid::class],
true
)) {
return
true
;
}
if
(
self
::
MAX
===
strtr
(
$
uuid
,
'
F
'
,
'
f
'
) &&
\in_array
(
static
::class, [
__CLASS__
, MaxUuid::class],
true
)) {
return
true
;
}
if
(!
preg_match
(
'
{^[0-9a-f]{8}(?:-[0-9a-f]{4}){2}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$}Di
'
,
$
uuid
)) {
return
false
;
}
return
__CLASS__
===
static
::class ||
static
::
TYPE
=== (
int
)
$
uuid
[
14
];
}
public
function
toBinary
():
string
{
return
hex2bin
(
str_replace
(
'
-
'
,
''
,
$
this
->
uid
));
}
/**
* Returns the identifier as a RFC 9562/4122 case insensitive string.
*
* @see https://datatracker.ietf.org/doc/html/rfc9562/#section-4
*
* @example 09748193-048a-4bfb-b825-8528cf74fdc1 (len=36)
*/
public
function
toRfc4122
():
string
{
return
$
this
->
uid
;
}
public
function
toHex
():
string
{
return
'
0x
'
.
str_replace
(
'
-
'
,
''
,
$
this
->
uid
);
}
private
static
function
format
(
string
$
uuid
,
string
$
version
):
string
{
$
uuid
[
8
] =
$
uuid
[
8
] &
"\x3F"
|
"\x80"
;
$
uuid
=
substr_replace
(
bin2hex
(
$
uuid
),
'
-
'
,
8
,
0
);
$
uuid
=
substr_replace
(
$
uuid
,
$
version
,
13
,
1
);
$
uuid
=
substr_replace
(
$
uuid
,
'
-
'
,
18
,
0
);
return
substr_replace
(
$
uuid
,
'
-
'
,
23
,
0
);
}
/**
* Transforms a binary string, a base-32 string or a base-58 string to a RFC9562 string.
*
* @param int-mask-of<Uuid::FORMAT_*> $format
*
* @return string|false The RFC9562 string or false if the format doesn't match the input
*/
private
static
function
transformToRfc9562
(
string
$
uuid
,
int
$
format
):
string
|
false
{
$
inputUuid
=
$
uuid
;
$
fromBase58
=
false
;
if
(
22
===
\strlen
(
$
uuid
) &&
22
===
strspn
(
$
uuid
, BinaryUtil::
BASE58
[
''
]) &&
$
format
&
self
::
FORMAT_BASE_58
) {
$
uuid
=
str_pad
(BinaryUtil::
fromBase
(
$
uuid
, BinaryUtil::
BASE58
),
16
,
"\0"
, \
STR_PAD_LEFT
);
$
fromBase58
=
true
;
}
// base-58 are always transformed to binary string, but they must only be valid when the format is FORMAT_BASE_58
if
(
16
===
\strlen
(
$
uuid
) &&
$
format
&
self
::
FORMAT_BINARY
||
$
fromBase58
&&
$
format
&
self
::
FORMAT_BASE_58
) {
// don't use uuid_unparse(), it's slower
$
uuid
=
bin2hex
(
$
uuid
);
$
uuid
=
substr_replace
(
$
uuid
,
'
-
'
,
8
,
0
);
$
uuid
=
substr_replace
(
$
uuid
,
'
-
'
,
13
,
0
);
$
uuid
=
substr_replace
(
$
uuid
,
'
-
'
,
18
,
0
);
$
uuid
=
substr_replace
(
$
uuid
,
'
-
'
,
23
,
0
);
}
elseif
(
26
===
\strlen
(
$
uuid
) && Ulid::
isValid
(
$
uuid
) &&
$
format
&
self
::
FORMAT_BASE_32
) {
$
ulid
=
new
NilUlid
();
$
ulid
->
uid
=
strtoupper
(
$
uuid
);
$
uuid
=
$
ulid
->
toRfc4122
();
}
if
(
$
inputUuid
===
$
uuid
&& !(
$
format
&
self
::
FORMAT_RFC_9562
)) {
// input format doesn't match the input string
return
false
;
}
return
$
uuid
;
}
}
You can’t perform that action at this time.