Added validation logic for e164 (#521)

Vonage · Oct 31, 2024 · b1399d3 · b1399d3
1 parent 394213c
commit b1399d3
Show file tree

Hide file tree

Showing 31 changed files with 173 additions and 13 deletions.
diff --git a/src/Messages/Channel/MMS/MMSAudio.php b/src/Messages/Channel/MMS/MMSAudio.php
@@ -12,6 +12,7 @@ class MMSAudio extends BaseMessage
 
     protected string $channel = 'mms';
     protected string $subType = BaseMessage::MESSAGES_SUBTYPE_AUDIO;
+    protected bool $validatesE164 = true;
 
     public function __construct(
         string $to,
@@ -22,6 +23,11 @@ public function __construct(
         $this->from = $from;
     }
 
+    public function validatesE164(): bool
+    {
+        return $this->validatesE164;
+    }
+
     public function toArray(): array
     {
         $returnArray = $this->getBaseMessageUniversalOutputArray();

diff --git a/src/Messages/Channel/MMS/MMSImage.php b/src/Messages/Channel/MMS/MMSImage.php
@@ -12,6 +12,7 @@ class MMSImage extends BaseMessage
 
     protected string $channel = 'mms';
     protected string $subType = BaseMessage::MESSAGES_SUBTYPE_IMAGE;
+    protected bool $validatesE164 = true;
 
     public function __construct(
         string $to,
@@ -22,6 +23,11 @@ public function __construct(
         $this->from = $from;
     }
 
+    public function validatesE164(): bool
+    {
+        return $this->validatesE164;
+    }
+
     public function toArray(): array
     {
         $returnArray = $this->getBaseMessageUniversalOutputArray();

diff --git a/src/Messages/Channel/MMS/MMSVideo.php b/src/Messages/Channel/MMS/MMSVideo.php
@@ -13,6 +13,7 @@ class MMSVideo extends BaseMessage
 
     protected string $channel = 'mms';
     protected string $subType = BaseMessage::MESSAGES_SUBTYPE_VIDEO;
+    protected bool $validatesE164 = true;
 
     public function __construct(
         string $to,
@@ -23,6 +24,11 @@ public function __construct(
         $this->from = $from;
     }
 
+    public function validatesE164(): bool
+    {
+        return $this->validatesE164;
+    }
+
     public function toArray(): array
     {
         $returnArray = $this->getBaseMessageUniversalOutputArray();

diff --git a/src/Messages/Channel/MMS/MMSvCard.php b/src/Messages/Channel/MMS/MMSvCard.php
@@ -12,6 +12,7 @@ class MMSvCard extends BaseMessage
 
     protected string $channel = 'mms';
     protected string $subType = BaseMessage::MESSAGES_SUBTYPE_VCARD;
+    protected bool $validatesE164 = true;
 
     public function __construct(
         string $to,
@@ -22,6 +23,11 @@ public function __construct(
         $this->from = $from;
     }
 
+    public function validatesE164(): bool
+    {
+        return $this->validatesE164;
+    }
+
     public function toArray(): array
     {
         $returnArray = $this->getBaseMessageUniversalOutputArray();

diff --git a/src/Messages/Channel/Message.php b/src/Messages/Channel/Message.php
@@ -19,6 +19,7 @@ public function getWebhookUrl(): ?string;
     public function setWebhookUrl(string $url): void;
     public function getWebhookVersion(): ?string;
     public function setWebhookVersion(string $version): void;
+    public function validatesE164(): bool;
 
     /**
      * All message types have shared outputs required by the endpoint.

diff --git a/src/Messages/Channel/Messenger/MessengerAudio.php b/src/Messages/Channel/Messenger/MessengerAudio.php
@@ -11,6 +11,7 @@ class MessengerAudio extends BaseMessage
 
     protected string $channel = 'messenger';
     protected string $subType = BaseMessage::MESSAGES_SUBTYPE_AUDIO;
+    protected bool $validatesE164 = false;
 
     public function __construct(
         string $to,
@@ -25,6 +26,11 @@ public function __construct(
         $this->tag = $tag;
     }
 
+    public function validatesE164(): bool
+    {
+        return $this->validatesE164;
+    }
+
     public function toArray(): array
     {
         $returnArray = $this->getBaseMessageUniversalOutputArray();

diff --git a/src/Messages/Channel/Messenger/MessengerFile.php b/src/Messages/Channel/Messenger/MessengerFile.php
@@ -11,6 +11,7 @@ class MessengerFile extends BaseMessage
 
     protected string $channel = 'messenger';
     protected string $subType = BaseMessage::MESSAGES_SUBTYPE_FILE;
+    protected bool $validatesE164 = false;
 
     public function __construct(
         string $to,
@@ -36,4 +37,9 @@ public function toArray(): array
 
         return $returnArray;
     }
+
+    public function validatesE164(): bool
+    {
+        return $this->validatesE164;
+    }
 }
diff --git a/src/Messages/Channel/Messenger/MessengerImage.php b/src/Messages/Channel/Messenger/MessengerImage.php
@@ -11,6 +11,7 @@ class MessengerImage extends BaseMessage
 
     protected string $channel = 'messenger';
     protected string $subType = BaseMessage::MESSAGES_SUBTYPE_IMAGE;
+    protected bool $validatesE164 = false;
 
     public function __construct(
         string $to,
@@ -36,4 +37,9 @@ public function toArray(): array
 
         return $returnArray;
     }
+
+    public function validatesE164(): bool
+    {
+        return $this->validatesE164;
+    }
 }
diff --git a/src/Messages/Channel/Messenger/MessengerObjectTrait.php b/src/Messages/Channel/Messenger/MessengerObjectTrait.php
@@ -7,15 +7,11 @@ trait MessengerObjectTrait
     private ?string $category;
     private ?string $tag;
 
-    /**
-     * @return string
-     */
     public function getCategory(): ?string
     {
         return $this->category;
     }
 
-
     public function requiresMessengerObject(): bool
     {
         return $this->getTag() || $this->getCategory();
@@ -26,9 +22,6 @@ public function setCategory(string $category): void
         $this->category = $category;
     }
 
-    /**
-     * @return string
-     */
     public function getTag(): ?string
     {
         return $this->tag;

diff --git a/src/Messages/Channel/Messenger/MessengerText.php b/src/Messages/Channel/Messenger/MessengerText.php
@@ -12,6 +12,7 @@ class MessengerText extends BaseMessage
 
     protected string $subType = BaseMessage::MESSAGES_SUBTYPE_TEXT;
     protected string $channel = 'messenger';
+    protected bool $validatesE164 = false;
 
     public function __construct(
         string $to,
@@ -27,6 +28,11 @@ public function __construct(
         $this->tag = $tag;
     }
 
+    public function validatesE164(): bool
+    {
+        return $this->validatesE164;
+    }
+
     public function toArray(): array
     {
         $returnArray = $this->getBaseMessageUniversalOutputArray();

diff --git a/src/Messages/Channel/Messenger/MessengerVideo.php b/src/Messages/Channel/Messenger/MessengerVideo.php
@@ -11,6 +11,7 @@ class MessengerVideo extends BaseMessage
 
     protected string $channel = 'messenger';
     protected string $subType = BaseMessage::MESSAGES_SUBTYPE_VIDEO;
+    protected bool $validatesE164 = false;
 
     public function __construct(
         string $to,
@@ -25,6 +26,11 @@ public function __construct(
         $this->tag = $tag;
     }
 
+    public function validatesE164(): bool
+    {
+        return $this->validatesE164;
+    }
+
     public function toArray(): array
     {
         $returnArray = $this->getBaseMessageUniversalOutputArray();

diff --git a/src/Messages/Channel/RCS/RcsCustom.php b/src/Messages/Channel/RCS/RcsCustom.php
@@ -16,6 +16,7 @@ class RcsCustom extends BaseMessage
     protected string $subType = BaseMessage::MESSAGES_SUBTYPE_FILE;
     protected string $channel = 'rcs';
     protected array $custom;
+    protected bool $validatesE164 = true;
 
     public function __construct(
         string $to,
@@ -27,6 +28,11 @@ public function __construct(
         $this->custom = $custom;
     }
 
+    public function validatesE164(): bool
+    {
+        return $this->validatesE164;
+    }
+
     public function getCustom(): array
     {
         return $this->custom;

diff --git a/src/Messages/Channel/RCS/RcsFile.php b/src/Messages/Channel/RCS/RcsFile.php
@@ -16,6 +16,7 @@ class RcsFile extends BaseMessage
     protected string $subType = BaseMessage::MESSAGES_SUBTYPE_FILE;
     protected string $channel = 'rcs';
     protected FileObject $file;
+    protected bool $validatesE164 = true;
 
     public function __construct(
         string $to,
@@ -27,6 +28,11 @@ public function __construct(
         $this->file = $file;
     }
 
+    public function validatesE164(): bool
+    {
+        return $this->validatesE164;
+    }
+
     public function setTtl(?int $ttl): void
     {
         $range = [

diff --git a/src/Messages/Channel/RCS/RcsImage.php b/src/Messages/Channel/RCS/RcsImage.php
@@ -16,6 +16,7 @@ class RcsImage extends BaseMessage
     protected string $subType = BaseMessage::MESSAGES_SUBTYPE_IMAGE;
     protected string $channel = 'rcs';
     protected ImageObject $image;
+    protected bool $validatesE164 = true;
 
     public function __construct(
         string $to,
@@ -27,6 +28,11 @@ public function __construct(
         $this->image = $image;
     }
 
+    public function validatesE164(): bool
+    {
+        return $this->validatesE164;
+    }
+
     public function setTtl(?int $ttl): void
     {
         $range = [

diff --git a/src/Messages/Channel/RCS/RcsText.php b/src/Messages/Channel/RCS/RcsText.php
@@ -16,6 +16,7 @@ class RcsText extends BaseMessage
 
     protected string $subType = BaseMessage::MESSAGES_SUBTYPE_TEXT;
     protected string $channel = 'rcs';
+    protected bool $validatesE164 = true;
 
     public function __construct(
         string $to,
@@ -27,6 +28,11 @@ public function __construct(
         $this->text = $message;
     }
 
+    public function validatesE164(): bool
+    {
+        return $this->validatesE164;
+    }
+
     public function setTtl(?int $ttl): void
     {
         $range = [

diff --git a/src/Messages/Channel/RCS/RcsVideo.php b/src/Messages/Channel/RCS/RcsVideo.php
@@ -16,6 +16,7 @@ class RcsVideo extends BaseMessage
     protected string $subType = BaseMessage::MESSAGES_SUBTYPE_VIDEO;
     protected string $channel = 'rcs';
     protected VideoObject $video;
+    protected bool $validatesE164 = true;
 
     public function __construct(
         string $to,
@@ -27,6 +28,11 @@ public function __construct(
         $this->video = $videoObject;
     }
 
+    public function validatesE164(): bool
+    {
+        return $this->validatesE164;
+    }
+
     public function setTtl(?int $ttl): void
     {
         $range = [

diff --git a/src/Messages/Channel/SMS/SMSText.php b/src/Messages/Channel/SMS/SMSText.php
@@ -21,6 +21,7 @@ class SMSText extends BaseMessage
     protected ?string $encodingType = null;
     protected ?string $contentId = null;
     protected ?string $entityId = null;
+    protected bool $validatesE164 = true;
 
     public function __construct(
         string $to,
@@ -32,6 +33,11 @@ public function __construct(
         $this->text = $message;
     }
 
+    public function validatesE164(): bool
+    {
+        return $this->validatesE164;
+    }
+
     public function getEncodingType(): ?string
     {
         return $this->encodingType;

diff --git a/src/Messages/Channel/Viber/ViberFile.php b/src/Messages/Channel/Viber/ViberFile.php
@@ -11,6 +11,7 @@ class ViberFile extends BaseMessage
 
     protected string $channel = 'viber_service';
     protected string $subType = BaseMessage::MESSAGES_SUBTYPE_FILE;
+    protected bool $validatesE164 = true;
 
     public function __construct(
         string $to,
@@ -21,6 +22,11 @@ public function __construct(
         $this->from = $from;
     }
 
+    public function validatesE164(): bool
+    {
+        return $this->validatesE164;
+    }
+
     public function toArray(): array
     {
         $returnArray = $this->getBaseMessageUniversalOutputArray();

diff --git a/src/Messages/Channel/Viber/ViberImage.php b/src/Messages/Channel/Viber/ViberImage.php
@@ -12,6 +12,7 @@ class ViberImage extends BaseMessage
 
     protected string $channel = 'viber_service';
     protected string $subType = BaseMessage::MESSAGES_SUBTYPE_IMAGE;
+    protected bool $validatesE164 = true;
 
     public function __construct(
         string $to,
@@ -30,6 +31,11 @@ public function __construct(
         $this->action = $viberActionObject;
     }
 
+    public function validatesE164(): bool
+    {
+        return $this->validatesE164;
+    }
+
     public function toArray(): array
     {
         $returnArray = $this->getBaseMessageUniversalOutputArray();

diff --git a/src/Messages/Channel/Viber/ViberText.php b/src/Messages/Channel/Viber/ViberText.php
@@ -13,6 +13,7 @@ class ViberText extends BaseMessage
 
     protected string $subType = BaseMessage::MESSAGES_SUBTYPE_TEXT;
     protected string $channel = 'viber_service';
+    protected bool $validatesE164 = true;
 
     public function __construct(
         string $to,
@@ -32,6 +33,11 @@ public function __construct(
         $this->action = $viberActionObject;
     }
 
+    public function validatesE164(): bool
+    {
+        return $this->validatesE164;
+    }
+
     public function toArray(): array
     {
         $returnArray = $this->getBaseMessageUniversalOutputArray();