PhpDDD\Domain\Event\EventInterface

Size/Duplication

Total Lines	14
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
	setAggregateRootId()	0	1	?
	getAggregateRootId()	0	1	?

<?php

namespace PhpDDD\Domain\Event;

use PhpDDD\Domain\Exception\RuntimeException;

/**
 * Domain Events happen an Aggregate is modified.
 *
 * They are assumed be immutable objects that cannot change after instantiation.
 * Changing events can cause weird problems, so avoid this.
 */
interface EventInterface
{
    /**
     * @param mixed $aggregateRootId
     *
     * @throws RuntimeException When setting an aggregate id where one already exists.
     */
    public function setAggregateRootId($aggregateRootId);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

    /**
     * @return mixed
     */
    public function getAggregateRootId();
}