nonstandard-uuidv6.rst 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. .. _reference.nonstandard.uuidv6:
  2. ===================
  3. Nonstandard\\UuidV6
  4. ===================
  5. .. php:namespace:: Ramsey\Uuid\Nonstandard
  6. .. php:class:: UuidV6
  7. .. attention::
  8. :php:class:`Ramsey\\Uuid\\Nonstandard\\UuidV6` is deprecated in favor of
  9. :php:class:`Ramsey\\Uuid\\Rfc4122\\UuidV6`. Please migrate any code
  10. using ``Nonstandard\UuidV6`` to ``Rfc4122\UuidV6``. The interface is
  11. otherwise identical.
  12. Implements :php:interface:`Ramsey\\Uuid\\Rfc4122\\UuidInterface`.
  13. UuidV6 represents a :ref:`version 6, reordered time UUID
  14. <nonstandard.version6>`. In addition to providing the methods defined on the
  15. interface, this class additionally provides the following methods.
  16. .. php:method:: getDateTime()
  17. :returns: A date object representing the timestamp associated with the UUID
  18. :returntype: ``\DateTimeInterface``
  19. .. php:method:: toUuidV1()
  20. :returns: A version 1 UUID, converted from this version 6 UUID
  21. :returntype: Ramsey\\Uuid\\Rfc4122\\UuidV1
  22. .. php:staticmethod:: fromUuidV1()
  23. :param Ramsey\\Uuid\\Rfc4122\\UuidV1 $uuidV1: A version 1 UUID
  24. :returns: A version 6 UUID, converted from the given version 1 UUID
  25. :returntype: Ramsey\\Uuid\\Rfc4122\\UuidV6