Merge branch 'feature/538-more-types' into release-3.0.0

Close #538

Author: weierophinney

CHANGELOG.md

@@ -9,6 +9,9 @@ All notable changes to this project will be documented in this file, in reverse
 - [#529](https://github.com/zendframework/zend-expressive/pull/529) adds support
   for PSR-15.
 
+- [#538](https://github.com/zendframework/zend-expressive/pull/538) adds scalar
+  and return type hints to methods wherever possible.
+
 ### Changed
 
 - Nothing.

src/AppFactory.php

@@ -41,7 +41,6 @@ final class AppFactory
      *     instance
      * @param null|Router\RouterInterface $router Router implementation to use;
      *     defaults to the FastRoute router bridge.
-     * @return Application
      * @throws Exception\MissingDependencyException if the container was not
      *     provided and the ServiceManager class is not present.
      * @throws Exception\MissingDependencyException if the router was not
@@ -50,7 +49,7 @@ final class AppFactory
     public static function create(
         ContainerInterface $container = null,
         Router\RouterInterface $router = null
-    ) {
+    ) : Application {
         if (! $container && ! class_exists(ServiceManager::class)) {
             throw new Exception\MissingDependencyException(sprintf(
                 '%s requires a container, but none was provided and %s is not installed',

src/Application.php

@@ -81,12 +81,9 @@ class Application extends MiddlewarePipe
     private $responsePrototype;
 
     /**
-     * Constructor
-     *
      * Calls on the parent constructor, and then uses the provided arguments
      * to set internal properties.
      *
-     * @param Router\RouterInterface $router
      * @param null|ContainerInterface $container IoC container from which to pull services, if any.
      * @param null|RequestHandlerInterface $defaultDelegate Default delegate
      *     to use when $out is not provided on invocation / run() is invoked.
@@ -109,67 +106,55 @@ public function __construct(
     }
 
     /**
-     * @param string|Router\Route $path
      * @param callable|string $middleware Middleware (or middleware service name) to associate with route.
      * @param null|string $name The name of the route.
-     * @return Router\Route
      */
-    public function get($path, $middleware, $name = null)
+    public function get(string $path, $middleware, string $name = null) : Router\Route
     {
         return $this->route($path, $middleware, ['GET'], $name);
     }
 
     /**
-     * @param string|Router\Route $path
      * @param callable|string $middleware Middleware (or middleware service name) to associate with route.
      * @param null|string $name The name of the route.
-     * @return Router\Route
      */
-    public function post($path, $middleware, $name = null)
+    public function post(string $path, $middleware, $name = null) : Router\Route
     {
         return $this->route($path, $middleware, ['POST'], $name);
     }
 
     /**
-     * @param string|Router\Route $path
      * @param callable|string $middleware Middleware (or middleware service name) to associate with route.
      * @param null|string $name The name of the route.
-     * @return Router\Route
      */
-    public function put($path, $middleware, $name = null)
+    public function put(string $path, $middleware, string $name = null) : Router\Route
     {
         return $this->route($path, $middleware, ['PUT'], $name);
     }
 
     /**
-     * @param string|Router\Route $path
      * @param callable|string $middleware Middleware (or middleware service name) to associate with route.
      * @param null|string $name The name of the route.
-     * @return Router\Route
      */
-    public function patch($path, $middleware, $name = null)
+    public function patch(string $path, $middleware, string $name = null) : Router\Route
     {
         return $this->route($path, $middleware, ['PATCH'], $name);
     }
 
     /**
-     * @param string|Router\Route $path
      * @param callable|string $middleware Middleware (or middleware service name) to associate with route.
      * @param null|string $name The name of the route.
-     * @return Router\Route
      */
-    public function delete($path, $middleware, $name = null)
+    public function delete(string $path, $middleware, string $name = null) : Router\Route
     {
         return $this->route($path, $middleware, ['DELETE'], $name);
     }
 
     /**
-     * @param string|Router\Route $path
      * @param callable|string $middleware Middleware (or middleware service name) to associate with route.
      * @param null|string $name The name of the route.
-     * @return Router\Route
      */
-    public function any($path, $middleware, $name = null)
+    public function any(string $path, $middleware, string $name = null) : Router\Route
     {
         return $this->route($path, $middleware, null, $name);
     }
@@ -206,7 +191,7 @@ public function any($path, $middleware, $name = null)
      *
      * @param string|array|callable $path Either a URI path prefix, or middleware.
      * @param null|string|array|callable $middleware Middleware
-     * @return self
+     * @return $this
      */
     public function pipe($path, $middleware = null) : parent
     {
@@ -254,10 +239,8 @@ public function pipe($path, $middleware = null) : parent
 
     /**
      * Register the routing middleware in the middleware pipeline.
-     *
-     * @return void
      */
-    public function pipeRoutingMiddleware()
+    public function pipeRoutingMiddleware() : void
     {
         if ($this->routeMiddlewareIsRegistered) {
             return;
@@ -267,10 +250,8 @@ public function pipeRoutingMiddleware()
 
     /**
      * Register the dispatch middleware in the middleware pipeline.
-     *
-     * @return void
      */
-    public function pipeDispatchMiddleware()
+    public function pipeDispatchMiddleware() : void
     {
         if ($this->dispatchMiddlewareIsRegistered) {
             return;
@@ -317,7 +298,7 @@ public function route(string $path, $middleware, array $methods = null, string $
      *
      * @return Router\Route[]
      */
-    public function getRoutes()
+    public function getRoutes() : array
     {
         return $this->routes;
     }
@@ -334,12 +315,8 @@ public function getRoutes()
      *
      * Once it has processed itself, it emits the returned response using the
      * composed emitter.
-     *
-     * @param null|ServerRequestInterface $request
-     * @param null|ResponseInterface $response
-     * @return void
      */
-    public function run(ServerRequestInterface $request = null, ResponseInterface $response = null)
+    public function run(ServerRequestInterface $request = null, ResponseInterface $response = null) : void
     {
         try {
             $request  = $request ?: ServerRequestFactory::fromGlobals();
@@ -364,10 +341,9 @@ public function run(ServerRequestInterface $request = null, ResponseInterface $r
      *
      * If no IoC container is registered, we raise an exception.
      *
-     * @return ContainerInterface
      * @throws Exception\ContainerNotRegisteredException
      */
-    public function getContainer()
+    public function getContainer() : ContainerInterface
     {
         if (null === $this->container) {
             throw new Exception\ContainerNotRegisteredException();
@@ -384,10 +360,8 @@ public function getContainer()
      *   service, pulls that service, assigns it, and returns it.
      * - If no container is composed, creates an instance of Delegate\NotFoundDelegate
      *   using the current response prototype only (i.e., no templating).
-     *
-     * @return RequestHandlerInterface
      */
-    public function getDefaultDelegate()
+    public function getDefaultDelegate() : RequestHandlerInterface
     {
         if ($this->defaultDelegate) {
             return $this->defaultDelegate;
@@ -413,10 +387,8 @@ public function getDefaultDelegate()
      *
      * If none was registered during instantiation, this will lazy-load an
      * EmitterStack composing an SapiEmitter instance.
-     *
-     * @return EmitterInterface
      */
-    public function getEmitter()
+    public function getEmitter() : EmitterInterface
     {
         if (! $this->emitter) {
             $this->emitter = new Emitter\EmitterStack();
@@ -432,11 +404,9 @@ public function getEmitter()
      * if so, and it responds to any of the $methods indicated, raises
      * a DuplicateRouteException indicating a duplicate route.
      *
-     * @param string $path
-     * @param null|array $methods
      * @throws Exception\DuplicateRouteException on duplicate route detection.
      */
-    private function checkForDuplicateRoute($path, $methods = null)
+    private function checkForDuplicateRoute(string $path, array $methods = null) : void
     {
         if (null === $methods) {
             $methods = Router\Route::HTTP_METHOD_ANY;
@@ -463,11 +433,7 @@ private function checkForDuplicateRoute($path, $methods = null)
         }
     }
 
-    /**
-     * @param Throwable $exception
-     * @return void
-     */
-    private function emitMarshalServerRequestException(Throwable $exception)
+    private function emitMarshalServerRequestException(Throwable $exception) : void
     {
         if ($this->container && $this->container->has(Middleware\ErrorResponseGenerator::class)) {
             $generator = $this->container->get(Middleware\ErrorResponseGenerator::class);

src/ApplicationConfigInjectionTrait.php

@@ -67,9 +67,8 @@ trait ApplicationConfigInjectionTrait
      *
      * @param null|array $config If null, attempts to pull the 'config' service
      *     from the composed container.
-     * @return void
      */
-    public function injectPipelineFromConfig(array $config = null)
+    public function injectPipelineFromConfig(array $config = null) : void
     {
         if (null === $config) {
             $config = $this->container->has('config') ? $this->container->get('config') : [];
@@ -136,10 +135,9 @@ public function injectPipelineFromConfig(array $config = null)
      *
      * @param null|array $config If null, attempts to pull the 'config' service
      *     from the composed container.
-     * @return void
      * @throws Exception\InvalidArgumentException
      */
-    public function injectRoutesFromConfig(array $config = null)
+    public function injectRoutesFromConfig(array $config = null) : void
     {
         if (null === $config) {
             $config = $this->container->has('config') ? $this->container->get('config') : [];
@@ -202,10 +200,9 @@ public function injectRoutesFromConfig(array $config = null)
      * If the 'middleware' value is missing, or not viable as middleware, it
      * raises an exception, to ensure the pipeline is built correctly.
      *
-     * @return callable
      * @throws Exception\InvalidArgumentException
      */
-    private function createCollectionMapper()
+    private function createCollectionMapper() : callable
     {
         $appMiddlewares = [
             Application::ROUTING_MIDDLEWARE,
@@ -240,10 +237,8 @@ private function createCollectionMapper()
      *
      * The function is useful to reduce an array of pipeline middleware to a
      * priority queue.
-     *
-     * @return callable
      */
-    private function createPriorityQueueReducer()
+    private function createPriorityQueueReducer() : callable
     {
         // $serial is used to ensure that items of the same priority are enqueued
         // in the order in which they are inserted.

src/Container/ApplicationFactory.php

@@ -54,11 +54,8 @@ class ApplicationFactory
      *
      * See the class level docblock for information on what services this
      * factory will optionally consume.
-     *
-     * @param ContainerInterface $container
-     * @return Application
      */
-    public function __invoke(ContainerInterface $container)
+    public function __invoke(ContainerInterface $container) : Application
     {
         $config = $container->has('config') ? $container->get('config') : [];
         $config = $config instanceof ArrayObject ? $config->getArrayCopy() : $config;
@@ -86,12 +83,8 @@ public function __invoke(ContainerInterface $container)
 
     /**
      * Injects routes and the middleware pipeline into the application.
-     *
-     * @param Application $app
-     * @param array $config
-     * @return void
      */
-    private function injectRoutesAndPipeline(Application $app, array $config)
+    private function injectRoutesAndPipeline(Application $app, array $config) : void
     {
         $app->injectRoutesFromConfig($config);
         $app->injectPipelineFromConfig($config);

src/Container/ErrorHandlerFactory.php

@@ -16,11 +16,7 @@
 
 class ErrorHandlerFactory
 {
-    /**
-     * @param ContainerInterface $container
-     * @return ErrorHandler
-     */
-    public function __invoke(ContainerInterface $container)
+    public function __invoke(ContainerInterface $container) : ErrorHandler
     {
         $generator = $container->has(ErrorResponseGenerator::class)
             ? $container->get(ErrorResponseGenerator::class)

src/Container/ErrorResponseGeneratorFactory.php

@@ -15,11 +15,7 @@
 
 class ErrorResponseGeneratorFactory
 {
-    /**
-     * @param ContainerInterface $container
-     * @return ErrorResponseGenerator
-     */
-    public function __invoke(ContainerInterface $container)
+    public function __invoke(ContainerInterface $container) : ErrorResponseGenerator
     {
         $config = $container->has('config') ? $container->get('config') : [];
 

src/Container/NotFoundDelegateFactory.php

@@ -16,11 +16,7 @@
 
 class NotFoundDelegateFactory
 {
-    /**
-     * @param ContainerInterface $container
-     * @return NotFoundDelegate
-     */
-    public function __invoke(ContainerInterface $container)
+    public function __invoke(ContainerInterface $container) : NotFoundDelegate
     {
         $config   = $container->has('config') ? $container->get('config') : [];
         $renderer = $container->has(TemplateRendererInterface::class)

src/Container/NotFoundHandlerFactory.php

@@ -15,11 +15,7 @@
 
 class NotFoundHandlerFactory
 {
-    /**
-     * @param ContainerInterface $container
-     * @return NotFoundHandler
-     */
-    public function __invoke(ContainerInterface $container)
+    public function __invoke(ContainerInterface $container) : NotFoundHandler
     {
         return new NotFoundHandler($container->get(NotFoundDelegate::class));
     }

src/Container/WhoopsErrorResponseGeneratorFactory.php

@@ -14,11 +14,7 @@
 
 class WhoopsErrorResponseGeneratorFactory
 {
-    /**
-     * @param ContainerInterface $container
-     * @return WhoopsErrorResponseGenerator
-     */
-    public function __invoke(ContainerInterface $container)
+    public function __invoke(ContainerInterface $container) : WhoopsErrorResponseGenerator
     {
         return new WhoopsErrorResponseGenerator(
             $container->get('Zend\Expressive\Whoops')