BoardInvites - Code Metrics - Inspection of "Merge pull request #301 from seregazhuk/develop" - seregazhuk/php-pinterest-bot - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 4a1452...eedec2 )

by Sergey

created 2017-07-19 18:47 UTC

BoardInvites A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	133
Duplicated Lines	15.04 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

Metric	Value
dl	20
loc	133
rs	10
c	0
b	0
f	0
wmc	14
lcom	1
cbo	1

9 Methods

Rating	Name	Duplication	Size	Complexity
A	requiresLoginForBoardInvites()	0	10	1
A	invites()	0	11	2
A	sendInviteByEmail()	10	10	2
A	sendInvite()	0	10	3
A	sendInviteByUserId()	10	10	2
A	deleteInvite()	0	11	1
A	ignoreInvite()	0	4	1
A	acceptInvite()	0	4	1
A	makeInviteCall()	0	9	1

How to fix Duplicated Code

<?php

namespace seregazhuk\PinterestBot\Api\Traits;

use seregazhuk\PinterestBot\Helpers\UrlBuilder;

trait BoardInvites
{
    use HandlesRequest;

    /**
     * @return array
     */
    protected function requiresLoginForBoardInvites() {
        return [
            'sendInvite',
            'sendInviteByEmail',
            'sendInviteByUserId',
            'deleteInvite',
            'acceptInvite',
            'invites',
        ];
    }

    /**
     * Get boards invites
     * @return array
     */
    public function invites()
    {
        $data = [
            'current_user' => true,
            'field_set_key' => 'news',
        ];

        $invites = $this->get($data, UrlBuilder::RESOURCE_BOARDS_INVITES);

        return !$invites ? [] : $invites;
    }

    /**
     * @param string $boardId
     * @param string|array $emails
     * @return bool
     */
    public function sendInviteByEmail($boardId, $emails)

    {
        $emails = is_array($emails) ? $emails : [$emails];
        $data = [
            "board_id" => $boardId,
            "emails" => $emails,
        ];

        return $this->post($data, UrlBuilder::RESOURCE_CREATE_EMAIL_INVITE);
    }

    /**
     * @param string $boardId
     * @param string|array $users
     * @return bool
     */
    public function sendInvite($boardId, $users)
    {
        $users = is_array($users) ? $users : [$users];

        $isEmail = filter_var($users[0], FILTER_VALIDATE_EMAIL);

        return $isEmail ?
            $this->sendInviteByEmail($boardId, $users) :
            $this->sendInviteByUserId($boardId, $users);
    }

    /**
     * @param string $boardId
     * @param string|array $userIds
     * @return bool
     */
    public function sendInviteByUserId($boardId, $userIds)

    {
        $userIds = is_array($userIds) ? $userIds : [$userIds];
        $data = [
            "board_id"         => $boardId,
            "invited_user_ids" => $userIds,
        ];

        return $this->post($data, UrlBuilder::RESOURCE_CREATE_USER_ID_INVITE);
    }

    /**
     * @param string $boardId
     * @param string $userId
     * @param bool $ban
     * @return bool
     */
    public function deleteInvite($boardId, $userId, $ban = false)
    {
        $data = [
            'ban'             => $ban,
            'board_id'        => $boardId,
            'field_set_key'   => 'boardEdit',
            'invited_user_id' => $userId,
        ];

        return $this->post($data, UrlBuilder::RESOURCE_DELETE_INVITE);
    }

    /**
     * @param string $boardId
     * @return bool
     */
    public function ignoreInvite($boardId)
    {
        return $this->makeInviteCall($boardId, UrlBuilder::RESOURCE_DELETE_INVITE);
    }

    /**
     * @param string $boardId
     * @return bool
     */
    public function acceptInvite($boardId)
    {
        return $this->makeInviteCall($boardId, UrlBuilder::RESOURCE_ACCEPT_INVITE);
    }

    /**
     * @param string $boardId
     * @param string $endpoint
     * @return bool
     */
    protected function makeInviteCall($boardId, $endpoint)
    {
        $data = [
            'board_id'        => $boardId,
            'invited_user_id' => $this->container->user->id(),
class MyClass { }

$x = new MyClass();
$x->foo = true;
        ];

        return $this->post($data, $endpoint);
    }
}

1		<?php
2
3		namespace seregazhuk\PinterestBot\Api\Traits;
4
5		use seregazhuk\PinterestBot\Helpers\UrlBuilder;
6
7		trait BoardInvites
8		{
9		use HandlesRequest;
10
11		/**
12		* @return array
13		*/
14		protected function requiresLoginForBoardInvites() {
15		return [
16		'sendInvite',
17		'sendInviteByEmail',
18		'sendInviteByUserId',
19		'deleteInvite',
20		'acceptInvite',
21		'invites',
22		];
23		}
24
25		/**
26		* Get boards invites
27		* @return array
28		*/
29		public function invites()
30		{
31		$data = [
32		'current_user' => true,
33		'field_set_key' => 'news',
34		];
35
36		$invites = $this->get($data, UrlBuilder::RESOURCE_BOARDS_INVITES);
37
38		return !$invites ? [] : $invites;
39		}
40
41		/**
42		* @param string $boardId
43		* @param string\|array $emails
44		* @return bool
45		*/
46	View Code Duplication	public function sendInviteByEmail($boardId, $emails)
		0 ignored issues – show Duplication introduced 2017-07-02 07:07 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...
47		{
48		$emails = is_array($emails) ? $emails : [$emails];
49		$data = [
50		"board_id" => $boardId,
51		"emails" => $emails,
52		];
53
54		return $this->post($data, UrlBuilder::RESOURCE_CREATE_EMAIL_INVITE);
55		}
56
57		/**
58		* @param string $boardId
59		* @param string\|array $users
60		* @return bool
61		*/
62		public function sendInvite($boardId, $users)
63		{
64		$users = is_array($users) ? $users : [$users];
65
66		$isEmail = filter_var($users[0], FILTER_VALIDATE_EMAIL);
67
68		return $isEmail ?
69		$this->sendInviteByEmail($boardId, $users) :
70		$this->sendInviteByUserId($boardId, $users);
71		}
72
73		/**
74		* @param string $boardId
75		* @param string\|array $userIds
76		* @return bool
77		*/
78	View Code Duplication	public function sendInviteByUserId($boardId, $userIds)
		0 ignored issues – show Duplication introduced 2017-07-02 07:07 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...
79		{
80		$userIds = is_array($userIds) ? $userIds : [$userIds];
81		$data = [
82		"board_id" => $boardId,
83		"invited_user_ids" => $userIds,
84		];
85
86		return $this->post($data, UrlBuilder::RESOURCE_CREATE_USER_ID_INVITE);
87		}
88
89		/**
90		* @param string $boardId
91		* @param string $userId
92		* @param bool $ban
93		* @return bool
94		*/
95		public function deleteInvite($boardId, $userId, $ban = false)
96		{
97		$data = [
98		'ban' => $ban,
99		'board_id' => $boardId,
100		'field_set_key' => 'boardEdit',
101		'invited_user_id' => $userId,
102		];
103
104		return $this->post($data, UrlBuilder::RESOURCE_DELETE_INVITE);
105		}
106
107		/**
108		* @param string $boardId
109		* @return bool
110		*/
111		public function ignoreInvite($boardId)
112		{
113		return $this->makeInviteCall($boardId, UrlBuilder::RESOURCE_DELETE_INVITE);
114		}
115
116		/**
117		* @param string $boardId
118		* @return bool
119		*/
120		public function acceptInvite($boardId)
121		{
122		return $this->makeInviteCall($boardId, UrlBuilder::RESOURCE_ACCEPT_INVITE);
123		}
124
125		/**
126		* @param string $boardId
127		* @param string $endpoint
128		* @return bool
129		*/
130		protected function makeInviteCall($boardId, $endpoint)
131		{
132		$data = [
133		'board_id' => $boardId,
134		'invited_user_id' => $this->container->user->id(),
		0 ignored issues – show Bug introduced 2017-07-02 07:07 UTC by Report Bug Copy Issue Report The property `container` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
135		];
136
137		return $this->post($data, $endpoint);
138		}
139		}

seregazhuk / php-pinterest-bot

Push — master ( 4a1452...eedec2 )

BoardInvites A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

9 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like