SmoothPhp\Contracts\EventStore\EventStore

Size/Duplication

Total Lines	34
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
	append()	0	1	?
	getEventCountByTypes()	0	1	?
	load()	0	1	?
	getEventsByType()	0	1	?
	deleteStream()	0	1	?

<?php
declare(strict_types=1);

namespace SmoothPhp\Contracts\EventStore;

use SmoothPhp\Contracts\Domain\DomainEventStream;
use SmoothPhp\EventStore\EventStreamNotFound;

/**
 * Interface EventStore
 * @package SmoothPhp\EventStore
 * @author Simon Bennett <simon@bennett.im>
 */
interface EventStore
{
    /**
     * @param string $id
     * @return DomainEventStream
     * @throws EventStreamNotFound
     */
    public function load(string $id) : DomainEventStream;

    /**
     * @param mixed $id
     * @param DomainEventStream $eventStream
     * @return void
     */
    public function append(string $id, DomainEventStream $eventStream) : void;

    /**
     * @param string[] $eventTypes
     * @return int
     */
    public function getEventCountByTypes(array $eventTypes) : int;

    /**
     * @param string[] $eventTypes
     * @param int $take
     * @return \Generator
     */
    public function getEventsByType(array $eventTypes, int $take) : \Generator;

    /**
     * @param string $streamId
     */
    public function deleteStream(string $streamId) : void;
}