1 | <?php |
||
7 | class GuestPassService |
||
8 | { |
||
9 | /** |
||
10 | * Create a new instance. |
||
11 | */ |
||
12 | public function __construct() |
||
16 | |||
17 | /** |
||
18 | * Register the routes. |
||
19 | * @return void |
||
20 | */ |
||
21 | public function routes() |
||
26 | |||
27 | /** |
||
28 | * Create a new Guest Pass. |
||
29 | * @param lluminate\Database\Eloquent\Model $owner |
||
|
|||
30 | * @param lluminate\Database\Eloquent\Model $object |
||
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) |
||
51 | |||
52 | /** |
||
53 | * Check if the given user created the Guest Pass. |
||
54 | * @param lluminate\Database\Eloquent\Model $owner |
||
55 | * @param lluminate\Database\Eloquent\Model $guestpass |
||
56 | * @return bool |
||
57 | */ |
||
58 | public function isOwner(Model $owner, Model $guestpass) |
||
62 | |||
63 | /** |
||
64 | * Get all keys belonging to the owner. |
||
65 | * @param lluminate\Database\Eloquent\Model $owner |
||
66 | * @return array |
||
67 | */ |
||
68 | public function getKeysOf(Model $owner) |
||
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 |
||
80 | * @return lluminate\Database\Eloquent\Collection|Exception |
||
81 | */ |
||
82 | public function findGuestPass(Model $owner, Model $object) |
||
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) |
||
101 | } |
||
102 |
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.