1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
namespace Flugg\Responder; |
4
|
|
|
|
5
|
|
|
use Flugg\Responder\Console\MakeTransformer; |
6
|
|
|
use Flugg\Responder\Contracts\ErrorFactory as ErrorFactoryContract; |
7
|
|
|
use Flugg\Responder\Contracts\ErrorMessageResolver as ErrorMessageResolverContract; |
8
|
|
|
use Flugg\Responder\Contracts\ErrorSerializer as ErrorSerializerContract; |
9
|
|
|
use Flugg\Responder\Contracts\Pagination\PaginatorFactory as PaginatorFactoryContract; |
10
|
|
|
use Flugg\Responder\Contracts\Resources\ResourceFactory as ResourceFactoryContract; |
11
|
|
|
use Flugg\Responder\Contracts\Resources\ResourceKeyResolver as ResourceKeyResolverContract; |
12
|
|
|
use Flugg\Responder\Contracts\Responder as ResponderContract; |
13
|
|
|
use Flugg\Responder\Contracts\ResponseFactory; |
14
|
|
|
use Flugg\Responder\Contracts\ResponseFactory as ResponseFactoryContract; |
15
|
|
|
use Flugg\Responder\Contracts\SimpleTransformer as SimpleTransformerContract; |
16
|
|
|
use Flugg\Responder\Contracts\Transformers\TransformerResolver as TransformerResolverContract; |
17
|
|
|
use Flugg\Responder\Contracts\TransformFactory as TransformFactoryContract; |
18
|
|
|
use Flugg\Responder\Http\Responses\ErrorResponseBuilder; |
19
|
|
|
use Flugg\Responder\Http\Responses\Factories\LaravelResponseFactory; |
20
|
|
|
use Flugg\Responder\Http\Responses\Factories\LumenResponseFactory; |
21
|
|
|
use Flugg\Responder\Pagination\PaginatorFactory; |
22
|
|
|
use Flugg\Responder\Resources\ResourceFactory; |
23
|
|
|
use Flugg\Responder\Resources\ResourceKeyResolver; |
24
|
|
|
use Flugg\Responder\Transformers\Transformer as BaseTransformer; |
25
|
|
|
use Flugg\Responder\Transformers\TransformerResolver; |
26
|
|
|
use Illuminate\Contracts\Container\Container; |
27
|
|
|
use Illuminate\Foundation\Application as Laravel; |
28
|
|
|
use Illuminate\Http\Request; |
29
|
|
|
use Illuminate\Support\ServiceProvider as BaseServiceProvider; |
30
|
|
|
use Illuminate\Translation\Translator; |
31
|
|
|
use Laravel\Lumen\Application as Lumen; |
32
|
|
|
use League\Fractal\Manager; |
33
|
|
|
use League\Fractal\Serializer\SerializerAbstract; |
34
|
|
|
|
35
|
|
|
/** |
36
|
|
|
* A service provider class responsible for bootstrapping the parts of the Laravel package. |
37
|
|
|
* |
38
|
|
|
* @package flugger/laravel-responder |
39
|
|
|
* @author Alexander Tømmerås <[email protected]> |
40
|
|
|
* @license The MIT License |
41
|
|
|
*/ |
42
|
|
|
class ResponderServiceProvider extends BaseServiceProvider |
43
|
|
|
{ |
44
|
|
|
/** |
45
|
|
|
* Indicates if loading of the provider is deferred. |
46
|
|
|
* |
47
|
|
|
* @var bool |
48
|
|
|
*/ |
49
|
|
|
protected $defer = false; |
50
|
|
|
|
51
|
|
|
/** |
52
|
|
|
* Register the service provider. |
53
|
|
|
* |
54
|
|
|
* @return void |
55
|
|
|
*/ |
56
|
182 |
|
public function register() |
57
|
|
|
{ |
58
|
182 |
|
if ($this->app instanceof Laravel) { |
59
|
182 |
|
$this->registerLaravelBindings(); |
60
|
|
|
} elseif ($this->app instanceof Lumen) { |
|
|
|
|
61
|
|
|
$this->registerLumenBindings(); |
62
|
|
|
} |
63
|
|
|
|
64
|
182 |
|
$this->registerSerializerBindings(); |
65
|
182 |
|
$this->registerErrorBindings(); |
66
|
182 |
|
$this->registerFractalBindings(); |
67
|
182 |
|
$this->registerTransformerBindings(); |
68
|
182 |
|
$this->registerResourceBindings(); |
69
|
182 |
|
$this->registerPaginationBindings(); |
70
|
182 |
|
$this->registerTransformationBindings(); |
71
|
182 |
|
$this->registerServiceBindings(); |
72
|
182 |
|
} |
73
|
|
|
|
74
|
|
|
/** |
75
|
|
|
* Register Laravel bindings. |
76
|
|
|
* |
77
|
|
|
* @return void |
78
|
|
|
*/ |
79
|
|
|
protected function registerLaravelBindings() |
80
|
|
|
{ |
81
|
182 |
|
$this->app->singleton(ResponseFactoryContract::class, function ($app) { |
82
|
46 |
|
return $this->decorateResponseFactory($app->make(LaravelResponseFactory::class)); |
83
|
182 |
|
}); |
84
|
182 |
|
} |
85
|
|
|
|
86
|
|
|
/** |
87
|
|
|
* Register Lumen bindings. |
88
|
|
|
* |
89
|
|
|
* @return void |
90
|
|
|
*/ |
91
|
|
|
protected function registerLumenBindings() |
92
|
|
|
{ |
93
|
|
|
$this->app->singleton(ResponseFactoryContract::class, function ($app) { |
94
|
|
|
return $this->decorateResponseFactory($app->make(LumenResponseFactory::class)); |
95
|
|
|
}); |
96
|
|
|
|
97
|
|
|
$this->app->bind(Translator::class, function ($app) { |
98
|
|
|
return $app['translator']; |
99
|
|
|
}); |
100
|
|
|
} |
101
|
|
|
|
102
|
|
|
/** |
103
|
|
|
* Decorate response factories. |
104
|
|
|
* |
105
|
|
|
* @param \Flugg\Responder\Contracts\ResponseFactory $factory |
106
|
|
|
* @return \Flugg\Responder\Contracts\ResponseFactory |
107
|
|
|
*/ |
108
|
46 |
|
protected function decorateResponseFactory(ResponseFactoryContract $factory): ResponseFactory |
109
|
|
|
{ |
110
|
46 |
|
foreach ($this->app->config['responder.decorators'] as $decorator) { |
111
|
46 |
|
$factory = new $decorator($factory); |
112
|
|
|
}; |
113
|
|
|
|
114
|
46 |
|
return $factory; |
115
|
|
|
} |
116
|
|
|
|
117
|
|
|
/** |
118
|
|
|
* Register serializer bindings. |
119
|
|
|
* |
120
|
|
|
* @return void |
121
|
|
|
*/ |
122
|
|
|
protected function registerSerializerBindings() |
123
|
|
|
{ |
124
|
182 |
|
$this->app->bind(ErrorSerializerContract::class, function ($app) { |
125
|
46 |
|
return $app->make($app->config['responder.serializers.error']); |
126
|
182 |
|
}); |
127
|
|
|
|
128
|
182 |
|
$this->app->bind(SerializerAbstract::class, function ($app) { |
129
|
46 |
|
return $app->make($app->config['responder.serializers.success']); |
130
|
182 |
|
}); |
131
|
182 |
|
} |
132
|
|
|
|
133
|
|
|
/** |
134
|
|
|
* Register error bindings. |
135
|
|
|
* |
136
|
|
|
* @return void |
137
|
|
|
*/ |
138
|
|
|
protected function registerErrorBindings() |
139
|
|
|
{ |
140
|
182 |
|
$this->app->singleton(ErrorMessageResolverContract::class, function ($app) { |
141
|
46 |
|
return $app->make(ErrorMessageResolver::class); |
142
|
182 |
|
}); |
143
|
|
|
|
144
|
182 |
|
$this->app->singleton(ErrorFactoryContract::class, function ($app) { |
145
|
46 |
|
return $app->make(ErrorFactory::class); |
146
|
182 |
|
}); |
147
|
|
|
|
148
|
182 |
|
$this->app->bind(ErrorResponseBuilder::class, function ($app) { |
149
|
46 |
|
return (new ErrorResponseBuilder($app->make(ResponseFactoryContract::class), $app->make(ErrorFactoryContract::class)))->serializer($app->make(ErrorSerializerContract::class)); |
150
|
182 |
|
}); |
151
|
182 |
|
} |
152
|
|
|
|
153
|
|
|
/** |
154
|
|
|
* Register Fractal bindings. |
155
|
|
|
* |
156
|
|
|
* @return void |
157
|
|
|
*/ |
158
|
|
|
protected function registerFractalBindings() |
159
|
|
|
{ |
160
|
182 |
|
$this->app->bind(Manager::class, function ($app) { |
161
|
46 |
|
return (new Manager)->setRecursionLimit($app->config['responder.recursion_limit']); |
162
|
182 |
|
}); |
163
|
182 |
|
} |
164
|
|
|
|
165
|
|
|
/** |
166
|
|
|
* Register transformer bindings. |
167
|
|
|
* |
168
|
|
|
* @return void |
169
|
|
|
*/ |
170
|
|
|
protected function registerTransformerBindings() |
171
|
|
|
{ |
172
|
182 |
|
$this->app->singleton(TransformerResolverContract::class, function ($app) { |
173
|
48 |
|
return $app->make(TransformerResolver::class); |
174
|
182 |
|
}); |
175
|
|
|
|
176
|
182 |
|
BaseTransformer::containerResolver(function () { |
177
|
10 |
|
return $this->app->make(Container::class); |
178
|
182 |
|
}); |
179
|
182 |
|
} |
180
|
|
|
|
181
|
|
|
/** |
182
|
|
|
* Register pagination bindings. |
183
|
|
|
* |
184
|
|
|
* @return void |
185
|
|
|
*/ |
186
|
|
|
protected function registerResourceBindings() |
187
|
|
|
{ |
188
|
182 |
|
$this->app->singleton(ResourceKeyResolverContract::class, function ($app) { |
189
|
48 |
|
return $app->make(ResourceKeyResolver::class); |
190
|
182 |
|
}); |
191
|
|
|
|
192
|
182 |
|
$this->app->singleton(ResourceFactoryContract::class, function ($app) { |
193
|
48 |
|
return $app->make(ResourceFactory::class); |
194
|
182 |
|
}); |
195
|
182 |
|
} |
196
|
|
|
|
197
|
|
|
/** |
198
|
|
|
* Register pagination bindings. |
199
|
|
|
* |
200
|
|
|
* @return void |
201
|
|
|
*/ |
202
|
|
|
protected function registerPaginationBindings() |
203
|
|
|
{ |
204
|
182 |
|
$this->app->bind(PaginatorFactoryContract::class, function ($app) { |
205
|
46 |
|
return new PaginatorFactory($app->make(Request::class)->query()); |
206
|
182 |
|
}); |
207
|
182 |
|
} |
208
|
|
|
|
209
|
|
|
/** |
210
|
|
|
* Register transformation bindings. |
211
|
|
|
* |
212
|
|
|
* @return void |
213
|
|
|
*/ |
214
|
|
|
protected function registerTransformationBindings() |
215
|
|
|
{ |
216
|
182 |
|
$this->app->bind(TransformFactoryContract::class, function ($app) { |
217
|
46 |
|
return $app->make(FractalTransformFactory::class); |
218
|
182 |
|
}); |
219
|
|
|
|
220
|
182 |
|
$this->app->bind(TransformBuilder::class, function ($app) { |
221
|
46 |
|
$request = $this->app->make(Request::class); |
222
|
46 |
|
$relations = $request->input($this->app->config['responder.load_relations_parameter'], []); |
223
|
46 |
|
$fieldsets = $request->input($app->config['responder.filter_fields_parameter'], []); |
224
|
|
|
|
225
|
46 |
|
return (new TransformBuilder($app->make(ResourceFactoryContract::class), $app->make(TransformFactoryContract::class), $app->make(PaginatorFactoryContract::class))) |
226
|
46 |
|
->serializer($app->make(SerializerAbstract::class)) |
227
|
46 |
|
->with(is_string($relations) ? explode(',', $relations) : $relations) |
228
|
46 |
|
->only($fieldsets); |
229
|
182 |
|
}); |
230
|
182 |
|
} |
231
|
|
|
|
232
|
|
|
/** |
233
|
|
|
* Register service bindings. |
234
|
|
|
* |
235
|
|
|
* @return void |
236
|
|
|
*/ |
237
|
|
|
protected function registerServiceBindings() |
238
|
|
|
{ |
239
|
182 |
|
$this->app->bind(ResponderContract::class, function ($app) { |
240
|
45 |
|
return $app->make(Responder::class); |
241
|
182 |
|
}); |
242
|
|
|
|
243
|
182 |
|
$this->app->bind(SimpleTransformerContract::class, function ($app) { |
244
|
|
|
return $app->make(SimpleTransformer::class); |
245
|
182 |
|
}); |
246
|
182 |
|
} |
247
|
|
|
|
248
|
|
|
/** |
249
|
|
|
* Bootstrap the application events. |
250
|
|
|
* |
251
|
|
|
* @return void |
252
|
|
|
*/ |
253
|
182 |
|
public function boot() |
254
|
|
|
{ |
255
|
182 |
|
if ($this->app instanceof Laravel) { |
256
|
182 |
|
$this->bootLaravelApplication(); |
257
|
|
|
} elseif ($this->app instanceof Lumen) { |
|
|
|
|
258
|
|
|
$this->bootLumenApplication(); |
259
|
|
|
} |
260
|
|
|
|
261
|
182 |
|
$this->mergeConfigFrom(__DIR__ . '/../config/responder.php', 'responder'); |
262
|
182 |
|
$this->commands(MakeTransformer::class); |
263
|
182 |
|
} |
264
|
|
|
|
265
|
|
|
/** |
266
|
|
|
* Bootstrap the Laravel application. |
267
|
|
|
* |
268
|
|
|
* @return void |
269
|
|
|
*/ |
270
|
182 |
|
protected function bootLaravelApplication() |
271
|
|
|
{ |
272
|
182 |
|
if ($this->app->runningInConsole()) { |
273
|
182 |
|
$this->publishes([ |
274
|
182 |
|
__DIR__ . '/../config/responder.php' => config_path('responder.php'), |
275
|
182 |
|
], 'config'); |
276
|
182 |
|
$this->publishes([ |
277
|
182 |
|
__DIR__ . '/../resources/lang/en/errors.php' => base_path('resources/lang/en/errors.php'), |
278
|
182 |
|
], 'lang'); |
279
|
|
|
} |
280
|
182 |
|
} |
281
|
|
|
|
282
|
|
|
/** |
283
|
|
|
* Bootstrap the Lumen application. |
284
|
|
|
* |
285
|
|
|
* @return void |
286
|
|
|
*/ |
287
|
|
|
protected function bootLumenApplication() |
288
|
|
|
{ |
289
|
|
|
$this->app->configure('responder'); |
|
|
|
|
290
|
|
|
} |
291
|
|
|
} |
This error could be the result of:
1. Missing dependencies
PHP Analyzer uses your
composer.json
file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects thecomposer.json
to be in the root folder of your repository.Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the
require
orrequire-dev
section?2. Missing use statement
PHP does not complain about undefined classes in
ìnstanceof
checks. For example, the following PHP code will work perfectly fine:If you have not tested against this specific condition, such errors might go unnoticed.