Gears\Event\EventBehaviour

Complexity

Total Complexity

7

Size/Duplication

Total Lines	84
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getMetadata()	0	4	1
A	withMetadata()	0	8	1
A	setMetadata()	0	22	4
A	getCreatedAt()	0	4	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\DTO\Exception\InvalidScalarParameterException;
use Gears\DTO\ScalarPayloadBehaviour;
use Gears\Immutability\ImmutabilityBehaviour;

use function DeepCopy\deep_copy;

/**
 * Event metadata behaviour.
 */
trait EventBehaviour
{
    use ImmutabilityBehaviour, ScalarPayloadBehaviour {
        ScalarPayloadBehaviour::__call insteadof ImmutabilityBehaviour;
    }

    /**
     * Event metadata.
     *
     * @var array<string, mixed>
     */
    private $metadata = [];

    /**
     * @var \DateTimeImmutable
     */
    private $createdAt;

    /**
     * Get event metadata.
     *
     * @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)

     */
    final public function getMetadata(): array
    {
        return $this->metadata;
    }

    /**
     * Get event with new metadata.
     *
     * @param array<string, mixed> $metadata
     *
     * @return mixed|self

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

     */
    final public function withMetadata(array $metadata)
    {
        /* @var self $self */
        $self = deep_copy($this);
        $self->setMetadata($metadata);

        return $self;
    }

    /**
     * Set event metadata.
     *
     * @param array<string, mixed> $parameters
     *
     * @throws InvalidScalarParameterException
     */
    private function setMetadata(array $parameters): void
    {
        $this->metadata = [];

        foreach ($parameters as $parameter => $value) {
            try {
                $this->checkParameterType($value);
            } catch (InvalidScalarParameterException $exception) {
                throw new InvalidScalarParameterException(
                    \sprintf(
                        'Class %s can only accept scalar metadata parameters, %s given',
                        self::class,
                        \is_object($value) ? \get_class($value) : \gettype($value)
                    ),
                    $exception->getCode(),
                    $exception
                );
            }

            $this->metadata[$parameter] = $value;
        }
    }

    /**
     * Get event creation time.
     *
     * @return \DateTimeImmutable
     */
    final public function getCreatedAt(): \DateTimeImmutable
    {
        return $this->createdAt;
    }
}