media-cloud-sync / includes / sdk / google / ramsey / uuid / src / Codec / TimestampLastCombCodec.php

TimestampLastCombCodec.php in Media Cloud Sync 1.0.1, at includes/sdk/google/ramsey/uuid/src/Codec/TimestampLastCombCodec.php

50 lines 1.6 KB

Raw Download Zip

1	<?php
2
3	/**
4	* This file is part of the ramsey/uuid library
5	*
6	* For the full copyright and license information, please view the LICENSE
7	* file that was distributed with this source code.
8	*
9	* @copyright Copyright (c) Ben Ramsey <ben@benramsey.com>
10	* @license http://opensource.org/licenses/MIT MIT
11	*/
12	declare (strict_types=1);
13	namespace Dudlewebs\WPMCS\Ramsey\Uuid\Codec;
14
15	/**
16	* TimestampLastCombCodec encodes and decodes COMBs, with the timestamp as the
17	* last 48 bits
18	*
19	* The CombGenerator when used with the StringCodec (and, by proxy, the
20	* TimestampLastCombCodec) adds the timestamp to the last 48 bits of the COMB.
21	* The TimestampLastCombCodec is provided for the sake of consistency. In
22	* practice, it is identical to the standard StringCodec but, it may be used
23	* with the CombGenerator for additional context when reading code.
24	*
25	* Consider the following code. By default, the codec used by UuidFactory is the
26	* StringCodec, but here, we explicitly set the TimestampLastCombCodec. It is
27	* redundant, but it is clear that we intend this COMB to be generated with the
28	* timestamp appearing at the end.
29	*
30	* ``` php
31	* $factory = new UuidFactory();
32	*
33	* $factory->setCodec(new TimestampLastCombCodec($factory->getUuidBuilder()));
34	*
35	* $factory->setRandomGenerator(new CombGenerator(
36	* $factory->getRandomGenerator(),
37	* $factory->getNumberConverter()
38	* ));
39	*
40	* $timestampLastComb = $factory->uuid4();
41	* ```
42	*
43	* @link https://www.informit.com/articles/printerfriendly/25862 The Cost of GUIDs as Primary Keys
44	*
45	* @psalm-immutable
46	*/
47	class TimestampLastCombCodec extends StringCodec
48	{
49	}
50