Organizer - Code Metrics - Inspection of "Merge pull request #395 from cultuurnet/feature/II..." - cultuurnet/udb3-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( dc3001...f72a69 )

by Luc

created 2018-11-06 18:05 UTC

Organizer B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	482
Duplicated Lines	6.02 %

Coupling/Cohesion

Components	1
Dependencies	28

Importance

Changes

Metric	Value
wmc	49
lcom	1
cbo	28
dl	29
loc	482
rs	8.48
c	0
b	0
f	0

30 Methods

Rating	Name	Duplication	Size	Complexity
A	getAggregateRootId()	0	4	1
A	__construct()	0	9	1
A	importFromUDB2()	0	16	1
A	create()	0	14	1
A	updateWithCdbXml()	0	10	1
A	updateWebsite()	0	11	3
A	updateTitle()	0	21	3
A	updateAddress()	21	21	3
A	updateContactPoint()	0	8	2
A	addLabel()	0	6	2
A	removeLabel()	0	6	2
B	importLabels()	8	55	8
A	delete()	0	6	1
A	applyOrganizerCreated()	0	8	1
A	applyOrganizerCreatedWithUniqueWebsite()	0	10	1
A	applyOrganizerImportedFromUDB2()	0	17	1
A	applyOrganizerUpdatedFromUDB2()	0	14	1
A	applyWebsiteUpdated()	0	4	1
A	applyTitleUpdated()	0	4	1
A	applyTitleTranslated()	0	4	1
A	applyAddressUpdated()	0	4	1
A	applyAddressTranslated()	0	4	1
A	applyContactPointUpdated()	0	4	1
A	applyLabelAdded()	0	4	1
A	applyLabelRemoved()	0	4	1
A	getTitle()	0	14	2
A	setTitle()	0	4	1
A	isTitleChanged()	0	5	2
A	setAddress()	0	4	1
A	isAddressChanged()	0	5	2

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 Organizer 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 Organizer, and based on these observations, apply Extract Interface, too.

<?php

namespace CultuurNet\UDB3\Organizer;

use Broadway\EventSourcing\EventSourcedAggregateRoot;
use CultuurNet\UDB3\Address\Address;
use CultuurNet\UDB3\Cdb\ActorItemFactory;
use CultuurNet\UDB3\Cdb\UpdateableWithCdbXmlInterface;
use CultuurNet\UDB3\ContactPoint;
use CultuurNet\UDB3\Label;
use CultuurNet\UDB3\LabelAwareAggregateRoot;
use CultuurNet\UDB3\LabelCollection;
use CultuurNet\UDB3\Language;
use CultuurNet\UDB3\Model\ValueObject\Taxonomy\Label\LabelName;
use CultuurNet\UDB3\Model\ValueObject\Taxonomy\Label\Labels;
use CultuurNet\UDB3\Organizer\Events\AddressTranslated;
use CultuurNet\UDB3\Organizer\Events\AddressUpdated;
use CultuurNet\UDB3\Organizer\Events\ContactPointUpdated;
use CultuurNet\UDB3\Organizer\Events\LabelAdded;
use CultuurNet\UDB3\Organizer\Events\LabelRemoved;
use CultuurNet\UDB3\Organizer\Events\LabelsImported;
use CultuurNet\UDB3\Organizer\Events\OrganizerCreated;
use CultuurNet\UDB3\Organizer\Events\OrganizerCreatedWithUniqueWebsite;
use CultuurNet\UDB3\Organizer\Events\OrganizerDeleted;
use CultuurNet\UDB3\Organizer\Events\OrganizerImportedFromUDB2;
use CultuurNet\UDB3\Organizer\Events\OrganizerUpdatedFromUDB2;
use CultuurNet\UDB3\Organizer\Events\TitleTranslated;
use CultuurNet\UDB3\Organizer\Events\TitleUpdated;
use CultuurNet\UDB3\Organizer\Events\WebsiteUpdated;
use CultuurNet\UDB3\Title;
use ValueObjects\Web\Url;

class Organizer extends EventSourcedAggregateRoot implements UpdateableWithCdbXmlInterface, LabelAwareAggregateRoot
{
    /**
     * The actor id.
     *
     * @var string
     */
    protected $actorId;

    /**
     * @var Language
     */
    private $mainLanguage;

    /**
     * @var Url
     */
    private $website;

    /**
     * @var Title[]
     */
    private $titles;

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

    /**
     * @var ContactPoint
     */
    private $contactPoint;

    /**
     * @var LabelCollection|Label[]
     */
    private $labels;

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

    public function __construct()
    {
        // Contact points can be empty, but we only want to start recording
        // ContactPointUpdated events as soon as the organizer is updated
        // with a non-empty contact point. To enforce this we initialize the
        // aggregate state with an empty contact point.
        $this->contactPoint = new ContactPoint();
        $this->labels = new LabelCollection();
    }

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

        return $organizer;
    }

    /**
     * Factory method to create a new Organizer.
     *
     * @param string $id
     * @param Language $mainLanguage
     * @param Url $website
     * @param Title $title
     * @return Organizer
     */
    public static function create(
        $id,
        Language $mainLanguage,
        Url $website,
        Title $title
    ) {
        $organizer = new self();

        $organizer->apply(
            new OrganizerCreatedWithUniqueWebsite($id, $mainLanguage, $website, $title)
        );

        return $organizer;
    }

    /**
     * @inheritdoc
     */
    public function updateWithCdbXml($cdbXml, $cdbXmlNamespaceUri)
    {
        $this->apply(
            new OrganizerUpdatedFromUDB2(
                $this->actorId,
                $cdbXml,
                $cdbXmlNamespaceUri
            )
        );
    }

    /**
     * @param Url $website
     */
    public function updateWebsite(Url $website)
    {
        if (is_null($this->website) || !$this->website->sameValueAs($website)) {
            $this->apply(
                new WebsiteUpdated(
                    $this->actorId,
                    $website
                )
            );
        }
    }

    /**
     * @param Title $title
     * @param Language $language
     */
    public function updateTitle(
        Title $title,
        Language $language
    ) {
        if ($this->isTitleChanged($title, $language)) {
            if ($language->getCode() !== $this->mainLanguage->getCode()) {
                $event = new TitleTranslated(
                    $this->actorId,
                    $title,
                    $language
                );
            } else {
                $event = new TitleUpdated(
                    $this->actorId,
                    $title
                );
            }

            $this->apply($event);
        }
    }

    /**
     * @param Address $address
     * @param Language $language
     */
    public function updateAddress(

        Address $address,
        Language $language
    ) {
        if ($this->isAddressChanged($address, $language)) {
            if ($language->getCode() !== $this->mainLanguage->getCode()) {
                $event = new AddressTranslated(
                    $this->actorId,
                    $address,
                    $language
                );
            } else {
                $event = new AddressUpdated(
                    $this->actorId,
                    $address
                );
            }

            $this->apply($event);
        }
    }

    /**
     * @param ContactPoint $contactPoint
     */
    public function updateContactPoint(ContactPoint $contactPoint)
    {
        if (!$this->contactPoint->sameAs($contactPoint)) {
            $this->apply(
                new ContactPointUpdated($this->actorId, $contactPoint)
            );
        }
    }

    /**
     * @inheritdoc
     */
    public function addLabel(Label $label)
    {
        if (!$this->labels->contains($label)) {
            $this->apply(new LabelAdded($this->actorId, $label));
        }
    }

    /**
     * @inheritdoc
     */
    public function removeLabel(Label $label)
    {
        if ($this->labels->contains($label)) {
            $this->apply(new LabelRemoved($this->actorId, $label));
        }
    }

    /**
     * @param Labels $labels
     */
    public function importLabels(Labels $labels)
    {
        // Convert the imported labels to label collection.
        $importLabelsCollection = new LabelCollection(
            array_map(
                function (\CultuurNet\UDB3\Model\ValueObject\Taxonomy\Label\Label $label) {
                    return new Label(
                        $label->getName()->toString(),
                        $label->isVisible()
                    );
                },
                $labels->toArray()
            )
        );

        // What are the added labels?
        // Labels which are not inside the internal state but inside the imported labels
        $addedLabels = new LabelCollection();
        foreach ($importLabelsCollection->asArray() as $label) {
            if (!$this->labels->contains($label)) {
                $addedLabels = $addedLabels->with($label);
            }
        }

        // Fire a LabelsImported for all new labels.
        $importLabels = new Labels();
        foreach ($addedLabels->asArray() as $addedLabel) {

            $importLabels = $importLabels->with(
                new \CultuurNet\UDB3\Model\ValueObject\Taxonomy\Label\Label(
                    new LabelName((string) $addedLabel),
                    $addedLabel->isVisible()
                )
            );
        }
        if ($importLabels->count() > 0) {
            $this->apply(new LabelsImported(
                $this->actorId,
                $importLabels
            ));
        }

        // For each added label fire a LabelAdded event.
        foreach ($addedLabels->asArray() as $label) {
            $this->apply(new LabelAdded($this->actorId, $label));
        }

        // What are the deleted labels?
        // Labels which are inside the internal state but not inside imported labels.
        // For each deleted label fire a LabelDeleted event.
        foreach ($this->labels->asArray() as $label) {
            if (!$importLabelsCollection->contains($label)) {
                $this->apply(new LabelRemoved($this->actorId, $label));
            }
        }
    }

    public function delete()
    {
        $this->apply(
            new OrganizerDeleted($this->getAggregateRootId())
        );
    }

    /**
     * Apply the organizer created event.
     * @param OrganizerCreated $organizerCreated
     */
    protected function applyOrganizerCreated(OrganizerCreated $organizerCreated)
    {
        $this->actorId = $organizerCreated->getOrganizerId();

        $this->mainLanguage = new Language('nl');

        $this->setTitle($organizerCreated->getTitle(), $this->mainLanguage);
    }

    /**
     * Apply the organizer created event.
     * @param OrganizerCreatedWithUniqueWebsite $organizerCreated
     */
    protected function applyOrganizerCreatedWithUniqueWebsite(OrganizerCreatedWithUniqueWebsite $organizerCreated)
    {
        $this->actorId = $organizerCreated->getOrganizerId();

        $this->mainLanguage = $organizerCreated->getMainLanguage();

        $this->website = $organizerCreated->getWebsite();

        $this->setTitle($organizerCreated->getTitle(), $this->mainLanguage);
    }

    /**
     * @param OrganizerImportedFromUDB2 $organizerImported
     * @throws \CultureFeed_Cdb_ParseException
     */
    protected function applyOrganizerImportedFromUDB2(
        OrganizerImportedFromUDB2 $organizerImported
    ) {
        $this->actorId = (string) $organizerImported->getActorId();

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

        $actor = ActorItemFactory::createActorFromCdbXml(
            $organizerImported->getCdbXmlNamespaceUri(),
            $organizerImported->getCdbXml()
        );

        $this->setTitle($this->getTitle($actor), $this->mainLanguage);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}

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

    /**
     * @param OrganizerUpdatedFromUDB2 $organizerUpdatedFromUDB2
     * @throws \CultureFeed_Cdb_ParseException
     */
    protected function applyOrganizerUpdatedFromUDB2(
        OrganizerUpdatedFromUDB2 $organizerUpdatedFromUDB2
    ) {
        // Note: never change the main language on update from UDB2.

        $actor = ActorItemFactory::createActorFromCdbXml(
            $organizerUpdatedFromUDB2->getCdbXmlNamespaceUri(),
            $organizerUpdatedFromUDB2->getCdbXml()
        );

        $this->setTitle($this->getTitle($actor), $this->mainLanguage);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}

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

    /**
     * @param WebsiteUpdated $websiteUpdated
     */
    protected function applyWebsiteUpdated(WebsiteUpdated $websiteUpdated)
    {
        $this->website = $websiteUpdated->getWebsite();
    }

    /**
     * @param TitleUpdated $titleUpdated
     */
    protected function applyTitleUpdated(TitleUpdated $titleUpdated)
    {
        $this->setTitle($titleUpdated->getTitle(), $this->mainLanguage);
    }

    /**
     * @param TitleTranslated $titleTranslated
     */
    protected function applyTitleTranslated(TitleTranslated $titleTranslated)
    {
        $this->setTitle($titleTranslated->getTitle(), $titleTranslated->getLanguage());
    }

    /**
     * @param AddressUpdated $addressUpdated
     */
    protected function applyAddressUpdated(AddressUpdated $addressUpdated)
    {
        $this->setAddress($addressUpdated->getAddress(), $this->mainLanguage);
    }

    /**
     * @param AddressTranslated $addressTranslated
     */
    protected function applyAddressTranslated(AddressTranslated $addressTranslated)
    {
        $this->setAddress($addressTranslated->getAddress(), $addressTranslated->getLanguage());
    }

    /**
     * @param ContactPointUpdated $contactPointUpdated
     */
    protected function applyContactPointUpdated(ContactPointUpdated $contactPointUpdated)
    {
        $this->contactPoint = $contactPointUpdated->getContactPoint();
    }

    /**
     * @param LabelAdded $labelAdded
     */
    protected function applyLabelAdded(LabelAdded $labelAdded)
    {
        $this->labels = $this->labels->with($labelAdded->getLabel());
    }

    /**
     * @param LabelRemoved $labelRemoved
     */
    protected function applyLabelRemoved(LabelRemoved $labelRemoved)
    {
        $this->labels = $this->labels->without($labelRemoved->getLabel());
    }

    /**
     * @param \CultureFeed_Cdb_Item_Actor $actor
     * @return null|Title
     */
    private function getTitle(\CultureFeed_Cdb_Item_Actor $actor)
    {
        $details = $actor->getDetails();
        $details->rewind();

        // The first language detail found will be used to retrieve
        // properties from which in UDB3 are not any longer considered
        // to be language specific.
        if ($details->valid()) {
            return new Title($details->current()->getTitle());
        } else {
            return null;
        }
    }

    /**
     * @param Title $title
     * @param Language $language
     */
    private function setTitle(Title $title, Language $language)
    {
        $this->titles[$language->getCode()] = $title;
    }

    /**
     * @param Title $title
     * @param Language $language
     * @return bool
     */
    private function isTitleChanged(Title $title, Language $language)
    {
        return !isset($this->titles[$language->getCode()]) ||
            !$title->sameValueAs($this->titles[$language->getCode()]);
    }

    /**
     * @param Address $address
     * @param Language $language
     */
    private function setAddress(Address $address, Language $language)
    {
        $this->addresses[$language->getCode()] = $address;
    }

    /**
     * @param Address $address
     * @param Language $language
     * @return bool
     */
    private function isAddressChanged(Address $address, Language $language)
    {
        return !isset($this->addresses[$language->getCode()]) ||
            !$address->sameAs($this->addresses[$language->getCode()]);
    }
}


1		<?php
2
3		namespace CultuurNet\UDB3\Organizer;
4
5		use Broadway\EventSourcing\EventSourcedAggregateRoot;
6		use CultuurNet\UDB3\Address\Address;
7		use CultuurNet\UDB3\Cdb\ActorItemFactory;
8		use CultuurNet\UDB3\Cdb\UpdateableWithCdbXmlInterface;
9		use CultuurNet\UDB3\ContactPoint;
10		use CultuurNet\UDB3\Label;
11		use CultuurNet\UDB3\LabelAwareAggregateRoot;
12		use CultuurNet\UDB3\LabelCollection;
13		use CultuurNet\UDB3\Language;
14		use CultuurNet\UDB3\Model\ValueObject\Taxonomy\Label\LabelName;
15		use CultuurNet\UDB3\Model\ValueObject\Taxonomy\Label\Labels;
16		use CultuurNet\UDB3\Organizer\Events\AddressTranslated;
17		use CultuurNet\UDB3\Organizer\Events\AddressUpdated;
18		use CultuurNet\UDB3\Organizer\Events\ContactPointUpdated;
19		use CultuurNet\UDB3\Organizer\Events\LabelAdded;
20		use CultuurNet\UDB3\Organizer\Events\LabelRemoved;
21		use CultuurNet\UDB3\Organizer\Events\LabelsImported;
22		use CultuurNet\UDB3\Organizer\Events\OrganizerCreated;
23		use CultuurNet\UDB3\Organizer\Events\OrganizerCreatedWithUniqueWebsite;
24		use CultuurNet\UDB3\Organizer\Events\OrganizerDeleted;
25		use CultuurNet\UDB3\Organizer\Events\OrganizerImportedFromUDB2;
26		use CultuurNet\UDB3\Organizer\Events\OrganizerUpdatedFromUDB2;
27		use CultuurNet\UDB3\Organizer\Events\TitleTranslated;
28		use CultuurNet\UDB3\Organizer\Events\TitleUpdated;
29		use CultuurNet\UDB3\Organizer\Events\WebsiteUpdated;
30		use CultuurNet\UDB3\Title;
31		use ValueObjects\Web\Url;
32
33		class Organizer extends EventSourcedAggregateRoot implements UpdateableWithCdbXmlInterface, LabelAwareAggregateRoot
34		{
35		/**
36		* The actor id.
37		*
38		* @var string
39		*/
40		protected $actorId;
41
42		/**
43		* @var Language
44		*/
45		private $mainLanguage;
46
47		/**
48		* @var Url
49		*/
50		private $website;
51
52		/**
53		* @var Title[]
54		*/
55		private $titles;
56
57		/**
58		* @var Address[]\|null
59		*/
60		private $addresses;
61
62		/**
63		* @var ContactPoint
64		*/
65		private $contactPoint;
66
67		/**
68		* @var LabelCollection\|Label[]
69		*/
70		private $labels;
71
72		/**
73		* {@inheritdoc}
74		*/
75		public function getAggregateRootId()
76		{
77		return $this->actorId;
78		}
79
80		public function __construct()
81		{
82		// Contact points can be empty, but we only want to start recording
83		// ContactPointUpdated events as soon as the organizer is updated
84		// with a non-empty contact point. To enforce this we initialize the
85		// aggregate state with an empty contact point.
86		$this->contactPoint = new ContactPoint();
87		$this->labels = new LabelCollection();
88		}
89
90		/**
91		* Import from UDB2.
92		*
93		* @param string $actorId
94		* The actor id.
95		* @param string $cdbXml
96		* The cdb xml.
97		* @param string $cdbXmlNamespaceUri
98		* The cdb xml namespace uri.
99		*
100		* @return Organizer
101		* The actor.
102		*/
103		public static function importFromUDB2(
104		$actorId,
105		$cdbXml,
106		$cdbXmlNamespaceUri
107		) {
108		$organizer = new static();
109		$organizer->apply(
110		new OrganizerImportedFromUDB2(
111		$actorId,
112		$cdbXml,
113		$cdbXmlNamespaceUri
114		)
115		);
116
117		return $organizer;
118		}
119
120		/**
121		* Factory method to create a new Organizer.
122		*
123		* @param string $id
124		* @param Language $mainLanguage
125		* @param Url $website
126		* @param Title $title
127		* @return Organizer
128		*/
129		public static function create(
130		$id,
131		Language $mainLanguage,
132		Url $website,
133		Title $title
134		) {
135		$organizer = new self();
136
137		$organizer->apply(
138		new OrganizerCreatedWithUniqueWebsite($id, $mainLanguage, $website, $title)
139		);
140
141		return $organizer;
142		}
143
144		/**
145		* @inheritdoc
146		*/
147		public function updateWithCdbXml($cdbXml, $cdbXmlNamespaceUri)
148		{
149		$this->apply(
150		new OrganizerUpdatedFromUDB2(
151		$this->actorId,
152		$cdbXml,
153		$cdbXmlNamespaceUri
154		)
155		);
156		}
157
158		/**
159		* @param Url $website
160		*/
161		public function updateWebsite(Url $website)
162		{
163		if (is_null($this->website) \|\| !$this->website->sameValueAs($website)) {
164		$this->apply(
165		new WebsiteUpdated(
166		$this->actorId,
167		$website
168		)
169		);
170		}
171		}
172
173		/**
174		* @param Title $title
175		* @param Language $language
176		*/
177		public function updateTitle(
178		Title $title,
179		Language $language
180		) {
181		if ($this->isTitleChanged($title, $language)) {
182		if ($language->getCode() !== $this->mainLanguage->getCode()) {
183		$event = new TitleTranslated(
184		$this->actorId,
185		$title,
186		$language
187		);
188		} else {
189		$event = new TitleUpdated(
190		$this->actorId,
191		$title
192		);
193		}
194
195		$this->apply($event);
196		}
197		}
198
199		/**
200		* @param Address $address
201		* @param Language $language
202		*/
203	View Code Duplication	public function updateAddress(
		0 ignored issues – show Duplication introduced 2018-10-24 15:20 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...
204		Address $address,
205		Language $language
206		) {
207		if ($this->isAddressChanged($address, $language)) {
208		if ($language->getCode() !== $this->mainLanguage->getCode()) {
209		$event = new AddressTranslated(
210		$this->actorId,
211		$address,
212		$language
213		);
214		} else {
215		$event = new AddressUpdated(
216		$this->actorId,
217		$address
218		);
219		}
220
221		$this->apply($event);
222		}
223		}
224
225		/**
226		* @param ContactPoint $contactPoint
227		*/
228		public function updateContactPoint(ContactPoint $contactPoint)
229		{
230		if (!$this->contactPoint->sameAs($contactPoint)) {
231		$this->apply(
232		new ContactPointUpdated($this->actorId, $contactPoint)
233		);
234		}
235		}
236
237		/**
238		* @inheritdoc
239		*/
240		public function addLabel(Label $label)
241		{
242		if (!$this->labels->contains($label)) {
243		$this->apply(new LabelAdded($this->actorId, $label));
244		}
245		}
246
247		/**
248		* @inheritdoc
249		*/
250		public function removeLabel(Label $label)
251		{
252		if ($this->labels->contains($label)) {
253		$this->apply(new LabelRemoved($this->actorId, $label));
254		}
255		}
256
257		/**
258		* @param Labels $labels
259		*/
260		public function importLabels(Labels $labels)
261		{
262		// Convert the imported labels to label collection.
263		$importLabelsCollection = new LabelCollection(
264		array_map(
265		function (\CultuurNet\UDB3\Model\ValueObject\Taxonomy\Label\Label $label) {
266		return new Label(
267		$label->getName()->toString(),
268		$label->isVisible()
269		);
270		},
271		$labels->toArray()
272		)
273		);
274
275		// What are the added labels?
276		// Labels which are not inside the internal state but inside the imported labels
277		$addedLabels = new LabelCollection();
278		foreach ($importLabelsCollection->asArray() as $label) {
279		if (!$this->labels->contains($label)) {
280		$addedLabels = $addedLabels->with($label);
281		}
282		}
283
284		// Fire a LabelsImported for all new labels.
285		$importLabels = new Labels();
286	View Code Duplication	foreach ($addedLabels->asArray() as $addedLabel) {
		0 ignored issues – show Duplication introduced 2018-03-23 13:39 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
287		$importLabels = $importLabels->with(
288		new \CultuurNet\UDB3\Model\ValueObject\Taxonomy\Label\Label(
289		new LabelName((string) $addedLabel),
290		$addedLabel->isVisible()
291		)
292		);
293		}
294		if ($importLabels->count() > 0) {
295		$this->apply(new LabelsImported(
296		$this->actorId,
297		$importLabels
298		));
299		}
300
301		// For each added label fire a LabelAdded event.
302		foreach ($addedLabels->asArray() as $label) {
303		$this->apply(new LabelAdded($this->actorId, $label));
304		}
305
306		// What are the deleted labels?
307		// Labels which are inside the internal state but not inside imported labels.
308		// For each deleted label fire a LabelDeleted event.
309		foreach ($this->labels->asArray() as $label) {
310		if (!$importLabelsCollection->contains($label)) {
311		$this->apply(new LabelRemoved($this->actorId, $label));
312		}
313		}
314		}
315
316		public function delete()
317		{
318		$this->apply(
319		new OrganizerDeleted($this->getAggregateRootId())
320		);
321		}
322
323		/**
324		* Apply the organizer created event.
325		* @param OrganizerCreated $organizerCreated
326		*/
327		protected function applyOrganizerCreated(OrganizerCreated $organizerCreated)
328		{
329		$this->actorId = $organizerCreated->getOrganizerId();
330
331		$this->mainLanguage = new Language('nl');
332
333		$this->setTitle($organizerCreated->getTitle(), $this->mainLanguage);
334		}
335
336		/**
337		* Apply the organizer created event.
338		* @param OrganizerCreatedWithUniqueWebsite $organizerCreated
339		*/
340		protected function applyOrganizerCreatedWithUniqueWebsite(OrganizerCreatedWithUniqueWebsite $organizerCreated)
341		{
342		$this->actorId = $organizerCreated->getOrganizerId();
343
344		$this->mainLanguage = $organizerCreated->getMainLanguage();
345
346		$this->website = $organizerCreated->getWebsite();
347
348		$this->setTitle($organizerCreated->getTitle(), $this->mainLanguage);
349		}
350
351		/**
352		* @param OrganizerImportedFromUDB2 $organizerImported
353		* @throws \CultureFeed_Cdb_ParseException
354		*/
355		protected function applyOrganizerImportedFromUDB2(
356		OrganizerImportedFromUDB2 $organizerImported
357		) {
358		$this->actorId = (string) $organizerImported->getActorId();
359
360		// On import from UDB2 the default main language is 'nl'.
361		$this->mainLanguage = new Language('nl');
362
363		$actor = ActorItemFactory::createActorFromCdbXml(
364		$organizerImported->getCdbXmlNamespaceUri(),
365		$organizerImported->getCdbXml()
366		);
367
368		$this->setTitle($this->getTitle($actor), $this->mainLanguage);
		0 ignored issues – show Bug introduced 2017-06-02 18:38 UTC by Report Bug Copy Issue Report It seems like `$this->getTitle($actor)` can be `null`; however, `setTitle()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
369
370		$this->labels = LabelCollection::fromKeywords($actor->getKeywords(true));
371		}
372
373		/**
374		* @param OrganizerUpdatedFromUDB2 $organizerUpdatedFromUDB2
375		* @throws \CultureFeed_Cdb_ParseException
376		*/
377		protected function applyOrganizerUpdatedFromUDB2(
378		OrganizerUpdatedFromUDB2 $organizerUpdatedFromUDB2
379		) {
380		// Note: never change the main language on update from UDB2.
381
382		$actor = ActorItemFactory::createActorFromCdbXml(
383		$organizerUpdatedFromUDB2->getCdbXmlNamespaceUri(),
384		$organizerUpdatedFromUDB2->getCdbXml()
385		);
386
387		$this->setTitle($this->getTitle($actor), $this->mainLanguage);
		0 ignored issues – show Bug introduced 2017-06-02 18:38 UTC by Report Bug Copy Issue Report It seems like `$this->getTitle($actor)` can be `null`; however, `setTitle()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
388
389		$this->labels = LabelCollection::fromKeywords($actor->getKeywords(true));
390		}
391
392		/**
393		* @param WebsiteUpdated $websiteUpdated
394		*/
395		protected function applyWebsiteUpdated(WebsiteUpdated $websiteUpdated)
396		{
397		$this->website = $websiteUpdated->getWebsite();
398		}
399
400		/**
401		* @param TitleUpdated $titleUpdated
402		*/
403		protected function applyTitleUpdated(TitleUpdated $titleUpdated)
404		{
405		$this->setTitle($titleUpdated->getTitle(), $this->mainLanguage);
406		}
407
408		/**
409		* @param TitleTranslated $titleTranslated
410		*/
411		protected function applyTitleTranslated(TitleTranslated $titleTranslated)
412		{
413		$this->setTitle($titleTranslated->getTitle(), $titleTranslated->getLanguage());
414		}
415
416		/**
417		* @param AddressUpdated $addressUpdated
418		*/
419		protected function applyAddressUpdated(AddressUpdated $addressUpdated)
420		{
421		$this->setAddress($addressUpdated->getAddress(), $this->mainLanguage);
422		}
423
424		/**
425		* @param AddressTranslated $addressTranslated
426		*/
427		protected function applyAddressTranslated(AddressTranslated $addressTranslated)
428		{
429		$this->setAddress($addressTranslated->getAddress(), $addressTranslated->getLanguage());
430		}
431
432		/**
433		* @param ContactPointUpdated $contactPointUpdated
434		*/
435		protected function applyContactPointUpdated(ContactPointUpdated $contactPointUpdated)
436		{
437		$this->contactPoint = $contactPointUpdated->getContactPoint();
438		}
439
440		/**
441		* @param LabelAdded $labelAdded
442		*/
443		protected function applyLabelAdded(LabelAdded $labelAdded)
444		{
445		$this->labels = $this->labels->with($labelAdded->getLabel());
446		}
447
448		/**
449		* @param LabelRemoved $labelRemoved
450		*/
451		protected function applyLabelRemoved(LabelRemoved $labelRemoved)
452		{
453		$this->labels = $this->labels->without($labelRemoved->getLabel());
454		}
455
456		/**
457		* @param \CultureFeed_Cdb_Item_Actor $actor
458		* @return null\|Title
459		*/
460		private function getTitle(\CultureFeed_Cdb_Item_Actor $actor)
461		{
462		$details = $actor->getDetails();
463		$details->rewind();
464
465		// The first language detail found will be used to retrieve
466		// properties from which in UDB3 are not any longer considered
467		// to be language specific.
468		if ($details->valid()) {
469		return new Title($details->current()->getTitle());
470		} else {
471		return null;
472		}
473		}
474
475		/**
476		* @param Title $title
477		* @param Language $language
478		*/
479		private function setTitle(Title $title, Language $language)
480		{
481		$this->titles[$language->getCode()] = $title;
482		}
483
484		/**
485		* @param Title $title
486		* @param Language $language
487		* @return bool
488		*/
489		private function isTitleChanged(Title $title, Language $language)
490		{
491		return !isset($this->titles[$language->getCode()]) \|\|
492		!$title->sameValueAs($this->titles[$language->getCode()]);
493		}
494
495		/**
496		* @param Address $address
497		* @param Language $language
498		*/
499		private function setAddress(Address $address, Language $language)
500		{
501		$this->addresses[$language->getCode()] = $address;
502		}
503
504		/**
505		* @param Address $address
506		* @param Language $language
507		* @return bool
508		*/
509		private function isAddressChanged(Address $address, Language $language)
510		{
511		return !isset($this->addresses[$language->getCode()]) \|\|
512		!$address->sameAs($this->addresses[$language->getCode()]);
513		}
514		}
515

cultuurnet / udb3-php