Merge pull request #3 from TomHAnderson/hotfix/__get

Hotfix/  get

Author: TomHAnderson

README.md

@@ -25,8 +25,76 @@ use ApiSkeletons\Laravel\ApiProblem\Facades\ApiProblem;
 return ApiProblem::response('Detailed Unauthorized Message', 401);
 ```
 
+This will result in a 401 response with header
+
+```shell
+Content-Type: application/problem+json
+```
+
+and content
+```json
+{
+    "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
+    "title": "Unauthorized",
+    "status": 401,
+    "detail": "Detailed Unauthorized Messsge"
+}
+```
+
+## Use
+
+### Using the facade
+
+You may use the ApiProblem object in two ways.  First, you can use the facade to
+return a response quickly and directly as shown in the Quick Start.  When using
+the facade the arguments to the `response()` method are:
+
+```php
+    response(string|Throwable $detail, int|string $status, ?string $type = null, ?string $title = null, array $additional = [])
+```
+
+### Creating an object
+
+When creating an ApiProblem object directly, the first two parameters are swapped.
+The reason for this is the constructor for the original object remains unchanged
+and the `response()` function is modified to match the standard
+[Laravel response](https://laravel.com/docs/8.x/responses#response-objects)
+format.
+
+```php
+__construct(int|string $status, string|Throwable $detail, ?string $type = null, ?string $title = null, array $additional = [])
+```
+
+An example of creating an object directly:
+
+```php
+use ApiSkeletons\Laravel\ApiProblem\ApiProblem;
+
+$apiProblem = new ApiProblem(401, 'Detailed Unauthorized Message');
+return $apiProblem->response();
+```
+
+## Additional Details
+
+The 5th parameter to ApiProblem is $additional.  This array adds adhoc properties to the
+JSON response.  One method of using this array is a 422 response with details of the problem:
+
+```php
+use ApiSkeletons\Laravel\ApiProblem\Facades\ApiProblem;
+use Illuminate\Validation\ValidationException;
+
+try {
+    $validated = $request->validate([
+        'title' => 'required|unique:posts|max:255',
+        'body' => 'required',
+    ]);
+} catch (\Illuminate\Validation\ValidationException $e) {
+    return ApiProblem::response($e->getMessage(), 422, null, null, ['errors' => $e->errors()]);
+}
+```
+
 ## Attribution
 
 The bulk of this repository was copied from Laminas API Tools.  I wanted to provide a
 simplified interface specific to Laravel.  Though the tool could have been used directly
-from the Laminas library it would have come with a lot of overhead.  Thanks Laminas.
+from the Laminas library it would have come with a lot of overhead.

src/ApiProblem.php

@@ -187,6 +187,10 @@ public function __get(string $name): mixed
             return $this->additionalDetails[$normalized];
         }
 
+        if (isset($this->additionalDetails[$name])) {
+            return $this->additionalDetails[$name];
+        }
+
         throw new InvalidArgumentException(sprintf(
             'Invalid property name "%s"',
             $name

test/ApiProblemTest.php

@@ -303,9 +303,9 @@ public function testMagicGetNormalizedProperties(int $code): void
      */
     public function testMagicGetAdditionalDetails(int $code): void
     {
-        $apiProblem = new ApiProblem($code, 'Testing', 'test', 'title test', ['xxmore' => 'testing']);
+        $apiProblem = new ApiProblem($code, 'Testing', 'test', 'title test', ['MixedCase' => 'testing']);
 
-        $this->assertEquals('testing', $apiProblem->__get('xxmore'));
+        $this->assertEquals('testing', $apiProblem->__get('MixedCase'));
     }
 
     /**
@@ -314,8 +314,8 @@ public function testMagicGetAdditionalDetails(int $code): void
      */
     public function testMagicGetAdditionalDetailsNormalized(int $code): void
     {
-        $apiProblem = new ApiProblem($code, 'Testing', 'test', 'title test', ['code' => 'testing']);
+        $apiProblem = new ApiProblem($code, 'Testing', 'test', 'title test', ['xxcode' => 'testing']);
 
-        $this->assertEquals('testing', $apiProblem->__get('code'));
+        $this->assertEquals('testing', $apiProblem->__get('xxcode'));
     }
 }