EventSauce\EventSourcing\Message

Complexity

Total Complexity

11

Size/Duplication

Total Lines	85
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	header()	0	3	1
A	withHeader()	0	6	1
A	aggregateVersion()	0	9	2
A	__construct()	0	4	1
A	timeOfRecording()	0	6	1
A	event()	0	3	1
A	withTimeOfRecording()	0	3	1
A	headers()	0	3	1
A	aggregateRootId()	0	3	1
A	withHeaders()	0	6	1

<?php

declare(strict_types=1);

namespace EventSauce\EventSourcing;

use DateTimeImmutable;
use RuntimeException;

final class Message
{
    private const TIME_OF_RECORDING_FORMAT = 'Y-m-d H:i:s.uO';

    /**
     * @var object
     */
    private $event;

    /**
     * @var array
     */
    private $headers;

    public function __construct(object $event, array $headers = [])
    {
        $this->event = $event;
        $this->headers = $headers;
    }

    /**
     * @param mixed $value
     */
    public function withHeader(string $key, $value): Message
    {
        $clone = clone $this;
        $clone->headers[$key] = $value;

        return $clone;
    }

    public function withHeaders(array $headers): Message
    {
        $clone = clone $this;
        $clone->headers = $headers + $clone->headers;

        return $clone;
    }

    public function withTimeOfRecording(DateTimeImmutable $timeOfRecording): Message
    {
        return $this->withHeader(Header::TIME_OF_RECORDING, $timeOfRecording->format(self::TIME_OF_RECORDING_FORMAT));
    }

    public function aggregateVersion(): int
    {
        $version = $this->headers[Header::AGGREGATE_ROOT_VERSION] ?? null;

        if (null === $version) {
            throw new RuntimeException("Can't get the version if the message has none.");
        }

        return (int) $version;
    }

    public function aggregateRootId(): ?AggregateRootId
    {
        return $this->headers[Header::AGGREGATE_ROOT_ID] ?? null;
    }

    public function timeOfRecording(): DateTimeImmutable
    {
        /** @var DateTimeImmutable */
        return DateTimeImmutable::createFromFormat(

The expression return DateTimeImmutable::createFromFormat(self::TIME_OF_RECORDING_FORMAT, $this->headers[EventSauce\EventSourcing\Header::TIME_OF_RECORDING]) could return the type false which is incompatible with the type-hinted return DateTimeImmutable. Consider adding an additional type-check to rule them out.

            self::TIME_OF_RECORDING_FORMAT,
            $this->headers[Header::TIME_OF_RECORDING]
        );
    }

    /**
     * @return mixed|null
     */
    public function header(string $key)
    {
        return $this->headers[$key] ?? null;
    }

    public function headers(): array
    {
        return $this->headers;
    }

    public function event(): object
    {
        return $this->event;
    }
}