Implement new method ColorInterface::isClear() (#1387)

Intervention · Aug 11, 2024 · 4a614dd · 4a614dd
1 parent 6196ff1
commit 4a614dd
Show file tree

Hide file tree

Showing 9 changed files with 80 additions and 0 deletions.
diff --git a/src/Colors/Cmyk/Color.php b/src/Colors/Cmyk/Color.php
@@ -152,4 +152,14 @@ public function isTransparent(): bool
     {
         return false;
     }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @see ColorInterface::isClear()
+     */
+    public function isClear(): bool
+    {
+        return false;
+    }
 }
diff --git a/src/Colors/Hsl/Color.php b/src/Colors/Hsl/Color.php
@@ -120,4 +120,14 @@ public function isTransparent(): bool
     {
         return false;
     }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @see ColorInterface::isClear()
+     */
+    public function isClear(): bool
+    {
+        return false;
+    }
 }
diff --git a/src/Colors/Hsv/Color.php b/src/Colors/Hsv/Color.php
@@ -120,4 +120,14 @@ public function isTransparent(): bool
     {
         return false;
     }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @see ColorInterface::isClear()
+     */
+    public function isClear(): bool
+    {
+        return false;
+    }
 }
diff --git a/src/Colors/Rgb/Color.php b/src/Colors/Rgb/Color.php
@@ -178,4 +178,14 @@ public function isTransparent(): bool
     {
         return $this->alpha()->value() < $this->alpha()->max();
     }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @see ColorInterface::isClear()
+     */
+    public function isClear(): bool
+    {
+        return $this->alpha()->value() == 0;
+    }
 }
diff --git a/src/Interfaces/ColorInterface.php b/src/Interfaces/ColorInterface.php
@@ -97,4 +97,11 @@ public function isGreyscale(): bool;
      * @return bool
      */
     public function isTransparent(): bool;
+
+    /**
+     * Determine whether the current color is completely transparent
+     *
+     * @return bool
+     */
+    public function isClear(): bool;
 }
diff --git a/tests/Unit/Colors/Cmyk/ColorTest.php b/tests/Unit/Colors/Cmyk/ColorTest.php
@@ -111,4 +111,10 @@ public function testIsTransparent(): void
         $color = new Color(100, 50, 50, 0);
         $this->assertFalse($color->isTransparent());
     }
+
+    public function testIsClear(): void
+    {
+        $color = new Color(0, 0, 0, 0);
+        $this->assertFalse($color->isClear());
+    }
 }
diff --git a/tests/Unit/Colors/Hsl/ColorTest.php b/tests/Unit/Colors/Hsl/ColorTest.php
@@ -108,4 +108,10 @@ public function testIsTransparent(): void
         $color = new Color(0, 1, 0);
         $this->assertFalse($color->isTransparent());
     }
+
+    public function testIsClear(): void
+    {
+        $color = new Color(0, 1, 0);
+        $this->assertFalse($color->isClear());
+    }
 }
diff --git a/tests/Unit/Colors/Hsv/ColorTest.php b/tests/Unit/Colors/Hsv/ColorTest.php
@@ -108,4 +108,10 @@ public function testIsTransparent(): void
         $color = new Color(1, 0, 0);
         $this->assertFalse($color->isTransparent());
     }
+
+    public function testIsClear(): void
+    {
+        $color = new Color(0, 1, 0);
+        $this->assertFalse($color->isClear());
+    }
 }
diff --git a/tests/Unit/Colors/Rgb/ColorTest.php b/tests/Unit/Colors/Rgb/ColorTest.php
@@ -163,4 +163,19 @@ public function testIsTransparent(): void
         $color = new Color(255, 255, 255, 0);
         $this->assertTrue($color->isTransparent());
     }
+
+    public function testIsClear(): void
+    {
+        $color = new Color(255, 255, 255);
+        $this->assertFalse($color->isClear());
+
+        $color = new Color(255, 255, 255, 255);
+        $this->assertFalse($color->isClear());
+
+        $color = new Color(255, 255, 255, 85);
+        $this->assertFalse($color->isClear());
+
+        $color = new Color(255, 255, 255, 0);
+        $this->assertTrue($color->isClear());
+    }
 }