Use XMLStringElementTrait (#18)

* Bump xml-common

* Migrate ds-namespace to XMLStringElementTrait

Author: tvdijen

composer.json

@@ -40,7 +40,7 @@
 
         "robrichards/xmlseclibs": "^3.1.1",
         "simplesamlphp/assert": "~0.2.2",
-        "simplesamlphp/xml-common": "~0.3.2"
+        "simplesamlphp/xml-common": "~0.4.8"
     },
     "require-dev": {
         "simplesamlphp/simplesamlphp-test-framework": "^1.0.5"

src/XML/ds/DigestValue.php

@@ -7,6 +7,7 @@
 use DOMElement;
 use SimpleSAML\Assert\Assert;
 use SimpleSAML\XML\Exception\InvalidDOMElementException;
+use SimpleSAML\XML\XMLStringElementTrait;
 
 /**
  * Class representing a ds:DigestValue element.
@@ -15,46 +16,20 @@
  */
 final class DigestValue extends AbstractDsElement
 {
-    /**
-     * The digest value.
-     *
-     * @var string
-     */
-    protected string $digest;
+    use XMLStringElementTrait;
 
 
     /**
-     * Initialize a DigestValue element.
+     * Validate the content of the element.
      *
-     * @param string $digest
+     * @param string $content  The value to go in the XML textContent
+     * @throws \Exception on failure
+     * @return void
      */
-    public function __construct(string $digest)
+    protected function validateContent(string $content): void
     {
-        $this->setDigest($digest);
-    }
-
-
-    /**
-     * Collect the value of the digest-property
-     *
-     * @return string
-     */
-    public function getDigest(): string
-    {
-        return $this->digest;
-    }
-
-
-    /**
-     * Set the value of the digest-property
-     *
-     * @param string $digest
-     */
-    private function setDigest(string $digest): void
-    {
-        Assert::notEmpty($digest, 'DigestValue cannot be empty');
-        Assert::stringPlausibleBase64($digest, 'ds:DigestValue is not a valid Base64 encoded string');
-        $this->digest = $digest;
+        Assert::notEmpty($content, 'DigestValue cannot be empty');
+        Assert::stringPlausibleBase64($content, 'ds:DigestValue is not a valid Base64 encoded string');
     }
 
 
@@ -74,19 +49,4 @@ public static function fromXML(DOMElement $xml): object
 
         return new self($xml->textContent);
     }
-
-
-    /**
-     * Convert this DigestValue element to XML.
-     *
-     * @param \DOMElement|null $parent The element we should append this DigestValue element to.
-     * @return \DOMElement
-     */
-    public function toXML(DOMElement $parent = null): DOMElement
-    {
-        $e = $this->instantiateParentElement($parent);
-        $e->textContent = $this->digest;
-
-        return $e;
-    }
 }

src/XML/ds/KeyName.php

@@ -7,6 +7,8 @@
 use DOMElement;
 use SimpleSAML\Assert\Assert;
 use SimpleSAML\XML\Exception\InvalidDOMElementException;
+use SimpleSAML\XML\XMLStringElementTrait;
+
 
 /**
  * Class representing a ds:KeyName element.
@@ -15,44 +17,22 @@
  */
 final class KeyName extends AbstractDsElement
 {
-    /**
-     * The key name.
-     *
-     * @var string
-     */
-    protected string $name;
-
-
-    /**
-     * Initialize a KeyName element.
-     *
-     * @param string $name
-     */
-    public function __construct(string $name)
-    {
-        $this->setName($name);
-    }
-
-
-    /**
-     * Collect the value of the name-property
-     *
-     * @return string
-     */
-    public function getName(): string
-    {
-        return $this->name;
-    }
+    use XMLStringElementTrait;
 
 
     /**
-     * Set the value of the name-property
+     * Validate the content of the element.
      *
-     * @param string $name
+     * @param string $content  The value to go in the XML textContent
+     * @throws \Exception on failure
+     * @return void
      */
-    private function setName(string $name): void
+    protected function validateContent(string $content): void
     {
-        $this->name = $name;
+        /**
+         * Perform no validation by default.
+         * Override this method on the implementing class to perform content validation.
+         */
     }
 
 
@@ -72,19 +52,4 @@ public static function fromXML(DOMElement $xml): object
 
         return new self($xml->textContent);
     }
-
-
-    /**
-     * Convert this KeyName element to XML.
-     *
-     * @param \DOMElement|null $parent The element we should append this KeyName element to.
-     * @return \DOMElement
-     */
-    public function toXML(DOMElement $parent = null): DOMElement
-    {
-        $e = $this->instantiateParentElement($parent);
-        $e->textContent = $this->name;
-
-        return $e;
-    }
 }

src/XML/ds/SignatureValue.php

@@ -7,6 +7,7 @@
 use DOMElement;
 use SimpleSAML\Assert\Assert;
 use SimpleSAML\XML\Exception\InvalidDOMElementException;
+use SimpleSAML\XML\XMLStringElementTrait;
 
 /**
  * Class representing a ds:SignatureValue element.
@@ -15,41 +16,20 @@
  */
 final class SignatureValue extends AbstractDsElement
 {
-    /** @var string */
-    protected string $value;
+    use XMLStringElementTrait;
 
 
     /**
-     * Initialize a SignatureValue element.
+     * Validate the content of the element.
      *
-     * @param string $value
+     * @param string $content  The value to go in the XML textContent
+     * @throws \Exception on failure
+     * @return void
      */
-    public function __construct(string $value) {
-        $this->setValue($value);
-    }
-
-
-    /**
-     * Get the signature value.
-     *
-     * @return string
-     */
-    public function getValue(): string
+    protected function validateContent(string $content): void
     {
-        return $this->value;
-    }
-
-
-    /**
-     * Set the value.
-     *
-     * @param string $value
-     */
-    private function setValue(string $value): void
-    {
-        Assert::notEmpty($value, 'SignatureValue cannot be empty');
-        Assert::stringPlausibleBase64($value, 'SignatureValue is not a valid Base64 encoded string');
-        $this->value = $value;
+        Assert::notEmpty($content, 'SignatureValue cannot be empty');
+        Assert::stringPlausibleBase64($content, 'SignatureValue is not a valid Base64 encoded string');
     }
 
 
@@ -69,19 +49,4 @@ public static function fromXML(DOMElement $xml): object
 
         return new self($xml->textContent);
     }
-
-
-    /**
-     * Convert this SignatureValue to XML.
-     *
-     * @param \DOMElement|null $parent The element we should append this SignatureValue element to.
-     * @return \DOMElement
-     */
-    public function toXML(DOMElement $parent = null): \DOMElement
-    {
-        $e = $this->instantiateParentElement($parent);
-        $e->textContent = $this->value;
-
-        return $e;
-    }
 }

src/XML/ds/X509Certificate.php

@@ -7,6 +7,8 @@
 use DOMElement;
 use SimpleSAML\Assert\Assert;
 use SimpleSAML\XML\Exception\InvalidDOMElementException;
+use SimpleSAML\XML\XMLStringElementTrait;
+
 
 /**
  * Class representing a ds:X509Certificate element.
@@ -15,47 +17,20 @@
  */
 final class X509Certificate extends AbstractDsElement
 {
-    /**
-     * The base64-encoded certificate.
-     *
-     * @var string
-     */
-    protected string $certificate;
-
-
-    /**
-     * Initialize an X509Certificate element.
-     *
-     * @param string $certificate
-     */
-    public function __construct(string $certificate)
-    {
-        $this->setCertificate($certificate);
-    }
+    use XMLStringElementTrait;
 
 
     /**
-     * Collect the value of the certificate-property
+     * Validate the content of the element.
      *
-     * @return string
+     * @param string $content  The value to go in the XML textContent
+     * @throws \Exception on failure
+     * @return void
      */
-    public function getCertificate(): string
+    protected function validateContent(string $content): void
     {
-        return $this->certificate;
-    }
-
-
-    /**
-     * Set the value of the certificate-property
-     *
-     * @param string $certificate
-     */
-    private function setCertificate(string $certificate): void
-    {
-        Assert::notEmpty($certificate, 'ds:X509Certificate cannot be empty');
-        Assert::stringPlausibleBase64($certificate, 'ds:X509Certificate is not a valid Base64 encoded string');
-
-        $this->certificate = $certificate;
+        Assert::notEmpty($content, 'ds:X509Certificate cannot be empty');
+        Assert::stringPlausibleBase64($content, 'ds:X509Certificate is not a valid Base64 encoded string');
     }
 
 
@@ -75,19 +50,4 @@ public static function fromXML(DOMElement $xml): object
 
         return new self($xml->textContent);
     }
-
-
-    /**
-     * Convert this X509Certificate element to XML.
-     *
-     * @param \DOMElement|null $parent The element we should append this X509Certificate element to.
-     * @return \DOMElement
-     */
-    public function toXML(DOMElement $parent = null): DOMElement
-    {
-        $e = $this->instantiateParentElement($parent);
-        $e->textContent = $this->certificate;
-
-        return $e;
-    }
 }