defender-security / vendor / ramsey / uuid / src / Codec / CodecInterface.php

CodecInterface.php in Defender Security – Malware Scanner, Login Security & Firewall 5.7.2, at vendor/ramsey/uuid/src/Codec/CodecInterface.php

70 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 <[email protected]>
10	* @license http://opensource.org/licenses/MIT MIT
11	*/
12
13	declare(strict_types=1);
14
15	namespace Ramsey\Uuid\Codec;
16
17	use Ramsey\Uuid\UuidInterface;
18
19	/**
20	* A codec encodes and decodes a UUID according to defined rules
21	*
22	* @immutable
23	*/
24	interface CodecInterface
25	{
26	/**
27	* Returns a hexadecimal string representation of a UuidInterface
28	*
29	* @param UuidInterface $uuid The UUID for which to create a hexadecimal string representation
30	*
31	* @return non-empty-string Hexadecimal string representation of a UUID
32	*
33	* @pure
34	*/
35	public function encode(UuidInterface $uuid): string;
36
37	/**
38	* Returns a binary string representation of a UuidInterface
39	*
40	* @param UuidInterface $uuid The UUID for which to create a binary string representation
41	*
42	* @return non-empty-string Binary string representation of a UUID
43	*
44	* @pure
45	*/
46	public function encodeBinary(UuidInterface $uuid): string;
47
48	/**
49	* Returns a UuidInterface derived from a hexadecimal string representation
50	*
51	* @param string $encodedUuid The hexadecimal string representation to convert into a UuidInterface instance
52	*
53	* @return UuidInterface An instance of a UUID decoded from a hexadecimal string representation
54	*
55	* @pure
56	*/
57	public function decode(string $encodedUuid): UuidInterface;
58
59	/**
60	* Returns a UuidInterface derived from a binary string representation
61	*
62	* @param string $bytes The binary string representation to convert into a UuidInterface instance
63	*
64	* @return UuidInterface An instance of a UUID decoded from a binary string representation
65	*
66	* @pure
67	*/
68	public function decodeBytes(string $bytes): UuidInterface;
69	}
70