Debian Codegraph @

vendor/ramsey/uuid/src/Generator/DceSecurityGeneratorInterface.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\Rfc4122\UuidV2;
18 use Ramsey\Uuid\Type\Hexadecimal;
19 use Ramsey\Uuid\Type\Integer as IntegerObject;
20
21 /**
22 * A DCE Security generator generates strings of binary data based on a local domain, local identifier, node ID, clock
23 * sequence, and the current time
24 *
25 * @see UuidV2
26 */
27 interface DceSecurityGeneratorInterface
28 {
29 /**
30 * Generate a binary string from a local domain, local identifier, node ID, clock sequence, and current time
31 *
32 * @param int $localDomain The local domain to use when generating bytes, according to DCE Security
33 * @param IntegerObject | null $localIdentifier The local identifier for the given domain; this may be a UID or GID
34 * on POSIX systems if the local domain is "person" or "group," or it may be a site-defined identifier if the
35 * local domain is "org"
36 * @param Hexadecimal | null $node A 48-bit number representing the hardware address
37 * @param int | null $clockSeq A 14-bit number used to help avoid duplicates that could arise when the clock is set
38 * backwards in time or if the node ID changes
39 *
40 * @return string A binary string
41 */
42 public function generate(
43 int $localDomain,
44 ?IntegerObject $localIdentifier = null,
45 ?Hexadecimal $node = null,
46 ?int $clockSeq = null,
47 ): string;
48 }