ManagesContacts - Code Metrics - Inspection of "Additional Contact methods" - testmonitor/activecampaign - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#17)

by Pablo

created 2019-12-06 01:36 UTC

ManagesContacts A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	224
Duplicated Lines	12.5 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

Metric	Value
wmc	19
lcom	1
cbo	3
dl	28
loc	224
rs	10
c	0
b	0
f	0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	contacts()	0	8	1
A	findContact()	0	10	1
A	findContactById()	0	5	1
A	createContact()	0	9	1
A	findOrCreateContact()	0	10	2
A	updateContact()	0	8	1
A	deleteContact()	0	4	1
A	contactAutomations()	0	8	1
A	contactTags()	0	8	1
A	removeAutomationFromContact()	14	14	2
A	removeAllAutomationsFromContact()	0	8	2
A	removeTagFromContact()	14	14	2
A	getContactId()	0	12	3

How to fix Duplicated Code

<?php

namespace TestMonitor\ActiveCampaign\Actions;

use TestMonitor\ActiveCampaign\Resources\Tag;
use TestMonitor\ActiveCampaign\Resources\Contact;
use TestMonitor\ActiveCampaign\Resources\Automation;
use TestMonitor\ActiveCampaign\Resources\ContactTag;
use TestMonitor\ActiveCampaign\Resources\ContactAutomation;

trait ManagesContacts
{
    /**
     * Get all contacts.
     *
     * @return array
     */
    public function contacts()
    {
        return $this->transformCollection(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            $this->get('contacts'),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            Contact::class,
            'contacts'
        );
    }

    /**
     * Find contact by email.
     *
     * @param string $email
     *
     * @return Contact|null
     */
    public function findContact($email)
    {
        $contacts = $this->transformCollection(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            $this->get('contacts', ['query' => ['email' => $email]]),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            Contact::class,
            'contacts'
        );

        return array_shift($contacts);
    }

    /**
     * Find contact by ID.
     *
     * @param int $id
     *
     * @return Contact|null
     */
    public function findContactById($id)
    {
        $contact = (object) $this->get('contacts/'.$id);
        return new Contact($contact->contact);
    }

    /**
     * Create new contact.
     *
     * @param string $email
     * @param string $firstName
     * @param string $lastName
     * @param int|null $orgid
     *
     * @return Contact|null
     */
    public function createContact($email, $firstName, $lastName, $orgid = null)
    {
        $contacts = $this->transformCollection(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            $this->post('contacts', ['json' => ['contact' => compact('email', 'firstName', 'lastName', 'orgid')]]),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            Contact::class
        );

        return array_shift($contacts);
    }

    /**
     * Find or create a contact.
     *
     * @param string $email
     * @param string $firstName
     * @param string $lastName
     * @param int|null $orgid
     *
     * @return Contact
     */
    public function findOrCreateContact($email, $firstName, $lastName, $orgid = null)
    {
        $contact = $this->findContact($email);

        if ($contact instanceof Contact) {
            return $contact;
        }

        return $this->createContact($email, $firstName, $lastName, $orgid);
    }

    /**
     * Updates a contact.
     *
     * @param Contact|int|string $id
     * @param string|null        $email
     * @param string|null        $firstName
     * @param string|null        $lastName
     * @param null               $orgid
     *
     * @return Contact|null
     */
    public function updateContact($id, $email, $firstName, $lastName, $orgid = null)
    {
        $id = $this->getContactId($id);

        $this->put('contacts/'.$id, ['json' => ['contact' => compact('email', 'firstName', 'lastName', 'orgid')]]);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        return $this->findContactById($id);
    }

    /**
     * Deletes a contact.
     *
     * @param Contact|int|string $contact
     */
    public function deleteContact($contact)
    {
        $this->delete('contacts/'.$this->getContactId($contact));

    }

    /**
     * Get all automations of a contact.
     *
     * @param \TestMonitor\ActiveCampaign\Resources\Contact $contact
     *
     * @return array
     */
    public function contactAutomations(Contact $contact)
    {
        return $this->transformCollection(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            $this->get("contacts/{$contact->id}/contactAutomations"),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            ContactAutomation::class,
            'contactAutomations'
        );
    }

    /**
     * Get all tags of a contact.
     *
     * @param \TestMonitor\ActiveCampaign\Resources\Contact $contact
     *
     * @return array
     */
    public function contactTags(Contact $contact)
    {
        return $this->transformCollection(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            $this->get("contacts/{$contact->id}/contactTags"),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            ContactTag::class,
            'contactTags'
        );
    }

    /**
     * Removing a automation from a contact.
     *
     * @param \TestMonitor\ActiveCampaign\Resources\Contact $contact
     * @param \TestMonitor\ActiveCampaign\Resources\Automation $automation
     */
    public function removeAutomationFromContact(Contact $contact, Automation $automation)

    {
        $contactAutomations = $this->contactAutomations($contact);

        $contactAutomation = current(array_filter($contactAutomations, function ($contactAutomation) use ($automation) {
            return $contactAutomation->automation == $automation->id;
        }));

        if (empty($contactAutomation)) {
            return;
        }

        $this->delete("contactAutomations/{$contactAutomation->id}");

    }

    /**
     * Removing all automations from a contact.
     *
     * @param \TestMonitor\ActiveCampaign\Resources\Contact $contact
     */
    public function removeAllAutomationsFromContact(Contact $contact)
    {
        $contactAutomations = $this->contactAutomations($contact);

        foreach ($contactAutomations as $contactAutomation) {
            $this->delete("contactAutomations/{$contactAutomation->id}");

        }
    }

    /**
     * Removing a tag from a contact.
     *
     * @param \TestMonitor\ActiveCampaign\Resources\Contact $contact
     * @param \TestMonitor\ActiveCampaign\Resources\Tag $tag
     */
    public function removeTagFromContact(Contact $contact, Tag $tag)

    {
        $contactTags = $this->contactTags($contact);

        $contactTag = current(array_filter($contactTags, function ($contactTag) use ($tag) {
            return $contactTag->tag == $tag->id;
        }));

        if (empty($contactTag)) {
            return;
        }

        $this->delete("contactTags/{$contactTag->id}");

    }

    /**
     * Determines the contact ID.
     *
     * @param Contact|int|string $contact
     */
    protected function getContactId($contact)
    {
        if ($contact instanceof Contact) {
            return $contact->id;
        } elseif (is_numeric($contact)) {
            return (int) $contact;
        } else {
            $contact = $this->findContact($contact);

            return $contact->id;
        }
    }
}


1		<?php
2
3		namespace TestMonitor\ActiveCampaign\Actions;
4
5		use TestMonitor\ActiveCampaign\Resources\Tag;
6		use TestMonitor\ActiveCampaign\Resources\Contact;
7		use TestMonitor\ActiveCampaign\Resources\Automation;
8		use TestMonitor\ActiveCampaign\Resources\ContactTag;
9		use TestMonitor\ActiveCampaign\Resources\ContactAutomation;
10
11		trait ManagesContacts
12		{
13		/**
14		* Get all contacts.
15		*
16		* @return array
17		*/
18		public function contacts()
19		{
20		return $this->transformCollection(
		0 ignored issues – show Bug introduced 2019-07-15 14:12 UTC by Report Bug Copy Issue Report It seems like `transformCollection()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
21		$this->get('contacts'),
		0 ignored issues – show Bug introduced 2019-07-15 14:12 UTC by Report Bug Copy Issue Report It seems like `get()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
22		Contact::class,
23		'contacts'
24		);
25		}
26
27		/**
28		* Find contact by email.
29		*
30		* @param string $email
31		*
32		* @return Contact\|null
33		*/
34		public function findContact($email)
35		{
36		$contacts = $this->transformCollection(
		0 ignored issues – show Bug introduced 2019-07-15 14:12 UTC by Report Bug Copy Issue Report It seems like `transformCollection()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
37		$this->get('contacts', ['query' => ['email' => $email]]),
		0 ignored issues – show Bug introduced 2019-07-15 14:12 UTC by Report Bug Copy Issue Report It seems like `get()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
38		Contact::class,
39		'contacts'
40		);
41
42		return array_shift($contacts);
43		}
44
45		/**
46		* Find contact by ID.
47		*
48		* @param int $id
49		*
50		* @return Contact\|null
51		*/
52		public function findContactById($id)
53		{
54		$contact = (object) $this->get('contacts/'.$id);
55		return new Contact($contact->contact);
56		}
57
58		/**
59		* Create new contact.
60		*
61		* @param string $email
62		* @param string $firstName
63		* @param string $lastName
64		* @param int\|null $orgid
65		*
66		* @return Contact\|null
67		*/
68		public function createContact($email, $firstName, $lastName, $orgid = null)
69		{
70		$contacts = $this->transformCollection(
		0 ignored issues – show Bug introduced 2019-08-12 11:56 UTC by Report Bug Copy Issue Report It seems like `transformCollection()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
71		$this->post('contacts', ['json' => ['contact' => compact('email', 'firstName', 'lastName', 'orgid')]]),
		0 ignored issues – show Bug introduced 2019-07-15 14:12 UTC by Report Bug Copy Issue Report It seems like `post()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
72		Contact::class
73		);
74
75		return array_shift($contacts);
76		}
77
78		/**
79		* Find or create a contact.
80		*
81		* @param string $email
82		* @param string $firstName
83		* @param string $lastName
84		* @param int\|null $orgid
85		*
86		* @return Contact
87		*/
88		public function findOrCreateContact($email, $firstName, $lastName, $orgid = null)
89		{
90		$contact = $this->findContact($email);
91
92		if ($contact instanceof Contact) {
93		return $contact;
94		}
95
96		return $this->createContact($email, $firstName, $lastName, $orgid);
97		}
98
99		/**
100		* Updates a contact.
101		*
102		* @param Contact\|int\|string $id
103		* @param string\|null $email
104		* @param string\|null $firstName
105		* @param string\|null $lastName
106		* @param null $orgid
107		*
108		* @return Contact\|null
109		*/
110		public function updateContact($id, $email, $firstName, $lastName, $orgid = null)
111		{
112		$id = $this->getContactId($id);
113
114		$this->put('contacts/'.$id, ['json' => ['contact' => compact('email', 'firstName', 'lastName', 'orgid')]]);
		0 ignored issues – show Bug introduced 2019-08-12 12:16 UTC by Report Bug Copy Issue Report It seems like `put()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
115
116		return $this->findContactById($id);
117		}
118
119		/**
120		* Deletes a contact.
121		*
122		* @param Contact\|int\|string $contact
123		*/
124		public function deleteContact($contact)
125		{
126		$this->delete('contacts/'.$this->getContactId($contact));
		0 ignored issues – show Bug introduced 2019-08-13 13:28 UTC by Report Bug Copy Issue Report The method `delete()` does not exist on `TestMonitor\ActiveCampaign\Actions\ManagesContacts`. Did you maybe mean `deleteContact()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
127		}
128
129		/**
130		* Get all automations of a contact.
131		*
132		* @param \TestMonitor\ActiveCampaign\Resources\Contact $contact
133		*
134		* @return array
135		*/
136		public function contactAutomations(Contact $contact)
137		{
138		return $this->transformCollection(
		0 ignored issues – show Bug introduced 2019-07-15 14:12 UTC by Report Bug Copy Issue Report It seems like `transformCollection()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
139		$this->get("contacts/{$contact->id}/contactAutomations"),
		0 ignored issues – show Bug introduced 2019-07-15 14:12 UTC by Report Bug Copy Issue Report It seems like `get()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
140		ContactAutomation::class,
141		'contactAutomations'
142		);
143		}
144
145		/**
146		* Get all tags of a contact.
147		*
148		* @param \TestMonitor\ActiveCampaign\Resources\Contact $contact
149		*
150		* @return array
151		*/
152		public function contactTags(Contact $contact)
153		{
154		return $this->transformCollection(
		0 ignored issues – show Bug introduced 2019-07-15 14:12 UTC by Report Bug Copy Issue Report It seems like `transformCollection()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
155		$this->get("contacts/{$contact->id}/contactTags"),
		0 ignored issues – show Bug introduced 2019-07-15 14:12 UTC by Report Bug Copy Issue Report It seems like `get()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
156		ContactTag::class,
157		'contactTags'
158		);
159		}
160
161		/**
162		* Removing a automation from a contact.
163		*
164		* @param \TestMonitor\ActiveCampaign\Resources\Contact $contact
165		* @param \TestMonitor\ActiveCampaign\Resources\Automation $automation
166		*/
167	View Code Duplication	public function removeAutomationFromContact(Contact $contact, Automation $automation)
		0 ignored issues – show Duplication introduced 2019-07-15 14:12 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...
168		{
169		$contactAutomations = $this->contactAutomations($contact);
170
171		$contactAutomation = current(array_filter($contactAutomations, function ($contactAutomation) use ($automation) {
172		return $contactAutomation->automation == $automation->id;
173		}));
174
175		if (empty($contactAutomation)) {
176		return;
177		}
178
179		$this->delete("contactAutomations/{$contactAutomation->id}");
		0 ignored issues – show Bug introduced 2019-08-13 13:28 UTC by Report Bug Copy Issue Report The method `delete()` does not exist on `TestMonitor\ActiveCampaign\Actions\ManagesContacts`. Did you maybe mean `deleteContact()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
180		}
181
182		/**
183		* Removing all automations from a contact.
184		*
185		* @param \TestMonitor\ActiveCampaign\Resources\Contact $contact
186		*/
187		public function removeAllAutomationsFromContact(Contact $contact)
188		{
189		$contactAutomations = $this->contactAutomations($contact);
190
191		foreach ($contactAutomations as $contactAutomation) {
192		$this->delete("contactAutomations/{$contactAutomation->id}");
		0 ignored issues – show Bug introduced 2019-08-13 13:28 UTC by Report Bug Copy Issue Report The method `delete()` does not exist on `TestMonitor\ActiveCampaign\Actions\ManagesContacts`. Did you maybe mean `deleteContact()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
193		}
194		}
195
196		/**
197		* Removing a tag from a contact.
198		*
199		* @param \TestMonitor\ActiveCampaign\Resources\Contact $contact
200		* @param \TestMonitor\ActiveCampaign\Resources\Tag $tag
201		*/
202	View Code Duplication	public function removeTagFromContact(Contact $contact, Tag $tag)
		0 ignored issues – show Duplication introduced 2019-07-15 14:12 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...
203		{
204		$contactTags = $this->contactTags($contact);
205
206		$contactTag = current(array_filter($contactTags, function ($contactTag) use ($tag) {
207		return $contactTag->tag == $tag->id;
208		}));
209
210		if (empty($contactTag)) {
211		return;
212		}
213
214		$this->delete("contactTags/{$contactTag->id}");
		0 ignored issues – show Bug introduced 2019-08-13 13:28 UTC by Report Bug Copy Issue Report The method `delete()` does not exist on `TestMonitor\ActiveCampaign\Actions\ManagesContacts`. Did you maybe mean `deleteContact()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
215		}
216
217		/**
218		* Determines the contact ID.
219		*
220		* @param Contact\|int\|string $contact
221		*/
222		protected function getContactId($contact)
223		{
224		if ($contact instanceof Contact) {
225		return $contact->id;
226		} elseif (is_numeric($contact)) {
227		return (int) $contact;
228		} else {
229		$contact = $this->findContact($contact);
230
231		return $contact->id;
232		}
233		}
234		}
235

testmonitor / activecampaign

Pull Request — master (#17)

ManagesContacts A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

13 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like