unreal4u\MQTT\Internals\ReadableContent

Complexity

Total Complexity

6

Size/Duplication

Total Lines	70
Duplicated Lines	0 %

Test Coverage

Coverage

76.47%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	instantiateObject()	0	7	1
A	checkControlPacketValue()	0	12	2
A	performSpecialActions()	0	3	1
A	fillObject()	0	3	1
A	extractPacketIdentifier()	0	3	1

<?php

declare(strict_types=1);

namespace unreal4u\MQTT\Internals;

use unreal4u\MQTT\Exceptions\InvalidResponseType;
use unreal4u\MQTT\Utilities;

/**
 * Trait ReadableContent
 * @package unreal4u\MQTT\Internals
 */
trait ReadableContent
{
    /**
     * Length of variable header
     * @var int
     */
    protected $variableHeaderSize = 0;

    final public function instantiateObject(string $rawMQTTHeaders, ClientInterface $client): bool
    {
        //var_dump(base64_encode($rawMQTTHeaders)); // For now: make it a bit easier to create unit tests
        $this->checkControlPacketValue(\ord($rawMQTTHeaders[0]) >> 4);
        $this->fillObject($rawMQTTHeaders, $client);

        return true;
    }

    /**
     * Checks whether the control packet corresponds to this object
     *
     * @param int $controlPacketValue
     * @return bool
     * @throws \unreal4u\MQTT\Exceptions\InvalidResponseType
     */
    private function checkControlPacketValue(int $controlPacketValue): bool
    {
        // Check whether the first byte corresponds to the expected control packet value
        if (static::CONTROL_PACKET_VALUE !== $controlPacketValue) {

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

            throw new InvalidResponseType(sprintf(
                'Value of received value does not correspond to response (Expected: %d, Actual: %d)',
                static::CONTROL_PACKET_VALUE,
                $controlPacketValue
            ));
        }

        return true;
    }

    /**
     * Extracts the packet identifier from the raw headers
     *
     * @param string $rawMQTTHeaders
     * @return int
     * @throws \OutOfRangeException
     */
    private function extractPacketIdentifier(string $rawMQTTHeaders): int
    {
        return Utilities::convertBinaryStringToNumber($rawMQTTHeaders{2} . $rawMQTTHeaders{3});
    }

    /**
     * Any class can overwrite the default behaviour (which is do nothing)
     * @param string $rawMQTTHeaders
     * @param ClientInterface $client
     * @return ReadableContentInterface
     */
    public function fillObject(string $rawMQTTHeaders, ClientInterface $client): ReadableContentInterface

The parameter $client is not used and could be removed.

The parameter $rawMQTTHeaders is not used and could be removed.

    {
        return $this;

The expression return $this returns the type unreal4u\MQTT\Internals\ReadableContent which is incompatible with the type-hinted return unreal4u\MQTT\Internals\ReadableContentInterface.

    }

    /**
     * Any class can overwrite the default behaviour
     * @param ClientInterface $client
     * @param WritableContentInterface $originalRequest
     * @return bool
     */
    public function performSpecialActions(ClientInterface $client, WritableContentInterface $originalRequest): bool

The parameter $client is not used and could be removed.

The parameter $originalRequest is not used and could be removed.

    {
        return false;
    }
}