BenGorUser\User\Domain\Model\UserAggregateRoot

Complexity

Total Complexity

4

Size/Duplication

Total Lines	53
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	2
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	eraseEvents()	0	4	1
A	events()	0	4	1
A	publish()	0	4	1
A	record()	0	4	1

<?php

/*
 * This file is part of the BenGorUser package.
 *
 * (c) Beñat Espiña <benatespina@gmail.com>
 * (c) Gorka Laucirica <gorka.lauzirika@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace BenGorUser\User\Domain\Model;

use BenGorUser\User\Domain\Model\Event\UserEvent;

/**
 * User aggregate root class.
 *
 * @author Beñat Espiña <benatespina@gmail.com>
 */
abstract class UserAggregateRoot
{
    /**
     * Array which contains the domain events.
     *
     * @var array
     */
    private $events = [];

    /**
     * Clears the events container.
     */
    public function eraseEvents()
    {
        $this->events = [];
    }

    /**
     * Gets the recorded domain events.
     *
     * @return array
     */
    public function events()
    {
        return $this->events;
    }

    /**
     * Publishes the domain event.
     *
     * If the solution needs a singleton based event system,
     * this methods will be overwritten.
     *
     * The recommend way is to record events domains in the aggregate root
     * so, by default, this method calls to the "record" method.
     *
     * @param UserEvent $anEvent The domain event
     */
    protected function publish(UserEvent $anEvent)
    {
        $this->record($anEvent);
    }

    /**
     * Saves the given domain event inside event container.
     *
     * @param UserEvent $anEvent The domain event
     */
    private function record(UserEvent $anEvent)
    {
        $this->events[] = $anEvent;
    }
}