GuestPassService::getKeysOf()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 7
Code Lines 5

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 7
rs 9.4285
c 0
b 0
f 0
cc 1
eloc 5
nc 1
nop 1
1
<?php
2
3
namespace JeroenG\GuestPass;
4
5
use Illuminate\Database\Eloquent\Model;
6
7
class GuestPassService
8
{
9
    /**
10
     * Create a new instance.
11
     */
12
    public function __construct()
13
    {
14
        // constructor body
15
    }
16
17
    /**
18
     * Register the routes.
19
     * @return void
20
     */
21
    public function routes()
22
    {
23
        $router = app('router');
24
        $router->get('gp/{owner}/{key}', 'JeroenG\GuestPass\Controllers\Access');
25
    }
26
27
    /**
28
     * Create a new Guest Pass.
29
     * @param  lluminate\Database\Eloquent\Model $owner
0 ignored issues
show
Documentation introduced by
Should the type for parameter $owner not be Model?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
30
     * @param  lluminate\Database\Eloquent\Model $object
0 ignored issues
show
Documentation introduced by
Should the type for parameter $object not be Model?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
31
     * @param  string|null                       $view   Leave out the .blade.php extension.
32
     * @return bool|Exception
33
     */
34
    public function create(Model $owner, Model $object, $view = null)
35
    {
36
        try {
37
            GuestPass::create([
0 ignored issues
show
Bug introduced by
The method create() does not exist on JeroenG\GuestPass\GuestPass. Did you maybe mean created()?

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...
38
                'key' => str_random(10),
39
                'owner_id' => $owner->id,
40
                'owner_model' => get_class($owner),
41
                'object_id' => $object->id,
42
                'object_model' => get_class($object),
43
                'view' => $view,
44
            ]);
45
46
            return true;
47
        } catch (Exception $e) {
0 ignored issues
show
Bug introduced by
The class JeroenG\GuestPass\Exception does not exist. Did you forget a USE statement, or did you not list all dependencies?

Scrutinizer analyzes your composer.json/composer.lock file if available to determine the classes, and functions that are defined by your dependencies.

It seems like the listed class was neither found in your dependencies, nor was it found in the analyzed files in your repository. If you are using some other form of dependency management, you might want to disable this analysis.

Loading history...
48
            return false;
49
        }
50
    }
51
52
    /**
53
     * Check if the given user created the Guest Pass.
54
     * @param  lluminate\Database\Eloquent\Model $owner
0 ignored issues
show
Documentation introduced by
Should the type for parameter $owner not be Model?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
55
     * @param  lluminate\Database\Eloquent\Model $guestpass
0 ignored issues
show
Documentation introduced by
Should the type for parameter $guestpass not be Model?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
56
     * @return bool
57
     */
58
    public function isOwner(Model $owner, Model $guestpass)
59
    {
60
        return $owner->id == $guestpass->owner_id;
61
    }
62
63
    /**
64
     * Get all keys belonging to the owner.
65
     * @param  lluminate\Database\Eloquent\Model  $owner
0 ignored issues
show
Documentation introduced by
Should the type for parameter $owner not be Model?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
66
     * @return array
67
     */
68
    public function getKeysOf(Model $owner)
69
    {
70
        return GuestPass::where([
71
            'owner_id' => $owner->id,
72
            'owner_model' => get_class($owner),
73
        ])->get()->keyBy('key');
74
    }
75
76
    /**
77
     * Find (or fail) the Guest Pass belonging to an owner-object pairing.
78
     * @param  lluminate\Database\Eloquent\Model                $owner
79
     * @param  lluminate\Database\Eloquent\Model                $object
0 ignored issues
show
Documentation introduced by
Should the type for parameter $object not be Model?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
80
     * @return lluminate\Database\Eloquent\Collection|Exception
81
     */
82
    public function findGuestPass(Model $owner, Model $object)
83
    {
84
        return GuestPass::where([
85
            'owner_id' => $owner->id,
86
            'owner_model' => get_class($owner),
87
            'object_id' => $object->id,
88
            'object_model' => get_class($object),
89
        ])->firstOrFail();
90
    }
91
92
    /**
93
     * Get a Guest Pass by its key (or fail).
94
     * @param  string                                      $key
95
     * @return lluminate\Database\Eloquent\Model|Exception
96
     */
97
    public function getGuestPass($key)
98
    {
99
        return GuestPass::where('key', $key)->firstOrFail();
100
    }
101
}
102