Add MiddlewareStackInteface phpDoc

alexgivi · samdark · web-flow · commit 3f33c8bdc3e6 · 2021-01-26T16:43:42.000+03:00
Co-authored-by: Alexander Makarov &lt;sam@rmcreative.ru&gt;
diff --git a/src/MiddlewareStackInterface.php b/src/MiddlewareStackInterface.php
@@ -4,13 +4,33 @@
 
 namespace Yiisoft\Middleware\Dispatcher;
 
+use Psr\Http\Server\MiddlewareInterface;
 use Psr\Http\Server\RequestHandlerInterface;
 
+/**
+ * A stack of PSR-15 middlewares to be used with {@see MiddlewareDispatcher}.
+ * @see https://www.php-fig.org/psr/psr-15/
+ */
 interface MiddlewareStackInterface extends RequestHandlerInterface
 {
+    /**
+     * Builds a middleware stack from an array of middleware instances and a fallback request handler.
+     * If the middlewares array is empty, only the fallback handler will be used.
+     *
+     * @param MiddlewareInterface[] $middlewares Middlewares being composed to stack. Can be empty.
+     * @param RequestHandlerInterface $fallbackHandler Fallback request handler.
+     *
+     * @return self
+     */
     public function build(array $middlewares, RequestHandlerInterface $fallbackHandler): self;
 
+    /**
+     * Clears the middleware stack and fallback request handler.
+     */
     public function reset(): void;
 
+    /**
+     * @return bool Whether there are any middlewares or fallback request handler bound.
+     */
     public function isEmpty(): bool;
 }
