ManagesLists - Code Metrics - Inspection of "Wrappers to manage Contacts Lists and track Events" - testmonitor/activecampaign - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#18)

unknown

created 2020-04-28 22:05 UTC

ManagesLists A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	145
Duplicated Lines	12.41 %

Coupling/Cohesion

Components	0
Dependencies	1

Importance

Changes

Metric	Value
wmc	12
lcom	0
cbo	1
dl	18
loc	145
rs	10
c	0
b	0
f	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	lists()	0	8	1
A	getList()	0	17	4
A	findList()	0	10	1
A	createList()	0	18	2
A	deleteList()	0	4	1
A	subscribe()	9	9	1
A	unsubscribe()	9	9	1
A	contactsByList()	0	8	1

How to fix Duplicated Code

<?php

namespace TestMonitor\ActiveCampaign\Actions;

use TestMonitor\ActiveCampaign\Resources\Contact;
use TestMonitor\ActiveCampaign\Resources\ContactsList;

trait ManagesLists
{
    /**
     * Returns all lists
     *
     * @return ContactsList[]
     */
    public function lists()
    {
        return $this->transformCollection(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            $this->get('lists'),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            ContactsList::class,
            'lists'
        );
    }

    /**
     * Returns list by ID
     *
     * @param string $name
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @return ContactsList|null
     */
    public function getList($id)
    {
        try
        {
            $lists = $this->get('lists/' . $id);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

            if (isset($lists['list']) && count($lists['list']))
            {
                return new ContactsList($lists['list']);
            }
        }
        catch (\TestMonitor\ActiveCampaign\Exceptions\NotFoundException $e)

        {
        }

        return null;
    }

    /**
     * Finds list by it's name or URL-safe name
     *
     * @param string $name name of list to find
     *
     * @return null|ContactsList
     */
    public function findList($name)
    {
        $lists = $this->transformCollection(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            $this->get('lists', ['query' => ['filters[name]' => $name]]),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            ContactsList::class,
            'lists'
        );

        return array_shift($lists);
    }

    /**
     * Creates a new list
     *
     * @param string $name Name of the list to create
     * @param string $senderUrl The website URL this list is for.
     * @param array  $params other options to create list
     *
     * @return ContactsList
     */
    public function createList($name, $senderUrl, $params = [])
    {
        $params['name'] = $name;
        if (!isset($params['stringid']))
        {
            $params['stringid'] = strtolower(preg_replace('/[^A-Z0-9]+/i', '-', $name));
        }
        $params['sender_url'] = $senderUrl;
        $params['sender_reminder'] = 'You signed up for my mailing list.';

        $lists = $this->transformCollection(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            $this->post('lists', ['json' => ['list' => $params]]),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            ContactsList::class
        );

        return array_shift($lists);

    }

    /**
     * Removes list
     *
     * @param int $id ID of the list to delete
     *
     * @throws \TestMonitor\ActiveCampaign\Exceptions\NotFoundException
     */
    public function deleteList($id)
    {
        $this->delete('lists/' . $id);

    }

    /**
     * Adds contact to the list
     *
     * @param int $contactId ID of contact to add to list
     * @param int $listId    ID of list to add contact to
     */
    public function subscribe($contactId, $listId)

    {
        $this->post('contactLists', ['json' => [
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            'contactList' => [
                'list' => $listId,
                'contact' => $contactId,
                'status' => 1,
            ]]]);
    }

    /**
     * Remove contact from the list
     *
     * @param int $contactId ID of contact to remove from list
     * @param int $listId ID of list to remove contact from
     */
    public function unsubscribe($contactId, $listId)

    {
        $this->post('contactLists', ['json' => [
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            'contactList' => [
                'list' => $listId,
                'contact' => $contactId,
                'status' => 2,
            ]]]);
    }

    /**
     * Get all contacts related to the list.
     *
     * @return Contact[]
     */
    public function contactsByList($listId)
    {
        return $this->transformCollection(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            $this->get('contacts', ['query' => ['listid' => $listId]]),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            Contact::class,
            'contacts'
        );
    }
}

1		<?php
2
3		namespace TestMonitor\ActiveCampaign\Actions;
4
5		use TestMonitor\ActiveCampaign\Resources\Contact;
6		use TestMonitor\ActiveCampaign\Resources\ContactsList;
7
8		trait ManagesLists
9		{
10		/**
11		* Returns all lists
12		*
13		* @return ContactsList[]
14		*/
15		public function lists()
16		{
17		return $this->transformCollection(
		0 ignored issues – show Bug introduced 2020-04-28 22:06 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...
18		$this->get('lists'),
		0 ignored issues – show Bug introduced 2020-04-28 22:06 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...
19		ContactsList::class,
20		'lists'
21		);
22		}
23
24		/**
25		* Returns list by ID
26		*
27		* @param string $name
		0 ignored issues – show Bug introduced 2020-04-28 22:06 UTC by Report Bug Copy Issue Report There is no parameter named `$name`. 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...
28		*
29		* @return ContactsList\|null
30		*/
31		public function getList($id)
32		{
33		try
34		{
35		$lists = $this->get('lists/' . $id);
		0 ignored issues – show Bug introduced 2020-04-28 22:06 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...
36
37		if (isset($lists['list']) && count($lists['list']))
38		{
39		return new ContactsList($lists['list']);
40		}
41		}
42		catch (\TestMonitor\ActiveCampaign\Exceptions\NotFoundException $e)
		0 ignored issues – show Coding Style Comprehensibility introduced 2020-04-28 22:06 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
43		{
44		}
45
46		return null;
47		}
48
49		/**
50		* Finds list by it's name or URL-safe name
51		*
52		* @param string $name name of list to find
53		*
54		* @return null\|ContactsList
55		*/
56		public function findList($name)
57		{
58		$lists = $this->transformCollection(
		0 ignored issues – show Bug introduced 2019-08-13 13:28 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...
59		$this->get('lists', ['query' => ['filters[name]' => $name]]),
		0 ignored issues – show Bug introduced 2020-04-28 22:06 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...
60		ContactsList::class,
61		'lists'
62		);
63
64		return array_shift($lists);
65		}
66
67		/**
68		* Creates a new list
69		*
70		* @param string $name Name of the list to create
71		* @param string $senderUrl The website URL this list is for.
72		* @param array $params other options to create list
73		*
74		* @return ContactsList
75		*/
76		public function createList($name, $senderUrl, $params = [])
77		{
78		$params['name'] = $name;
79		if (!isset($params['stringid']))
80		{
81		$params['stringid'] = strtolower(preg_replace('/[^A-Z0-9]+/i', '-', $name));
82		}
83		$params['sender_url'] = $senderUrl;
84		$params['sender_reminder'] = 'You signed up for my mailing list.';
85
86		$lists = $this->transformCollection(
		0 ignored issues – show Bug introduced 2020-04-28 22:06 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...
87		$this->post('lists', ['json' => ['list' => $params]]),
		0 ignored issues – show Bug introduced 2020-04-28 22:06 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...
88		ContactsList::class
89		);
90
91		return array_shift($lists);
92
93		}
94
95		/**
96		* Removes list
97		*
98		* @param int $id ID of the list to delete
99		*
100		* @throws \TestMonitor\ActiveCampaign\Exceptions\NotFoundException
101		*/
102		public function deleteList($id)
103		{
104		$this->delete('lists/' . $id);
		0 ignored issues – show Bug introduced 2020-04-28 22:06 UTC by Report Bug Copy Issue Report The method `delete()` does not exist on `TestMonitor\ActiveCampaign\Actions\ManagesLists`. Did you maybe mean `deleteList()`? 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...
105		}
106
107		/**
108		* Adds contact to the list
109		*
110		* @param int $contactId ID of contact to add to list
111		* @param int $listId ID of list to add contact to
112		*/
113	View Code Duplication	public function subscribe($contactId, $listId)
		0 ignored issues – show Duplication introduced 2020-04-28 22:06 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...
114		{
115		$this->post('contactLists', ['json' => [
		0 ignored issues – show Bug introduced 2020-04-28 22:06 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...
116		'contactList' => [
117		'list' => $listId,
118		'contact' => $contactId,
119		'status' => 1,
120		]]]);
121		}
122
123		/**
124		* Remove contact from the list
125		*
126		* @param int $contactId ID of contact to remove from list
127		* @param int $listId ID of list to remove contact from
128		*/
129	View Code Duplication	public function unsubscribe($contactId, $listId)
		0 ignored issues – show Duplication introduced 2020-04-28 22:06 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...
130		{
131		$this->post('contactLists', ['json' => [
		0 ignored issues – show Bug introduced 2020-04-28 22:06 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...
132		'contactList' => [
133		'list' => $listId,
134		'contact' => $contactId,
135		'status' => 2,
136		]]]);
137		}
138
139		/**
140		* Get all contacts related to the list.
141		*
142		* @return Contact[]
143		*/
144		public function contactsByList($listId)
145		{
146		return $this->transformCollection(
		0 ignored issues – show Bug introduced 2020-04-28 22:06 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...
147		$this->get('contacts', ['query' => ['listid' => $listId]]),
		0 ignored issues – show Bug introduced 2019-08-12 11:56 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...
148		Contact::class,
149		'contacts'
150		);
151		}
152		}

testmonitor / activecampaign

Pull Request — master (#18)

ManagesLists A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

8 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like