Create RelayStateTrait

Author: tvdijen

src/Binding.php

@@ -25,13 +25,6 @@
  */
 abstract class Binding
 {
-    /**
-     * The RelayState associated with the message.
-     *
-     * @var string|null
-     */
-    protected ?string $relayState = null;
-
     /**
      * The destination of messages.
      *
@@ -156,29 +149,6 @@ public function getDestination(): ?string
     }
 
 
-    /**
-     * Set the RelayState associated with he message.
-     *
-     * @param string|null $relayState The RelayState.
-     */
-    public function setRelayState(?string $relayState = null): void
-    {
-        Assert::nullOrValidRelayState($relayState);
-        $this->relayState = $relayState;
-    }
-
-
-    /**
-     * Get the RelayState associated with the message.
-     *
-     * @return string|null The RelayState.
-     */
-    public function getRelayState(): ?string
-    {
-        return $this->relayState;
-    }
-
-
     /**
      * Override the destination of a message.
      *

src/Binding/HTTPArtifact.php

@@ -14,6 +14,7 @@
 use SimpleSAML\Metadata\MetaDataStorageHandler;
 use SimpleSAML\Module\saml\Message as MSG;
 use SimpleSAML\SAML2\Binding;
+use SimpleSAML\SAML2\Binding\RelayStateTrait;
 use SimpleSAML\SAML2\SOAPClient;
 use SimpleSAML\SAML2\Utils;
 use SimpleSAML\SAML2\XML\saml\Issuer;
@@ -43,6 +44,8 @@
  */
 class HTTPArtifact extends Binding
 {
+    use RelayStateTrait;
+
     /**
      * @psalm-suppress UndefinedDocblockClass
      * @psalm-suppress UndefinedClass

src/Binding/HTTPPost.php

@@ -10,6 +10,7 @@
 use Psr\Http\Message\ServerRequestInterface;
 use SimpleSAML\Assert\Assert;
 use SimpleSAML\SAML2\Binding;
+use SimpleSAML\SAML2\Binding\RelayStateTrait;
 use SimpleSAML\SAML2\Exception\ProtocolViolationException;
 use SimpleSAML\SAML2\Utils;
 use SimpleSAML\SAML2\XML\samlp\AbstractMessage;
@@ -28,6 +29,8 @@
  */
 class HTTPPost extends Binding
 {
+    use RelayStateTrait;
+
     /**
      * Send a SAML 2 message using the HTTP-POST binding.
      *

src/Binding/HTTPRedirect.php

@@ -10,6 +10,7 @@
 use Psr\Http\Message\ServerRequestInterface;
 use SimpleSAML\Assert\Assert;
 use SimpleSAML\SAML2\Binding;
+use SimpleSAML\SAML2\Binding\RelayStateTrait;
 use SimpleSAML\SAML2\Compat\ContainerSingleton;
 use SimpleSAML\SAML2\Constants as C;
 use SimpleSAML\SAML2\Exception\ProtocolViolationException;
@@ -39,6 +40,8 @@
  */
 class HTTPRedirect extends Binding
 {
+    use RelayStateTrait;
+
     /**
      * Create the redirect URL for a message.
      *

src/Binding/RelayStateTrait.php

@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\SAML2\Binding;
+
+use SimpleSAML\SAML2\Assert\Assert;
+
+/**
+ * Trait grouping common functionality for binding that use a RelayState.
+ *
+ * @package simplesamlphp/saml2
+ */
+trait RelayStateTrait
+{
+    /**
+     * The relay state.
+     *
+     * @var string|null
+     */
+    protected ?string $relayState = null;
+
+
+    /**
+     * Set the RelayState associated with he message.
+     *
+     * @param string|null $relayState The RelayState.
+     */
+    public function setRelayState(?string $relayState = null): void
+    {
+        Assert::nullOrValidRelayState($relayState);
+        $this->relayState = $relayState;
+    }
+
+
+    /**
+     * Get the RelayState associated with the message.
+     *
+     * @return string|null The RelayState.
+     */
+    public function getRelayState(): ?string
+    {
+        return $this->relayState;
+    }
+}