DaveRandom\LibLifxLan\Decoding\PacketDecoder

Complexity

Total Complexity

7

Size/Duplication

Total Lines	75
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	decodePacket()	0	13	1
A	getHeaderDecoder()	0	3	1
A	getValidDataLength()	0	19	3
A	__construct()	0	4	1
A	getMessageDecoder()	0	3	1

<?php declare(strict_types=1);

namespace DaveRandom\LibLifxLan\Decoding;

use DaveRandom\LibLifxLan\Decoding\Exceptions\DecodingException;
use DaveRandom\LibLifxLan\Decoding\Exceptions\InsufficientDataException;
use DaveRandom\LibLifxLan\Decoding\Exceptions\InvalidMessagePayloadLengthException;
use DaveRandom\LibLifxLan\Header\Header;
use DaveRandom\LibLifxLan\Packet;

final class PacketDecoder
{
    private const HEADER_OFFSET = 0;
    private const MESSAGE_OFFSET = Header::WIRE_SIZE;

    private $headerDecoder;
    private $messageDecoder;

    /**
     * @param string $buffer
     * @param int $offset
     * @param int $length
     * @return int
     * @throws InsufficientDataException
     * @throws InvalidMessagePayloadLengthException
     */
    private function getValidDataLength(string $buffer, int $offset, int $length): int
    {
        $dataLength = $length ?? (\strlen($buffer) - $offset);

        if ($dataLength < Header::WIRE_SIZE) {
            throw new InsufficientDataException(
                "Data length {$dataLength} less than minimum packet size " . Header::WIRE_SIZE
            );
        }

        $statedLength = \unpack('vlength', $buffer, $offset)['length'];

        if ($statedLength !== $dataLength) {
            throw new InvalidMessagePayloadLengthException(
                "Packet length is stated to be {$statedLength} bytes, buffer is {$dataLength} bytes"
            );
        }

        return $statedLength;
    }

    public function __construct(HeaderDecoder $headerDecoder = null, MessageDecoder $messageDecoder = null)
    {
        $this->headerDecoder = $headerDecoder ?? new HeaderDecoder;
        $this->messageDecoder = $messageDecoder ?? new MessageDecoder;
    }

    public function getHeaderDecoder(): HeaderDecoder
    {
        return $this->headerDecoder;
    }

    public function getMessageDecoder(): MessageDecoder
    {
        return $this->messageDecoder;
    }

    /**
     * @param string $buffer
     * @param int $offset
     * @param int|null $length
     * @return Packet
     * @throws DecodingException
     * @throws InsufficientDataException
     * @throws InvalidMessagePayloadLengthException
     */
    public function decodePacket(string $buffer, int $offset = 0, int $length = null): Packet
    {
        $dataLength = $this->getValidDataLength($buffer, $offset, $length);

It seems like $length can also be of type null; however, parameter $length of DaveRandom\LibLifxLan\Decoding\PacketDecoder::getValidDataLength() does only seem to accept integer, maybe add an additional type check?

        $header = $this->headerDecoder->decodeHeader($buffer, $offset + self::HEADER_OFFSET);
        $payload = $this->messageDecoder->decodeMessage(
            $header->getProtocolHeader()->getType(),
            $buffer,
            $offset + self::MESSAGE_OFFSET,
            $dataLength - Header::WIRE_SIZE
        );

        return new Packet($header, $payload);
    }
}