summaryrefslogtreecommitdiffstats
path: root/vendor/ramsey/uuid/src/Converter/NumberConverterInterface.php
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/ramsey/uuid/src/Converter/NumberConverterInterface.php')
-rw-r--r--vendor/ramsey/uuid/src/Converter/NumberConverterInterface.php57
1 files changed, 57 insertions, 0 deletions
diff --git a/vendor/ramsey/uuid/src/Converter/NumberConverterInterface.php b/vendor/ramsey/uuid/src/Converter/NumberConverterInterface.php
new file mode 100644
index 0000000..b33ec31
--- /dev/null
+++ b/vendor/ramsey/uuid/src/Converter/NumberConverterInterface.php
@@ -0,0 +1,57 @@
+<?php
+
+/**
+ * This file is part of the ramsey/uuid library
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @copyright Copyright (c) Ben Ramsey <ben@benramsey.com>
+ * @license http://opensource.org/licenses/MIT MIT
+ */
+
+declare(strict_types=1);
+
+namespace Ramsey\Uuid\Converter;
+
+/**
+ * A number converter converts UUIDs from hexadecimal characters into
+ * representations of integers and vice versa
+ *
+ * @psalm-immutable
+ */
+interface NumberConverterInterface
+{
+ /**
+ * Converts a hexadecimal number into an string integer representation of
+ * the number
+ *
+ * The integer representation returned is a string representation of the
+ * integer, to accommodate unsigned integers greater than PHP_INT_MAX.
+ *
+ * @param string $hex The hexadecimal string representation to convert
+ *
+ * @return string String representation of an integer
+ *
+ * @psalm-return numeric-string
+ *
+ * @psalm-pure
+ */
+ public function fromHex(string $hex): string;
+
+ /**
+ * Converts a string integer representation into a hexadecimal string
+ * representation of the number
+ *
+ * @param string $number A string integer representation to convert; this
+ * must be a numeric string to accommodate unsigned integers greater
+ * than PHP_INT_MAX.
+ *
+ * @return string Hexadecimal string
+ *
+ * @psalm-return non-empty-string
+ *
+ * @psalm-pure
+ */
+ public function toHex(string $number): string;
+}