Add equals-method to compare value types

Author: tvdijen

src/Type/AbstractValueType.php

@@ -4,7 +4,9 @@
 
 namespace SimpleSAML\XML\Type;
 
+use function is_string;
 use function preg_replace;
+use function strcmp;
 use function trim;
 
 /**
@@ -132,4 +134,20 @@ public function __toString(): string
     {
         return $this->getValue();
     }
+
+
+    /**
+     * Compare the value to another one
+     *
+     * @param \SimpleSAML\Type\ValueTypeInterface|string
+     * @return bool
+     */
+    public function equals(ValueTypeInterface|string $other): bool
+    {
+        if (is_string($other)) {
+            $other = static::fromString($other);
+        }
+
+        return strcmp($this->getValue(), $other->getValue()) === 0;
+    }
 }

tests/Type/AnyURIValueTest.php

@@ -8,7 +8,7 @@
 use PHPUnit\Framework\TestCase;
 use SimpleSAML\Test\XML\Assert\AnyURITest;
 use SimpleSAML\XML\Exception\SchemaViolationException;
-use SimpleSAML\XML\Type\AnyURIValue;
+use SimpleSAML\XML\Type\{AnyURIValue, StringValue};
 
 /**
  * Class \SimpleSAML\Test\XML\Type\AnyURIValueTest
@@ -36,6 +36,22 @@ public function testAnyURI(bool $shouldPass, string $uri): void
     }
 
 
+    /**
+     */
+    public function testEquals(): void
+    {
+        // Assert that two identical values are equal
+        $this->assertTrue(AnyURIValue::fromString('hello')->equals(AnyURIValue::fromString('hello')));
+        $this->assertTrue(AnyURIValue::fromString('hello')->equals(StringValue::fromString('hello')));
+        $this->assertTrue(AnyURIValue::fromString('hello')->equals('hello'));
+
+        // Assert that two different values are not equal
+        $this->assertFalse(AnyURIValue::fromString('hello')->equals(AnyURIValue::fromString('world')));
+        $this->assertFalse(AnyURIValue::fromString('hello')->equals(StringValue::fromString('world')));
+        $this->assertFalse(AnyURIValue::fromString('hello')->equals('world'));
+    }
+
+
     /**
      * @return array<string, array{0: true, 1: string}>
      */