OXIESEC PANEL

Name	Size	Modified	Perms
📁 ..	-	08/12/2024 10:34:34 AM	rwxr-xr-x
📄 calculators.rst	6.92 KB	08/12/2024 10:34:32 AM	rw-r--r--
📄 exceptions.rst	2.83 KB	08/12/2024 10:34:32 AM	rw-r--r--
📄 fields-fieldsinterface.rst	363 bytes	08/12/2024 10:34:32 AM	rw-r--r--
📄 guid-fields.rst	263 bytes	08/12/2024 10:34:32 AM	rw-r--r--
📄 guid-guid.rst	510 bytes	08/12/2024 10:34:32 AM	rw-r--r--
📄 helper.rst	2.68 KB	08/12/2024 10:34:32 AM	rw-r--r--
📄 name-based-namespaces.rst	1.12 KB	08/12/2024 10:34:33 AM	rw-r--r--
📄 nonstandard-fields.rst	317 bytes	08/12/2024 10:34:33 AM	rw-r--r--
📄 nonstandard-uuid.rst	562 bytes	08/12/2024 10:34:33 AM	rw-r--r--
📄 nonstandard-uuidv6.rst	1.3 KB	08/12/2024 10:34:33 AM	rw-r--r--
📄 rfc4122-fieldsinterface.rst	2.35 KB	08/12/2024 10:34:33 AM	rw-r--r--
📄 rfc4122-uuidinterface.rst	587 bytes	08/12/2024 10:34:33 AM	rw-r--r--
📄 rfc4122-uuidv1.rst	608 bytes	08/12/2024 10:34:33 AM	rw-r--r--
📄 rfc4122-uuidv2.rst	1.65 KB	08/12/2024 10:34:33 AM	rw-r--r--
📄 rfc4122-uuidv3.rst	311 bytes	08/12/2024 10:34:33 AM	rw-r--r--
📄 rfc4122-uuidv4.rst	301 bytes	08/12/2024 10:34:33 AM	rw-r--r--
📄 rfc4122-uuidv5.rst	313 bytes	08/12/2024 10:34:33 AM	rw-r--r--
📄 rfc4122-uuidv6.rst	1012 bytes	08/12/2024 10:34:33 AM	rw-r--r--
📄 rfc4122-uuidv7.rst	609 bytes	08/12/2024 10:34:33 AM	rw-r--r--
📄 rfc4122-uuidv8.rst	301 bytes	08/12/2024 10:34:33 AM	rw-r--r--
📄 types.rst	2.45 KB	08/12/2024 10:34:33 AM	rw-r--r--
📄 uuid.rst	6.91 KB	08/12/2024 10:34:33 AM	rw-r--r--
📄 uuidfactoryinterface.rst	4.05 KB	08/12/2024 10:34:33 AM	rw-r--r--
📄 uuidinterface.rst	1.68 KB	08/12/2024 10:34:33 AM	rw-r--r--
📄 validators.rst	920 bytes	08/12/2024 10:34:33 AM	rw-r--r--

Editing: helper.rst

.. _reference.helper:

================
Helper Functions
================

ramsey/uuid additionally provides the following helper functions, which return
only the string standard representation of a UUID.

.. php:function:: Ramsey\\Uuid\\v1([$node[, $clockSeq]])

Generates a string standard representation of a version 1, Gregorian time UUID.

:param Ramsey\\Uuid\\Type\\Hexadecimal|null $node: An optional hexadecimal node to use
    :param int|null $clockSeq: An optional clock sequence to use
    :returns: A string standard representation of a version 1 UUID
    :returntype: string

.. php:function:: Ramsey\\Uuid\\v2($localDomain[, $localIdentifier[, $node[, $clockSeq]]])

Generates a string standard representation of a version 2, DCE Security UUID.

:param int $localDomain: The local domain to use (one of ``Uuid::DCE_DOMAIN_PERSON``, ``Uuid::DCE_DOMAIN_GROUP``, or ``Uuid::DCE_DOMAIN_ORG``)
    :param Ramsey\\Uuid\\Type\\Integer|null $localIdentifier: A local identifier for the domain (defaults to system UID or GID for *person* or *group*)
    :param Ramsey\\Uuid\\Type\\Hexadecimal|null $node: An optional hexadecimal node to use
    :param int|null $clockSeq: An optional clock sequence to use
    :returns: A string standard representation of a version 2 UUID
    :returntype: string

.. php:function:: Ramsey\\Uuid\\v3($ns, $name)

Generates a string standard representation of a version 3, name-based (MD5) UUID.

:param Ramsey\\Uuid\\UuidInterface|string $ns: The namespace for this identifier
    :param string $name: The name from which to generate an identifier
    :returns: A string standard representation of a version 3 UUID
    :returntype: string

.. php:function:: Ramsey\\Uuid\\v4()

Generates a string standard representation of a version 4, random UUID.

:returns: A string standard representation of a version 4 UUID
    :returntype: string

.. php:function:: Ramsey\\Uuid\\v5($ns, $name)

Generates a string standard representation of a version 5, name-based (SHA-1) UUID.

.. php:function:: Ramsey\\Uuid\\v6([$node[, $clockSeq]])

Generates a string standard representation of a version 6, reordered time UUID.