Event - Code Metrics - Inspection of "Feature/iii 484" - cultuurnet/udb3-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#103)

by Kristof

created 2015-12-16 10:39 UTC

Event F

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	561
Duplicated Lines	2.14 %

Coupling/Cohesion

Components	1
Dependencies	35

Importance

Changes	23
Bugs	4	Features	7

Metric	Value
wmc	58
c	23
b	4
f	7
lcom	1
cbo	35
dl	12
loc	561
rs	1.3043

44 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	create()	0	12	2
A	importFromUDB2()	0	16	1
A	createFromCdbXml()	0	16	1
A	updateFromCdbXml()	0	13	1
A	mergeLabels()	0	15	2
A	applyTranslation()	0	16	1
A	deleteTranslation()	0	14	2
A	isSameCollaborationDataAlreadyPresent()	0	12	2
A	addCollaborationData()	0	16	2
A	getAggregateRootId()	0	4	1
A	getTranslations()	0	4	1
A	getLabels()	0	4	1
A	label()	0	6	2
A	unlabel()	0	6	2
A	applyEventCreated()	0	4	1
A	applyEventWasLabelled()	0	8	2
A	applyUnlabelled()	0	6	1
A	applyEventImportedFromUDB2()	0	6	1
A	applyEventUpdatedFromUDB2()	0	5	1
A	setUDB2Data()	0	10	1
A	translateTitle()	0	4	1
A	translateDescription()	0	6	1
A	updateDescription()	0	4	1
A	updateTypicalAgeRange()	0	4	1
A	deleteTypicalAgeRange()	0	4	1
A	updateOrganizer()	0	4	1
A	deleteOrganizer()	0	4	1
A	updateContactPoint()	0	4	1
A	updateBookingInfo()	0	4	1
A	addImage()	0	4	1
A	updateImage()	0	4	1
A	deleteImage()	0	4	1
A	updateMajorInfo()	0	4	1
A	deleteEvent()	0	4	1
A	setLabelsFromUDB2Event()	0	14	3
A	resetLabels()	0	4	1
A	applyEventCreatedFromCdbXml()	0	12	1
A	applyEventUpdatedFromCdbXml()	12	12	1
A	applyLabelsMerged()	0	5	1
A	applyTranslationApplied()	0	20	2
A	applyTranslationDeleted()	0	9	2
A	applyCollaborationDataAdded()	0	17	3
A	updateWithCdbXml()	0	10	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 Event 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 Event, and based on these observations, apply Extract Interface, too.

<?php

namespace CultuurNet\UDB3\Event;

use Broadway\EventSourcing\EventSourcedAggregateRoot;
use CultuurNet\UDB3\BookingInfo;
use CultuurNet\UDB3\CalendarInterface;
use CultuurNet\UDB3\Cdb\EventItemFactory;
use CultuurNet\UDB3\CollaborationDataCollection;
use CultuurNet\UDB3\ContactPoint;
use CultuurNet\UDB3\Event\Events\BookingInfoUpdated;
use CultuurNet\UDB3\Event\Events\ContactPointUpdated;
use CultuurNet\UDB3\Event\Events\DescriptionUpdated;
use CultuurNet\UDB3\Event\Events\EventCdbXMLInterface;
use CultuurNet\UDB3\Event\Events\EventCreated;
use CultuurNet\UDB3\Event\Events\EventCreatedFromCdbXml;
use CultuurNet\UDB3\Event\Events\EventDeleted;
use CultuurNet\UDB3\Event\Events\EventImportedFromUDB2;
use CultuurNet\UDB3\Event\Events\EventUpdatedFromCdbXml;
use CultuurNet\UDB3\Event\Events\EventUpdatedFromUDB2;
use CultuurNet\UDB3\Event\Events\EventWasLabelled;
use CultuurNet\UDB3\Event\Events\ImageAdded;
use CultuurNet\UDB3\Event\Events\ImageDeleted;
use CultuurNet\UDB3\Event\Events\ImageUpdated;
use CultuurNet\UDB3\Event\Events\LabelsMerged;
use CultuurNet\UDB3\Event\Events\CollaborationDataAdded;
use CultuurNet\UDB3\Event\Events\MajorInfoUpdated;
use CultuurNet\UDB3\Event\Events\OrganizerDeleted;
use CultuurNet\UDB3\Event\Events\OrganizerUpdated;
use CultuurNet\UDB3\Event\Events\TranslationApplied;
use CultuurNet\UDB3\Event\Events\TranslationDeleted;
use CultuurNet\UDB3\Event\Events\TypicalAgeRangeDeleted;
use CultuurNet\UDB3\Event\Events\TypicalAgeRangeUpdated;
use CultuurNet\UDB3\Event\Events\Unlabelled;
use CultuurNet\UDB3\EventXmlString;
use CultuurNet\UDB3\Label;
use CultuurNet\UDB3\LabelCollection;
use CultuurNet\UDB3\Language;
use CultuurNet\UDB3\CollaborationData;
use CultuurNet\UDB3\Location;
use CultuurNet\UDB3\MediaObject;
use CultuurNet\UDB3\Title;
use CultuurNet\UDB3\Translation;
use ValueObjects\String\String;

class Event extends EventSourcedAggregateRoot
{
    protected $eventId;

    /**
     * @var LabelCollection
     */
    protected $labels;

    /**
     * @var Translation[]
     */
    protected $translations = [];

    /**
     * @var CollaborationDataCollection[]
     *   Array of different collections, keyed by language.
     */
    protected $collaborationData;

    const MAIN_LANGUAGE_CODE = 'nl';

    public function __construct()
    {
        $this->resetLabels();
    }

    /**
     * Factory method to create a new event.
     *
     * @param Title $title
     * @param EventType $eventType
     * @param Location $location
     * @param CalendarBase $calendar
     * @param Theme/null $theme

     *
     * @return Event
     */
    public static function create($eventId, Title $title, EventType $eventType, Location $location, CalendarInterface $calendar, $theme = null)
    {
        if (!is_string($eventId)) {
            throw new \InvalidArgumentException(
                'Expected eventId to be a string, received ' . gettype($eventId)
            );
        }
        $event = new self();
        $event->apply(new EventCreated($eventId, $title, $eventType, $location, $calendar, $theme));

        return $event;
    }

    /**
     * @param string $eventId
     * @param string $cdbXml
     * @param string $cdbXmlNamespaceUri
     * @return Event
     */
    public static function importFromUDB2(
        $eventId,
        $cdbXml,
        $cdbXmlNamespaceUri
    ) {
        $event = new self();
        $event->apply(
            new EventImportedFromUDB2(
                $eventId,
                $cdbXml,
                $cdbXmlNamespaceUri
            )
        );

        return $event;
    }

    /**
     * @param EventXmlString $xmlString
     * @param String $eventId
     * @param String $cdbXmlNamespaceUri
     * @return Event
     */
    public static function createFromCdbXml(
        String $eventId,
        EventXmlString $xmlString,
        String $cdbXmlNamespaceUri
    ) {
        $event = new self();
        $event->apply(
            new EventCreatedFromCdbXml(
                $eventId,
                $xmlString,
                $cdbXmlNamespaceUri
            )
        );

        return $event;
    }

    /**
     * @param String $eventId
     * @param EventXmlString $xmlString
     * @param String $cdbXmlNamespaceUri
     * @return Event
     */
    public function updateFromCdbXml(
        String $eventId,
        EventXmlString $xmlString,
        String $cdbXmlNamespaceUri
    ) {
        $this->apply(
            new EventUpdatedFromCdbXml(
                $eventId,
                $xmlString,
                $cdbXmlNamespaceUri
            )
        );
    }

    /**
     * @param LabelCollection $labels
     */
    public function mergeLabels(LabelCollection $labels)
    {
        if (count($labels) === 0) {
            throw new \InvalidArgumentException(
                'Argument $labels should contain at least one label'
            );
        }

        $this->apply(
            new LabelsMerged(
                new String($this->eventId),
                $labels
            )
        );
    }

    /**
     * @param Language $language
     * @param String|null $title
     * @param String|null $shortDescription
     * @param String|null $longDescription
     */
    public function applyTranslation(
        Language $language,
        String $title = null,
        String $shortDescription = null,
        String $longDescription = null
    ) {
        $this->apply(
            new TranslationApplied(
                new String($this->eventId),
                $language,
                $title,
                $shortDescription,
                $longDescription
            )
        );
    }

    /**
     * @param Language $language
     */
    public function deleteTranslation(
        Language $language
    ) {
        if (!array_key_exists($language->getCode(), $this->translations)) {
            return;
        }

        $this->apply(
            new TranslationDeleted(
                new String($this->eventId),
                $language
            )
        );
    }

    /**
     * @param Language $language
     * @param CollaborationData $collaborationData
     * @return bool
     */
    protected function isSameCollaborationDataAlreadyPresent(
        Language $language,
        CollaborationData $collaborationData
    ) {
        if (!isset($this->collaborationData[$language->getCode()])) {
            return false;
        }

        $languageCollaborationData = $this->collaborationData[$language->getCode()];

        return $languageCollaborationData->contains($collaborationData);
    }

    /**
     * @param Language $language
     * @param \CultuurNet\UDB3\CollaborationData $collaborationData
     */
    public function addCollaborationData(
        Language $language,
        CollaborationData $collaborationData
    ) {
        if ($this->isSameCollaborationDataAlreadyPresent($language, $collaborationData)) {
            return;
        }

        $collaborationDataAdded = new CollaborationDataAdded(
            new String($this->eventId),
            $language,
            $collaborationData
        );

        $this->apply($collaborationDataAdded);
    }

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

    /**
     * @return Translation[]
     */
    public function getTranslations()
    {
        return $this->translations;
    }

    /**
     * @return LabelCollection
     */
    public function getLabels()
    {
        return $this->labels;
    }

    /**
     * @param Label $label
     */
    public function label(Label $label)
    {
        if (!$this->labels->contains($label)) {
            $this->apply(new EventWasLabelled($this->eventId, $label));
        }
    }

    /**
     * @param Label $label
     */
    public function unlabel(Label $label)
    {
        if ($this->labels->contains($label)) {
            $this->apply(new Unlabelled($this->eventId, $label));
        }
    }

    protected function applyEventCreated(EventCreated $eventCreated)
    {
        $this->eventId = $eventCreated->getEventId();
    }

    protected function applyEventWasLabelled(EventWasLabelled $eventLabelled)
    {
        $newLabel = $eventLabelled->getLabel();

        if (!$this->labels->contains($newLabel)) {
            $this->labels = $this->labels->with($newLabel);
        }
    }

    protected function applyUnlabelled(Unlabelled $unlabelled)
    {
        $removedLabel = $unlabelled->getLabel();

        $this->labels = $this->labels->without($removedLabel);
    }

    protected function applyEventImportedFromUDB2(
        EventImportedFromUDB2 $eventImported
    ) {
        $this->eventId = $eventImported->getEventId();
        $this->setUDB2Data($eventImported);
    }

    /**
     * @param EventUpdatedFromUDB2 $eventUpdated
     */
    protected function applyEventUpdatedFromUDB2(
        EventUpdatedFromUDB2 $eventUpdated
    ) {
        $this->setUDB2Data($eventUpdated);
    }

    /**
     * @param EventCdbXMLInterface $eventCdbXML
     */
    protected function setUDB2Data(
        EventCdbXMLInterface $eventCdbXML
    ) {
        $udb2Event = EventItemFactory::createEventFromCdbXml(
            $eventCdbXML->getCdbXmlNamespaceUri(),
            $eventCdbXML->getCdbXml()
        );

        $this->setLabelsFromUDB2Event($udb2Event);
    }

    /**
     * @param Language $language
     * @param string $title
     */
    public function translateTitle(Language $language, $title)
    {
        $this->apply(new TitleTranslated($this->eventId, $language, $title));
    }

    /**
     * @param Language $language
     * @param string $description
     */
    public function translateDescription(Language $language, $description)
    {
        $this->apply(
            new DescriptionTranslated($this->eventId, $language, $description)
        );
    }

    /**
     * @param string $description
     */
    public function updateDescription($description)
    {
        $this->apply(new DescriptionUpdated($this->eventId, $description));
    }

    /**
     * @param string $typicalAgeRange
     */
    public function updateTypicalAgeRange($typicalAgeRange)
    {
        $this->apply(new TypicalAgeRangeUpdated($this->eventId, $typicalAgeRange));
    }

    public function deleteTypicalAgeRange()
    {
        $this->apply(new TypicalAgeRangeDeleted($this->eventId));
    }

    /**
     * @param string $organizerId
     */
    public function updateOrganizer($organizerId)
    {
        $this->apply(new OrganizerUpdated($this->eventId, $organizerId));
    }

    /**
     * Delete the given organizer.
     *
     * @param string $organizerId
     */
    public function deleteOrganizer($organizerId)
    {
        $this->apply(new OrganizerDeleted($this->eventId, $organizerId));
    }

    /**
     * Updated the contact info.
     *
     * @param array $phones
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param array $emails
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param array $urls
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     */
    public function updateContactPoint(ContactPoint $contactPoint)
    {
        $this->apply(new ContactPointUpdated($this->eventId, $contactPoint));
    }

    /**
     * Updated the booking info.
     *
     * @param BookingInfo $bookingInfo
     */
    public function updateBookingInfo(BookingInfo $bookingInfo)
    {
        $this->apply(new BookingInfoUpdated($this->eventId, $bookingInfo));
    }

    /**
     * Add a new image.
     *
     * @param MediaObject $mediaObject
     */
    public function addImage(MediaObject $mediaObject)
    {
        $this->apply(new ImageAdded($this->eventId, $mediaObject));
    }

    /**
     * Update an image.
     *
     * @param int $indexToUpdate
     * @param MediaObject $mediaObject
     */
    public function updateImage($indexToUpdate, MediaObject $mediaObject)
    {
        $this->apply(new ImageUpdated($this->eventId, $indexToUpdate, $mediaObject));
    }

    /**
     * Delete an image.
     *
     * @param int $indexToDelete
     * @param mixed int|string $internalId
     */
    public function deleteImage($indexToDelete, $internalId)
    {
        $this->apply(new ImageDeleted($this->eventId, $indexToDelete, $internalId));
    }

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

    /**
     * Delete this item.
     */
    public function deleteEvent()
    {
        $this->apply(new EventDeleted($this->eventId));
    }

    /**
     * @param \CultureFeed_Cdb_Item_Event $udb2Event
     */
    protected function setLabelsFromUDB2Event(\CultureFeed_Cdb_Item_Event $udb2Event)
    {
        $this->resetLabels();

        /** @var \CultureFeed_Cdb_Data_Keyword $udb2Keyword */
        foreach (array_values($udb2Event->getKeywords(true)) as $udb2Keyword) {
            $keyword = trim($udb2Keyword->getValue());
            if ($keyword) {
                $this->labels = $this->labels->with(
                    new Label($keyword, $udb2Keyword->isVisible())
                );
            }
        }
    }

    protected function resetLabels()
    {
        $this->labels = new LabelCollection();
    }

    protected function applyEventCreatedFromCdbXml(
        EventCreatedFromCdbXml $eventCreatedFromCdbXml
    ) {
        $this->eventId = $eventCreatedFromCdbXml->getEventId()->toNative();

        $udb2Event = EventItemFactory::createEventFromCdbXml(
            $eventCreatedFromCdbXml->getCdbXmlNamespaceUri(),
            $eventCreatedFromCdbXml->getEventXmlString()->toEventXmlString()
        );

        $this->setLabelsFromUDB2Event($udb2Event);
    }

    protected function applyEventUpdatedFromCdbXml(

        EventUpdatedFromCdbXml $eventUpdatedFromCdbXml
    ) {
        $this->eventId = $eventUpdatedFromCdbXml->getEventId()->toNative();

        $udb2Event = EventItemFactory::createEventFromCdbXml(
            $eventUpdatedFromCdbXml->getCdbXmlNamespaceUri(),
            $eventUpdatedFromCdbXml->getEventXmlString()->toEventXmlString()
        );

        $this->setLabelsFromUDB2Event($udb2Event);
    }

    protected function applyLabelsMerged(
        LabelsMerged $labelsMerged
    ) {
        $this->labels = $this->labels->merge($labelsMerged->getLabels());
    }

    protected function applyTranslationApplied(
        TranslationApplied $translationApplied
    ) {
        $this->eventId = $translationApplied->getEventId()->toNative();

        $language = $translationApplied->getLanguage()->getCode();
        $translation = new Translation(
            $translationApplied->getLanguage(),
            $translationApplied->getTitle(),
            $translationApplied->getShortdescription(),
            $translationApplied->getLongdescription()
        );

        if (!array_key_exists($language, $this->translations)) {
            $this->translations[$language] = $translation;
        } else {
            $newTranslation = $this->translations[$language]->mergeTranslation($translation);
            $this->translations[$language] = $newTranslation;
        }
    }

    protected function applyTranslationDeleted(
        TranslationDeleted $translationDeleted
    ) {
        $language = $translationDeleted->getLanguage()->getCode();

        if (array_key_exists($language, $this->translations)) {
            unset($this->translations[$language]);
        }
    }

    protected function applyCollaborationDataAdded(
        CollaborationDataAdded $collaborationDataAdded
    ) {
        $language = $collaborationDataAdded->getLanguage()->getCode();
        $collaborationData = $collaborationDataAdded->getCollaborationData();

        if (!isset($this->collaborationData[$language])) {
            $this->collaborationData[$language] = new CollaborationDataCollection();
        }

        if ($this->collaborationData[$language]->contains($collaborationData)) {
            return;
        }

        $this->collaborationData[$language] = $this->collaborationData[$language]
            ->with($collaborationData);
    }

    public function updateWithCdbXml($cdbXml, $cdbXmlNamespaceUri)
    {
        $this->apply(
            new EventUpdatedFromUDB2(
                $this->eventId,
                $cdbXml,
                $cdbXmlNamespaceUri
            )
        );
    }
}


1		<?php
2
3		namespace CultuurNet\UDB3\Event;
4
5		use Broadway\EventSourcing\EventSourcedAggregateRoot;
6		use CultuurNet\UDB3\BookingInfo;
7		use CultuurNet\UDB3\CalendarInterface;
8		use CultuurNet\UDB3\Cdb\EventItemFactory;
9		use CultuurNet\UDB3\CollaborationDataCollection;
10		use CultuurNet\UDB3\ContactPoint;
11		use CultuurNet\UDB3\Event\Events\BookingInfoUpdated;
12		use CultuurNet\UDB3\Event\Events\ContactPointUpdated;
13		use CultuurNet\UDB3\Event\Events\DescriptionUpdated;
14		use CultuurNet\UDB3\Event\Events\EventCdbXMLInterface;
15		use CultuurNet\UDB3\Event\Events\EventCreated;
16		use CultuurNet\UDB3\Event\Events\EventCreatedFromCdbXml;
17		use CultuurNet\UDB3\Event\Events\EventDeleted;
18		use CultuurNet\UDB3\Event\Events\EventImportedFromUDB2;
19		use CultuurNet\UDB3\Event\Events\EventUpdatedFromCdbXml;
20		use CultuurNet\UDB3\Event\Events\EventUpdatedFromUDB2;
21		use CultuurNet\UDB3\Event\Events\EventWasLabelled;
22		use CultuurNet\UDB3\Event\Events\ImageAdded;
23		use CultuurNet\UDB3\Event\Events\ImageDeleted;
24		use CultuurNet\UDB3\Event\Events\ImageUpdated;
25		use CultuurNet\UDB3\Event\Events\LabelsMerged;
26		use CultuurNet\UDB3\Event\Events\CollaborationDataAdded;
27		use CultuurNet\UDB3\Event\Events\MajorInfoUpdated;
28		use CultuurNet\UDB3\Event\Events\OrganizerDeleted;
29		use CultuurNet\UDB3\Event\Events\OrganizerUpdated;
30		use CultuurNet\UDB3\Event\Events\TranslationApplied;
31		use CultuurNet\UDB3\Event\Events\TranslationDeleted;
32		use CultuurNet\UDB3\Event\Events\TypicalAgeRangeDeleted;
33		use CultuurNet\UDB3\Event\Events\TypicalAgeRangeUpdated;
34		use CultuurNet\UDB3\Event\Events\Unlabelled;
35		use CultuurNet\UDB3\EventXmlString;
36		use CultuurNet\UDB3\Label;
37		use CultuurNet\UDB3\LabelCollection;
38		use CultuurNet\UDB3\Language;
39		use CultuurNet\UDB3\CollaborationData;
40		use CultuurNet\UDB3\Location;
41		use CultuurNet\UDB3\MediaObject;
42		use CultuurNet\UDB3\Title;
43		use CultuurNet\UDB3\Translation;
44		use ValueObjects\String\String;
45
46		class Event extends EventSourcedAggregateRoot
47		{
48		protected $eventId;
49
50		/**
51		* @var LabelCollection
52		*/
53		protected $labels;
54
55		/**
56		* @var Translation[]
57		*/
58		protected $translations = [];
59
60		/**
61		* @var CollaborationDataCollection[]
62		* Array of different collections, keyed by language.
63		*/
64		protected $collaborationData;
65
66		const MAIN_LANGUAGE_CODE = 'nl';
67
68		public function __construct()
69		{
70		$this->resetLabels();
71		}
72
73		/**
74		* Factory method to create a new event.
75		*
76		* @param Title $title
77		* @param EventType $eventType
78		* @param Location $location
79		* @param CalendarBase $calendar
80		* @param Theme/null $theme
		0 ignored issues – show Documentation introduced 2015-11-24 14:42 UTC by Report Bug Copy Issue Report The doc-type `Theme/null` could not be parsed: Unknown type name "Theme/null" at position 0. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
81		*
82		* @return Event
83		*/
84		public static function create($eventId, Title $title, EventType $eventType, Location $location, CalendarInterface $calendar, $theme = null)
85		{
86		if (!is_string($eventId)) {
87		throw new \InvalidArgumentException(
88		'Expected eventId to be a string, received ' . gettype($eventId)
89		);
90		}
91		$event = new self();
92		$event->apply(new EventCreated($eventId, $title, $eventType, $location, $calendar, $theme));
93
94		return $event;
95		}
96
97		/**
98		* @param string $eventId
99		* @param string $cdbXml
100		* @param string $cdbXmlNamespaceUri
101		* @return Event
102		*/
103		public static function importFromUDB2(
104		$eventId,
105		$cdbXml,
106		$cdbXmlNamespaceUri
107		) {
108		$event = new self();
109		$event->apply(
110		new EventImportedFromUDB2(
111		$eventId,
112		$cdbXml,
113		$cdbXmlNamespaceUri
114		)
115		);
116
117		return $event;
118		}
119
120		/**
121		* @param EventXmlString $xmlString
122		* @param String $eventId
123		* @param String $cdbXmlNamespaceUri
124		* @return Event
125		*/
126		public static function createFromCdbXml(
127		String $eventId,
128		EventXmlString $xmlString,
129		String $cdbXmlNamespaceUri
130		) {
131		$event = new self();
132		$event->apply(
133		new EventCreatedFromCdbXml(
134		$eventId,
135		$xmlString,
136		$cdbXmlNamespaceUri
137		)
138		);
139
140		return $event;
141		}
142
143		/**
144		* @param String $eventId
145		* @param EventXmlString $xmlString
146		* @param String $cdbXmlNamespaceUri
147		* @return Event
148		*/
149		public function updateFromCdbXml(
150		String $eventId,
151		EventXmlString $xmlString,
152		String $cdbXmlNamespaceUri
153		) {
154		$this->apply(
155		new EventUpdatedFromCdbXml(
156		$eventId,
157		$xmlString,
158		$cdbXmlNamespaceUri
159		)
160		);
161		}
162
163		/**
164		* @param LabelCollection $labels
165		*/
166		public function mergeLabels(LabelCollection $labels)
167		{
168		if (count($labels) === 0) {
169		throw new \InvalidArgumentException(
170		'Argument $labels should contain at least one label'
171		);
172		}
173
174		$this->apply(
175		new LabelsMerged(
176		new String($this->eventId),
177		$labels
178		)
179		);
180		}
181
182		/**
183		* @param Language $language
184		* @param String\|null $title
185		* @param String\|null $shortDescription
186		* @param String\|null $longDescription
187		*/
188		public function applyTranslation(
189		Language $language,
190		String $title = null,
191		String $shortDescription = null,
192		String $longDescription = null
193		) {
194		$this->apply(
195		new TranslationApplied(
196		new String($this->eventId),
197		$language,
198		$title,
199		$shortDescription,
200		$longDescription
201		)
202		);
203		}
204
205		/**
206		* @param Language $language
207		*/
208		public function deleteTranslation(
209		Language $language
210		) {
211		if (!array_key_exists($language->getCode(), $this->translations)) {
212		return;
213		}
214
215		$this->apply(
216		new TranslationDeleted(
217		new String($this->eventId),
218		$language
219		)
220		);
221		}
222
223		/**
224		* @param Language $language
225		* @param CollaborationData $collaborationData
226		* @return bool
227		*/
228		protected function isSameCollaborationDataAlreadyPresent(
229		Language $language,
230		CollaborationData $collaborationData
231		) {
232		if (!isset($this->collaborationData[$language->getCode()])) {
233		return false;
234		}
235
236		$languageCollaborationData = $this->collaborationData[$language->getCode()];
237
238		return $languageCollaborationData->contains($collaborationData);
239		}
240
241		/**
242		* @param Language $language
243		* @param \CultuurNet\UDB3\CollaborationData $collaborationData
244		*/
245		public function addCollaborationData(
246		Language $language,
247		CollaborationData $collaborationData
248		) {
249		if ($this->isSameCollaborationDataAlreadyPresent($language, $collaborationData)) {
250		return;
251		}
252
253		$collaborationDataAdded = new CollaborationDataAdded(
254		new String($this->eventId),
255		$language,
256		$collaborationData
257		);
258
259		$this->apply($collaborationDataAdded);
260		}
261
262		/**
263		* {@inheritdoc}
264		*/
265		public function getAggregateRootId()
266		{
267		return $this->eventId;
268		}
269
270		/**
271		* @return Translation[]
272		*/
273		public function getTranslations()
274		{
275		return $this->translations;
276		}
277
278		/**
279		* @return LabelCollection
280		*/
281		public function getLabels()
282		{
283		return $this->labels;
284		}
285
286		/**
287		* @param Label $label
288		*/
289		public function label(Label $label)
290		{
291		if (!$this->labels->contains($label)) {
292		$this->apply(new EventWasLabelled($this->eventId, $label));
293		}
294		}
295
296		/**
297		* @param Label $label
298		*/
299		public function unlabel(Label $label)
300		{
301		if ($this->labels->contains($label)) {
302		$this->apply(new Unlabelled($this->eventId, $label));
303		}
304		}
305
306		protected function applyEventCreated(EventCreated $eventCreated)
307		{
308		$this->eventId = $eventCreated->getEventId();
309		}
310
311		protected function applyEventWasLabelled(EventWasLabelled $eventLabelled)
312		{
313		$newLabel = $eventLabelled->getLabel();
314
315		if (!$this->labels->contains($newLabel)) {
316		$this->labels = $this->labels->with($newLabel);
317		}
318		}
319
320		protected function applyUnlabelled(Unlabelled $unlabelled)
321		{
322		$removedLabel = $unlabelled->getLabel();
323
324		$this->labels = $this->labels->without($removedLabel);
325		}
326
327		protected function applyEventImportedFromUDB2(
328		EventImportedFromUDB2 $eventImported
329		) {
330		$this->eventId = $eventImported->getEventId();
331		$this->setUDB2Data($eventImported);
332		}
333
334		/**
335		* @param EventUpdatedFromUDB2 $eventUpdated
336		*/
337		protected function applyEventUpdatedFromUDB2(
338		EventUpdatedFromUDB2 $eventUpdated
339		) {
340		$this->setUDB2Data($eventUpdated);
341		}
342
343		/**
344		* @param EventCdbXMLInterface $eventCdbXML
345		*/
346		protected function setUDB2Data(
347		EventCdbXMLInterface $eventCdbXML
348		) {
349		$udb2Event = EventItemFactory::createEventFromCdbXml(
350		$eventCdbXML->getCdbXmlNamespaceUri(),
351		$eventCdbXML->getCdbXml()
352		);
353
354		$this->setLabelsFromUDB2Event($udb2Event);
355		}
356
357		/**
358		* @param Language $language
359		* @param string $title
360		*/
361		public function translateTitle(Language $language, $title)
362		{
363		$this->apply(new TitleTranslated($this->eventId, $language, $title));
364		}
365
366		/**
367		* @param Language $language
368		* @param string $description
369		*/
370		public function translateDescription(Language $language, $description)
371		{
372		$this->apply(
373		new DescriptionTranslated($this->eventId, $language, $description)
374		);
375		}
376
377		/**
378		* @param string $description
379		*/
380		public function updateDescription($description)
381		{
382		$this->apply(new DescriptionUpdated($this->eventId, $description));
383		}
384
385		/**
386		* @param string $typicalAgeRange
387		*/
388		public function updateTypicalAgeRange($typicalAgeRange)
389		{
390		$this->apply(new TypicalAgeRangeUpdated($this->eventId, $typicalAgeRange));
391		}
392
393		public function deleteTypicalAgeRange()
394		{
395		$this->apply(new TypicalAgeRangeDeleted($this->eventId));
396		}
397
398		/**
399		* @param string $organizerId
400		*/
401		public function updateOrganizer($organizerId)
402		{
403		$this->apply(new OrganizerUpdated($this->eventId, $organizerId));
404		}
405
406		/**
407		* Delete the given organizer.
408		*
409		* @param string $organizerId
410		*/
411		public function deleteOrganizer($organizerId)
412		{
413		$this->apply(new OrganizerDeleted($this->eventId, $organizerId));
414		}
415
416		/**
417		* Updated the contact info.
418		*
419		* @param array $phones
		0 ignored issues – show Bug introduced 2015-11-24 14:42 UTC by Report Bug Copy Issue Report There is no parameter named `$phones`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
420		* @param array $emails
		0 ignored issues – show Bug introduced 2015-11-24 14:42 UTC by Report Bug Copy Issue Report There is no parameter named `$emails`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
421		* @param array $urls
		0 ignored issues – show Bug introduced 2015-11-24 14:42 UTC by Report Bug Copy Issue Report There is no parameter named `$urls`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
422		*/
423		public function updateContactPoint(ContactPoint $contactPoint)
424		{
425		$this->apply(new ContactPointUpdated($this->eventId, $contactPoint));
426		}
427
428		/**
429		* Updated the booking info.
430		*
431		* @param BookingInfo $bookingInfo
432		*/
433		public function updateBookingInfo(BookingInfo $bookingInfo)
434		{
435		$this->apply(new BookingInfoUpdated($this->eventId, $bookingInfo));
436		}
437
438		/**
439		* Add a new image.
440		*
441		* @param MediaObject $mediaObject
442		*/
443		public function addImage(MediaObject $mediaObject)
444		{
445		$this->apply(new ImageAdded($this->eventId, $mediaObject));
446		}
447
448		/**
449		* Update an image.
450		*
451		* @param int $indexToUpdate
452		* @param MediaObject $mediaObject
453		*/
454		public function updateImage($indexToUpdate, MediaObject $mediaObject)
455		{
456		$this->apply(new ImageUpdated($this->eventId, $indexToUpdate, $mediaObject));
457		}
458
459		/**
460		* Delete an image.
461		*
462		* @param int $indexToDelete
463		* @param mixed int\|string $internalId
464		*/
465		public function deleteImage($indexToDelete, $internalId)
466		{
467		$this->apply(new ImageDeleted($this->eventId, $indexToDelete, $internalId));
468		}
469
470		/**
471		* Update the major info.
472		*
473		* @param Title $title
474		* @param EventType $eventType
475		* @param Location $location
476		* @param CalendarInterface $calendar
477		* @param type $theme
478		*/
479		public function updateMajorInfo(Title $title, EventType $eventType, Location $location, CalendarInterface $calendar, $theme = null)
480		{
481		$this->apply(new MajorInfoUpdated($this->eventId, $title, $eventType, $location, $calendar, $theme));
482		}
483
484		/**
485		* Delete this item.
486		*/
487		public function deleteEvent()
488		{
489		$this->apply(new EventDeleted($this->eventId));
490		}
491
492		/**
493		* @param \CultureFeed_Cdb_Item_Event $udb2Event
494		*/
495		protected function setLabelsFromUDB2Event(\CultureFeed_Cdb_Item_Event $udb2Event)
496		{
497		$this->resetLabels();
498
499		/** @var \CultureFeed_Cdb_Data_Keyword $udb2Keyword */
500		foreach (array_values($udb2Event->getKeywords(true)) as $udb2Keyword) {
501		$keyword = trim($udb2Keyword->getValue());
502		if ($keyword) {
503		$this->labels = $this->labels->with(
504		new Label($keyword, $udb2Keyword->isVisible())
505		);
506		}
507		}
508		}
509
510		protected function resetLabels()
511		{
512		$this->labels = new LabelCollection();
513		}
514
515		protected function applyEventCreatedFromCdbXml(
516		EventCreatedFromCdbXml $eventCreatedFromCdbXml
517		) {
518		$this->eventId = $eventCreatedFromCdbXml->getEventId()->toNative();
519
520		$udb2Event = EventItemFactory::createEventFromCdbXml(
521		$eventCreatedFromCdbXml->getCdbXmlNamespaceUri(),
522		$eventCreatedFromCdbXml->getEventXmlString()->toEventXmlString()
523		);
524
525		$this->setLabelsFromUDB2Event($udb2Event);
526		}
527
528	View Code Duplication	protected function applyEventUpdatedFromCdbXml(
		0 ignored issues – show Duplication introduced 2015-11-24 14:43 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...
529		EventUpdatedFromCdbXml $eventUpdatedFromCdbXml
530		) {
531		$this->eventId = $eventUpdatedFromCdbXml->getEventId()->toNative();
532
533		$udb2Event = EventItemFactory::createEventFromCdbXml(
534		$eventUpdatedFromCdbXml->getCdbXmlNamespaceUri(),
535		$eventUpdatedFromCdbXml->getEventXmlString()->toEventXmlString()
536		);
537
538		$this->setLabelsFromUDB2Event($udb2Event);
539		}
540
541		protected function applyLabelsMerged(
542		LabelsMerged $labelsMerged
543		) {
544		$this->labels = $this->labels->merge($labelsMerged->getLabels());
545		}
546
547		protected function applyTranslationApplied(
548		TranslationApplied $translationApplied
549		) {
550		$this->eventId = $translationApplied->getEventId()->toNative();
551
552		$language = $translationApplied->getLanguage()->getCode();
553		$translation = new Translation(
554		$translationApplied->getLanguage(),
555		$translationApplied->getTitle(),
556		$translationApplied->getShortdescription(),
557		$translationApplied->getLongdescription()
558		);
559
560		if (!array_key_exists($language, $this->translations)) {
561		$this->translations[$language] = $translation;
562		} else {
563		$newTranslation = $this->translations[$language]->mergeTranslation($translation);
564		$this->translations[$language] = $newTranslation;
565		}
566		}
567
568		protected function applyTranslationDeleted(
569		TranslationDeleted $translationDeleted
570		) {
571		$language = $translationDeleted->getLanguage()->getCode();
572
573		if (array_key_exists($language, $this->translations)) {
574		unset($this->translations[$language]);
575		}
576		}
577
578		protected function applyCollaborationDataAdded(
579		CollaborationDataAdded $collaborationDataAdded
580		) {
581		$language = $collaborationDataAdded->getLanguage()->getCode();
582		$collaborationData = $collaborationDataAdded->getCollaborationData();
583
584		if (!isset($this->collaborationData[$language])) {
585		$this->collaborationData[$language] = new CollaborationDataCollection();
586		}
587
588		if ($this->collaborationData[$language]->contains($collaborationData)) {
589		return;
590		}
591
592		$this->collaborationData[$language] = $this->collaborationData[$language]
593		->with($collaborationData);
594		}
595
596		public function updateWithCdbXml($cdbXml, $cdbXmlNamespaceUri)
597		{
598		$this->apply(
599		new EventUpdatedFromUDB2(
600		$this->eventId,
601		$cdbXml,
602		$cdbXmlNamespaceUri
603		)
604		);
605		}
606		}
607

cultuurnet / udb3-php