Renamed default_types to default_types_map

Author: acelaya

mkdocs.yml

@@ -9,6 +9,7 @@ pages:
         - "Exceptions": exception.md
         - "Error Handling Middleware": middleware.md
         - "Not Found Handler": not-found-handler.md
+        - "Default types": default-types.md
 site_name: zend-problem-details
 site_description: 'PSR-7 Problem Details for HTTP API responses and middleware'
 repo_url: 'https://github.com/zendframework/zend-problem-details'

src/ProblemDetailsResponseFactory.php

@@ -211,15 +211,15 @@ class ProblemDetailsResponseFactory
      *
      * @var array
      */
-    private $defaultTypes;
+    private $defaultTypesMap;
 
     public function __construct(
         callable $responseFactory,
         bool $isDebug = self::EXCLUDE_THROWABLE_DETAILS,
         int $jsonFlags = null,
         bool $exceptionDetailsInResponse = false,
         string $defaultDetailMessage = self::DEFAULT_DETAIL_MESSAGE,
-        array $defaultTypes = []
+        array $defaultTypesMap = []
     ) {
         // Ensures type safety of the composed factory
         $this->responseFactory = function () use ($responseFactory) : ResponseInterface {
@@ -238,7 +238,7 @@ public function __construct(
         $this->jsonFlags = $jsonFlags;
         $this->exceptionDetailsInResponse = $exceptionDetailsInResponse;
         $this->defaultDetailMessage = $defaultDetailMessage;
-        $this->defaultTypes = $defaultTypes;
+        $this->defaultTypesMap = $defaultTypesMap;
     }
 
     public function createResponse(
@@ -403,7 +403,7 @@ private function createTitleFromStatus(int $status) : string
 
     private function createTypeFromStatus(int $status) : string
     {
-        return $this->defaultTypes[$status] ?? sprintf('https://httpstatus.es/%s', $status);
+        return $this->defaultTypesMap[$status] ?? sprintf('https://httpstatus.es/%s', $status);
     }
 
     private function createThrowableDetail(Throwable $e) : array

src/ProblemDetailsResponseFactoryFactory.php

@@ -21,15 +21,15 @@ public function __invoke(ContainerInterface $container) : ProblemDetailsResponse
 
         $problemDetailsConfig = $config['problem-details'] ?? [];
         $jsonFlags = $problemDetailsConfig['json_flags'] ?? null;
-        $defaultTypes = $problemDetailsConfig['default_types'] ?? [];
+        $defaultTypesMap = $problemDetailsConfig['default_types_map'] ?? [];
 
         return new ProblemDetailsResponseFactory(
             $container->get(ResponseInterface::class),
             $includeThrowableDetail,
             $jsonFlags,
             $includeThrowableDetail,
             ProblemDetailsResponseFactory::DEFAULT_DETAIL_MESSAGE,
-            $defaultTypes
+            $defaultTypesMap
         );
     }
 }

test/ProblemDetailsResponseFactoryFactoryTest.php

@@ -147,7 +147,9 @@ public function testUsesDefaultTypesSettingFromConfigWhenPresent() : void
         ];
 
         $this->container->has('config')->willReturn(true);
-        $this->container->get('config')->willReturn(['problem-details' => ['default_types' => $expectedDefaultTypes]]);
+        $this->container->get('config')->willReturn(
+            ['problem-details' => ['default_types_map' => $expectedDefaultTypes]]
+        );
 
         $this->container->get(ResponseInterface::class)->willReturn(function () {
         });
@@ -156,6 +158,6 @@ public function testUsesDefaultTypesSettingFromConfigWhenPresent() : void
         $factory = $factoryFactory($this->container->reveal());
 
         $this->assertInstanceOf(ProblemDetailsResponseFactory::class, $factory);
-        $this->assertAttributeSame($expectedDefaultTypes, 'defaultTypes', $factory);
+        $this->assertAttributeSame($expectedDefaultTypes, 'defaultTypesMap', $factory);
     }
 }

test/ProblemDetailsResponseFactoryTest.php

@@ -479,23 +479,23 @@ function (array $payload) {
 
     public function provideMappedStatuses() : array
     {
-        $defaultTypes = [
+        $defaultTypesMap = [
             404 => 'https://example.com/problem-details/error/not-found',
             500 => 'https://example.com/problem-details/error/internal-server-error',
         ];
 
         return [
-            [$defaultTypes, 404, 'https://example.com/problem-details/error/not-found'],
-            [$defaultTypes, 500, 'https://example.com/problem-details/error/internal-server-error'],
-            [$defaultTypes, 400, 'https://httpstatus.es/400'],
+            [$defaultTypesMap, 404, 'https://example.com/problem-details/error/not-found'],
+            [$defaultTypesMap, 500, 'https://example.com/problem-details/error/internal-server-error'],
+            [$defaultTypesMap, 400, 'https://httpstatus.es/400'],
             [[], 500, 'https://httpstatus.es/500'],
         ];
     }
 
     /**
      * @dataProvider provideMappedStatuses
      */
-    public function testTypeIsInferredFromDefaultTypesMap(array $defaultTypes, int $status, string $expectedType) : void
+    public function testTypeIsInferredFromDefaultTypesMap(array $map, int $status, string $expectedType) : void
     {
         $this->request->getHeaderLine('Accept')->willReturn('application/json');
 
@@ -519,7 +519,7 @@ function () {
             null,
             false,
             '',
-            $defaultTypes
+            $map
         );
 
         $factory->createResponse($this->request->reveal(), $status, 'detail');