Gears\Event\AbstractEvent

Complexity

Total Complexity

10

Size/Duplication

Total Lines	96
Duplicated Lines	0 %

Importance

Changes	2
Bugs	1	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	getEventType()	0	3	1
A	__unserialize()	0	3	1
A	reconstitute()	0	9	2
A	__construct()	0	6	1
A	getAllowedInterfaces()	0	3	1
A	__wakeup()	0	3	1
A	occurred()	0	5	1
A	__serialize()	0	3	1
A	__sleep()	0	3	1

<?php

/*
 * event (https://github.com/phpgears/event).
 * Event handling.
 *
 * @license MIT
 * @link https://github.com/phpgears/event
 * @author Julián Gutiérrez <juliangut@gmail.com>
 */

declare(strict_types=1);

namespace Gears\Event;

use Gears\Event\Exception\EventException;
use Gears\Event\Time\SystemTimeProvider;
use Gears\Event\Time\TimeProvider;

/**
 * Abstract immutable event.
 */
abstract class AbstractEvent implements Event
{
    use EventBehaviour;

    /**
     * AbstractEvent constructor.
     *
     * @param array<string, mixed> $payload
     * @param \DateTimeImmutable   $createdAt
     */
    private function __construct(array $payload, \DateTimeImmutable $createdAt)
    {
        $this->assertImmutable();

        $this->setPayload($payload);
        $this->createdAt = $createdAt->setTimezone(new \DateTimeZone('UTC'));

It seems like $createdAt->setTimezone(new DateTimeZone('UTC')) can also be of type false. However, the property $createdAt is declared as type DateTimeImmutable. Maybe add an additional type check?

    }

    /**
     * {@inheritdoc}
     */
    public function getEventType(): string
    {
        return static::class;
    }

    /**
     * Instantiate new event.
     *
     * @param array<string, mixed> $payload
     * @param TimeProvider         $timeProvider
     *
     * @return mixed|self
     */
    final protected static function occurred(array $payload, ?TimeProvider $timeProvider = null)
    {
        $timeProvider = $timeProvider ?? new SystemTimeProvider();

        return new static($payload, $timeProvider->getCurrentTime());
    }

    /**
     * {@inheritdoc}
     *
     * @return mixed|self
     */
    public static function reconstitute(array $payload, \DateTimeImmutable $createdAt, array $attributes)
    {
        $event = new static($payload, $createdAt);

        if (isset($attributes['metadata'])) {
            $event->addMetadata($attributes['metadata']);
        }

        return $event;
    }

    /**
     * @return string[]
     */
    final public function __sleep(): array
    {
        throw new EventException(\sprintf('Event "%s" cannot be serialized.', static::class));
    }

    final public function __wakeup(): void
    {
        throw new EventException(\sprintf('Event "%s" cannot be unserialized.', static::class));
    }

    /**
     * @return array<string, mixed>
     */
    final public function __serialize(): array
    {
        throw new EventException(\sprintf('Event "%s" cannot be serialized.', static::class));
    }

    /**
     * @param array<string, mixed> $data
     *
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     */
    final public function __unserialize(array $data): void
    {
        throw new EventException(\sprintf('Event "%s" cannot be unserialized.', static::class));
    }

    /**
     * {@inheritdoc}
     *
     * @return string[]
     */
    final protected function getAllowedInterfaces(): array
    {
        return [Event::class];
    }
}