mirror of
https://github.com/ramsey/uuid.git
synced 2026-06-14 15:56:48 +03:00
Ben Ramsey
57 lines
2.5 KiB
ReStructuredText
57 lines
2.5 KiB
ReStructuredText
.. _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, time-based 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: (*string*) A string standard representation of a version 1 UUID
|
|
|
|
.. 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: (*string*) A string standard representation of a version 2 UUID
|
|
|
|
.. 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: (*string*) A string standard representation of a version 3 UUID
|
|
|
|
.. php:function:: Ramsey\\Uuid\\v4()
|
|
|
|
Generates a string standard representation of a version 4, random UUID.
|
|
|
|
:returns: (*string*) A string standard representation of a version 4 UUID
|
|
|
|
.. php:function:: Ramsey\\Uuid\\v5($ns, $name)
|
|
|
|
Generates a string standard representation of a version 5, name-based (SHA-1) UUID.
|
|
|
|
:param Ramsey\\Uuid\\UuidInterface|string $ns: The namespace for this identifier
|
|
:param string $name: The name from which to generate an identifier
|
|
:returns: (*string*) A string standard representation of a version 5 UUID
|
|
|
|
.. php:function:: Ramsey\\Uuid\\v6([$node[, $clockSeq]])
|
|
|
|
Generates a string standard representation of a version 6, ordered-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: (*string*) A string standard representation of a version 6 UUID
|