media-cloud-sync / includes / sdk / google / ramsey / uuid / src / Codec / CodecInterface.php

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

64 lines 2.0 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\Codec;
14
15	use Dudlewebs\WPMCS\GCP\Ramsey\Uuid\UuidInterface;
16	/**
17	* A codec encodes and decodes a UUID according to defined rules
18	*
19	* @immutable
20	*/
21	interface CodecInterface
22	{
23	/**
24	* Returns a hexadecimal string representation of a UuidInterface
25	*
26	* @param UuidInterface $uuid The UUID for which to create a hexadecimal string representation
27	*
28	* @return non-empty-string Hexadecimal string representation of a UUID
29	*
30	* @pure
31	*/
32	public function encode(UuidInterface $uuid) : string;
33	/**
34	* Returns a binary string representation of a UuidInterface
35	*
36	* @param UuidInterface $uuid The UUID for which to create a binary string representation
37	*
38	* @return non-empty-string Binary string representation of a UUID
39	*
40	* @pure
41	*/
42	public function encodeBinary(UuidInterface $uuid) : string;
43	/**
44	* Returns a UuidInterface derived from a hexadecimal string representation
45	*
46	* @param string $encodedUuid The hexadecimal string representation to convert into a UuidInterface instance
47	*
48	* @return UuidInterface An instance of a UUID decoded from a hexadecimal string representation
49	*
50	* @pure
51	*/
52	public function decode(string $encodedUuid) : UuidInterface;
53	/**
54	* Returns a UuidInterface derived from a binary string representation
55	*
56	* @param string $bytes The binary string representation to convert into a UuidInterface instance
57	*
58	* @return UuidInterface An instance of a UUID decoded from a binary string representation
59	*
60	* @pure
61	*/
62	public function decodeBytes(string $bytes) : UuidInterface;
63	}
64