Surfnet\StepupMiddleware\MiddlewareBundle\EventSourcing\EventCollection

Complexity

Total Complexity

12

Size/Duplication

Total Lines	77
Duplicated Lines	0 %

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	select()	0	14	2
A	contains()	0	3	1
A	getIterator()	0	3	1
A	getEventNames()	0	3	1
A	formatAsEventStreamTypes()	0	5	1
A	__construct()	0	17	6

<?php

/**
 * Copyright 2017 SURFnet B.V.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

Missing @link tag in file comment

namespace Surfnet\StepupMiddleware\MiddlewareBundle\EventSourcing;

use ArrayIterator;
use Iterator;
use IteratorAggregate;
use Surfnet\StepupMiddleware\MiddlewareBundle\Exception\InvalidArgumentException;

/**
 * @implements IteratorAggregate<int, string>
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

final class EventCollection implements IteratorAggregate
{
    /**
     * @var string[]
     */
    private array $eventNames = [];

    /**
     * @param string[] $eventNames
     */
    public function __construct(array $eventNames)
    {
        foreach ($eventNames as $eventName) {
            if (!is_string($eventName) || ($eventName === '' || $eventName === '0')) {
                throw InvalidArgumentException::invalidType('non-empty string', 'eventName', $eventName);
            }

            if (!class_exists($eventName)) {
                throw new InvalidArgumentException(
                    sprintf(
                        'Cannot create EventCollection: class "%s" does not exist',
                        $eventName,
                    ),
                );
            }

            $this->eventNames[] = $eventName;
        }
    }

    /**
     * @return string[]
     */
    public function getEventNames(): array
    {
        return $this->eventNames;
    }

    /**
     * @return string[]
     */
    public function formatAsEventStreamTypes(): array
    {
        return array_map(
            fn($eventName): string => strtr($eventName, '\\', '.'),
            $this->eventNames,
        );
    }

    public function select(array $subset): self
    {
        $nonAvailableEventNames = array_diff($subset, $this->eventNames);

        if ($nonAvailableEventNames !== []) {
            throw new InvalidArgumentException(
                sprintf(
                    'Subset of event names contains event names not present in collection: %s',
                    implode(', ', $nonAvailableEventNames),
                ),
            );
        }

        return new self($subset);
    }


    public function contains(string $eventName): bool
    {
        return in_array($eventName, $this->eventNames);
    }

    /**
     * @return Iterator<int, string>
     */
    public function getIterator(): Iterator
    {
        return new ArrayIterator($this->eventNames);
    }
}