docs: add summary

apiato · Jun 8, 2024 · 6174709 · 6174709
1 parent 3845577
commit 6174709
Show file tree

Hide file tree

Showing 6 changed files with 60 additions and 34 deletions.
diff --git a/src/Macros/ResponseTransformer/Accepted.php b/src/Macros/ResponseTransformer/Accepted.php
@@ -9,12 +9,16 @@
 class Accepted {
     public function __invoke(): callable
     {
-        return function (): JsonResponse {
-            /** @var ResponseTransformer $this */
-            if (is_null($this->getTransformer())) {
-                $this->transformWith(Transformer::empty());
-            }
-            return $this->respond(202);
-        };
+        return
+            /**
+             * Returns a 202 Accepted response.
+             */
+            function (): JsonResponse {
+                /** @var ResponseTransformer $this */
+                if (is_null($this->getTransformer())) {
+                    $this->transformWith(Transformer::empty());
+                }
+                return $this->respond(202);
+            };
     }
 }
diff --git a/src/Macros/ResponseTransformer/CreateFrom.php b/src/Macros/ResponseTransformer/CreateFrom.php
@@ -9,8 +9,12 @@
 class CreateFrom {
     public function __invoke(): callable
     {
-        return function (mixed $data = null, callable|TransformerAbstract|null $transformer = null, SerializerAbstract|null $serializer = null): ResponseTransformer {
-            return ResponseTransformer::create($data, $transformer, $serializer);
-        };
+        return
+            /**
+             * Create a new Response instance.
+             */
+            function (mixed $data = null, callable|TransformerAbstract|null $transformer = null, SerializerAbstract|null $serializer = null): ResponseTransformer {
+                return ResponseTransformer::create($data, $transformer, $serializer);
+            };
     }
 }
diff --git a/src/Macros/ResponseTransformer/Created.php b/src/Macros/ResponseTransformer/Created.php
@@ -9,12 +9,16 @@
 class Created {
     public function __invoke(): callable
     {
-        return function (): JsonResponse {
-            /** @var ResponseTransformer $this */
-            if (is_null($this->getTransformer())) {
-                $this->transformWith(Transformer::empty());
-            }
-            return $this->respond(201);
-        };
+        return
+            /**
+             * Returns a 201 Created response.
+             */
+            function (): JsonResponse {
+                /** @var ResponseTransformer $this */
+                if (is_null($this->getTransformer())) {
+                    $this->transformWith(Transformer::empty());
+                }
+                return $this->respond(201);
+            };
     }
 }
diff --git a/src/Macros/ResponseTransformer/GetRequestedIncludes.php b/src/Macros/ResponseTransformer/GetRequestedIncludes.php
@@ -10,8 +10,14 @@ class GetRequestedIncludes
 {
     public function __invoke(): callable
     {
-        return function (): array {
-            return app(Manager::class)->parseIncludes(Request::get(Config::get('apiato.requests.params.include', 'include'), []))->getRequestedIncludes();
-        };
+        return
+            /**
+             * Parse the include parameter from the request and return an array of resources to include.
+             *
+             * Includes can be Array or csv string of resources to include.
+             */
+            function (): array {
+                return app(Manager::class)->parseIncludes(Request::get(Config::get('apiato.requests.params.include', 'include'), []))->getRequestedIncludes();
+            };
     }
 }
diff --git a/src/Macros/ResponseTransformer/NoContent.php b/src/Macros/ResponseTransformer/NoContent.php
@@ -9,12 +9,16 @@
 class NoContent {
     public function __invoke(): callable
     {
-        return function (): JsonResponse {
-            /** @var ResponseTransformer $this */
-            if (is_null($this->getTransformer())) {
-                $this->transformWith(Transformer::empty());
-            }
-            return $this->respond(204);
-        };
+        return
+            /**
+             * Returns a 204 No Content response.
+             */
+            function (): JsonResponse {
+                /** @var ResponseTransformer $this */
+                if (is_null($this->getTransformer())) {
+                    $this->transformWith(Transformer::empty());
+                }
+                return $this->respond(204);
+            };
     }
 }
diff --git a/src/Macros/ResponseTransformer/Ok.php b/src/Macros/ResponseTransformer/Ok.php
@@ -9,12 +9,16 @@
 class Ok {
     public function __invoke(): callable
     {
-        return function (): JsonResponse {
-            /** @var ResponseTransformer $this */
-            if (is_null($this->getTransformer())) {
-                $this->transformWith(Transformer::empty());
-            }
-            return $this->respond(200);
-        };
+        return
+            /**
+             * Returns a 200 OK response.
+             */
+            function (): JsonResponse {
+                /** @var ResponseTransformer $this */
+                if (is_null($this->getTransformer())) {
+                    $this->transformWith(Transformer::empty());
+                }
+                return $this->respond(200);
+            };
     }
 }