media-cloud-sync / includes / sdk / google / ramsey / uuid / src / Generator / DceSecurityGeneratorInterface.php

DceSecurityGeneratorInterface.php in Media Cloud Sync 1.4.1, at includes/sdk/google/ramsey/uuid/src/Generator/DceSecurityGeneratorInterface.php

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