PacketIdentifier::getPacketIdentifierValue()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 1

Importance

Changes 1
Bugs 0 Features 0
Metric Value
eloc 1
c 1
b 0
f 0
dl 0
loc 3
ccs 2
cts 2
cp 1
rs 10
cc 1
nc 1
nop 0
crap 1
1
<?php
2
3
declare(strict_types=1);
4
5
namespace unreal4u\MQTT\DataTypes;
6
7
use unreal4u\MQTT\Utilities;
8
9
/**
10
 * This Value Object will always contain a valid Packet Identifier
11
 */
12
final class PacketIdentifier
13
{
14
    /**
15
     * This field indicates the level of assurance for delivery of an Application Message. Can be 0, 1 or 2
16
     *
17
     * 0: At most once delivery (default)
18
     * 1: At least once delivery
19
     * 2: Exactly once delivery
20
     *
21
     * @var int
22
     */
23
    private $packetIdentifier;
24
25
    /**
26
     * QoSLevel constructor.
27
     *
28
     * @param int $packetIdentifier
29
     * @throws \OutOfRangeException
30
     */
31 44
    public function __construct(int $packetIdentifier)
32
    {
33 44
        if ($packetIdentifier > 65535 || $packetIdentifier < 1) {
34 4
            throw new \OutOfRangeException(sprintf(
35 4
                'The provided packet identifier is invalid. Valid values are 1-65535 (Provided: %d)',
36
                $packetIdentifier
37
            ));
38
        }
39
40 40
        $this->packetIdentifier = $packetIdentifier;
41 40
    }
42
43
    /**
44
     * Gets the current packet identifier value
45
     *
46
     * @return int
47
     */
48 33
    public function getPacketIdentifierValue(): int
49
    {
50 33
        return $this->packetIdentifier;
51
    }
52
53 1
    public function __toString(): string
54
    {
55
        // Save to ignore this inspection here because this exception is already handled by the VO itself
56
        /** @noinspection MagicMethodsValidityInspection */
57 1
        return Utilities::convertNumberToBinaryString($this->packetIdentifier);
58
    }
59
}
60