Gears\Event\Async\ReceivedEvent

Complexity

Total Complexity

9

Size/Duplication

Total Lines	105
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getOriginalEvent()	0	4	1
A	has()	0	4	1
A	get()	0	4	1
A	getPayload()	0	4	1
A	getMetadata()	0	4	1
A	withMetadata()	0	4	1
A	getCreatedAt()	0	4	1
A	reconstitute()	0	4	1

<?php

/*
 * event-async (https://github.com/phpgears/event-async).
 * Async decorator for Event bus.
 *
 * @license MIT
 * @link https://github.com/phpgears/event-async
 * @author Julián Gutiérrez <juliangut@gmail.com>
 */

declare(strict_types=1);

namespace Gears\Event\Async;

use Gears\Event\Async\Exception\ReceivedEventException;
use Gears\Event\Event;

final class ReceivedEvent implements Event
{
    /**
     * @var Event
     */
    private $originalEvent;

    /**
     * ReceivedEvent constructor.
     *
     * @param Event $originalEvent
     */
    public function __construct(Event $originalEvent)
    {
        $this->originalEvent = $originalEvent;
    }

    /**
     * Get original event.
     *
     * @return Event
     */
    public function getOriginalEvent(): Event
    {
        return $this->originalEvent;
    }

    /**
     * {@inheritdoc}
     *
     * @throws ReceivedEventException
     */
    public function has(string $parameter): bool
    {
        throw new ReceivedEventException(\sprintf('Method %s should not be called ', __METHOD__));
    }

    /**
     * {@inheritdoc}
     *
     * @throws ReceivedEventException
     *
     * @return mixed

Consider making the return type a bit more specific; maybe use NoType.

     */
    public function get(string $parameter)
    {
        throw new ReceivedEventException(\sprintf('Method %s should not be called ', __METHOD__));
    }

    /**
     * {@inheritdoc}
     *
     * @throws ReceivedEventException
     *
     * @return array<string, mixed>

The doc-type array<string, could not be parsed: Expected ">" at position 5, but found "end of type". (view supported doc-types)

     */
    public function getPayload(): array
    {
        throw new ReceivedEventException(\sprintf('Method %s should not be called ', __METHOD__));
    }

    /**
     * {@inheritdoc}
     *
     * @throws ReceivedEventException
     *
     * @return array<string, mixed>

The doc-type array<string, could not be parsed: Expected ">" at position 5, but found "end of type". (view supported doc-types)

     */
    public function getMetadata(): array
    {
        throw new ReceivedEventException(\sprintf('Method %s should not be called ', __METHOD__));
    }

    /**
     * {@inheritdoc}
     *
     * @throws ReceivedEventException
     *
     * @return array<string, mixed>

The doc-type array<string, could not be parsed: Expected ">" at position 5, but found "end of type". (view supported doc-types)

     */
    public function withMetadata(array $metadata)
    {
        throw new ReceivedEventException(\sprintf('Method %s should not be called ', __METHOD__));
    }

    /**
     * {@inheritdoc}
     *
     * @throws ReceivedEventException
     */
    public function getCreatedAt(): \DateTimeImmutable
    {
        throw new ReceivedEventException(\sprintf('Method %s should not be called ', __METHOD__));
    }

    /**
     * {@inheritdoc}
     *
     * @throws ReceivedEventException
     */
    public static function reconstitute(array $payload, array $attributes = []): void
    {
        throw new ReceivedEventException(\sprintf('Method %s should not be called ', __METHOD__));
    }
}