|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
namespace EllipseSynergie\ApiResponse\Laravel; |
|
4
|
|
|
|
|
5
|
|
|
use EllipseSynergie\ApiResponse\Serializer\Serializer; |
|
6
|
|
|
use Illuminate\Support\ServiceProvider; |
|
7
|
|
|
use League\Fractal\Manager; |
|
8
|
|
|
|
|
9
|
|
|
/** |
|
10
|
|
|
* Class ResponseServiceProvider |
|
11
|
|
|
* |
|
12
|
|
|
* For the full copyright and license information, please view the LICENSE |
|
13
|
|
|
* file that was distributed with this source code. |
|
14
|
|
|
* |
|
15
|
|
|
* @package EllipseSynergie\ApiResponse\Laravel |
|
16
|
|
|
* @author Maxime Beaudoin <[email protected]> |
|
17
|
|
|
*/ |
|
18
|
|
|
class ResponseServiceProvider extends ServiceProvider |
|
19
|
|
|
{ |
|
20
|
|
|
/** |
|
21
|
|
|
* Register the service provider. |
|
22
|
|
|
* |
|
23
|
|
|
* @return void |
|
24
|
|
|
*/ |
|
25
|
|
|
public function boot() |
|
26
|
|
|
{ |
|
27
|
|
|
$response = $this->bootResponse(); |
|
28
|
|
|
$this->registerMacro($response); |
|
|
|
|
|
|
29
|
|
|
} |
|
30
|
|
|
|
|
31
|
|
|
/** |
|
32
|
|
|
* Override this to use your own serializer. |
|
33
|
|
|
* |
|
34
|
|
|
* @return Serializer |
|
35
|
|
|
*/ |
|
36
|
|
|
protected function getSerializer() |
|
37
|
|
|
{ |
|
38
|
|
|
return new Serializer(); |
|
39
|
|
|
} |
|
40
|
|
|
|
|
41
|
|
|
/** |
|
42
|
|
|
* Boot response |
|
43
|
|
|
* |
|
44
|
|
|
* @return Response |
|
45
|
|
|
*/ |
|
46
|
|
|
protected function bootResponse() |
|
47
|
|
|
{ |
|
48
|
|
|
$manager = new Manager; |
|
49
|
|
|
|
|
50
|
|
|
// Custom serializer because DataArraySerializer doesn't provide the opportunity to change the resource key |
|
51
|
|
|
$manager->setSerializer($this->getSerializer()); |
|
52
|
|
|
|
|
53
|
|
|
// Are we going to try and include embedded data? |
|
54
|
|
|
$manager->parseIncludes(explode(',', $this->app['Illuminate\Http\Request']->get('include'))); |
|
55
|
|
|
|
|
56
|
|
|
// Return the Response object |
|
57
|
|
|
$response = new Response($manager); |
|
58
|
|
|
|
|
59
|
|
|
//Set the response instance properly |
|
60
|
|
|
$this->app->instance('EllipseSynergie\ApiResponse\Contracts\Response', $response); |
|
61
|
|
|
|
|
62
|
|
|
return $response; |
|
63
|
|
|
} |
|
64
|
|
|
|
|
65
|
|
|
/** |
|
66
|
|
|
* Register the service provider. |
|
67
|
|
|
* |
|
68
|
|
|
* @return void |
|
69
|
|
|
*/ |
|
70
|
|
|
public function register() |
|
71
|
|
|
{ |
|
72
|
|
|
// |
|
73
|
|
|
} |
|
74
|
|
|
|
|
75
|
|
|
/** |
|
76
|
|
|
* Register response macro |
|
77
|
|
|
* |
|
78
|
|
|
* @deprecated We still register macro for backward compatibility, but DO NOT USE THIS MACRO ANYMORE ! |
|
79
|
|
|
* @param Response $response |
|
80
|
|
|
*/ |
|
81
|
|
|
private function registerMacro($response) |
|
82
|
|
|
{ |
|
83
|
|
|
\Response::macro('api', function () use ($response) { |
|
|
|
|
|
|
84
|
|
|
return $response; |
|
85
|
|
|
}); |
|
86
|
|
|
} |
|
87
|
|
|
} |
|
88
|
|
|
|
ellipsesynergie /
api-response
Loading history...
This method has been deprecated. The supplier of the class has supplied an explanatory message.
The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead.