update clearMetadata()

Author: michalsn

system/Images/Handlers/BaseHandler.php

@@ -777,10 +777,8 @@ public function getHeight()
      * since all the data are cleared automatically.
      *
      * GDHandler can't preserve the image metadata.
-     *
-     * @param array<int|string, array<int, string>|string> $data
      */
-    public function clearMetadata(array $data = []): static
+    public function clearMetadata(): static
     {
         return $this;
     }

system/Images/Handlers/ImageMagickHandler.php

@@ -539,48 +539,17 @@ public function reorient(bool $silent = false)
     }
 
     /**
-     * Clears metadata from the image based on specified parameters.
-     *
-     * Configuration for metadata clearing:
-     *    - If empty, all metadata is stripped
-     *    - If contains 'except' key, keeps only those properties
-     *    - Otherwise, deletes only the specified keys
-     *
-     * @param array<int|string, array<int, string>|string> $data
+     * Clears metadata from the image.
      *
      * @return $this
      *
      * @throws ImagickException
      */
-    public function clearMetadata(array $data = []): static
+    public function clearMetadata(): static
     {
         $this->ensureResource();
 
-        // Strip all metadata when no parameters are provided
-        if ($data === []) {
-            $this->resource->stripImage();
-
-            return $this;
-        }
-
-        // Keep only properties specified in 'except' array
-        if (isset($data['except'])) {
-            $propertiesToKeep = (array) $data['except'];
-            $allPropertyNames = $this->resource->getImageProperties('*', false);
-
-            foreach ($allPropertyNames as $property) {
-                if (! in_array($property, $propertiesToKeep, true)) {
-                    $this->resource->deleteImageProperty($property);
-                }
-            }
-
-            return $this;
-        }
-
-        // Delete only specific properties
-        foreach ($data as $property) {
-            $this->resource->deleteImageProperty($property);
-        }
+        $this->resource->stripImage();
 
         return $this;
     }

tests/system/Images/ImageMagickHandlerTest.php

@@ -459,72 +459,24 @@ public function testClearMetadataReturnsSelf(): void
         $this->assertSame($this->handler, $result);
     }
 
-    public function testClearMetadataAll(): void
+    public function testClearMetadata(): void
     {
-        $this->handler->withFile($this->path);
+        $this->handler->withFile($this->origin . 'Steveston_dusk.JPG');
         /** @var Imagick $imagick */
         $imagick = $this->handler->getResource();
         $before  = $imagick->getImageProperties();
-        $this->assertGreaterThan(10, $before);
-
-        $this->handler
-            ->clearMetadata()
-            ->save($this->root . 'ci-logo-no-metadata.png');
-
-        $this->handler->withFile($this->root . 'ci-logo-no-metadata.png');
-        /** @var Imagick $imagick */
-        $imagick = $this->handler->getResource();
-        $after   = $imagick->getImageProperties();
 
-        $this->assertLessThan(10, count($after));
-    }
-
-    public function testClearMetadataExcept(): void
-    {
-        $this->handler->withFile($this->path);
-        /** @var Imagick $imagick */
-        $imagick = $this->handler->getResource();
-        $before  = $imagick->getImageProperties();
-        $this->assertArrayHasKey('png:gAMA', $before);
+        $this->assertCount(44, $before);
 
-        // Keep 2 properties
         $this->handler
-            ->clearMetadata(['except' => ['png:bKGD', 'png:cHRM']])
-            ->save($this->root . 'ci-logo-no-metadata.png');
-
-        $this->handler->withFile($this->root . 'ci-logo-no-metadata.png');
-        /** @var Imagick $imagick */
-        $imagick = $this->handler->getResource();
-        $after   = $imagick->getImageProperties();
-
-        $this->assertArrayHasKey('png:bKGD', $after);
-        $this->assertArrayHasKey('png:cHRM', $after);
-        $this->assertArrayNotHasKey('png:gAMA', $after);
-    }
-
-    public function testClearMetadataSpecific(): void
-    {
-        $this->handler->withFile($this->path);
-        /** @var Imagick $imagick */
-        $imagick = $this->handler->getResource();
-        $before  = $imagick->getImageProperties();
-
-        $this->assertArrayHasKey('png:bKGD', $before);
-        $this->assertArrayHasKey('png:cHRM', $before);
-        $this->assertArrayHasKey('png:gAMA', $before);
-
-        // Delete only 1
-        $this->handler
-            ->clearMetadata(['png:gAMA'])
-            ->save($this->root . 'ci-logo-no-metadata.png');
+            ->clearMetadata()
+            ->save($this->root . 'exif-info-no-metadata.jpg');
 
-        $this->handler->withFile($this->root . 'ci-logo-no-metadata.png');
+        $this->handler->withFile($this->root . 'exif-info-no-metadata.jpg');
         /** @var Imagick $imagick */
         $imagick = $this->handler->getResource();
         $after   = $imagick->getImageProperties();
 
-        $this->assertArrayHasKey('png:bKGD', $after);
-        $this->assertArrayHasKey('png:cHRM', $after);
-        $this->assertArrayNotHasKey('png:gAMA', $after);
+        $this->assertCount(5, $after);
     }
 }

user_guide_src/source/libraries/images.rst

@@ -264,26 +264,14 @@ The possible options that are recognized are as follows:
 Clearing Image Metadata
 =======================
 
-This method provides control over which metadata is preserved or removed from an image.
+This method removes metadata (EXIF, XMP, ICC, IPTC, comments, etc.) from an image.
 
 .. important:: The GD image library automatically strips all metadata during processing,
         so this method has no additional effect when using the GD handler.
         This behavior is built into GD itself and cannot be modified.
 
-.. note:: Some essential technical metadata (dimensions, color depth) will be regenerated
-        during save operations as they're required for image display. However, all privacy-sensitive
-        information such as GPS location, camera details, and timestamps can be completely removed.
-
-The method supports three different operations depending on the provided parameters:
-
-**Clear all metadata** - When an empty array is passed, all metadata is stripped from the image.
+Some essential technical metadata (dimensions, color depth) will be regenerated during save operations
+as they're required for image display. However, all privacy-sensitive information such as GPS location,
+camera details, and timestamps will be completely removed.
 
 .. literalinclude:: images/015.php
-
-**Keep only specific properties** - When using the 'except' key, only the specified properties are preserved.
-
-.. literalinclude:: images/016.php
-
-**Delete specific properties** - When providing a list of property names, only those properties are removed.
-
-.. literalinclude:: images/017.php

user_guide_src/source/libraries/images/016.php

@@ -1,4 +1,4 @@
-# total 3320 errors
+# total 3316 errors
 includes:
     - argument.type.neon
     - assign.propertyType.neon

user_guide_src/source/libraries/images/017.php

@@ -1,10 +1,10 @@
-# total 8 errors
+# total 4 errors
 
 parameters:
     ignoreErrors:
         -
             message: '#^PHPDoc tag @var with type Imagick is not subtype of type resource\.$#'
-            count: 6
+            count: 2
             path: ../../tests/system/Images/ImageMagickHandlerTest.php
 
         -