Skip to content

Commit beceef6

Browse files
committed
Rename stack to stackMiddleware
1 parent 41abe37 commit beceef6

File tree

6 files changed

+13
-13
lines changed

6 files changed

+13
-13
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -173,10 +173,10 @@ public function handleRequest(Request $request, RequestHandler $next): Response
173173
`handleRequest` is the only method of the `Middleware` interface. If the `Middleware` doesn't handle the request itself, it should delegate the response creation to the received `RequestHandler`.
174174

175175
```php
176-
function stack(RequestHandler $handler, Middleware ...$middleware): RequestHandler
176+
function stackMiddleware(RequestHandler $handler, Middleware ...$middleware): RequestHandler
177177
```
178178

179-
Multiple middlewares can be stacked by using `Amp\Http\Server\Middleware\stack()`, which accepts a `RequestHandler` as first argument and a variable number of `Middleware` instances. The returned `RequestHandler` will invoke each middleware in the provided order.
179+
Multiple middlewares can be stacked by using `Amp\Http\Server\Middleware\stackMiddleware()`, which accepts a `RequestHandler` as first argument and a variable number of `Middleware` instances. The returned `RequestHandler` will invoke each middleware in the provided order.
180180

181181
```php
182182
$requestHandler = new class implements RequestHandler {
@@ -202,7 +202,7 @@ $middleware = new class implements Middleware {
202202
}
203203
};
204204

205-
$stackedHandler = Middleware\stack($requestHandler, $middleware);
205+
$stackedHandler = Middleware\stackMiddleware($requestHandler, $middleware);
206206
$errorHandler = new DefaultErrorHandler();
207207

208208
// $logger is a PSR-7 logger instance.

src/Middleware.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
/**
66
* Middlewares allow pre-processing of requests and post-processing of responses.
77
*
8-
* @see stack() for how to apply a middleware to a request handler.
8+
* @see stackMiddleware() for how to apply a middleware to a request handler.
99
*/
1010
interface Middleware
1111
{

src/Middleware/Internal/MiddlewareRequestHandler.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
/**
1111
* Wraps a request handler with a single middleware.
1212
*
13-
* @see stack()
13+
* @see stackMiddleware()
1414
* @internal
1515
*/
1616
final class MiddlewareRequestHandler implements RequestHandler

src/Middleware/functions.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
*
1515
* @return RequestHandler Wrapped request handler.
1616
*/
17-
function stack(RequestHandler $requestHandler, Middleware ...$middlewares): RequestHandler
17+
function stackMiddleware(RequestHandler $requestHandler, Middleware ...$middlewares): RequestHandler
1818
{
1919
foreach (\array_reverse($middlewares) as $middleware) {
2020
$requestHandler = new MiddlewareRequestHandler($middleware, $requestHandler);

src/SocketHttpServer.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -164,8 +164,8 @@ private static function createCompressionMiddleware(PsrLogger $logger): ?Compres
164164
}
165165

166166
/**
167-
* @param array<Middleware> $middleware Default middlewares. You may also use {@see Middleware\stack()} before
168-
* passing the {@see RequestHandler} to {@see self::start()}.
167+
* @param array<Middleware> $middleware Default middlewares. You may also use {@see Middleware\stackMiddleware()}
168+
* before passing the {@see RequestHandler} to {@see self::start()}.
169169
* @param array<non-empty-string>|null $allowedMethods Use null to disable request method filtering.
170170
*/
171171
public function __construct(
@@ -249,15 +249,15 @@ public function start(RequestHandler $requestHandler, ErrorHandler $errorHandler
249249
$this->logger->warning("The 'xdebug' extension is loaded, which has a major impact on performance.");
250250
}
251251

252-
$requestHandler = Middleware\stack($requestHandler, ...$this->middleware);
252+
$requestHandler = Middleware\stackMiddleware($requestHandler, ...$this->middleware);
253253

254254
if ($this->allowedMethods !== null) {
255255
$this->logger->notice(\sprintf(
256256
'Request methods restricted to %s.',
257257
\implode(', ', $this->allowedMethods),
258258
));
259259

260-
$requestHandler = Middleware\stack(
260+
$requestHandler = Middleware\stackMiddleware(
261261
$requestHandler,
262262
new AllowedMethodsMiddleware($errorHandler, $this->logger, $this->allowedMethods),
263263
);

test/Middleware/StackTest.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@
1111
use Amp\Http\Server\Response;
1212
use Amp\PHPUnit\AsyncTestCase;
1313
use League\Uri;
14-
use function Amp\Http\Server\Middleware\stack;
14+
use function Amp\Http\Server\Middleware\stackMiddleware;
1515

1616
class StackTest extends AsyncTestCase
1717
{
1818
public function testStackAppliesMiddlewaresInCorrectOrder(): void
1919
{
2020
$request = new Request($this->createMock(Client::class), "GET", Uri\Http::createFromString("/foobar"));
2121

22-
$stack = stack(new ClosureRequestHandler(function (Request $request) {
22+
$stack = stackMiddleware(new ClosureRequestHandler(function (Request $request) {
2323
$response = new Response(HttpStatus::OK, [], "OK");
2424
$response->setHeader("stack", $request->getAttribute(StackTest::class));
2525

@@ -45,6 +45,6 @@ public function handleRequest(Request $request, RequestHandler $requestHandler):
4545
public function testEmptyMiddlewareSet(): void
4646
{
4747
$mock = $this->createMock(RequestHandler::class);
48-
self::assertSame($mock, stack($mock));
48+
self::assertSame($mock, stackMiddleware($mock));
4949
}
5050
}

0 commit comments

Comments
 (0)