1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
|
.. _reference.rfc4122.fieldsinterface:
========================
Rfc4122\\FieldsInterface
========================
.. php:namespace:: Ramsey\Uuid\Rfc4122
.. php:interface:: FieldsInterface
Implements :php:interface:`Ramsey\\Uuid\\Fields\\FieldsInterface`.
Rfc4122\FieldsInterface represents the fields of an RFC 4122 UUID.
In addition to the methods defined on the interface, this class additionally
defines the following methods.
.. php:method:: getClockSeq()
:returns: The full 16-bit clock sequence, with the variant bits (two most significant bits) masked out.
:returntype: Ramsey\\Uuid\\Type\\Hexadecimal
.. php:method:: getClockSeqHiAndReserved()
:returns: The high field of the clock sequence multiplexed with the variant.
:returntype: Ramsey\\Uuid\\Type\\Hexadecimal
.. php:method:: getClockSeqLow()
:returns: The low field of the clock sequence.
:returntype: Ramsey\\Uuid\\Type\\Hexadecimal
.. php:method:: getNode()
:returns: The node field.
:returntype: Ramsey\\Uuid\\Type\\Hexadecimal
.. php:method:: getTimeHiAndVersion()
:returns: The high field of the timestamp multiplexed with the version.
:returntype: Ramsey\\Uuid\\Type\\Hexadecimal
.. php:method:: getTimeLow()
:returns: The low field of the timestamp.
:returntype: Ramsey\\Uuid\\Type\\Hexadecimal
.. php:method:: getTimeMid()
:returns: The middle field of the timestamp.
:returntype: Ramsey\\Uuid\\Type\\Hexadecimal
.. php:method:: getTimestamp()
:returns: The full 60-bit timestamp, without the version.
:returntype: Ramsey\\Uuid\\Type\\Hexadecimal
.. php:method:: getVariant()
Returns the variant, which, for RFC 4122 variant UUIDs, should always be
the value ``2``.
:returns: The UUID variant.
:returntype: ``int``
.. php:method:: getVersion()
:returns: The UUID version.
:returntype: ``int``
.. php:method:: isNil()
A *nil* UUID is a special type of UUID with all 128 bits set to zero.
Its string standard representation is always
``00000000-0000-0000-0000-000000000000``.
:returns: True if this UUID represents a nil UUID.
:returntype: ``bool``
|