VersionString Class Reference

Public Member Functions
	__construct ($version=\pocketmine\VERSION)
	getNumber ()
	getStage ()
	getGeneration ()
	getMajor ()
	getMinor ()
	getRelease ()
	getBuild ()
	isDev ()
	get ($build=false)
	__toString ()
	compare ($target, $diff=false)

Detailed Description

Manages PocketMine-MP version strings, and compares them

Constructor & Destructor Documentation

__construct()

__construct

(

$version = \pocketmine\VERSION

)

VersionString constructor.

Parameters

string

$version

                                                               {
        if(is_int($version)){
            $this->minor = $version & 0x1F;
            $this->major = ($version >> 5) & 0x0F;
            $this->generation = ($version >> 9) & 0x0F;
        }else{
            $this->generation = 0;
            $this->major = 0;
            $this->minor = 0;
            $this->development = true;
            $this->build = 0;
        }
    }

Member Function Documentation

__toString()

__toString

(

)

Returns

string

                                {
        return $this->get();
    }

compare()

compare	(		$target,
			$diff = false
	)

Parameters

	$target
bool	$diff

Returns

int

                                                   {
        if(($target instanceof VersionString) === false){
            $target = new VersionString($target);
        }
        $number = $this->getNumber();
        $tNumber = $target->getNumber();
        if($diff === true){
            return $tNumber - $number;
        }
        if($number > $tNumber){
            return -1; //Target is older
        }elseif($number < $tNumber){
            return 1; //Target is newer
        }elseif($target->getBuild() > $this->getBuild()){
            return 1;
        }elseif($target->getBuild() < $this->getBuild()){
            return -1;
        }else{
            return 0; //Same version
        }
    }

get()

get

(

$build = false

)

Parameters

bool

$build

Returns

string

                                       {
        return $this->getRelease() . ($this->development === true ? "dev" : "") . (($this->build > 0 and $build === true) ? "-" . $this->build : "");
    }

getBuild()

getBuild

(

)

Returns

int

                              {
        return $this->build;
    }

getGeneration()

getGeneration

(

)

Returns

int

                                   {
        return $this->generation;
    }

getMajor()

getMajor

(

)

Returns

int

                              {
        return $this->major;
    }

getMinor()

getMinor

(

)

Returns

int

                              {
        return $this->minor;
    }

getNumber()

getNumber

(

)

Returns

int

                               {
        return (int) (($this->generation << 9) + ($this->major << 5) + $this->minor);
    }

getRelease()

getRelease

(

)

Returns

string

                                {
        return $this->generation . "." . $this->major . ($this->minor > 0 ? "." . $this->minor : "");
    }

getStage()

getStage

(

)

Deprecated:

                              {
        return "final";
    }

isDev()

isDev

(

)

Returns

bool

                           {
        return $this->development === true;
    }

---

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

• src/pocketmine/utils/VersionString.php