Place - Code Metrics - Inspection of "III-2498 Prevent unnecessary aggregates updates." - cultuurnet/udb3-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#342)

by Luc

created 2018-03-09 13:35 UTC

Place F

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	517
Duplicated Lines	14.12 %

Coupling/Cohesion

Components	1
Dependencies	44

Importance

Changes

Metric	Value
wmc	48
lcom	1
cbo	44
dl	73
loc	517
rs	3.2371
c	0
b	0
f	0

44 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	getAggregateRootId()	0	4	1
B	createPlace()	24	24	1
A	applyPlaceCreated()	0	7	1
A	updateMajorInfo()	0	18	1
A	applyMajorInfoUpdated()	0	4	1
A	updateAddress()	0	12	3
A	applyAddressUpdated()	0	4	1
A	applyAddressTranslated()	0	4	1
A	allowAddressUpdate()	0	14	3
A	importFromUDB2Actor()	0	16	1
B	applyPlaceImportedFromUDB2()	25	25	1
B	applyPlaceUpdatedFromUDB2()	24	24	1
A	updateWithCdbXml()	0	12	1
A	createLabelAddedEvent()	0	4	1
A	createLabelRemovedEvent()	0	4	1
A	createImageAddedEvent()	0	4	1
A	createImageRemovedEvent()	0	4	1
A	createImageUpdatedEvent()	0	10	1
A	createMainImageSelectedEvent()	0	4	1
A	createTitleTranslatedEvent()	0	4	1
A	createTitleUpdatedEvent()	0	4	1
A	createDescriptionTranslatedEvent()	0	4	1
A	createDescriptionUpdatedEvent()	0	4	1
A	createCalendarUpdatedEvent()	0	4	1
A	createTypicalAgeRangeUpdatedEvent()	0	4	1
A	createTypicalAgeRangeDeletedEvent()	0	4	1
A	createOrganizerUpdatedEvent()	0	4	1
A	createOrganizerDeletedEvent()	0	4	1
A	createContactPointUpdatedEvent()	0	4	1
A	createGeoCoordinatesUpdatedEvent()	0	4	1
A	createBookingInfoUpdatedEvent()	0	4	1
A	createPriceInfoUpdatedEvent()	0	4	1
A	createOfferDeletedEvent()	0	4	1
A	createPublishedEvent()	0	4	1
A	createApprovedEvent()	0	4	1
A	createRejectedEvent()	0	4	1
A	createFlaggedAsDuplicate()	0	4	1
A	createFlaggedAsInappropriate()	0	4	1
A	createImagesImportedFromUDB2()	0	4	1
A	createImagesUpdatedFromUDB2()	0	4	1
A	createTypeUpdatedEvent()	0	4	1
A	createThemeUpdatedEvent()	0	4	1
A	createFacilitiesUpdatedEvent()	0	4	1

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like Place often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use Place, and based on these observations, apply Extract Interface, too.

<?php

namespace CultuurNet\UDB3\Place;

use CultuurNet\Geocoding\Coordinate\Coordinates;
use CultuurNet\UDB3\Address\Address;
use CultuurNet\UDB3\BookingInfo;
use CultuurNet\UDB3\Calendar;
use CultuurNet\UDB3\CalendarInterface;
use CultuurNet\UDB3\Cdb\ActorItemFactory;
use CultuurNet\UDB3\Cdb\UpdateableWithCdbXmlInterface;
use CultuurNet\UDB3\ContactPoint;
use CultuurNet\UDB3\Event\EventType;
use CultuurNet\UDB3\Label;
use CultuurNet\UDB3\LabelCollection;
use CultuurNet\UDB3\Media\ImageCollection;
use CultuurNet\UDB3\Offer\Commands\Image\AbstractUpdateImage;
use CultuurNet\UDB3\Language;
use CultuurNet\UDB3\Offer\Offer;
use CultuurNet\UDB3\Media\Image;
use CultuurNet\UDB3\Offer\WorkflowStatus;
use CultuurNet\UDB3\Place\Events\AddressTranslated;
use CultuurNet\UDB3\Place\Events\AddressUpdated;
use CultuurNet\UDB3\Place\Events\BookingInfoUpdated;
use CultuurNet\UDB3\Place\Events\CalendarUpdated;
use CultuurNet\UDB3\Place\Events\ContactPointUpdated;
use CultuurNet\UDB3\Place\Events\DescriptionTranslated;
use CultuurNet\UDB3\Place\Events\DescriptionUpdated;
use CultuurNet\UDB3\Place\Events\FacilitiesUpdated;
use CultuurNet\UDB3\Place\Events\GeoCoordinatesUpdated;
use CultuurNet\UDB3\Place\Events\Image\ImagesImportedFromUDB2;
use CultuurNet\UDB3\Place\Events\Image\ImagesUpdatedFromUDB2;
use CultuurNet\UDB3\Place\Events\ImageAdded;
use CultuurNet\UDB3\Place\Events\ImageRemoved;
use CultuurNet\UDB3\Place\Events\ImageUpdated;
use CultuurNet\UDB3\Place\Events\MainImageSelected;
use CultuurNet\UDB3\Place\Events\LabelAdded;
use CultuurNet\UDB3\Place\Events\LabelRemoved;
use CultuurNet\UDB3\Place\Events\MajorInfoUpdated;
use CultuurNet\UDB3\Place\Events\Moderation\Approved;
use CultuurNet\UDB3\Place\Events\Moderation\FlaggedAsDuplicate;
use CultuurNet\UDB3\Place\Events\Moderation\FlaggedAsInappropriate;
use CultuurNet\UDB3\Place\Events\Moderation\Published;
use CultuurNet\UDB3\Place\Events\Moderation\Rejected;
use CultuurNet\UDB3\Place\Events\OrganizerDeleted;
use CultuurNet\UDB3\Place\Events\OrganizerUpdated;
use CultuurNet\UDB3\Place\Events\PlaceCreated;
use CultuurNet\UDB3\Place\Events\PlaceDeleted;
use CultuurNet\UDB3\Place\Events\PlaceImportedFromUDB2;
use CultuurNet\UDB3\Place\Events\PlaceUpdatedFromUDB2;
use CultuurNet\UDB3\Place\Events\PriceInfoUpdated;
use CultuurNet\UDB3\Place\Events\ThemeUpdated;
use CultuurNet\UDB3\Place\Events\TitleTranslated;
use CultuurNet\UDB3\Place\Events\TitleUpdated;
use CultuurNet\UDB3\Place\Events\TypeUpdated;
use CultuurNet\UDB3\Place\Events\TypicalAgeRangeDeleted;
use CultuurNet\UDB3\Place\Events\TypicalAgeRangeUpdated;
use CultuurNet\UDB3\PriceInfo\PriceInfo;
use CultuurNet\UDB3\Theme;
use CultuurNet\UDB3\Title;
use DateTimeImmutable;
use ValueObjects\StringLiteral\StringLiteral;

class Place extends Offer implements UpdateableWithCdbXmlInterface
{
    /**
     * @var string
     */
    private $placeId;

    /**
     * @var Address[]
     */
    private $addresses;

    public function __construct()
    {
        parent::__construct();

        $this->addresses = [];
    }

    /**
     * {@inheritdoc}
     */
    public function getAggregateRootId()
    {
        return $this->placeId;
    }

    /**
     * Factory method to create a new Place.
     *
     * @todo Refactor this method so it can be called create. Currently the
     * normal behavior for create is taken by the legacy udb2 logic.
     * The PlaceImportedFromUDB2 could be a superclass of Place.
     *
     * @param string $id
     * @param Language $mainLanguage
     * @param Title $title
     * @param EventType $eventType
     * @param Address $address
     * @param CalendarInterface $calendar
     * @param Theme|null $theme
     * @param DateTimeImmutable|null $publicationDate
     *
     * @return self
     */
    public static function createPlace(

        $id,
        Language $mainLanguage,
        Title $title,
        EventType $eventType,
        Address $address,
        CalendarInterface $calendar,
        Theme $theme = null,
        DateTimeImmutable $publicationDate = null
    ) {
        $place = new self();
        $place->apply(new PlaceCreated(
            $id,
            $mainLanguage,
            $title,
            $eventType,
            $address,
            $calendar,
            $theme,
            $publicationDate
        ));

        return $place;
    }

    /**
     * Apply the place created event.
     * @param PlaceCreated $placeCreated
     */
    protected function applyPlaceCreated(PlaceCreated $placeCreated)
    {
        $this->mainLanguage = $placeCreated->getMainLanguage();
        $this->addresses[$this->mainLanguage->getCode()] = $placeCreated->getAddress();
        $this->placeId = $placeCreated->getPlaceId();
        $this->workflowStatus = WorkflowStatus::DRAFT();
    }

    /**
     * Update the major info.
     *
     * @param Title $title
     * @param EventType $eventType
     * @param Address $address
     * @param CalendarInterface $calendar
     * @param Theme $theme
     */
    public function updateMajorInfo(
        Title $title,
        EventType $eventType,
        Address $address,
        CalendarInterface $calendar,
        Theme $theme = null
    ) {
        $this->apply(
            new MajorInfoUpdated(
                $this->placeId,
                $title,
                $eventType,
                $address,
                $calendar,
                $theme
            )
        );
    }

    /**
     * @param MajorInfoUpdated $majorInfoUpdated
     */
    public function applyMajorInfoUpdated(MajorInfoUpdated $majorInfoUpdated)
    {
        $this->addresses[$this->mainLanguage->getCode()] = $majorInfoUpdated->getAddress();
    }

    /**
     * @param Address $address
     * @param Language $language
     */
    public function updateAddress(Address $address, Language $language)
    {
        if ($language->getCode() === $this->mainLanguage->getCode()) {
            $event = new AddressUpdated($this->placeId, $address);
        } else {
            $event = new AddressTranslated($this->placeId, $address, $language);
        }

        if ($this->allowAddressUpdate($address, $language)) {
            $this->apply($event);
        }
    }

    /**
     * @param AddressUpdated $addressUpdated
     */
    protected function applyAddressUpdated(AddressUpdated $addressUpdated)
    {
        $this->addresses[$this->mainLanguage->getCode()] = $addressUpdated->getAddress();
    }

    /**
     * @param AddressTranslated $addressTranslated
     */
    protected function applyAddressTranslated(AddressTranslated $addressTranslated)
    {
        $this->addresses[$addressTranslated->getLanguage()->getCode()] = $addressTranslated->getAddress();
    }

    /**
     * @param Address $address
     * @param Language $language
     * @return bool
     */
    private function allowAddressUpdate(Address $address, Language $language)
    {
        // No current address in the provided language so update with new address is allowed.
        if (!isset($this->addresses[$language->getCode()])) {
            return true;
        }

        // The current address in de the provided language is different then the new address, so update allowed.
        if (!$this->addresses[$language->getCode()]->sameAs($address)) {
            return true;
        }

        return false;
    }

    /**
     * Import from UDB2.
     *
     * @param string $actorId
     *   The actor id.
     * @param string $cdbXml
     *   The cdb xml.
     * @param string $cdbXmlNamespaceUri
     *   The cdb xml namespace uri.
     *
     * @return Place
     */
    public static function importFromUDB2Actor(
        $actorId,
        $cdbXml,
        $cdbXmlNamespaceUri
    ) {
        $place = new static();
        $place->apply(
            new PlaceImportedFromUDB2(
                $actorId,
                $cdbXml,
                $cdbXmlNamespaceUri
            )
        );

        return $place;
    }

    /**
     * @param PlaceImportedFromUDB2 $placeImported
     */
    public function applyPlaceImportedFromUDB2(

        PlaceImportedFromUDB2 $placeImported
    ) {
        $this->placeId = $placeImported->getActorId();

        // When importing from UDB2 the default main language is always 'nl'.
        $this->mainLanguage = new Language('nl');

        $udb2Actor = ActorItemFactory::createActorFromCdbXml(
            $placeImported->getCdbXmlNamespaceUri(),
            $placeImported->getCdbXml()
        );

        // Just clear the facilities.
        $this->facilities = [];

        // Just clear the contact point.
        $this->contactPoint = null;

        // Just clear the calendar.
        $this->calendar = null;

        $this->importWorkflowStatus($udb2Actor);
        $this->labels = LabelCollection::fromKeywords($udb2Actor->getKeywords(true));
    }

    /**
     * @param PlaceUpdatedFromUDB2 $placeUpdatedFromUDB2
     */
    public function applyPlaceUpdatedFromUDB2(

        PlaceUpdatedFromUDB2 $placeUpdatedFromUDB2
    ) {
        // Note: when updating from UDB2 never change the main language.

        $udb2Actor = ActorItemFactory::createActorFromCdbXml(
            $placeUpdatedFromUDB2->getCdbXmlNamespaceUri(),
            $placeUpdatedFromUDB2->getCdbXml()
        );

        // Just clear the facilities.
        $this->facilities = [];

        // Just clear the contact point.
        $this->contactPoint = null;

        // Just clear the calendar.
        $this->calendar = null;

        $this->importWorkflowStatus($udb2Actor);
        $this->labels = LabelCollection::fromKeywords($udb2Actor->getKeywords(true));

        unset($this->addresses[$this->mainLanguage->getCode()]);
    }

    /**
     * @inheritdoc
     */
    public function updateWithCdbXml($cdbXml, $cdbXmlNamespaceUri)
    {
        ActorItemFactory::createActorFromCdbXml($cdbXmlNamespaceUri, $cdbXml);

        $this->apply(
            new PlaceUpdatedFromUDB2(
                $this->placeId,
                $cdbXml,
                $cdbXmlNamespaceUri
            )
        );
    }

    /**
     * @param Label $label
     * @return LabelAdded
     */
    protected function createLabelAddedEvent(Label $label)
    {
        return new LabelAdded($this->placeId, $label);
    }

    /**
     * @param Label $label
     * @return LabelRemoved
     */
    protected function createLabelRemovedEvent(Label $label)
    {
        return new LabelRemoved($this->placeId, $label);
    }

    protected function createImageAddedEvent(Image $image)
    {
        return new ImageAdded($this->placeId, $image);
    }

    protected function createImageRemovedEvent(Image $image)
    {
        return new ImageRemoved($this->placeId, $image);
    }

    protected function createImageUpdatedEvent(
        AbstractUpdateImage $updateImageCommand
    ) {
        return new ImageUpdated(
            $this->placeId,
            $updateImageCommand->getMediaObjectId(),
            $updateImageCommand->getDescription(),
            $updateImageCommand->getCopyrightHolder()
        );
    }

    protected function createMainImageSelectedEvent(Image $image)
    {
        return new MainImageSelected($this->placeId, $image);
    }

    /**
     * @param Language $language
     * @param StringLiteral $title
     * @return TitleTranslated
     */
    protected function createTitleTranslatedEvent(Language $language, StringLiteral $title)
    {
        return new TitleTranslated($this->placeId, $language, $title);
    }

    /**
     * @param Title $title
     * @return TitleUpdated
     */
    protected function createTitleUpdatedEvent(Title $title)
    {
        return new TitleUpdated($this->placeId, $title);
    }

    /**
     * @param Language $language
     * @param StringLiteral $description
     * @return DescriptionTranslated
     */
    protected function createDescriptionTranslatedEvent(Language $language, StringLiteral $description)
    {
        return new DescriptionTranslated($this->placeId, $language, $description);
    }

    /**
     * @param string $description
     * @return DescriptionUpdated
     */
    protected function createDescriptionUpdatedEvent($description)
    {
        return new DescriptionUpdated($this->placeId, $description);
    }

    /**
     * @inheritdoc
     */
    protected function createCalendarUpdatedEvent(Calendar $calendar)
    {
        return new CalendarUpdated($this->placeId, $calendar);
    }
    
    /**
     * @param string $typicalAgeRange
     * @return TypicalAgeRangeUpdated
     */
    protected function createTypicalAgeRangeUpdatedEvent($typicalAgeRange)
    {
        return new TypicalAgeRangeUpdated($this->placeId, $typicalAgeRange);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * @return TypicalAgeRangeDeleted
     */
    protected function createTypicalAgeRangeDeletedEvent()
    {
        return new TypicalAgeRangeDeleted($this->placeId);
    }

    /**
     * @param string $organizerId
     * @return OrganizerUpdated
     */
    protected function createOrganizerUpdatedEvent($organizerId)
    {
        return new OrganizerUpdated($this->placeId, $organizerId);
    }

    /**
     * @param string $organizerId
     * @return OrganizerDeleted
     */
    protected function createOrganizerDeletedEvent($organizerId)
    {
        return new OrganizerDeleted($this->placeId, $organizerId);
    }

    /**
     * @param ContactPoint $contactPoint
     * @return ContactPointUpdated
     */
    protected function createContactPointUpdatedEvent(ContactPoint $contactPoint)
    {
        return new ContactPointUpdated($this->placeId, $contactPoint);
    }

    /**
     * @inheritdoc
     */
    protected function createGeoCoordinatesUpdatedEvent(Coordinates $coordinates)
    {
        return new GeoCoordinatesUpdated($this->placeId, $coordinates);
    }

    /**
     * @param BookingInfo $bookingInfo
     * @return BookingInfoUpdated
     */
    protected function createBookingInfoUpdatedEvent(BookingInfo $bookingInfo)
    {
        return new BookingInfoUpdated($this->placeId, $bookingInfo);
    }

    /**
     * @param PriceInfo $priceInfo
     * @return PriceInfoUpdated
     */
    protected function createPriceInfoUpdatedEvent(PriceInfo $priceInfo)
    {
        return new PriceInfoUpdated($this->placeId, $priceInfo);
    }

    /**
     * @return PlaceDeleted
     */
    protected function createOfferDeletedEvent()
    {
        return new PlaceDeleted($this->placeId);
    }

    /**
     * @inheritDoc
     */
    protected function createPublishedEvent(\DateTimeInterface $publicationDate)
    {
        return new Published($this->placeId, $publicationDate);
    }

    /**
     * @inheritDoc
     */
    protected function createApprovedEvent()
    {
        return new Approved($this->placeId);
    }

    /**
     * @inheritDoc
     */
    protected function createRejectedEvent(StringLiteral $reason)
    {
        return new Rejected($this->placeId, $reason);
    }

    /**
     * @inheritDoc
     */
    protected function createFlaggedAsDuplicate()
    {
        return new FlaggedAsDuplicate($this->placeId);
    }

    /**
     * @inheritDoc
     */
    protected function createFlaggedAsInappropriate()
    {
        return new FlaggedAsInappropriate($this->placeId);
    }

    /**
     * @inheritDoc
     * @return ImagesImportedFromUDB2
     */
    protected function createImagesImportedFromUDB2(ImageCollection $images)
    {
        return new ImagesImportedFromUDB2($this->placeId, $images);
    }

    /**
     * @inheritDoc
     * @return ImagesUpdatedFromUDB2
     */
    protected function createImagesUpdatedFromUDB2(ImageCollection $images)
    {
        return new ImagesUpdatedFromUDB2($this->placeId, $images);
    }

    protected function createTypeUpdatedEvent(EventType $type)
    {
        return new TypeUpdated($this->placeId, $type);
    }

    protected function createThemeUpdatedEvent(Theme $theme)
    {
        return new ThemeUpdated($this->placeId, $theme);
    }

    /**
     * @inheritdoc
     */
    protected function createFacilitiesUpdatedEvent(array $facilities)
    {
        return new FacilitiesUpdated($this->placeId, $facilities);
    }
}


1		<?php
2
3		namespace CultuurNet\UDB3\Place;
4
5		use CultuurNet\Geocoding\Coordinate\Coordinates;
6		use CultuurNet\UDB3\Address\Address;
7		use CultuurNet\UDB3\BookingInfo;
8		use CultuurNet\UDB3\Calendar;
9		use CultuurNet\UDB3\CalendarInterface;
10		use CultuurNet\UDB3\Cdb\ActorItemFactory;
11		use CultuurNet\UDB3\Cdb\UpdateableWithCdbXmlInterface;
12		use CultuurNet\UDB3\ContactPoint;
13		use CultuurNet\UDB3\Event\EventType;
14		use CultuurNet\UDB3\Label;
15		use CultuurNet\UDB3\LabelCollection;
16		use CultuurNet\UDB3\Media\ImageCollection;
17		use CultuurNet\UDB3\Offer\Commands\Image\AbstractUpdateImage;
18		use CultuurNet\UDB3\Language;
19		use CultuurNet\UDB3\Offer\Offer;
20		use CultuurNet\UDB3\Media\Image;
21		use CultuurNet\UDB3\Offer\WorkflowStatus;
22		use CultuurNet\UDB3\Place\Events\AddressTranslated;
23		use CultuurNet\UDB3\Place\Events\AddressUpdated;
24		use CultuurNet\UDB3\Place\Events\BookingInfoUpdated;
25		use CultuurNet\UDB3\Place\Events\CalendarUpdated;
26		use CultuurNet\UDB3\Place\Events\ContactPointUpdated;
27		use CultuurNet\UDB3\Place\Events\DescriptionTranslated;
28		use CultuurNet\UDB3\Place\Events\DescriptionUpdated;
29		use CultuurNet\UDB3\Place\Events\FacilitiesUpdated;
30		use CultuurNet\UDB3\Place\Events\GeoCoordinatesUpdated;
31		use CultuurNet\UDB3\Place\Events\Image\ImagesImportedFromUDB2;
32		use CultuurNet\UDB3\Place\Events\Image\ImagesUpdatedFromUDB2;
33		use CultuurNet\UDB3\Place\Events\ImageAdded;
34		use CultuurNet\UDB3\Place\Events\ImageRemoved;
35		use CultuurNet\UDB3\Place\Events\ImageUpdated;
36		use CultuurNet\UDB3\Place\Events\MainImageSelected;
37		use CultuurNet\UDB3\Place\Events\LabelAdded;
38		use CultuurNet\UDB3\Place\Events\LabelRemoved;
39		use CultuurNet\UDB3\Place\Events\MajorInfoUpdated;
40		use CultuurNet\UDB3\Place\Events\Moderation\Approved;
41		use CultuurNet\UDB3\Place\Events\Moderation\FlaggedAsDuplicate;
42		use CultuurNet\UDB3\Place\Events\Moderation\FlaggedAsInappropriate;
43		use CultuurNet\UDB3\Place\Events\Moderation\Published;
44		use CultuurNet\UDB3\Place\Events\Moderation\Rejected;
45		use CultuurNet\UDB3\Place\Events\OrganizerDeleted;
46		use CultuurNet\UDB3\Place\Events\OrganizerUpdated;
47		use CultuurNet\UDB3\Place\Events\PlaceCreated;
48		use CultuurNet\UDB3\Place\Events\PlaceDeleted;
49		use CultuurNet\UDB3\Place\Events\PlaceImportedFromUDB2;
50		use CultuurNet\UDB3\Place\Events\PlaceUpdatedFromUDB2;
51		use CultuurNet\UDB3\Place\Events\PriceInfoUpdated;
52		use CultuurNet\UDB3\Place\Events\ThemeUpdated;
53		use CultuurNet\UDB3\Place\Events\TitleTranslated;
54		use CultuurNet\UDB3\Place\Events\TitleUpdated;
55		use CultuurNet\UDB3\Place\Events\TypeUpdated;
56		use CultuurNet\UDB3\Place\Events\TypicalAgeRangeDeleted;
57		use CultuurNet\UDB3\Place\Events\TypicalAgeRangeUpdated;
58		use CultuurNet\UDB3\PriceInfo\PriceInfo;
59		use CultuurNet\UDB3\Theme;
60		use CultuurNet\UDB3\Title;
61		use DateTimeImmutable;
62		use ValueObjects\StringLiteral\StringLiteral;
63
64		class Place extends Offer implements UpdateableWithCdbXmlInterface
65		{
66		/**
67		* @var string
68		*/
69		private $placeId;
70
71		/**
72		* @var Address[]
73		*/
74		private $addresses;
75
76		public function __construct()
77		{
78		parent::__construct();
79
80		$this->addresses = [];
81		}
82
83		/**
84		* {@inheritdoc}
85		*/
86		public function getAggregateRootId()
87		{
88		return $this->placeId;
89		}
90
91		/**
92		* Factory method to create a new Place.
93		*
94		* @todo Refactor this method so it can be called create. Currently the
95		* normal behavior for create is taken by the legacy udb2 logic.
96		* The PlaceImportedFromUDB2 could be a superclass of Place.
97		*
98		* @param string $id
99		* @param Language $mainLanguage
100		* @param Title $title
101		* @param EventType $eventType
102		* @param Address $address
103		* @param CalendarInterface $calendar
104		* @param Theme\|null $theme
105		* @param DateTimeImmutable\|null $publicationDate
106		*
107		* @return self
108		*/
109	View Code Duplication	public static function createPlace(
		0 ignored issues – show Duplication introduced 2017-01-06 08:49 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
110		$id,
111		Language $mainLanguage,
112		Title $title,
113		EventType $eventType,
114		Address $address,
115		CalendarInterface $calendar,
116		Theme $theme = null,
117		DateTimeImmutable $publicationDate = null
118		) {
119		$place = new self();
120		$place->apply(new PlaceCreated(
121		$id,
122		$mainLanguage,
123		$title,
124		$eventType,
125		$address,
126		$calendar,
127		$theme,
128		$publicationDate
129		));
130
131		return $place;
132		}
133
134		/**
135		* Apply the place created event.
136		* @param PlaceCreated $placeCreated
137		*/
138		protected function applyPlaceCreated(PlaceCreated $placeCreated)
139		{
140		$this->mainLanguage = $placeCreated->getMainLanguage();
141		$this->addresses[$this->mainLanguage->getCode()] = $placeCreated->getAddress();
142		$this->placeId = $placeCreated->getPlaceId();
143		$this->workflowStatus = WorkflowStatus::DRAFT();
144		}
145
146		/**
147		* Update the major info.
148		*
149		* @param Title $title
150		* @param EventType $eventType
151		* @param Address $address
152		* @param CalendarInterface $calendar
153		* @param Theme $theme
154		*/
155		public function updateMajorInfo(
156		Title $title,
157		EventType $eventType,
158		Address $address,
159		CalendarInterface $calendar,
160		Theme $theme = null
161		) {
162		$this->apply(
163		new MajorInfoUpdated(
164		$this->placeId,
165		$title,
166		$eventType,
167		$address,
168		$calendar,
169		$theme
170		)
171		);
172		}
173
174		/**
175		* @param MajorInfoUpdated $majorInfoUpdated
176		*/
177		public function applyMajorInfoUpdated(MajorInfoUpdated $majorInfoUpdated)
178		{
179		$this->addresses[$this->mainLanguage->getCode()] = $majorInfoUpdated->getAddress();
180		}
181
182		/**
183		* @param Address $address
184		* @param Language $language
185		*/
186		public function updateAddress(Address $address, Language $language)
187		{
188		if ($language->getCode() === $this->mainLanguage->getCode()) {
189		$event = new AddressUpdated($this->placeId, $address);
190		} else {
191		$event = new AddressTranslated($this->placeId, $address, $language);
192		}
193
194		if ($this->allowAddressUpdate($address, $language)) {
195		$this->apply($event);
196		}
197		}
198
199		/**
200		* @param AddressUpdated $addressUpdated
201		*/
202		protected function applyAddressUpdated(AddressUpdated $addressUpdated)
203		{
204		$this->addresses[$this->mainLanguage->getCode()] = $addressUpdated->getAddress();
205		}
206
207		/**
208		* @param AddressTranslated $addressTranslated
209		*/
210		protected function applyAddressTranslated(AddressTranslated $addressTranslated)
211		{
212		$this->addresses[$addressTranslated->getLanguage()->getCode()] = $addressTranslated->getAddress();
213		}
214
215		/**
216		* @param Address $address
217		* @param Language $language
218		* @return bool
219		*/
220		private function allowAddressUpdate(Address $address, Language $language)
221		{
222		// No current address in the provided language so update with new address is allowed.
223		if (!isset($this->addresses[$language->getCode()])) {
224		return true;
225		}
226
227		// The current address in de the provided language is different then the new address, so update allowed.
228		if (!$this->addresses[$language->getCode()]->sameAs($address)) {
229		return true;
230		}
231
232		return false;
233		}
234
235		/**
236		* Import from UDB2.
237		*
238		* @param string $actorId
239		* The actor id.
240		* @param string $cdbXml
241		* The cdb xml.
242		* @param string $cdbXmlNamespaceUri
243		* The cdb xml namespace uri.
244		*
245		* @return Place
246		*/
247		public static function importFromUDB2Actor(
248		$actorId,
249		$cdbXml,
250		$cdbXmlNamespaceUri
251		) {
252		$place = new static();
253		$place->apply(
254		new PlaceImportedFromUDB2(
255		$actorId,
256		$cdbXml,
257		$cdbXmlNamespaceUri
258		)
259		);
260
261		return $place;
262		}
263
264		/**
265		* @param PlaceImportedFromUDB2 $placeImported
266		*/
267	View Code Duplication	public function applyPlaceImportedFromUDB2(
		0 ignored issues – show Duplication introduced 2017-07-31 14:18 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
268		PlaceImportedFromUDB2 $placeImported
269		) {
270		$this->placeId = $placeImported->getActorId();
271
272		// When importing from UDB2 the default main language is always 'nl'.
273		$this->mainLanguage = new Language('nl');
274
275		$udb2Actor = ActorItemFactory::createActorFromCdbXml(
276		$placeImported->getCdbXmlNamespaceUri(),
277		$placeImported->getCdbXml()
278		);
279
280		// Just clear the facilities.
281		$this->facilities = [];
282
283		// Just clear the contact point.
284		$this->contactPoint = null;
285
286		// Just clear the calendar.
287		$this->calendar = null;
288
289		$this->importWorkflowStatus($udb2Actor);
290		$this->labels = LabelCollection::fromKeywords($udb2Actor->getKeywords(true));
291		}
292
293		/**
294		* @param PlaceUpdatedFromUDB2 $placeUpdatedFromUDB2
295		*/
296	View Code Duplication	public function applyPlaceUpdatedFromUDB2(
		0 ignored issues – show Duplication introduced 2017-07-31 14:18 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
297		PlaceUpdatedFromUDB2 $placeUpdatedFromUDB2
298		) {
299		// Note: when updating from UDB2 never change the main language.
300
301		$udb2Actor = ActorItemFactory::createActorFromCdbXml(
302		$placeUpdatedFromUDB2->getCdbXmlNamespaceUri(),
303		$placeUpdatedFromUDB2->getCdbXml()
304		);
305
306		// Just clear the facilities.
307		$this->facilities = [];
308
309		// Just clear the contact point.
310		$this->contactPoint = null;
311
312		// Just clear the calendar.
313		$this->calendar = null;
314
315		$this->importWorkflowStatus($udb2Actor);
316		$this->labels = LabelCollection::fromKeywords($udb2Actor->getKeywords(true));
317
318		unset($this->addresses[$this->mainLanguage->getCode()]);
319		}
320
321		/**
322		* @inheritdoc
323		*/
324		public function updateWithCdbXml($cdbXml, $cdbXmlNamespaceUri)
325		{
326		ActorItemFactory::createActorFromCdbXml($cdbXmlNamespaceUri, $cdbXml);
327
328		$this->apply(
329		new PlaceUpdatedFromUDB2(
330		$this->placeId,
331		$cdbXml,
332		$cdbXmlNamespaceUri
333		)
334		);
335		}
336
337		/**
338		* @param Label $label
339		* @return LabelAdded
340		*/
341		protected function createLabelAddedEvent(Label $label)
342		{
343		return new LabelAdded($this->placeId, $label);
344		}
345
346		/**
347		* @param Label $label
348		* @return LabelRemoved
349		*/
350		protected function createLabelRemovedEvent(Label $label)
351		{
352		return new LabelRemoved($this->placeId, $label);
353		}
354
355		protected function createImageAddedEvent(Image $image)
356		{
357		return new ImageAdded($this->placeId, $image);
358		}
359
360		protected function createImageRemovedEvent(Image $image)
361		{
362		return new ImageRemoved($this->placeId, $image);
363		}
364
365		protected function createImageUpdatedEvent(
366		AbstractUpdateImage $updateImageCommand
367		) {
368		return new ImageUpdated(
369		$this->placeId,
370		$updateImageCommand->getMediaObjectId(),
371		$updateImageCommand->getDescription(),
372		$updateImageCommand->getCopyrightHolder()
373		);
374		}
375
376		protected function createMainImageSelectedEvent(Image $image)
377		{
378		return new MainImageSelected($this->placeId, $image);
379		}
380
381		/**
382		* @param Language $language
383		* @param StringLiteral $title
384		* @return TitleTranslated
385		*/
386		protected function createTitleTranslatedEvent(Language $language, StringLiteral $title)
387		{
388		return new TitleTranslated($this->placeId, $language, $title);
389		}
390
391		/**
392		* @param Title $title
393		* @return TitleUpdated
394		*/
395		protected function createTitleUpdatedEvent(Title $title)
396		{
397		return new TitleUpdated($this->placeId, $title);
398		}
399
400		/**
401		* @param Language $language
402		* @param StringLiteral $description
403		* @return DescriptionTranslated
404		*/
405		protected function createDescriptionTranslatedEvent(Language $language, StringLiteral $description)
406		{
407		return new DescriptionTranslated($this->placeId, $language, $description);
408		}
409
410		/**
411		* @param string $description
412		* @return DescriptionUpdated
413		*/
414		protected function createDescriptionUpdatedEvent($description)
415		{
416		return new DescriptionUpdated($this->placeId, $description);
417		}
418
419		/**
420		* @inheritdoc
421		*/
422		protected function createCalendarUpdatedEvent(Calendar $calendar)
423		{
424		return new CalendarUpdated($this->placeId, $calendar);
425		}
426
427		/**
428		* @param string $typicalAgeRange
429		* @return TypicalAgeRangeUpdated
430		*/
431		protected function createTypicalAgeRangeUpdatedEvent($typicalAgeRange)
432		{
433		return new TypicalAgeRangeUpdated($this->placeId, $typicalAgeRange);
		0 ignored issues – show Documentation introduced 2017-04-04 13:38 UTC by Report Bug Copy Issue Report `$typicalAgeRange` is of type `string`, but the function expects a `object<CultuurNet\UDB3\Offer\AgeRange>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
434		}
435
436		/**
437		* @return TypicalAgeRangeDeleted
438		*/
439		protected function createTypicalAgeRangeDeletedEvent()
440		{
441		return new TypicalAgeRangeDeleted($this->placeId);
442		}
443
444		/**
445		* @param string $organizerId
446		* @return OrganizerUpdated
447		*/
448		protected function createOrganizerUpdatedEvent($organizerId)
449		{
450		return new OrganizerUpdated($this->placeId, $organizerId);
451		}
452
453		/**
454		* @param string $organizerId
455		* @return OrganizerDeleted
456		*/
457		protected function createOrganizerDeletedEvent($organizerId)
458		{
459		return new OrganizerDeleted($this->placeId, $organizerId);
460		}
461
462		/**
463		* @param ContactPoint $contactPoint
464		* @return ContactPointUpdated
465		*/
466		protected function createContactPointUpdatedEvent(ContactPoint $contactPoint)
467		{
468		return new ContactPointUpdated($this->placeId, $contactPoint);
469		}
470
471		/**
472		* @inheritdoc
473		*/
474		protected function createGeoCoordinatesUpdatedEvent(Coordinates $coordinates)
475		{
476		return new GeoCoordinatesUpdated($this->placeId, $coordinates);
477		}
478
479		/**
480		* @param BookingInfo $bookingInfo
481		* @return BookingInfoUpdated
482		*/
483		protected function createBookingInfoUpdatedEvent(BookingInfo $bookingInfo)
484		{
485		return new BookingInfoUpdated($this->placeId, $bookingInfo);
486		}
487
488		/**
489		* @param PriceInfo $priceInfo
490		* @return PriceInfoUpdated
491		*/
492		protected function createPriceInfoUpdatedEvent(PriceInfo $priceInfo)
493		{
494		return new PriceInfoUpdated($this->placeId, $priceInfo);
495		}
496
497		/**
498		* @return PlaceDeleted
499		*/
500		protected function createOfferDeletedEvent()
501		{
502		return new PlaceDeleted($this->placeId);
503		}
504
505		/**
506		* @inheritDoc
507		*/
508		protected function createPublishedEvent(\DateTimeInterface $publicationDate)
509		{
510		return new Published($this->placeId, $publicationDate);
511		}
512
513		/**
514		* @inheritDoc
515		*/
516		protected function createApprovedEvent()
517		{
518		return new Approved($this->placeId);
519		}
520
521		/**
522		* @inheritDoc
523		*/
524		protected function createRejectedEvent(StringLiteral $reason)
525		{
526		return new Rejected($this->placeId, $reason);
527		}
528
529		/**
530		* @inheritDoc
531		*/
532		protected function createFlaggedAsDuplicate()
533		{
534		return new FlaggedAsDuplicate($this->placeId);
535		}
536
537		/**
538		* @inheritDoc
539		*/
540		protected function createFlaggedAsInappropriate()
541		{
542		return new FlaggedAsInappropriate($this->placeId);
543		}
544
545		/**
546		* @inheritDoc
547		* @return ImagesImportedFromUDB2
548		*/
549		protected function createImagesImportedFromUDB2(ImageCollection $images)
550		{
551		return new ImagesImportedFromUDB2($this->placeId, $images);
552		}
553
554		/**
555		* @inheritDoc
556		* @return ImagesUpdatedFromUDB2
557		*/
558		protected function createImagesUpdatedFromUDB2(ImageCollection $images)
559		{
560		return new ImagesUpdatedFromUDB2($this->placeId, $images);
561		}
562
563		protected function createTypeUpdatedEvent(EventType $type)
564		{
565		return new TypeUpdated($this->placeId, $type);
566		}
567
568		protected function createThemeUpdatedEvent(Theme $theme)
569		{
570		return new ThemeUpdated($this->placeId, $theme);
571		}
572
573		/**
574		* @inheritdoc
575		*/
576		protected function createFacilitiesUpdatedEvent(array $facilities)
577		{
578		return new FacilitiesUpdated($this->placeId, $facilities);
579		}
580		}
581

cultuurnet / udb3-php