chore(app): Style, Rector, and Stan changes

Author: lonnieezell

app/Transformers/Customer.php

@@ -9,8 +9,6 @@ class Customer extends BaseTransformer
     /**
      * Transform the resource into an array.
      *
-     * @param mixed $resource
-     *
      * @return array<string, mixed>
      */
     public function toArray(mixed $resource): array

loader.neon

@@ -0,0 +1,4 @@
+# total 5 errors
+
+includes:
+    - missingType.iterableValue.neon

system/API/ApiException.php

@@ -13,15 +13,15 @@
 
 namespace CodeIgniter\API;
 
+use Exception;
+
 /**
  * Custom exception for API-related errors.
  */
-class ApiException extends \Exception
+class ApiException extends Exception
 {
     /**
      * Thrown when the fields requested in a URL are not valid.
-     *
-     * @return ApiException
      */
     public static function forInvalidFields(string $field): self
     {
@@ -30,8 +30,6 @@ public static function forInvalidFields(string $field): self
 
     /**
      * Thrown when the includes requested in a URL are not valid.
-     *
-     * @return ApiException
      */
     public static function forInvalidIncludes(string $include): self
     {
@@ -41,8 +39,6 @@ public static function forInvalidIncludes(string $include): self
     /**
      * Thrown when an include is requested, but the method to handle it
      * does not exist on the model.
-     *
-     * @return ApiException
      */
     public static function forMissingInclude(string $include): self
     {
@@ -51,8 +47,6 @@ public static function forMissingInclude(string $include): self
 
     /**
      * Thrown when a transformer class cannot be found.
-     *
-     * @return ApiException
      */
     public static function forTransformerNotFound(string $transformerClass): self
     {
@@ -61,8 +55,6 @@ public static function forTransformerNotFound(string $transformerClass): self
 
     /**
      * Thrown when a transformer class does not implement TransformerInterface.
-     *
-     * @return ApiException
      */
     public static function forInvalidTransformer(string $transformerClass): self
     {

system/API/BaseTransformer.php

@@ -56,22 +56,29 @@
  */
 abstract class BaseTransformer implements TransformerInterface
 {
+    /**
+     * @var list<string>|null
+     */
     private ?array $fields = null;
+
+    /**
+     * @var list<string>|null
+     */
     private ?array $includes = null;
+
     protected mixed $resource = null;
 
     public function __construct(
         private ?IncomingRequest $request = null,
-    )
-    {
+    ) {
         $this->request = $request ?? request();
 
-        $fields = $this->request->getGet('fields');
+        $fields       = $this->request->getGet('fields');
         $this->fields = is_string($fields)
             ? array_map('trim', explode(',', $fields))
             : $fields;
 
-        $includes = $this->request->getGet('include');
+        $includes       = $this->request->getGet('include');
         $this->includes = is_string($includes)
             ? array_map('trim', explode(',', $includes))
             : $includes;
@@ -116,14 +123,15 @@ public function transform(mixed $resource = null): array
      */
     public function transformMany(array $resources): array
     {
-        return array_map(fn($resource) => $this->transform($resource), $resources);
+        return array_map(fn ($resource): array => $this->transform($resource), $resources);
     }
 
     /**
      * Conditionally include a value.
      *
      * @param mixed $value
      * @param mixed $default
+     *
      * @return mixed
      */
     protected function when(bool $condition, $value, $default = null)
@@ -133,16 +141,23 @@ protected function when(bool $condition, $value, $default = null)
 
     /**
      * Conditionally exclude a value.
+     *
+     * @param mixed      $value
+     * @param mixed|null $default
+     *
+     * @return mixed
      */
     protected function whenNot(bool $condition, $value, $default = null)
     {
-        return ! $condition ? $value : $default;
+        return $condition ? $default : $value;
     }
 
     /**
      * Define which fields can be requested via the 'fields' query parameter.
      * Override in child classes to restrict available fields.
      * Return null to allow all fields from toArray().
+     *
+     * @return list<string>|null
      */
     protected function getAllowedFields(): ?array
     {
@@ -154,6 +169,8 @@ protected function getAllowedFields(): ?array
      * Override in child classes to restrict available includes.
      * Return null to allow all includes that have corresponding methods.
      * Return an empty array to disable all includes.
+     *
+     * @return list<string>|null
      */
     protected function getAllowedIncludes(): ?array
     {
@@ -163,6 +180,10 @@ protected function getAllowedIncludes(): ?array
     /**
      * Limits the given data array to only the fields specified
      *
+     * @param array<string, mixed> $data
+     *
+     * @return array<string, mixed>
+     *
      * @throws InvalidArgumentException
      */
     private function limitFields(array $data): array
@@ -188,6 +209,10 @@ private function limitFields(array $data): array
     /**
      * Checks the request for 'include' query variable, and if present,
      * calls the corresponding include{Resource} methods to add related data.
+     *
+     * @param array<string, mixed> $data
+     *
+     * @return array<string, mixed>
      */
     private function insertIncludes(array $data): array
     {
@@ -201,7 +226,7 @@ private function insertIncludes(array $data): array
             return $data; // No includes allowed
         }
 
-         // If whitelist is defined, filter the requested includes
+        // If whitelist is defined, filter the requested includes
         if ($allowedIncludes !== null) {
             $invalidIncludes = array_diff($this->includes, $allowedIncludes);
 
@@ -213,7 +238,7 @@ private function insertIncludes(array $data): array
         foreach ($this->includes as $include) {
             $method = 'include' . ucfirst($include);
             if (method_exists($this, $method)) {
-                $data[$include] = $this->$method();
+                $data[$include] = $this->{$method}();
             } else {
                 throw ApiException::forMissingInclude($include);
             }

system/API/TransformerInterface.php

@@ -2,6 +2,15 @@
 
 declare(strict_types=1);
 
+/**
+ * This file is part of CodeIgniter 4 framework.
+ *
+ * (c) CodeIgniter Foundation <[email protected]>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
 namespace CodeIgniter\API;
 
 /**
@@ -17,16 +26,26 @@ interface TransformerInterface
      * This is overridden by child classes to define specific fields.
      *
      * @param mixed $resource The resource being transformed
+     *
+     * @return array<string, mixed>
      */
     public function toArray(mixed $resource): array;
 
     /**
      * Transforms the given resource into an array.
+     *
+     * @param array<string, mixed>|object $resource
+     *
+     * @return array<string, mixed>
      */
-    public function transform(object|array $resource): array;
+    public function transform(array|object $resource): array;
 
     /**
      * Transforms a collection of resources using $this->transform() on each item.
+     *
+     * @param array<int|string, mixed> $resources
+     *
+     * @return array<int, array<string, mixed>>
      */
     public function transformMany(array $resources): array;
 }

system/Language/en/Api.php

@@ -13,9 +13,9 @@
 
 // API language settings
 return [
-    'invalidFields'         => 'Invalid field requested: {0}',
-    'invalidIncludes'       => 'Invalid include requested: {0}',
-    'missingInclude'        => 'Missing include method for: {0}',
-    'transformerNotFound'   => 'Transformer class \'{0}\' not found.',
-    'invalidTransformer'    => 'Transformer class \'{0}\' must implement TransformerInterface.',
+    'invalidFields'       => 'Invalid field requested: {0}',
+    'invalidIncludes'     => 'Invalid include requested: {0}',
+    'missingInclude'      => 'Missing include method for: {0}',
+    'transformerNotFound' => 'Transformer class \'{0}\' not found.',
+    'invalidTransformer'  => 'Transformer class \'{0}\' must implement TransformerInterface.',
 ];

tests/_support/API/TestTransformer.php

@@ -23,17 +23,15 @@ class TestTransformer extends BaseTransformer
     /**
      * Transform the resource into an array.
      *
-     * @param mixed $resource
-     *
      * @return array<string, mixed>
      */
     public function toArray(mixed $resource): array
     {
         return [
-            'id'            => $resource['id'] ?? null,
-            'name'          => $resource['name'] ?? null,
-            'transformed'   => true,
-            'name_upper'    => isset($resource['name']) ? strtoupper($resource['name']) : null,
+            'id'          => $resource['id'] ?? null,
+            'name'        => $resource['name'] ?? null,
+            'transformed' => true,
+            'name_upper'  => isset($resource['name']) ? strtoupper($resource['name']) : null,
         ];
     }
 }

tests/system/API/ResponseTraitTest.php

@@ -36,6 +36,8 @@
 use Exception;
 use PHPUnit\Framework\Attributes\Group;
 use stdClass;
+use Tests\Support\API\InvalidTransformer;
+use Tests\Support\API\TestTransformer;
 
 /**
  * @internal
@@ -1065,7 +1067,7 @@ public function testPaginateWithTransformer(): void
 
         $controller = $this->makeController('/api/items');
 
-        $this->invoke($controller, 'paginate', [$model, 20, \Tests\Support\API\TestTransformer::class]);
+        $this->invoke($controller, 'paginate', [$model, 20, TestTransformer::class]);
 
         $responseBody = json_decode($this->response->getBody(), true);
 
@@ -1114,7 +1116,7 @@ public function testPaginateWithTransformerAndQueryBuilder(): void
 
         $controller = $this->makeController('/api/items');
 
-        $this->invoke($controller, 'paginate', [$builder, 20, \Tests\Support\API\TestTransformer::class]);
+        $this->invoke($controller, 'paginate', [$builder, 20, TestTransformer::class]);
 
         $responseBody = json_decode($this->response->getBody(), true);
 
@@ -1152,9 +1154,9 @@ public function testPaginateWithInvalidTransformer(): void
         $controller = $this->makeController('/api/items');
 
         $this->expectException(ApiException::class);
-        $this->expectExceptionMessage(lang('Api.invalidTransformer', [\Tests\Support\API\InvalidTransformer::class]));
+        $this->expectExceptionMessage(lang('Api.invalidTransformer', [InvalidTransformer::class]));
 
-        $this->invoke($controller, 'paginate', [$model, 20, \Tests\Support\API\InvalidTransformer::class]);
+        $this->invoke($controller, 'paginate', [$model, 20, InvalidTransformer::class]);
     }
 
     public function testPaginateWithTransformerPreservesMetaAndLinks(): void
@@ -1169,7 +1171,7 @@ public function testPaginateWithTransformerPreservesMetaAndLinks(): void
 
         $controller = $this->makeController('/api/items');
 
-        $this->invoke($controller, 'paginate', [$model, 2, \Tests\Support\API\TestTransformer::class]);
+        $this->invoke($controller, 'paginate', [$model, 2, TestTransformer::class]);
 
         $responseBody = json_decode($this->response->getBody(), true);
 
@@ -1199,7 +1201,7 @@ public function testPaginateWithTransformerEmptyData(): void
 
         $controller = $this->makeController('/api/items');
 
-        $this->invoke($controller, 'paginate', [$model, 20, \Tests\Support\API\TestTransformer::class]);
+        $this->invoke($controller, 'paginate', [$model, 20, TestTransformer::class]);
 
         $responseBody = json_decode($this->response->getBody(), true);