media-cloud-sync / includes / sdk / google / ramsey / uuid / src / Converter / TimeConverterInterface.php

TimeConverterInterface.php in Media Cloud Sync 1.4.2, at includes/sdk/google/ramsey/uuid/src/Converter/TimeConverterInterface.php

50 lines 1.8 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 <[email protected]>
10	* @license http://opensource.org/licenses/MIT MIT
11	*/
12	declare (strict_types=1);
13	namespace Dudlewebs\WPMCS\GCP\Ramsey\Uuid\Converter;
14
15	use Dudlewebs\WPMCS\GCP\Ramsey\Uuid\Type\Hexadecimal;
16	use Dudlewebs\WPMCS\GCP\Ramsey\Uuid\Type\Time;
17	/**
18	* A time converter converts timestamps into representations that may be used in UUIDs
19	*
20	* @immutable
21	*/
22	interface TimeConverterInterface
23	{
24	/**
25	* Uses the provided seconds and micro-seconds to calculate the count of 100-nanosecond intervals since
26	* UTC 00:00:00.00, 15 October 1582, for RFC 9562 (formerly RFC 4122) variant UUIDs
27	*
28	* @link https://www.rfc-editor.org/rfc/rfc9562#appendix-A RFC 9562, Appendix A. Test Vectors
29	*
30	* @param string $seconds A string representation of seconds since the Unix epoch for the time to calculate
31	* @param string $microseconds A string representation of the micro-seconds associated with the time to calculate
32	*
33	* @return Hexadecimal The full UUID timestamp as a Hexadecimal value
34	*
35	* @pure
36	*/
37	public function calculateTime(string $seconds, string $microseconds) : Hexadecimal;
38	/**
39	* Converts a timestamp extracted from a UUID to a Unix timestamp
40	*
41	* @param Hexadecimal $uuidTimestamp A hexadecimal representation of a UUID timestamp; a UUID timestamp is a count
42	* of 100-nanosecond intervals since UTC 00:00:00.00, 15 October 1582.
43	*
44	* @return Time An instance of {@see Time}
45	*
46	* @pure
47	*/
48	public function convertTime(Hexadecimal $uuidTimestamp) : Time;
49	}
50