unreal4u\MQTT\Internals\WritableContent

Complexity

Total Complexity

11

Size/Duplication

Total Lines	144
Duplicated Lines	0 %

Test Coverage

Coverage

80%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getProtocolLevel()	0	8	2
A	createSendableMessage()	0	10	1
A	createFixedHeader()	0	13	1
A	getRemainingLength()	0	19	4
A	createUTF8String()	0	3	1
A	expectAnswer()	0	6	1
A	getControlPacketValue()	0	3	1

<?php

declare(strict_types=1);

namespace unreal4u\MQTT\Internals;

use Psr\Log\LoggerInterface;
use unreal4u\MQTT\Exceptions\MessageTooBig;
use unreal4u\MQTT\Utilities;

/**
 * Trait WritableContent
 * @package unreal4u\MQTT\Internals
 */
trait WritableContent
{
    /**
     * @var LoggerInterface
     */
    protected $logger;

    /**
     * Any special flags that are set on runtime
     *
     * PUBLISH for example needs to know QoS, the retain bit and duplicate delivery settings
     * PUBREL, SUBSCRIBE and UNSUBSCRIBE has always bit 1 set to true
     *
     * @var int
     */
    protected $specialFlags = 0;

    /**
     * The protocol version we are talking with. Currently only v3.1.1 is supported
     * @var string
     */
    public $protocolLevel = '3.1.1';

    /**
     * Returns the fixed header part needed for all methods
     *
     * This takes into account the basic control packet value, any special flags and, in the second byte, the variable
     * header length
     *
     * @param int $variableHeaderLength
     * @return string
     * @throws \unreal4u\MQTT\Exceptions\MessageTooBig
     */
    final public function createFixedHeader(int $variableHeaderLength): string
    {
        $this->logger->debug('Creating fixed header with values', [
            'controlPacketValue' => static::CONTROL_PACKET_VALUE,

The constant unreal4u\MQTT\Internals\WritableContent::CONTROL_PACKET_VALUE was not found. Maybe you did not declare it correctly or list all dependencies?

            'specialFlags' => $this->specialFlags,
            'variableHeaderLength' => $variableHeaderLength,
            'composed' => decbin(\chr((static::CONTROL_PACKET_VALUE << 4) | $this->specialFlags)),

chr(static::CONTROL_PACKET_VALUE << 4 | $this->specialFlags) of type string is incompatible with the type integer expected by parameter $number of decbin().

        ]);

        // Binary OR is safe to do because the first 4 bits are always 0 after shifting
        return
            \chr((static::CONTROL_PACKET_VALUE << 4) | $this->specialFlags) .
            $this->getRemainingLength($variableHeaderLength);
    }

    /**
     * Returns the correct format for the length in bytes of the remaining bytes
     *
     * @param int $lengthInBytes
     * @return string
     * @throws \unreal4u\MQTT\Exceptions\MessageTooBig
     */
    final public function getRemainingLength(int $lengthInBytes): string
    {
        if ($lengthInBytes > 268435455) {
            throw new MessageTooBig('The message cannot exceed 268435455 bytes in length');
        }

        $x = $lengthInBytes;
        $outputString = '';
        do {
            $encodedByte = $x % 128;
            $x >>= 7; // Shift 7 bytes
            // if there are more data to encode, set the top bit of this byte
            if ($x > 0) {
                $encodedByte |= 128;
            }
            $outputString .= \chr($encodedByte);
        } while ($x > 0);

        return $outputString;
    }

    /**
     * Creates the entire message
     * @return string
     * @throws \unreal4u\MQTT\Exceptions\MessageTooBig
     */
    final public function createSendableMessage(): string
    {
        $variableHeader = $this->createVariableHeader();

It seems like createVariableHeader() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $this->logger->debug('Creating variable header', ['variableHeader' => base64_encode($variableHeader)]);
        $payload = $this->createPayload();

It seems like createPayload() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $this->logger->debug('Creating payload', ['payload' => base64_encode($payload)]);
        $fixedHeader = $this->createFixedHeader(\strlen($variableHeader . $payload));
        $this->logger->debug('Created fixed header', ['fixedHeader' => base64_encode($fixedHeader)]);

        return $fixedHeader . $variableHeader . $payload;
    }

    /**
     * Gets the current protocol lvl bit
     * @return string
     */
    final public function getProtocolLevel(): string
    {
        if ($this->protocolLevel === '3.1.1') {
            return \chr(4);
        }

        // Return a default of 0, which will be invalid anyway (but data will be sent to the broker this way)
        return \chr(0);
    }

    /**
     * Creates a UTF8 big-endian representation of the given string
     *
     * @param string $data
     * @return string
     * @throws \OutOfRangeException
     */
    final public function createUTF8String(string $data): string
    {
        return Utilities::convertNumberToBinaryString(\strlen($data)) . $data;
    }

    /**
     * Will return an object of the type the broker has returned to us
     *
     * @param string $data
     * @param ClientInterface $client
     *
     * @return ReadableContentInterface
     * @throws \DomainException
     */
    public function expectAnswer(string $data, ClientInterface $client): ReadableContentInterface
    {
        $this->logger->info('String of incoming data confirmed, returning new object', ['callee' => \get_class($this)]);

        $eventManager = new EventManager($this->logger);
        return $eventManager->analyzeHeaders($data, $client);
    }

    /**
     * Gets the control packet value for this object
     *
     * @return int
     */
    final public static function getControlPacketValue(): int
    {
        return static::CONTROL_PACKET_VALUE;

The constant unreal4u\MQTT\Internals\WritableContent::CONTROL_PACKET_VALUE was not found. Maybe you did not declare it correctly or list all dependencies?

    }
}