(app): Remove when / whenNot from BaseTransformer

Author: lonnieezell

system/API/BaseTransformer.php

@@ -43,7 +43,6 @@
  *          'email' => $resource['email'],
  *          'created_at' => $resource['created_at'],
  *          'updated_at' => $resource['updated_at'],
- *          'bio' => $this->when(($resource['bio'] ?? null) !== null, $resource['bio'] ?? null),
  *      ];
  *    }
  *
@@ -126,32 +125,6 @@ public function transformMany(array $resources): array
         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)
-    {
-        return $condition ? $value : $default;
-    }
-
-    /**
-     * Conditionally exclude a value.
-     *
-     * @param mixed      $value
-     * @param mixed|null $default
-     *
-     * @return mixed
-     */
-    protected function whenNot(bool $condition, $value, $default = null)
-    {
-        return $condition ? $default : $value;
-    }
-
     /**
      * Define which fields can be requested via the 'fields' query parameter.
      * Override in child classes to restrict available fields.

tests/system/API/TransformerTest.php

@@ -193,120 +193,6 @@ public function toArray(mixed $resource): array
         $this->assertSame([], $result);
     }
 
-    public function testWhenConditionIsTrue(): void
-    {
-        $request = $this->createMockRequest();
-
-        $transformer = new class ($request) extends BaseTransformer {
-            public function toArray(mixed $resource): array
-            {
-                return [
-                    'id'   => 1,
-                    'name' => $this->when(true, 'Visible Name'),
-                ];
-            }
-        };
-
-        $result = $transformer->transform(null);
-
-        $this->assertSame(['id' => 1, 'name' => 'Visible Name'], $result);
-    }
-
-    public function testWhenConditionIsFalse(): void
-    {
-        $request = $this->createMockRequest();
-
-        $transformer = new class ($request) extends BaseTransformer {
-            public function toArray(mixed $resource): array
-            {
-                return [
-                    'id'   => 1,
-                    'name' => $this->when(false, 'Visible Name'),
-                ];
-            }
-        };
-
-        $result = $transformer->transform(null);
-
-        $this->assertSame(['id' => 1, 'name' => null], $result);
-    }
-
-    public function testWhenConditionIsFalseWithDefault(): void
-    {
-        $request = $this->createMockRequest();
-
-        $transformer = new class ($request) extends BaseTransformer {
-            public function toArray(mixed $resource): array
-            {
-                return [
-                    'id'   => 1,
-                    'name' => $this->when(false, 'Visible Name', 'Default Name'),
-                ];
-            }
-        };
-
-        $result = $transformer->transform(null);
-
-        $this->assertSame(['id' => 1, 'name' => 'Default Name'], $result);
-    }
-
-    public function testWhenNotConditionIsTrue(): void
-    {
-        $request = $this->createMockRequest();
-
-        $transformer = new class ($request) extends BaseTransformer {
-            public function toArray(mixed $resource): array
-            {
-                return [
-                    'id'   => 1,
-                    'name' => $this->whenNot(true, 'Visible Name'),
-                ];
-            }
-        };
-
-        $result = $transformer->transform(null);
-
-        $this->assertSame(['id' => 1, 'name' => null], $result);
-    }
-
-    public function testWhenNotConditionIsFalse(): void
-    {
-        $request = $this->createMockRequest();
-
-        $transformer = new class ($request) extends BaseTransformer {
-            public function toArray(mixed $resource): array
-            {
-                return [
-                    'id'   => 1,
-                    'name' => $this->whenNot(false, 'Visible Name'),
-                ];
-            }
-        };
-
-        $result = $transformer->transform(null);
-
-        $this->assertSame(['id' => 1, 'name' => 'Visible Name'], $result);
-    }
-
-    public function testWhenNotConditionIsTrueWithDefault(): void
-    {
-        $request = $this->createMockRequest();
-
-        $transformer = new class ($request) extends BaseTransformer {
-            public function toArray(mixed $resource): array
-            {
-                return [
-                    'id'   => 1,
-                    'name' => $this->whenNot(true, 'Visible Name', 'Default Name'),
-                ];
-            }
-        };
-
-        $result = $transformer->transform(null);
-
-        $this->assertSame(['id' => 1, 'name' => 'Default Name'], $result);
-    }
-
     public function testLimitFieldsWithNoFieldsParam(): void
     {
         $request = $this->createMockRequest();

user_guide_src/source/outgoing/api_transformers.rst

@@ -100,37 +100,6 @@ it to the client.
 
 .. literalinclude:: api_resources/003.php
 
-***********************
-Conditional Fields
-***********************
-
-Often you'll want to include certain fields only under specific conditions. The ``when()`` and ``whenNot()``
-methods make this easy.
-
-Using when()
-============
-
-The ``when()`` method includes a value only if the condition is true:
-
-.. literalinclude:: api_resources/004.php
-
-In this example, the ``bio`` field will only be included if it has a non-null value. If the condition is
-false, the field will be set to ``null`` by default.
-
-Providing a Default Value
-==========================
-
-You can provide a default value to use when the condition is false:
-
-.. literalinclude:: api_resources/005.php
-
-Using whenNot()
-===============
-
-The ``whenNot()`` method is the opposite of ``when()`` - it includes a value only if the condition is false:
-
-.. literalinclude:: api_resources/006.php
-
 ***********************
 Field Filtering
 ***********************
@@ -332,32 +301,6 @@ Class Reference
 
         .. literalinclude:: api_resources/019.php
 
-    .. php:method:: when(bool $condition, $value, $default = null)
-
-        :param bool $condition: The condition to evaluate
-        :param mixed $value: The value to return if the condition is true
-        :param mixed $default: The value to return if the condition is false (defaults to ``null``)
-        :returns: The value or default based on the condition
-        :rtype: mixed
-
-        Helper method to conditionally include a value in the transformation. Returns ``$value`` if
-        ``$condition`` is true, otherwise returns ``$default``.
-
-        .. literalinclude:: api_resources/020.php
-
-    .. php:method:: whenNot(bool $condition, $value, $default = null)
-
-        :param bool $condition: The condition to evaluate
-        :param mixed $value: The value to return if the condition is false
-        :param mixed $default: The value to return if the condition is true (defaults to ``null``)
-        :returns: The value or default based on the condition
-        :rtype: mixed
-
-        Helper method to conditionally exclude a value. Returns ``$value`` if ``$condition`` is false,
-        otherwise returns ``$default``.
-
-        .. literalinclude:: api_resources/021.php
-
     .. php:method:: getAllowedFields()
 
         :returns: Array of allowed field names, or ``null`` to allow all fields