HasUsers::removeUser()   A
last analyzed

Complexity

Conditions 2
Paths 1

Size

Total Lines 4

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 2
nc 1
nop 1
dl 0
loc 4
rs 10
c 0
b 0
f 0
1
<?php
2
3
namespace Chriscreates\Projects\Traits;
4
5
use Illuminate\Database\Eloquent\Relations\BelongsToMany;
6
7
trait HasUsers
8
{
9
    /**
10
     * @return Illuminate\Database\Eloquent\Relations\BelongsToMany
11
     */
12
    public function users() : BelongsToMany
13
    {
14
        return $this->belongsToMany(
0 ignored issues
show
Bug introduced by
It seems like belongsToMany() 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...
15
            get_class(user_model()),
16
            'project_users',
17
            'user_id',
18
            'project_id'
19
        );
20
    }
21
22
    /**
23
     * Add a user to the current Project.
24
     *
25
     * @param  string|int|\Illuminate\Database\Eloquent\Model $user
26
     * @param  array                   $pivot_columns
27
     * @return self
28
     */
29
    public function addUser($user, array $pivot_columns = []) : self
30
    {
31
        return $this->addUsers([$user], $pivot_columns);
32
    }
33
34
    /**
35
     * Add one or multiple users to the current Project.
36
     *
37
     * @param  array                   $users
38
     * @param  array                   $pivot_columns
39
     * @return self
40
     */
41 View Code Duplication
    public function addUsers(array $users = [], array $pivot_columns = []) : self
0 ignored issues
show
Duplication introduced by
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...
42
    {
43
        $keyed = collect($users)
44
        ->mapWithKeys(function ($user) use ($pivot_columns) {
45
            return [
46
                is_a($user, user_model()) ? $user->id : $user => $pivot_columns,
47
            ];
48
        })->toArray();
49
50
        $this->users()->syncWithoutDetaching($keyed);
51
52
        $this->load('users');
0 ignored issues
show
Bug introduced by
It seems like load() 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...
53
54
        $this->refresh('users');
0 ignored issues
show
Bug introduced by
It seems like refresh() 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...
55
56
        return $this;
57
    }
58
59
    /**
60
     * Remove the given user from the current Project
61
     *
62
     * @param  string|int|\Illuminate\Database\Eloquent\Model $user
63
     * @return self
64
     */
65
    public function removeUser($user) : self
66
    {
67
        return $this->users()->detach(is_a($user, user_model()) ? $user->id : $user);
68
    }
69
70
    /**
71
     * Remove one or multiple users from the current Project
72
     *
73
     * @param  array                   $users
74
     * @return self
75
     */
76 View Code Duplication
    public function removeUsers(array $users = []) : self
0 ignored issues
show
Duplication introduced by
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...
77
    {
78
        $keyed = collect($users)
79
        ->map(function ($user) {
80
            return is_a($user, user_model()) ? $user->id : $user;
81
        })->toArray();
82
83
        $this->users()->detach($keyed);
84
85
        $this->load('users');
0 ignored issues
show
Bug introduced by
It seems like load() 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...
86
87
        $this->refresh('users');
0 ignored issues
show
Bug introduced by
It seems like refresh() 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
89
        return $this;
90
    }
91
92
    /**
93
     * Check if the given user is on the current Project
94
     *
95
     * @param  string|int|\Illuminate\Database\Eloquent\Model $user
96
     * @return bool
97
     */
98
    public function hasUser($user) : bool
99
    {
100
        return $this->users->contains('id', is_a($user, user_model()) ? $user->id : $user);
0 ignored issues
show
Bug introduced by
The property users 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...
101
    }
102
}
103