ILIAS\Data\UUID\RamseyUuidWrapper Class Reference

Inheritance diagram for ILIAS\Data\UUID\RamseyUuidWrapper:

Collaboration diagram for ILIAS\Data\UUID\RamseyUuidWrapper:

Public Member Functions
	__construct (RamseyUuidInterface $wrapped_uuid)
	getWrappedUuid ()
	compareTo (Uuid $other)
	Compares this UUID to the specified UUID. More...
	equals (Uuid $other)
	Compares this object to the specified object. More...
	toString ()
	Converts this UUID into a string representation. More...
	__toString ()
	Enforce that UUID implementation implement the __toString() magic method. More...

Private Attributes
RamseyUuidInterface	$wrapped_uuid

Detailed Description

Definition at line 31 of file RamseyUuidWrapper.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Data\UUID\RamseyUuidWrapper::__construct

(

RamseyUuidInterface

$wrapped_uuid

)

Definition at line 35 of file RamseyUuidWrapper.php.

References ILIAS\Data\UUID\RamseyUuidWrapper\$wrapped_uuid.

    {
        $this->wrapped_uuid = $wrapped_uuid;
    }

Member Function Documentation

__toString()

ILIAS\Data\UUID\RamseyUuidWrapper::__toString

(

)

Enforce that UUID implementation implement the __toString() magic method.

Implements ILIAS\Data\UUID\Uuid.

Definition at line 60 of file RamseyUuidWrapper.php.

References ILIAS\Data\UUID\RamseyUuidWrapper\toString().

                                : string
    {
        return $this->toString();
    }

Here is the call graph for this function:

compareTo()

ILIAS\Data\UUID\RamseyUuidWrapper::compareTo

(

Uuid

$other

)

Compares this UUID to the specified UUID.

The first of two UUIDs is greater than the second if the most significant field in which the UUIDs differ is greater for the first UUID.

• Q. What's the value of being able to sort UUIDs?
• A. Use them as keys in a B-Tree or similar mapping.

Parameters

Uuid

$other

UUID to which this UUID is compared

Returns

int -1, 0 or 1 as this UUID is less than, equal to, or greater than $uuid

Implements ILIAS\Data\UUID\Uuid.

Definition at line 45 of file RamseyUuidWrapper.php.

                                          : int
    {
        return $this->wrapped_uuid->compareTo($other->getWrappedUuid());
    }

equals()

ILIAS\Data\UUID\RamseyUuidWrapper::equals

(

Uuid

$other

)

Compares this object to the specified object.

The result is true if and only if the argument is not null, is a UUID object, has the same variant, and contains the same value, bit for bit, as this UUID.

Parameters

Uuid

$other

Returns

bool True if $other is equal to this UUID

Implements ILIAS\Data\UUID\Uuid.

Definition at line 50 of file RamseyUuidWrapper.php.

                                       : bool
    {
        return $this->wrapped_uuid->equals($other->getWrappedUuid());
    }

getWrappedUuid()

ILIAS\Data\UUID\RamseyUuidWrapper::getWrappedUuid

(

)

Definition at line 40 of file RamseyUuidWrapper.php.

References ILIAS\Data\UUID\RamseyUuidWrapper\$wrapped_uuid.

                                    : RamseyUuidInterface
    {
        return $this->wrapped_uuid;
    }

toString()

ILIAS\Data\UUID\RamseyUuidWrapper::toString

(

)

Converts this UUID into a string representation.

Implements ILIAS\Data\UUID\Uuid.

Definition at line 55 of file RamseyUuidWrapper.php.

Referenced by ILIAS\Data\UUID\RamseyUuidWrapper\__toString().

                              : string
    {
        return $this->wrapped_uuid->toString();
    }

Here is the caller graph for this function:

Field Documentation

$wrapped_uuid

RamseyUuidInterface ILIAS\Data\UUID\RamseyUuidWrapper::$wrapped_uuid

private

Definition at line 33 of file RamseyUuidWrapper.php.

Referenced by ILIAS\Data\UUID\RamseyUuidWrapper\__construct(), and ILIAS\Data\UUID\RamseyUuidWrapper\getWrappedUuid().

---

The documentation for this class was generated from the following file:

• components/ILIAS/Data/src/UUID/RamseyUuidWrapper.php