Add more phpdoc

samdark · samdark · commit 63acb3225368 · 2020-11-22T15:44:28.000+03:00
diff --git a/src/MiddlewareDispatcher.php b/src/MiddlewareDispatcher.php
@@ -39,6 +39,19 @@ public function dispatch(ServerRequestInterface $request, RequestHandlerInterfac
         return $this->stack->handle($request);
     }
 
+    /**
+     * Returns new instance with middleware handlers replaced.
+     * Last specified handler will be executed first.
+     *
+     * @param array $middlewareDefinitions Each array element is a name of PSR-15 middleware, a callable with
+     * `function(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface` signature or
+     * a handler action (an array of [handlerClass, handlerMethod]). For handler action and callable typed parameters
+     * are automatically injected using dependency injection container passed to the route.
+     * Current request and handler could be obtained by type-hinting for {@see ServerRequestInterface}
+     * and {@see RequestHandlerInterface}.
+     *
+     * @return self
+     */
     public function withMiddlewares(array $middlewareDefinitions): self
     {
         $clone = clone $this;
diff --git a/src/MiddlewareFactory.php b/src/MiddlewareFactory.php
@@ -27,7 +27,12 @@ public function create($middlewareDefinition): MiddlewareInterface
     }
 
     /**
-     * @param array|callable|string $middlewareDefinition
+     * @param array|callable|string $middlewareDefinition A name of PSR-15 middleware, a callable with
+     * `function(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface` signature or
+     * a handler action (an array of [handlerClass, handlerMethod]). For handler action and callable typed parameters
+     * are automatically injected using dependency injection container passed to the route.
+     * Current request and handler could be obtained by type-hinting for {@see ServerRequestInterface}
+     * and {@see RequestHandlerInterface}.
      *
      * @return MiddlewareInterface
      */
@@ -85,7 +90,12 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface
     }
 
     /**
-     * @param array|callable|string $middlewareDefinition
+     * @param array|callable|string $middlewareDefinition A name of PSR-15 middleware, a callable with
+     * `function(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface` signature or
+     * a handler action (an array of [handlerClass, handlerMethod]). For handler action and callable typed parameters
+     * are automatically injected using dependency injection container passed to the route.
+     * Current request and handler could be obtained by type-hinting for {@see ServerRequestInterface}
+     * and {@see RequestHandlerInterface}.
      */
     private function validateMiddleware($middlewareDefinition): void
     {
diff --git a/src/MiddlewareFactoryInterface.php b/src/MiddlewareFactoryInterface.php
@@ -8,5 +8,14 @@
 
 interface MiddlewareFactoryInterface
 {
+    /**
+     * @param array|callable|string $middlewareDefinition A name of PSR-15 middleware, a callable with
+     * `function(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface` signature or
+     * a handler action (an array of [handlerClass, handlerMethod]). For handler action and callable typed parameters
+     * are automatically injected using dependency injection container passed to the route.
+     * Current request and handler could be obtained by type-hinting for {@see ServerRequestInterface}
+     * and {@see RequestHandlerInterface}.
+     * @return MiddlewareInterface
+     */
     public function create($middlewareDefinition): MiddlewareInterface;
 }

Original file line number	Diff line number	Diff line change
`@@ -8,5 +8,14 @@`
`8`	`8`
`9`	`9`	`interface MiddlewareFactoryInterface`
`10`	`10`	`{`
	`11`	`+ /**`
	`12`	`+ * @param array\|callable\|string $middlewareDefinition A name of PSR-15 middleware, a callable with`
	`13`	+ * `function(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface` signature or
	`14`	`+ * a handler action (an array of [handlerClass, handlerMethod]). For handler action and callable typed parameters`
	`15`	`+ * are automatically injected using dependency injection container passed to the route.`
	`16`	`+ * Current request and handler could be obtained by type-hinting for {@see ServerRequestInterface}`
	`17`	`+ * and {@see RequestHandlerInterface}.`
	`18`	`+ * @return MiddlewareInterface`
	`19`	`+ */`
`11`	`20`	`public function create($middlewareDefinition): MiddlewareInterface;`
`12`	`21`	`}`