feature #48503 [Notifier] Add options to SmsMessage (gnito-org)

fabpot · fabpot · commit 6e63db7f12b2 · 2022-12-09T09:15:19.000+01:00
This PR was merged into the 6.3 branch. Discussion ---------- [Notifier] Add options to `SmsMessage` | Q | A | ------------- | --- | Branch? | 6.3 | Bug fix? | no | New feature? | yes | Deprecations? | no  | Tickets | | License | MIT | Doc PR | Add the ability to attach optional options to an SMS message, which can then be processed by the notifier bridge. Some SMS APIs allow dynamic options that can be set on a per message basis, which cannot be satisfied by options in the DSN. Commits ------- be77a1f [Notifier] Add options to SmsMessage
diff --git a/src/Symfony/Component/Notifier/Message/SmsMessage.php b/src/Symfony/Component/Notifier/Message/SmsMessage.php
@@ -24,8 +24,9 @@ class SmsMessage implements MessageInterface
     private string $subject;
     private string $phone;
     private string $from;
+    private ?MessageOptionsInterface $options;
 
-    public function __construct(string $phone, string $subject, string $from = '')
+    public function __construct(string $phone, string $subject, string $from = '', MessageOptionsInterface $options = null)
     {
         if ('' === $phone) {
             throw new InvalidArgumentException(sprintf('"%s" needs a phone number, it cannot be empty.', __CLASS__));
@@ -34,6 +35,7 @@ public function __construct(string $phone, string $subject, string $from = '')
         $this->subject = $subject;
         $this->phone = $phone;
         $this->from = $from;
+        $this->options = $options;
     }
 
     public static function fromNotification(Notification $notification, SmsRecipientInterface $recipient): self
@@ -110,8 +112,18 @@ public function getFrom(): string
         return $this->from;
     }
 
+    /**
+     * @return $this
+     */
+    public function options(MessageOptionsInterface $options): static
+    {
+        $this->options = $options;
+
+        return $this;
+    }
+
     public function getOptions(): ?MessageOptionsInterface
     {
-        return null;
+        return $this->options;
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -24,8 +24,9 @@ class SmsMessage implements MessageInterface`
`24`	`24`	`private string $subject;`
`25`	`25`	`private string $phone;`
`26`	`26`	`private string $from;`
	`27`	`+ private ?MessageOptionsInterface $options;`
`27`	`28`
`28`		`- public function __construct(string $phone, string $subject, string $from = '')`
	`29`	`+ public function __construct(string $phone, string $subject, string $from = '', MessageOptionsInterface $options = null)`
`29`	`30`	`{`
`30`	`31`	`if ('' === $phone) {`
`31`	`32`	`throw new InvalidArgumentException(sprintf('"%s" needs a phone number, it cannot be empty.', __CLASS__));`
`@@ -34,6 +35,7 @@ public function __construct(string $phone, string $subject, string $from = '')`
`34`	`35`	`$this->subject = $subject;`
`35`	`36`	`$this->phone = $phone;`
`36`	`37`	`$this->from = $from;`
	`38`	`+ $this->options = $options;`
`37`	`39`	`}`
`38`	`40`
`39`	`41`	`public static function fromNotification(Notification $notification, SmsRecipientInterface $recipient): self`
`@@ -110,8 +112,18 @@ public function getFrom(): string`
`110`	`112`	`return $this->from;`
`111`	`113`	`}`
`112`	`114`
	`115`	`+ /**`
	`116`	`+ * @return $this`
	`117`	`+ */`
	`118`	`+ public function options(MessageOptionsInterface $options): static`
	`119`	`+ {`
	`120`	`+ $this->options = $options;`
	`121`	`+`
	`122`	`+ return $this;`
	`123`	`+ }`
	`124`	`+`
`113`	`125`	`public function getOptions(): ?MessageOptionsInterface`
`114`	`126`	`{`
`115`		`- return null;`
	`127`	`+ return $this->options;`
`116`	`128`	`}`
`117`	`129`	`}`