-
-
Notifications
You must be signed in to change notification settings - Fork 828
/
Routes.php
205 lines (186 loc) · 6.65 KB
/
Routes.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
<?php
/*
* This file is part of Flarum.
*
* For detailed copyright and license information, please view the
* LICENSE file that was distributed with this source code.
*/
namespace Flarum\Extend;
use Flarum\Extension\Extension;
use Flarum\Http\RouteCollection;
use Flarum\Http\RouteHandlerFactory;
use Illuminate\Contracts\Container\Container;
class Routes implements ExtenderInterface
{
private $appName;
private $routes = [];
private $removedRoutes = [];
/**
* @param string $appName: Name of the app (api, forum, admin).
*/
public function __construct(string $appName)
{
$this->appName = $appName;
}
/**
* Add a GET route.
*
* @param string $path: The path of the route
* @param string $name: The name of the route, must be unique.
* @param callable|string $handler: ::class attribute of the controller class, or a closure.
*
* If the handler is a controller class, it should implement \Psr\Http\Server\RequestHandlerInterface,
* or extend one of the Flarum Api controllers within \Flarum\Api\Controller.
*
* The handler should accept:
* - \Psr\Http\Message\ServerRequestInterface $request
* - \Tobscure\JsonApi\Document $document: If it extends one of the Flarum Api controllers.
*
* The handler should return:
* - \Psr\Http\Message\ResponseInterface $response
*
* @return self
*/
public function get(string $path, string $name, $handler): self
{
return $this->route('GET', $path, $name, $handler);
}
/**
* Add a POST route.
*
* @param string $path: The path of the route
* @param string $name: The name of the route, must be unique.
* @param callable|string $handler: ::class attribute of the controller class, or a closure.
*
* If the handler is a controller class, it should implement \Psr\Http\Server\RequestHandlerInterface,
* or extend one of the Flarum Api controllers within \Flarum\Api\Controller.
*
* The handler should accept:
* - \Psr\Http\Message\ServerRequestInterface $request
* - \Tobscure\JsonApi\Document $document: If it extends one of the Flarum Api controllers.
*
* The handler should return:
* - \Psr\Http\Message\ResponseInterface $response
*
* @return self
*/
public function post(string $path, string $name, $handler): self
{
return $this->route('POST', $path, $name, $handler);
}
/**
* Add a PUT route.
*
* @param string $path: The path of the route
* @param string $name: The name of the route, must be unique.
* @param callable|string $handler: ::class attribute of the controller class, or a closure.
*
* If the handler is a controller class, it should implement \Psr\Http\Server\RequestHandlerInterface,
* or extend one of the Flarum Api controllers within \Flarum\Api\Controller.
*
* The handler should accept:
* - \Psr\Http\Message\ServerRequestInterface $request
* - \Tobscure\JsonApi\Document $document: If it extends one of the Flarum Api controllers.
*
* The handler should return:
* - \Psr\Http\Message\ResponseInterface $response
*
* @return self
*/
public function put(string $path, string $name, $handler): self
{
return $this->route('PUT', $path, $name, $handler);
}
/**
* Add a PATCH route.
*
* @param string $path: The path of the route
* @param string $name: The name of the route, must be unique.
* @param callable|string $handler: ::class attribute of the controller class, or a closure.
*
* If the handler is a controller class, it should implement \Psr\Http\Server\RequestHandlerInterface,
* or extend one of the Flarum Api controllers within \Flarum\Api\Controller.
*
* The handler should accept:
* - \Psr\Http\Message\ServerRequestInterface $request
* - \Tobscure\JsonApi\Document $document: If it extends one of the Flarum Api controllers.
*
* The handler should return:
* - \Psr\Http\Message\ResponseInterface $response
*
* @return self
*/
public function patch(string $path, string $name, $handler): self
{
return $this->route('PATCH', $path, $name, $handler);
}
/**
* Add a DELETE route.
*
* @param string $path: The path of the route
* @param string $name: The name of the route, must be unique.
* @param callable|string $handler: ::class attribute of the controller class, or a closure.
*
* If the handler is a controller class, it should implement \Psr\Http\Server\RequestHandlerInterface,
* or extend one of the Flarum Api controllers within \Flarum\Api\Controller.
*
* The handler should accept:
* - \Psr\Http\Message\ServerRequestInterface $request
* - \Tobscure\JsonApi\Document $document: If it extends one of the Flarum Api controllers.
*
* The handler should return:
* - \Psr\Http\Message\ResponseInterface $response
*
* @return self
*/
public function delete(string $path, string $name, $handler): self
{
return $this->route('DELETE', $path, $name, $handler);
}
private function route(string $httpMethod, string $path, string $name, $handler): self
{
$this->routes[] = [
'method' => $httpMethod,
'path' => $path,
'name' => $name,
'handler' => $handler
];
return $this;
}
/**
* Remove an existing route.
* Necessary before overriding a route.
*
* @param string $name: The name of the route.
* @return self
*/
public function remove(string $name): self
{
$this->removedRoutes[] = $name;
return $this;
}
public function extend(Container $container, Extension $extension = null)
{
if (empty($this->routes) && empty($this->removedRoutes)) {
return;
}
$container->resolving(
"flarum.{$this->appName}.routes",
function (RouteCollection $collection, Container $container) {
/** @var RouteHandlerFactory $factory */
$factory = $container->make(RouteHandlerFactory::class);
foreach ($this->removedRoutes as $routeName) {
$collection->removeRoute($routeName);
}
foreach ($this->routes as $route) {
$collection->addRoute(
$route['method'],
$route['path'],
$route['name'],
$factory->toController($route['handler'])
);
}
}
);
}
}