Surfnet\Stepup\Configuration\InstitutionConfiguration

Complexity

Total Complexity

18

Size/Duplication

Total Lines	140
Duplicated Lines	17.14 %

Coupling/Cohesion

Components	1
Dependencies	13

Importance

Changes	3
Bugs	0	Features	2

12 Methods

Rating	Name	Duplication	Size	Complexity
A	create()	0	7	1
A	__construct()	0	3	1
B	changeRaLocation()	8	37	5
A	removeRaLocation()	8	13	2
A	getAggregateRootId()	0	4	1
A	applyInstitutionConfigurationCreatedEvent()	0	4	1
A	applyRaLocationAddedEvent()	0	4	1
A	applyRaLocationRenamedEvent()	0	4	1
A	applyRaLocationRelocatedEvent()	0	4	1
A	applyRaLocationContactInformationChangedEvent()	0	4	1
A	applyRaLocationRemovedEvent()	0	4	1
A	addRaLocation()	8	23	2

<?php

/**
 * Copyright 2016 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.
 */

namespace Surfnet\Stepup\Configuration;

use Broadway\EventSourcing\EventSourcedAggregateRoot;
use Surfnet\Stepup\Configuration\Api\InstitutionConfiguration as InstitutionConfigurationInterface;
use Surfnet\Stepup\Configuration\Event\InstitutionConfigurationCreatedEvent;
use Surfnet\Stepup\Configuration\Event\RaLocationAddedEvent;
use Surfnet\Stepup\Configuration\Event\RaLocationContactInformationChangedEvent;
use Surfnet\Stepup\Configuration\Event\RaLocationRelocatedEvent;
use Surfnet\Stepup\Configuration\Event\RaLocationRemovedEvent;
use Surfnet\Stepup\Configuration\Event\RaLocationRenamedEvent;
use Surfnet\Stepup\Configuration\Value\ContactInformation;
use Surfnet\Stepup\Configuration\Value\Institution;
use Surfnet\Stepup\Configuration\Value\InstitutionConfigurationId;
use Surfnet\Stepup\Configuration\Value\Location;
use Surfnet\Stepup\Configuration\Value\RaLocationId;
use Surfnet\Stepup\Configuration\Value\RaLocationList;
use Surfnet\Stepup\Configuration\Value\RaLocationName;
use Surfnet\Stepup\Exception\DomainException;

/**
 * @SuppressWarnings(PHPMD.CouplingBetweenObjects) Events and value objects
 */
class InstitutionConfiguration extends EventSourcedAggregateRoot implements InstitutionConfigurationInterface
{
    /**
     * @var InstitutionConfigurationId
     */
    private $institutionConfigurationId;

    /**
     * @var RaLocationList
     */
    private $raLocations;

    /**
     * @param InstitutionConfigurationId $institutionConfigurationId
     * @param Institution $institution
     * @return InstitutionConfiguration

Should the return type not be InstitutionConfiguration|null?

     */
    public static function create(InstitutionConfigurationId $institutionConfigurationId, Institution $institution)
    {
        $institutionConfiguration = new self;
        $institutionConfiguration->apply(
            new InstitutionConfigurationCreatedEvent($institutionConfigurationId, $institution)
        );
    }

    final private function __construct()

Instead of declaring the constructor as final, maybe you should declare the entire class as final.

    {
    }

    public function addRaLocation(
        RaLocationId $raLocationId,
        RaLocationName $raLocationName,
        Location $location,
        ContactInformation $contactInformation
    ) {
        if ($this->raLocations->containsWithId($raLocationId)) {

This code seems to be duplicated across your project.

            throw new DomainException(sprintf(
                'Cannot add RaLocation with RaLocationId "%s" to RaLocations of InstitutionConfiguration "%s":'
                . 'it is already present',
                $raLocationId,
                $this->getAggregateRootId()
            ));
        }

        $this->apply(new RaLocationAddedEvent(
            $this->institutionConfigurationId,
            $raLocationId,
            $raLocationName,
            $location,
            $contactInformation
        ));
    }

    public function changeRaLocation(
        RaLocationId $raLocationId,
        RaLocationName $raLocationName,
        Location $location,
        ContactInformation $contactInformation
    ) {
        if (!$this->raLocations->containsWithId($raLocationId)) {

This code seems to be duplicated across your project.

            throw new DomainException(sprintf(
                'Cannot change RaLocation with RaLocationId "%s" in RaLocations of InstitutionConfiguration "%s":'
                . 'it is not present',
                $raLocationId,
                $this->getAggregateRootId()
            ));
        }

        $raLocation = $this->raLocations->getById($raLocationId);

        if (!$raLocation->getLocationName()->equals($raLocationName)) {
            $this->apply(
                new RaLocationRenamedEvent($this->institutionConfigurationId, $raLocationId, $raLocationName)
            );
        }
        if (!$raLocation->getLocation()->equals($location)) {
            $this->apply(
                new RaLocationRelocatedEvent($this->institutionConfigurationId, $raLocationId, $location)
            );
        }
        if (!$raLocation->getContactInformation()->equals($contactInformation)) {
            $this->apply(
                new RaLocationContactInformationChangedEvent(
                    $this->institutionConfigurationId,
                    $raLocationId,
                    $contactInformation
                )
            );
        }
    }

    public function removeRaLocation(RaLocationId $raLocationId)
    {
        if (!$this->raLocations->containsWithId($raLocationId)) {

This code seems to be duplicated across your project.

            throw new DomainException(sprintf(
                'Cannot remove RaLocation with RaLocationId "%s" in RaLocations of InstitutionConfiguration "%s":'
                . 'it is not present',
                $raLocationId,
                $this->getAggregateRootId()
            ));
        }

        $this->apply(new RaLocationRemovedEvent($this->institutionConfigurationId, $raLocationId));
    }

    public function getAggregateRootId()
    {
        return $this->institutionConfigurationId;
    }

    public function applyInstitutionConfigurationCreatedEvent()
    {
        // Implement
    }

    public function applyRaLocationAddedEvent()
    {
        // Implement
    }

    public function applyRaLocationRenamedEvent()
    {
        // Implement
    }

    public function applyRaLocationRelocatedEvent()
    {
        // Implement
    }

    public function applyRaLocationContactInformationChangedEvent()
    {
        // Implement
    }

    public function applyRaLocationRemovedEvent()
    {
        // Implement
    }
}