Buffer::__construct() - Code Metrics - Inspection of "Merge pull request #39 from afk11/add-buffer-getGm..." - Bit-Wasp/buffertools-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c0420c...edd451 )

by thomas

created 2016-06-17 00:51 UTC

Buffer::__construct() A

↳ Parent: Buffer

Complexity

Conditions	4
Paths	6

Size

Total Lines	15
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes	4
Bugs	1	Features	1

Metric	Value
c	4
b	1
f	1
dl	0
loc	15
rs	9.2
cc	4
eloc	9
nc	6
nop	3

<?php

namespace BitWasp\Buffertools;

use Mdanter\Ecc\EccFactory;
use Mdanter\Ecc\Math\GmpMathInterface;

class Buffer implements BufferInterface
{
    /**
     * @var int
     */
    protected $size;

    /**
     * @var string
     */
    protected $buffer;

    /**
     * @var GmpMathInterface
     */
    protected $math;

    /**
     * @param string               $byteString
     * @param null|integer         $byteSize
     * @param GmpMathInterface     $math
     * @throws \Exception
     */
    public function __construct($byteString = '', $byteSize = null, GmpMathInterface $math = null)
    {
        $this->math = $math ?: EccFactory::getAdapter();
        if ($byteSize !== null) {
            // Check the integer doesn't overflow its supposed size
            if (strlen($byteString) > $byteSize) {
                throw new \Exception('Byte string exceeds maximum size');
            }
        } else {
            $byteSize = strlen($byteString);
        }

        $this->size   = $byteSize;
        $this->buffer = $byteString;
    }

    /**
     * Create a new buffer from a hex string
     *
     * @param string $hexString
     * @param integer $byteSize
     * @param GmpMathInterface $math
     * @return Buffer
     * @throws \Exception
     */
    public static function hex($hexString = '', $byteSize = null, GmpMathInterface $math = null)
    {
        if (strlen($hexString) > 0 && !ctype_xdigit($hexString)) {
            throw new \InvalidArgumentException('BufferHex: non-hex character passed: ' . $hexString);
        }

        $math = $math ?: EccFactory::getAdapter();
        $binary = pack("H*", $hexString);
        return new self($binary, $byteSize, $math);
    }

    /**
     * @param int|string $integer
     * @param null|int $byteSize
     * @param GmpMathInterface|null $math
     * @return Buffer
     */
    public static function int($integer, $byteSize = null, GmpMathInterface $math = null)
    {
        $math = $math ?: EccFactory::getAdapter();
        $binary = pack("H*", $math->decHex($integer));
        return new self($binary, $byteSize, $math);
    }

    /**
     * @param integer      $start
     * @param integer|null $end
     * @return Buffer
     * @throws \Exception
     */
    public function slice($start, $end = null)
    {
        if ($start > $this->getSize()) {
            throw new \Exception('Start exceeds buffer length');
        }

        if ($end === null) {
            return new self(substr($this->getBinary(), $start));
        }

        if ($end > $this->getSize()) {
            throw new \Exception('Length exceeds buffer length');
        }

        $string = substr($this->getBinary(), $start, $end);
        $length = strlen($string);
        return new self($string, $length, $this->math);
    }

    /**
     * Get the size of the buffer to be returned
     *
     * @return int
     */
    public function getSize()
    {
        return $this->size;
    }

    /**
     * Get the size of the value stored in the buffer
     *
     * @return int
     */
    public function getInternalSize()
    {
        return strlen($this->buffer);
    }

    /**
     * @return string
     */
    public function getBinary()
    {
        // if a size is specified we'll make sure the value returned is that size
        if ($this->size !== null) {
            if (strlen($this->buffer) < $this->size) {
                return str_pad($this->buffer, $this->size, chr(0), STR_PAD_LEFT);
            } elseif (strlen($this->buffer) > $this->size) {
                return substr($this->buffer, 0, $this->size);
            }
        }

        return $this->buffer;
    }

    /**
     * @return string
     */
    public function getHex()
    {
        return bin2hex($this->getBinary());
    }

    /**
     * @return \GMP
     */
    public function getGmp()
    {
        $gmp = gmp_init($this->getHex(), 16);
        return $gmp;
class Author {
    private $name;

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

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * @return int|string
     */
    public function getInt()
    {
        return gmp_strval($this->getGmp(), 10);
    }

    /**
     * @return Buffer
     */
    public function flip()
    {
        return Buffertools::flipBytes($this);

    }

    /**
     * @param BufferInterface $other
     * @return bool
     */
    public function equals(BufferInterface $other)
    {
        return ($other->getSize() === $this->getSize()
             && $other->getBinary() === $this->getBinary());
    }
}


1			<?php
2
3			namespace BitWasp\Buffertools;
4
5			use Mdanter\Ecc\EccFactory;
6			use Mdanter\Ecc\Math\GmpMathInterface;
7
8			class Buffer implements BufferInterface
9			{
10			/**
11			* @var int
12			*/
13			protected $size;
14
15			/**
16			* @var string
17			*/
18			protected $buffer;
19
20			/**
21			* @var GmpMathInterface
22			*/
23			protected $math;
24
25			/**
26			* @param string $byteString
27			* @param null\|integer $byteSize
28			* @param GmpMathInterface $math
29			* @throws \Exception
30			*/
31			public function __construct($byteString = '', $byteSize = null, GmpMathInterface $math = null)
32			{
33			$this->math = $math ?: EccFactory::getAdapter();
34			if ($byteSize !== null) {
35			// Check the integer doesn't overflow its supposed size
36			if (strlen($byteString) > $byteSize) {
37			throw new \Exception('Byte string exceeds maximum size');
38			}
39			} else {
40			$byteSize = strlen($byteString);
41			}
42
43			$this->size = $byteSize;
44			$this->buffer = $byteString;
45			}
46
47			/**
48			* Create a new buffer from a hex string
49			*
50			* @param string $hexString
51			* @param integer $byteSize
52			* @param GmpMathInterface $math
53			* @return Buffer
54			* @throws \Exception
55			*/
56			public static function hex($hexString = '', $byteSize = null, GmpMathInterface $math = null)
57			{
58			if (strlen($hexString) > 0 && !ctype_xdigit($hexString)) {
59			throw new \InvalidArgumentException('BufferHex: non-hex character passed: ' . $hexString);
60			}
61
62			$math = $math ?: EccFactory::getAdapter();
63			$binary = pack("H*", $hexString);
64			return new self($binary, $byteSize, $math);
65			}
66
67			/**
68			* @param int\|string $integer
69			* @param null\|int $byteSize
70			* @param GmpMathInterface\|null $math
71			* @return Buffer
72			*/
73			public static function int($integer, $byteSize = null, GmpMathInterface $math = null)
74			{
75			$math = $math ?: EccFactory::getAdapter();
76			$binary = pack("H*", $math->decHex($integer));
77			return new self($binary, $byteSize, $math);
78			}
79
80			/**
81			* @param integer $start
82			* @param integer\|null $end
83			* @return Buffer
84			* @throws \Exception
85			*/
86			public function slice($start, $end = null)
87			{
88			if ($start > $this->getSize()) {
89			throw new \Exception('Start exceeds buffer length');
90			}
91
92			if ($end === null) {
93			return new self(substr($this->getBinary(), $start));
94			}
95
96			if ($end > $this->getSize()) {
97			throw new \Exception('Length exceeds buffer length');
98			}
99
100			$string = substr($this->getBinary(), $start, $end);
101			$length = strlen($string);
102			return new self($string, $length, $this->math);
103			}
104
105			/**
106			* Get the size of the buffer to be returned
107			*
108			* @return int
109			*/
110			public function getSize()
111			{
112			return $this->size;
113			}
114
115			/**
116			* Get the size of the value stored in the buffer
117			*
118			* @return int
119			*/
120			public function getInternalSize()
121			{
122			return strlen($this->buffer);
123			}
124
125			/**
126			* @return string
127			*/
128			public function getBinary()
129			{
130			// if a size is specified we'll make sure the value returned is that size
131			if ($this->size !== null) {
132			if (strlen($this->buffer) < $this->size) {
133			return str_pad($this->buffer, $this->size, chr(0), STR_PAD_LEFT);
134			} elseif (strlen($this->buffer) > $this->size) {
135			return substr($this->buffer, 0, $this->size);
136			}
137			}
138
139			return $this->buffer;
140			}
141
142			/**
143			* @return string
144			*/
145			public function getHex()
146			{
147			return bin2hex($this->getBinary());
148			}
149
150			/**
151			* @return \GMP
152			*/
153			public function getGmp()
154			{
155			$gmp = gmp_init($this->getHex(), 16);
156			return $gmp;
			0 ignored issues – show Bug Best Practice introduced 2016-06-17 01:15 UTC by Report Bug Copy Issue Report The return type of `return $gmp;` (`resource`) is incompatible with the return type declared by the interface `BitWasp\Buffertools\BufferInterface::getGmp` of type `GMP`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
157			}
158
159			/**
160			* @return int\|string
161			*/
162			public function getInt()
163			{
164			return gmp_strval($this->getGmp(), 10);
165			}
166
167			/**
168			* @return Buffer
169			*/
170			public function flip()
171			{
172			return Buffertools::flipBytes($this);
			0 ignored issues – show Bug Compatibility introduced 2016-02-04 16:20 UTC by Report Bug Copy Issue Report The expression `\BitWasp\Buffertools\Buf...ools::flipBytes($this);` of type `BitWasp\Buffertools\Buffer\|string` adds the type `string` to the return on line 172 which is incompatible with the return type declared by the interface `BitWasp\Buffertools\BufferInterface::flip` of type `BitWasp\Buffertools\Buffer`. Loading history...
173			}
174
175			/**
176			* @param BufferInterface $other
177			* @return bool
178			*/
179			public function equals(BufferInterface $other)
180			{
181			return ($other->getSize() === $this->getSize()
182			&& $other->getBinary() === $this->getBinary());
183			}
184			}
185

Bit-Wasp / buffertools-php

Push — master ( c0420c...edd451 )

Buffer::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like