1 | <?php |
||
15 | trait HashIdTrait |
||
16 | { |
||
17 | |||
18 | /** |
||
19 | * endpoint to be skipped from decoding their ID's (example for external ID's) |
||
20 | * @var array |
||
21 | */ |
||
22 | private $skippedEndpoints = [ |
||
23 | // 'orders/{id}/external', |
||
24 | ]; |
||
25 | |||
26 | /** |
||
27 | * All ID's passed with all endpoints will be decoded before entering the Application |
||
28 | */ |
||
29 | public function runEndpointsHashedIdsDecoder() |
||
49 | |||
50 | /** |
||
51 | * Will be used by the Eloquent Models (since it's used as trait there). |
||
52 | * |
||
53 | * @param null $key |
||
54 | * |
||
55 | * @return mixed |
||
56 | */ |
||
57 | public function getHashedKey($key = null) |
||
66 | |||
67 | |||
68 | /** |
||
69 | * without decoding the encoded ID's you won't be able to use |
||
70 | * validation features like `exists:table,id` |
||
71 | * |
||
72 | * @param array $requestData |
||
73 | * |
||
74 | * @return array |
||
75 | */ |
||
76 | private function decodeHashedIdsBeforeApplyingValidationRules(Array $requestData) |
||
99 | |||
100 | /** |
||
101 | * @param array $ids |
||
102 | * |
||
103 | * @return array |
||
104 | */ |
||
105 | public function decodeThisArrayOfIds(array $ids) |
||
114 | |||
115 | /** |
||
116 | * @param $id |
||
117 | * |
||
118 | * @return mixed |
||
119 | */ |
||
120 | public function decodeThisId($id) |
||
124 | |||
125 | /** |
||
126 | * @param $id |
||
127 | * |
||
128 | * @return mixed |
||
129 | */ |
||
130 | private function decoder($id) |
||
134 | |||
135 | /** |
||
136 | * @param $id |
||
137 | * |
||
138 | * @return mixed |
||
139 | */ |
||
140 | private function encoder($id) |
||
144 | |||
145 | } |
||
146 |
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
The trait
Idable
provides a methodequalsId
that in turn relies on the methodgetId()
. 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.