Completed
Push — master ( 114f7e...334f44 )
by Alexander
11:37 queued 08:18
created

ResponderServiceProvider   A

Complexity

Total Complexity 22

Size/Duplication

Total Lines 245
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 8

Test Coverage

Coverage 86.6%

Importance

Changes 0
Metric Value
dl 0
loc 245
ccs 84
cts 97
cp 0.866
rs 10
c 0
b 0
f 0
wmc 22
lcom 1
cbo 8

15 Methods

Rating   Name   Duplication   Size   Complexity  
A register() 0 17 3
A registerLaravelBindings() 0 6 1
A decorateResponseFactory() 0 8 2
A registerFractalBindings() 0 6 1
A registerPaginationBindings() 0 6 1
A registerServiceBindings() 0 6 1
A boot() 0 11 3
A bootLaravelApplication() 0 11 2
A bootLumenApplication() 0 4 1
A registerLumenBindings() 0 10 1
A registerSerializerBindings() 0 10 1
A registerErrorBindings() 0 14 1
A registerTransformerBindings() 0 10 1
A registerResourceBindings() 0 10 1
A registerTransformationBindings() 0 16 2
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 191
    public function register()
57
    {
58 191
        if ($this->app instanceof Laravel) {
59 191
            $this->registerLaravelBindings();
60
        } elseif ($this->app instanceof Lumen) {
0 ignored issues
show
Bug introduced by
The class Laravel\Lumen\Application does not exist. Did you forget a USE statement, or did you not list all dependencies?

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 the composer.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 or require-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 ($x instanceof DoesNotExist) {
    // Do something.
}

If you have not tested against this specific condition, such errors might go unnoticed.

Loading history...
61
            $this->registerLumenBindings();
62
        }
63
64 191
        $this->registerSerializerBindings();
65 191
        $this->registerErrorBindings();
66 191
        $this->registerFractalBindings();
67 191
        $this->registerTransformerBindings();
68 191
        $this->registerResourceBindings();
69 191
        $this->registerPaginationBindings();
70 191
        $this->registerTransformationBindings();
71 191
        $this->registerServiceBindings();
72 191
    }
73
74
    /**
75
     * Register Laravel bindings.
76
     *
77
     * @return void
78
     */
79 191
    protected function registerLaravelBindings()
80
    {
81
        $this->app->singleton(ResponseFactoryContract::class, function ($app) {
82 54
            return $this->decorateResponseFactory($app->make(LaravelResponseFactory::class));
83 191
        });
84 191
    }
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 54
    protected function decorateResponseFactory(ResponseFactoryContract $factory): ResponseFactory
109
    {
110 54
        foreach ($this->app->config['responder.decorators'] as $decorator) {
111 54
            $factory = new $decorator($factory);
112
        };
113
114 54
        return $factory;
115
    }
116
117
    /**
118
     * Register serializer bindings.
119
     *
120
     * @return void
121
     */
122 191
    protected function registerSerializerBindings()
123
    {
124
        $this->app->bind(ErrorSerializerContract::class, function ($app) {
125 54
            return $app->make($app->config['responder.serializers.error']);
126 191
        });
127
128
        $this->app->bind(SerializerAbstract::class, function ($app) {
129 54
            return $app->make($app->config['responder.serializers.success']);
130 191
        });
131 191
    }
132
133
    /**
134
     * Register error bindings.
135
     *
136
     * @return void
137
     */
138 191
    protected function registerErrorBindings()
139
    {
140
        $this->app->singleton(ErrorMessageResolverContract::class, function ($app) {
141 54
            return $app->make(ErrorMessageResolver::class);
142 191
        });
143
144
        $this->app->singleton(ErrorFactoryContract::class, function ($app) {
145 54
            return $app->make(ErrorFactory::class);
146 191
        });
147
148
        $this->app->bind(ErrorResponseBuilder::class, function ($app) {
149 54
            return (new ErrorResponseBuilder($app->make(ResponseFactoryContract::class), $app->make(ErrorFactoryContract::class)))->serializer($app->make(ErrorSerializerContract::class));
150 191
        });
151 191
    }
152
153
    /**
154
     * Register Fractal bindings.
155
     *
156
     * @return void
157
     */
158 191
    protected function registerFractalBindings()
159
    {
160
        $this->app->bind(Manager::class, function ($app) {
161 54
            return (new Manager)->setRecursionLimit($app->config['responder.recursion_limit']);
162 191
        });
163 191
    }
164
165
    /**
166
     * Register transformer bindings.
167
     *
168
     * @return void
169
     */
170 191
    protected function registerTransformerBindings()
171
    {
172
        $this->app->singleton(TransformerResolverContract::class, function ($app) {
173 56
            return new TransformerResolver($app, $app->config['responder.fallback_transformer']);
174 191
        });
175
176
        BaseTransformer::containerResolver(function () {
177 21
            return $this->app->make(Container::class);
178 191
        });
179 191
    }
180
181
    /**
182
     * Register pagination bindings.
183
     *
184
     * @return void
185
     */
186 191
    protected function registerResourceBindings()
187
    {
188
        $this->app->singleton(ResourceKeyResolverContract::class, function ($app) {
189 56
            return $app->make(ResourceKeyResolver::class);
190 191
        });
191
192
        $this->app->singleton(ResourceFactoryContract::class, function ($app) {
193 56
            return $app->make(ResourceFactory::class);
194 191
        });
195 191
    }
196
197
    /**
198
     * Register pagination bindings.
199
     *
200
     * @return void
201
     */
202 191
    protected function registerPaginationBindings()
203
    {
204
        $this->app->bind(PaginatorFactoryContract::class, function ($app) {
205 54
            return new PaginatorFactory($app->make(Request::class)->query());
206 191
        });
207 191
    }
208
209
    /**
210
     * Register transformation bindings.
211
     *
212
     * @return void
213
     */
214 191
    protected function registerTransformationBindings()
215
    {
216
        $this->app->bind(TransformFactoryContract::class, function ($app) {
217 54
            return $app->make(FractalTransformFactory::class);
218 191
        });
219
220
        $this->app->bind(TransformBuilder::class, function ($app) {
221 54
            $request = $this->app->make(Request::class);
222 54
            $relations = $request->input($this->app->config['responder.load_relations_parameter'], []);
223 54
            $fieldsets = $request->input($app->config['responder.filter_fields_parameter'], []);
224
225 54
            return (new TransformBuilder($app->make(ResourceFactoryContract::class), $app->make(TransformFactoryContract::class), $app->make(PaginatorFactoryContract::class)))->serializer($app->make(SerializerAbstract::class))
226 54
                ->with(is_string($relations) ? explode(',', $relations) : $relations)
227 54
                ->only($fieldsets);
228 191
        });
229 191
    }
230
231
    /**
232
     * Register service bindings.
233
     *
234
     * @return void
235
     */
236 191
    protected function registerServiceBindings()
237
    {
238
        $this->app->bind(ResponderContract::class, function ($app) {
239 53
            return $app->make(Responder::class);
240 191
        });
241 191
    }
242
243
    /**
244
     * Bootstrap the application events.
245
     *
246
     * @return void
247
     */
248 191
    public function boot()
249
    {
250 191
        if ($this->app instanceof Laravel) {
251 191
            $this->bootLaravelApplication();
252
        } elseif ($this->app instanceof Lumen) {
0 ignored issues
show
Bug introduced by
The class Laravel\Lumen\Application does not exist. Did you forget a USE statement, or did you not list all dependencies?

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 the composer.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 or require-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 ($x instanceof DoesNotExist) {
    // Do something.
}

If you have not tested against this specific condition, such errors might go unnoticed.

Loading history...
253
            $this->bootLumenApplication();
254
        }
255
256 191
        $this->mergeConfigFrom(__DIR__ . '/../config/responder.php', 'responder');
257 191
        $this->commands(MakeTransformer::class);
258 191
    }
259
260
    /**
261
     * Bootstrap the Laravel application.
262
     *
263
     * @return void
264
     */
265 191
    protected function bootLaravelApplication()
266
    {
267 191
        if ($this->app->runningInConsole()) {
268 191
            $this->publishes([
269 191
                __DIR__ . '/../config/responder.php' => config_path('responder.php'),
270 191
            ], 'config');
271 191
            $this->publishes([
272 191
                __DIR__ . '/../resources/lang/en/errors.php' => base_path('resources/lang/en/errors.php'),
273 191
            ], 'lang');
274
        }
275 191
    }
276
277
    /**
278
     * Bootstrap the Lumen application.
279
     *
280
     * @return void
281
     */
282
    protected function bootLumenApplication()
283
    {
284
        $this->app->configure('responder');
0 ignored issues
show
Bug introduced by
The method configure() does not exist on Illuminate\Contracts\Foundation\Application. Did you maybe mean registerConfiguredProviders()?

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...
285
    }
286
}