Debian Codegraph @

vendor/ramsey/uuid/src/Generator/TimeGeneratorInterface.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\Generator;
16
17 use Ramsey\Uuid\Type\Hexadecimal;
18
19 /**
20 * A time generator generates strings of binary data based on a node ID, clock sequence, and the current time
21 */
22 interface TimeGeneratorInterface
23 {
24 /**
25 * Generate a binary string from a node ID, clock sequence, and current time
26 *
27 * @param Hexadecimal | int | string | null $node A 48-bit number representing the hardware address; this number may
28 * be represented as an integer or a hexadecimal string
29 * @param int | null $clockSeq A 14-bit number used to help avoid duplicates that could arise when the clock is set
30 * backwards in time or if the node ID changes
31 *
32 * @return string A binary string
33 */
34 public function generate($node = null, ?int $clockSeq = null): string;
35 }