BigInt::signedOctets() - Code Metrics - Inspection of "Apply formatting" - sop/asn1 - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 6e6a53...7aa2fb )

by Joni
created 2019-06-26 05:54 UTC
BigInt::signedOctets() A

↳ Parent: BigInt
Complexity

Conditions	3
Paths	3
Size

Total Lines	10
Code Lines	6
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	6
CRAP Score	3
Importance

Changes
Metric	Value
cc	3
eloc	6
c	0
b	0
f	0
nc	3
nop	0
dl	0
loc	10
ccs	6
cts	6
cp	1
crap	3
rs	10
<?php

declare(strict_types = 1);

namespace Sop\ASN1\Util;

/**
 * Class to wrap an integer of arbirtary length.
 */
class BigInt
{
    /**
     * Number as a GMP object.
     *
     * @var \GMP
     */
    private $_gmp;

    /**
     * Number as a base 10 integer string.
     *
     * @internal Lazily initialized
     *
     * @var null|string
     */
    private $_num;

    /**
     * Number as an integer type.
     *
     * @internal Lazily initialized
     *
     * @var null|int
     */
    private $_intNum;

    /**
     * Constructor.
     *
     * @param \GMP|int|string $num Integer number in base 10
     */
    public function __construct($num)
    {
        // convert to GMP object
        if (!($num instanceof \GMP)) {
            $gmp = @gmp_init($num, 10);
            if (false === $gmp) {
                throw new \InvalidArgumentException(
                    "Unable to convert '{$num}' to integer.");
            }
            $num = $gmp;
        }
        $this->_gmp = $num;
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
    }

    /**
     * @return string
     */
    public function __toString(): string
    {
        return $this->base10();
    }

    /**
     * Initialize from an arbitrary length of octets as an unsigned integer.
     *
     * @param string $octets
     *
     * @return self
     */
    public static function fromUnsignedOctets(string $octets): self
    {
        if (!strlen($octets)) {
            throw new \InvalidArgumentException('Empty octets.');
        }
        return new self(gmp_import($octets, 1, GMP_MSW_FIRST | GMP_BIG_ENDIAN));
        return new self(/** @scrutinizer ignore-type */ gmp_import($octets, 1, GMP_MSW_FIRST | GMP_BIG_ENDIAN));
    }

    /**
     * Initialize from an arbitrary length of octets as an signed integer
     * having two's complement encoding.
     *
     * @param string $octets
     *
     * @return self
     */
    public static function fromSignedOctets(string $octets): self
    {
        if (!strlen($octets)) {
            throw new \InvalidArgumentException('Empty octets.');
        }
        $neg = ord($octets[0]) & 0x80;
        // negative, apply inversion of two's complement
        if ($neg) {
            $octets = ~$octets;
        }
        $num = gmp_import($octets, 1, GMP_MSW_FIRST | GMP_BIG_ENDIAN);
        // negative, apply addition of two's complement and produce negative result
        if ($neg) {
            $num = gmp_neg($num + 1);
        }
        return new self($num);
        return new self(/** @scrutinizer ignore-type */ $num);
    }

    /**
     * Get the number as a base 10 integer string.
     *
     * @return string
     */
    public function base10(): string
    {
        if (!isset($this->_num)) {
            $this->_num = gmp_strval($this->_gmp, 10);
        }
        return $this->_num;

    }

    /**
     * Get the number as an integer.
     *
     * @throws \RuntimeException If number overflows integer size
     *
     * @return int
     */
    public function intVal(): int
    {
        if (!isset($this->_intNum)) {
            if (gmp_cmp($this->_gmp, $this->_intMaxGmp()) > 0) {
                throw new \RuntimeException('Integer overflow.');
            }
            if (gmp_cmp($this->_gmp, $this->_intMinGmp()) < 0) {
                throw new \RuntimeException('Integer underflow.');
            }
            $this->_intNum = gmp_intval($this->_gmp);
        }
        return $this->_intNum;
    }

    /**
     * Get the number as a `GMP` object.
     *
     * @throws \RuntimeException if number is not a valid integer
     *
     * @return \GMP
     */
    public function gmpObj(): \GMP
    {
        return clone $this->_gmp;
    }

    /**
     * Get the number as an unsigned integer encoded in binary.
     *
     * @return string
     */
    public function unsignedOctets(): string
    {
        return gmp_export($this->_gmp, 1, GMP_MSW_FIRST | GMP_BIG_ENDIAN);
    }

    /**
     * Get the number as a signed integer encoded in two's complement binary.
     *
     * @return string
     */
    public function signedOctets(): string
    {
        switch (gmp_sign($this->_gmp)) {
            case 1:
                return $this->_signedPositiveOctets();
            case -1:
                return $this->_signedNegativeOctets();
        }
        // zero
        return chr(0);
    }

    /**
     * Encode positive integer in two's complement binary.
     *
     * @return string
     */
    private function _signedPositiveOctets(): string
    {
        $bin = gmp_export($this->_gmp, 1, GMP_MSW_FIRST | GMP_BIG_ENDIAN);
        // if first bit is 1, prepend full zero byte to represent positive two's complement
        if (ord($bin[0]) & 0x80) {
            $bin = chr(0x00) . $bin;
        }
        return $bin;
    }

    /**
     * Encode negative integer in two's complement binary.
     *
     * @return string
     */
    private function _signedNegativeOctets(): string
    {
        $num = gmp_abs($this->_gmp);
        // compute number of bytes required
        $width = 1;
        if ($num > 128) {
            $tmp = $num;
            do {
                ++$width;
                $tmp >>= 8;
            } while ($tmp > 128);
        }
        // compute two's complement 2^n - x
        $num = gmp_pow('2', 8 * $width) - $num;
        $bin = gmp_export($num, 1, GMP_MSW_FIRST | GMP_BIG_ENDIAN);
        // if first bit is 0, prepend full inverted byte to represent negative two's complement
        if (!(ord($bin[0]) & 0x80)) {
            $bin = chr(0xff) . $bin;
        }
        return $bin;
    }

    /**
     * Get the maximum integer value.
     *
     * @return \GMP
     */
    private function _intMaxGmp(): \GMP
    {
        static $gmp;
        if (!isset($gmp)) {
            $gmp = gmp_init(PHP_INT_MAX, 10);
        }
        return $gmp;
    }

    /**
     * Get the minimum integer value.
     *
     * @return \GMP
     */
    private function _intMinGmp(): \GMP
    {
        static $gmp;
        if (!isset($gmp)) {
            $gmp = gmp_init(PHP_INT_MIN, 10);
        }
        return $gmp;
    }
}

sop / asn1

GitHub Access Token became invalid

Push — master ( 6e6a53...7aa2fb )

BigInt::signedOctets() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
