Impersonable::getImpersonatingId()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 1 Features 0
Metric Value
c 1
b 1
f 0
dl 0
loc 4
rs 10
cc 1
eloc 2
nc 1
nop 0
1
<?php
2
3
namespace LaraComponents\Impersonation\Traits;
4
5
use Illuminate\Support\Facades\Session;
6
7
trait Impersonable
8
{
9
    /**
10
     * Start impersonating this user.
11
     *
12
     * @return $this
13
     */
14
    public function impersonate()
15
    {
16
        Session::put($this->getImpersonatingKey(), $this->getKey());
0 ignored issues
show
Bug introduced by
It seems like getKey() 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...
17
18
        return $this;
19
    }
20
21
    /**
22
     * Stop impersonating.
23
     *
24
     * @return $this
25
     */
26
    public function unimpersonate()
27
    {
28
        Session::forget($this->getImpersonatingKey());
29
30
        return $this;
31
    }
32
33
    /**
34
     * Check if user is impersonating.
35
     *
36
     * @return bool
37
     */
38
    public function isImpersonating()
39
    {
40
        return Session::has($this->getImpersonatingKey());
41
    }
42
43
    /**
44
     * Get impersonating user id.
45
     *
46
     * @return int
47
     */
48
    public function getImpersonatingId()
49
    {
50
        return Session::get($this->getImpersonatingKey());
51
    }
52
53
    /**
54
     * Get impersonating key.
55
     *
56
     * @return string
57
     */
58
    public function getImpersonatingKey()
59
    {
60
        return 'impersonate_id';
61
    }
62
}
63