Debian Codegraph @

vendor/ramsey/uuid/src/Codec/TimestampLastCombCodec.php

raw
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 <[email protected]>
10 * @license http://opensource.org/licenses/MIT MIT
11 */
12
13 declare(strict_types=1);
14
15 namespace Ramsey\Uuid\Codec;
16
17 /**
18 * TimestampLastCombCodec encodes and decodes COMBs, with the timestamp as the last 48 bits
19 *
20 * The CombGenerator when used with the StringCodec (and, by proxy, the TimestampLastCombCodec) adds the timestamp to
21 * the last 48 bits of the COMB. The TimestampLastCombCodec is provided for the sake of consistency. In practice, it is
22 * identical to the standard StringCodec, but it may be used with the CombGenerator for additional context when reading
23 * code.
24 *
25 * Consider the following code. By default, the codec used by UuidFactory is the StringCodec, but here, we explicitly
26 * set the TimestampLastCombCodec. It is redundant, but it is clear that we intend this COMB to be generated with the
27 * timestamp appearing at the end.
28 *
29 * ```
30 * $factory = new UuidFactory();
31 *
32 * $factory->setCodec(new TimestampLastCombCodec($factory->getUuidBuilder()));
33 *
34 * $factory->setRandomGenerator(new CombGenerator(
35 * $factory->getRandomGenerator(),
36 * $factory->getNumberConverter(),
37 * ));
38 *
39 * $timestampLastComb = $factory->uuid4();
40 * ```
41 *
42 * @deprecated Please use {@see StringCodec} instead.
43 *
44 * @immutable
45 */
46 class TimestampLastCombCodec extends StringCodec
47 {
48 }