Gears\Event\EventArrayCollection

Complexity

Total Complexity

14

Size/Duplication

Total Lines	110
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	current()	0	3	1
A	__construct()	0	12	4
A	valid()	0	3	1
A	key()	0	3	1
A	rewind()	0	3	1
A	__serialize()	0	3	1
A	next()	0	3	1
A	__wakeup()	0	3	1
A	__unserialize()	0	3	1
A	__sleep()	0	3	1
A	count()	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\Exception\InvalidEventException;

/**
 * @SuppressWarnings(PHPMD.TooManyPublicMethods)
 */
final class EventArrayCollection implements EventCollection
{
    /**
     * @var Event[]
     */
    private $events = [];

    /**
     * EventArrayCollection constructor.
     *
     * @param (Event|mixed)[] $events
     *
     * @throws InvalidEventException
     */
    public function __construct(array $events)
    {
        foreach ($events as $event) {
            if (!$event instanceof Event) {
                throw new InvalidEventException(\sprintf(
                    'Event collection only accepts "%s", "%s" given.',
                    Event::class,
                    \is_object($event) ? \get_class($event) : \gettype($event)
                ));
            }

            $this->events[] = $event;
        }
    }

    /**
     * {@inheritdoc}
     *
     * @return Event
     */
    public function current(): Event
    {
        return \current($this->events);
    }

    /**
     * {@inheritdoc}
     */
    public function next(): void
    {
        \next($this->events);
    }

    /**
     * {@inheritdoc}
     *
     * @return string|int|null
     */
    public function key()
    {
        return \key($this->events);
    }

    /**
     * {@inheritdoc}
     */
    public function valid(): bool
    {
        return \key($this->events) !== null;
    }

    /**
     * {@inheritdoc}
     */
    public function rewind(): void
    {
        \reset($this->events);
    }

    /**
     * {@inheritdoc}
     */
    public function count(): int
    {
        return \count($this->events);
    }

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

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

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

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