UUID Class Reference

Public Member Functions
	__construct ($part1=0, $part2=0, $part3=0, $part4=0, $version=null)
	getVersion ()
	equals (UUID $uuid)
	toBinary ()
	toString ()
	__toString ()
	getPart (int $partNumber)
	getParts ()

Static Public Member Functions
static	fromString ($uuid, $version=null)
static	fromBinary ($uuid, $version=null)
static	fromData (... $data)
static	fromRandom ()

Constructor & Destructor Documentation

__construct()

__construct	(		$part1 = 0,
			$part2 = 0,
			$part3 = 0,
			$part4 = 0,
			$version = null
	)

UUID constructor.

Parameters

int	$part1
int	$part2
int	$part3
int	$part4
null	$version

                                                                                                {
        $this->parts[0] = (int) $part1;
        $this->parts[1] = (int) $part2;
        $this->parts[2] = (int) $part3;
        $this->parts[3] = (int) $part4;

        $this->version = $version === null ? ($this->parts[1] & 0xf000) >> 12 : (int) $version;
    }

Member Function Documentation

__toString()

__toString

(

)

Returns

string

                                {
        return $this->toString();
    }

equals()

equals

(

UUID

$uuid

)

Parameters

UUID

$uuid

Returns

bool

                                      {
        return $uuid->parts[0] === $this->parts[0] and $uuid->parts[1] === $this->parts[1] and $uuid->parts[2] === $this->parts[2] and $uuid->parts[3] === $this->parts[3];
    }

fromBinary()

static fromBinary (   $uuid,   $version = null  )

static

Creates an UUID from a binary representation

Parameters

string	$uuid
int	$version

Returns

UUID

                                                             {
        if(strlen($uuid) !== 16){
            throw new \InvalidArgumentException("Must have exactly 16 bytes");
        }

        return new UUID(Binary::readInt(substr($uuid, 0, 4)), Binary::readInt(substr($uuid, 4, 4)), Binary::readInt(substr($uuid, 8, 4)), Binary::readInt(substr($uuid, 12, 4)), $version);
    }

fromData()

static fromData (   $data )

static

Creates an UUIDv3 from binary data or list of binary data

Parameters

array|string

...$data

Returns

UUID

                                             {
        $hash = hash("md5", implode($data), true);

        return self::fromBinary($hash, 3);
    }

fromRandom()

static fromRandom ( )

static

Returns

UUID

                                       {
        return self::fromData(Binary::writeInt(time()), Binary::writeShort(getmypid()), Binary::writeShort(getmyuid()), Binary::writeInt(mt_rand(-0x7fffffff, 0x7fffffff)), Binary::writeInt(mt_rand(-0x7fffffff, 0x7fffffff)));
    }

fromString()

static fromString (   $uuid,   $version = null  )

static

Creates an UUID from an hexadecimal representation

Parameters

string	$uuid
int	$version

Returns

UUID

                                                             {
        return self::fromBinary(hex2bin(str_replace("-", "", trim($uuid))), $version);
    }

getPart()

getPart

(

int

$partNumber

)

Parameters

int

$partNumber

Returns

mixed

                                            {
        if($partNumber < 0 or $partNumber > 3){
            throw new \InvalidArgumentException("Invalid UUID part index $partNumber");
        }
        return $this->parts[$partNumber];
    }

getParts()

getParts

(

)

Returns

array

                               : array{
        return $this->parts;
    }

getVersion()

getVersion

(

)

Returns

int|null

                                {
        return $this->version;
    }

toBinary()

toBinary

(

)

Returns

string

                              {
        return Binary::writeInt($this->parts[0]) . Binary::writeInt($this->parts[1]) . Binary::writeInt($this->parts[2]) . Binary::writeInt($this->parts[3]);
    }

toString()

toString

(

)

Returns

string

                              {
        $hex = bin2hex(self::toBinary());

        //xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx 8-4-4-12
        if($this->version !== null){
            return substr($hex, 0, 8) . "-" . substr($hex, 8, 4) . "-" . hexdec($this->version) . substr($hex, 13, 3) . "-8" . substr($hex, 17, 3) . "-" . substr($hex, 20, 12);
        }
        return substr($hex, 0, 8) . "-" . substr($hex, 8, 4) . "-" . substr($hex, 12, 4) . "-" . substr($hex, 16, 4) . "-" . substr($hex, 20, 12);
    }

---

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

• src/pocketmine/utils/UUID.php