predaddy\domain\AbstractDomainEvent

Complexity

Total Complexity

6

Size/Duplication

Total Lines	56
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes	11
Bugs	1	Features	1

5 Methods

Rating	Name	Duplication	Size	Complexity
A	initEvent()	0	6	1
A	__construct()	0	8	2
A	aggregateId()	0	4	1
A	toStringHelper()	0	6	1
A	setAggregateId()	0	5	1

<?php
/*
 * Copyright (c) 2013 Janos Szurovecz
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
 * of the Software, and to permit persons to whom the Software is furnished to do
 * so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

namespace predaddy\domain;

use predaddy\messagehandling\AbstractMessage;

/**
 * Base class for all Domain Events.
 * This class contains the basic behavior expected from any event
 * to be processed by event sourcing engines and aggregates.
 *
 * @author Janos Szurovecz <szjani@szjani.hu>
 */
abstract class AbstractDomainEvent extends AbstractMessage implements DomainEvent
{
    use StateHashTrait;

    protected $aggregateClass;
    protected $aggregateValue;

    /**
     * @param AbstractDomainEvent $event
     * @param AggregateId $aggregateId
     * @param $stateHash
     * @return AbstractDomainEvent
     */
    public static function initEvent(AbstractDomainEvent $event, AggregateId $aggregateId, $stateHash)
    {
        $event->setAggregateId($aggregateId);
        $event->stateHash = $stateHash;
        return $event;
    }

    /**
     * @param AggregateId|null $aggregateId
     */
    public function __construct(AggregateId $aggregateId = null)
    {
        parent::__construct();
        if ($aggregateId === null) {
            $aggregateId = NullAggregateId::instance();
        }
        $this->setAggregateId($aggregateId);
    }

    /**
     * @return GenericAggregateId
     */
    public function aggregateId()
    {
        return new GenericAggregateId($this->aggregateValue, $this->aggregateClass);
    }

    protected function toStringHelper()
    {
        return parent::toStringHelper()
            ->add($this->aggregateId())
            ->add('stateHash', $this->stateHash());
    }

    /**
     * @param AggregateId $aggregateId
     */
    private function setAggregateId(AggregateId $aggregateId)
    {
        $this->aggregateClass = $aggregateId->aggregateClass();
        $this->aggregateValue = $aggregateId->value();
    }
}