unreal4u\MQTT\Internals\PacketIdentifier

Complexity

Total Complexity

7

Size/Duplication

Total Lines	65
Duplicated Lines	0 %

Test Coverage

Coverage

44.44%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	generateRandomPacketIdentifier()	0	15	2
A	getPacketIdentifier()	0	3	1
A	setPacketIdentifierFromRawHeaders()	0	7	1
A	setPacketIdentifier()	0	4	1
A	getPacketIdentifierBinaryRepresentation()	0	7	2

<?php

declare(strict_types=1);

namespace unreal4u\MQTT\Internals;

use unreal4u\MQTT\DataTypes\PacketIdentifier as PacketIdentifierDataType;
use unreal4u\MQTT\Utilities;

/**
 * Trait ReadableContent
 * @package unreal4u\MQTT\Internals
 */
trait PacketIdentifier
{
    /**
     * The packet identifier variable
     * @var PacketIdentifierDataType
     */
    private $packetIdentifier;

    final public function setPacketIdentifier(PacketIdentifierDataType $packetIdentifier): self
    {
        $this->packetIdentifier = $packetIdentifier;
        return $this;
    }

    final public function getPacketIdentifier(): int
    {
        return $this->packetIdentifier->getPacketIdentifierValue();
    }

    /**
     * Returns the binary representation of the packet identifier
     *
     * @return string
     * @throws \OutOfRangeException
     */
    final public function getPacketIdentifierBinaryRepresentation(): string
    {
        if ($this->packetIdentifier === null) {
            $this->generateRandomPacketIdentifier();
        }

        return Utilities::convertNumberToBinaryString($this->packetIdentifier->getPacketIdentifierValue());
    }

    /**
     * Sets the packet identifier straight from the raw MQTT headers
     *
     * @param string $rawMQTTHeaders
     * @return self
     * @throws \OutOfRangeException
     */
    final public function setPacketIdentifierFromRawHeaders(string $rawMQTTHeaders): self
    {
        $this->packetIdentifier = new PacketIdentifierDataType(Utilities::convertBinaryStringToNumber(
            $rawMQTTHeaders{2} . $rawMQTTHeaders{3})
        );

        return $this;
    }

    final public function generateRandomPacketIdentifier(): self
    {
        try {
            $this->packetIdentifier = new PacketIdentifierDataType(random_int(1, 65535));
        } catch (\Exception $e) {
            /*
             * Default to an older method, there should be no security issues here I believe.
             *
             * If I am mistaken, please contact me at https://t.me/unreal4u
             */
            /** @noinspection ExceptionsAnnotatingAndHandlingInspection */
            /** @noinspection RandomApiMigrationInspection */
            $this->packetIdentifier = new PacketIdentifierDataType(mt_rand(1, 65535));
        }
        return $this;
    }
}