ZipStream\Bigint Class Reference

Collaboration diagram for ZipStream\Bigint:

Public Member Functions
	__construct (int $value=0)
	Initialize the bytes array. More...
	getHigh32 ()
	Get high 32. More...
	getValue (int $end=0, int $length=8)
	Get value from bytes array. More...
	getLowFF (bool $force=false)
	Get low FF. More...
	isOver32 (bool $force=false)
	Check if is over 32. More...
	getLow32 ()
	Get low 32. More...
	getHex64 ()
	Get hexadecimal. More...
	add (Bigint $other)
	Add. More...

Static Public Member Functions
static	init (int $value=0)
	Get an instance. More...
static	fromLowHigh (int $low, int $high)
	Fill bytes from low to high. More...

Protected Member Functions
	fillBytes (int $value, int $start, int $count)
	Fill the bytes field with int. More...

Private Attributes
	$bytes = [0, 0, 0, 0, 0, 0, 0, 0]

Detailed Description

Definition at line 8 of file Bigint.php.

Constructor & Destructor Documentation

__construct()

ZipStream\Bigint::__construct

(

int

$value = 0

)

Initialize the bytes array.

Parameters

int

$value

Definition at line 20 of file Bigint.php.

    {
        $this->fillBytes($value, 0, 8);
    }

Member Function Documentation

add()

ZipStream\Bigint::add

(

Bigint

$other

)

Add.

Parameters

Bigint

$other

Returns

Bigint

Definition at line 152 of file Bigint.php.

                                      : Bigint
    {
        $result = clone $this;
        $overflow = false;
        for ($i = 0; $i < 8; $i++) {
            $result->bytes[$i] += $other->bytes[$i];
            if ($overflow) {
                $result->bytes[$i]++;
                $overflow = false;
            }
            if ($result->bytes[$i] & 0x100) {
                $overflow = true;
                $result->bytes[$i] &= 0xFF;
            }
        }
        if ($overflow) {
            throw new OverflowException;
        }
        return $result;
    }

References $i, and $result.

fillBytes()

ZipStream\Bigint::fillBytes ( int  $value, int  $start, int  $count  )

protected

Fill the bytes field with int.

Parameters

int	$value
int	$start
int	$count

Returns

void

Definition at line 33 of file Bigint.php.

                                                                    : void
    {
        for ($i = 0; $i < $count; $i++) {
            $this->bytes[$start + $i] = $i >= PHP_INT_SIZE ? 0 : $value & 0xFF;
            $value >>= 8;
        }
    }

References $i, and $start.

fromLowHigh()

static ZipStream\Bigint::fromLowHigh ( int  $low, int  $high  )

static

Fill bytes from low to high.

Parameters

int	$low
int	$high

Returns

Bigint

Definition at line 59 of file Bigint.php.

                                                           : self
    {
        $bigint = new Bigint();
        $bigint->fillBytes($low, 0, 4);
        $bigint->fillBytes($high, 4, 4);
        return $bigint;
    }

Referenced by BigintTest\BigintTest\testAddWithOverflowAtInteger64().

Here is the caller graph for this function:

getHex64()

ZipStream\Bigint::getHex64

(

)

Get hexadecimal.

Returns

string

Definition at line 137 of file Bigint.php.

                              : string
    {
        $result = '0x';
        for ($i = 7; $i >= 0; $i--) {
            $result .= sprintf('%02X', $this->bytes[$i]);
        }
        return $result;
    }

References $i, and $result.

getHigh32()

ZipStream\Bigint::getHigh32

(

)

Get high 32.

Returns

int

Definition at line 72 of file Bigint.php.

                               : int
    {
        return $this->getValue(4, 4);
    }

getLow32()

ZipStream\Bigint::getLow32

(

)

Get low 32.

Returns

int

Definition at line 127 of file Bigint.php.

                              : int
    {
        return $this->getValue(0, 4);
    }

getLowFF()

ZipStream\Bigint::getLowFF

(

bool

$force = false

)

Get low FF.

Parameters

bool

$force

Returns

float

Definition at line 100 of file Bigint.php.

                                                 : float
    {
        if ($force || $this->isOver32()) {
            return (float)0xFFFFFFFF;
        }
        return (float)$this->getLow32();
    }

getValue()

ZipStream\Bigint::getValue	(	int	$end = 0,
		int	$length = 8
	)

Get value from bytes array.

Parameters

int	$end
int	$length

Returns

int

Definition at line 84 of file Bigint.php.

                                                           : int
    {
        $result = 0;
        for ($i = $end + $length - 1; $i >= $end; $i--) {
            $result <<= 8;
            $result |= $this->bytes[$i];
        }
        return $result;
    }

References $end, $i, and $result.

init()

static ZipStream\Bigint::init ( int  $value = 0 )

static

Get an instance.

Parameters

int

$value

Returns

Bigint

Definition at line 47 of file Bigint.php.

                                               : self
    {
        return new self($value);
    }

Referenced by BigintTest\BigintTest\testAddSmallValue(), BigintTest\BigintTest\testAddWithOverflowAtInteger32(), BigintTest\BigintTest\testAddWithOverflowAtInteger64(), and BigintTest\BigintTest\testAddWithOverflowAtLowestByte().

Here is the caller graph for this function:

isOver32()

ZipStream\Bigint::isOver32

(

bool

$force = false

)

Check if is over 32.

Parameters

bool

$force

Returns

bool

Definition at line 114 of file Bigint.php.

                                                 : bool
    {
        // value 0xFFFFFFFF already needs a Zip64 header
        return $force ||
            max(array_slice($this->bytes, 4, 4)) > 0 ||
            min(array_slice($this->bytes, 0, 4)) === 0xFF;
    }

Field Documentation

$bytes

ZipStream\Bigint::$bytes = [0, 0, 0, 0, 0, 0, 0, 0]

private

Definition at line 13 of file Bigint.php.

---

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

• libs/composer/vendor/maennchen/zipstream-php/src/Bigint.php