src/Entity/Whatsapp/WhatsappMessageStatus.php line 20

Open in your IDE?
  1. <?php
  3. namespace App\Entity\Whatsapp;
  5. use App\Enum\WhatsappMessageStatusEnum;
  6. use App\Repository\Whatsapp\WhatsappMessageStatusRepository;
  7. use DateTime;
  8. use DateTimeImmutable;
  9. use DateTimeInterface;
  10. use Doctrine\ORM\Mapping as ORM;
  12. /**
  13.  * @ORM\Table(name="vulco_whatsapp_message_status")
  14.  * @ORM\Entity(repositoryClass=WhatsappMessageStatusRepository::class)
  15.  *
  16.  * @see https://developers.facebook.com/docs/whatsapp/cloud-api/webhooks/payload-examples#message-status-updates
  17.  * @see https://developers.facebook.com/docs/whatsapp/cloud-api/webhooks/components#statuses-object
  18.  * @see https://developers.facebook.com/docs/whatsapp/cloud-api/support/error-codes
  19.  */
  20. class WhatsappMessageStatus
  21. {
  22.     /**
  23.      * @ORM\Id
  24.      * @ORM\GeneratedValue
  25.      * @ORM\Column(type="integer")
  26.      */
  27.     protected int $id;
  29.     /**
  30.      * @ORM\ManyToOne(targetEntity="WhatsappMessage", inversedBy="statuses")
  31.      */
  32.     private WhatsappMessage $whatsappMessage;
  34.     /**
  35.      * @ORM\Column(type="string", length=255, nullable=false, options={"default": "failed"})
  36.      */
  37.     private string $status = WhatsappMessageStatusEnum::FAILED;
  39.     /**
  40.      * @ORM\Column(type="datetime")
  41.      */
  42.     private DateTimeInterface $date;
  44.     /**
  45.      * @ORM\Column(type="string", length=255, nullable=true)
  46.      */
  47.     private ?string $errorCode = null; // @see https://developers.facebook.com/docs/whatsapp/cloud-api/support/error-codes
  49.     /**
  50.      * @ORM\Column(type="text", length=10000, nullable=true)
  51.      */
  52.     private ?string $errorMessage = null;
  54.     public function __construct(
  55.         string $status = WhatsappMessageStatusEnum::ACCEPTED,
  56.         DateTimeInterface $date = new DateTime())
  57.     {
  58.         $this->status = $status;
  59.         $this->date = $date;
  60.     }
  62.     public function getId(): int
  63.     {
  64.         return $this->id;
  65.     }
  67.     public function getWhatsappMessage(): WhatsappMessage
  68.     {
  69.         return $this->whatsappMessage;
  70.     }
  72.     public function setWhatsappMessage(WhatsappMessage $whatsappMessage): self
  73.     {
  74.         $this->whatsappMessage = $whatsappMessage;
  75.         return $this;
  76.     }
  78.     public function getStatus(): string
  79.     {
  80.         return $this->status;
  81.     }
  83.     public function getStatusAsTranslationKey(): string
  84.     {
  85.         if (array_key_exists($this->status, WhatsappMessageStatusEnum::getTranslations())) {
  86.             return WhatsappMessageStatusEnum::getTranslations()[$this->status];
  87.         }
  88.         return $this->status;
  89.     }
  91.     public function setStatus(string $status): self
  92.     {
  93.         $this->status = $status;
  95.         return $this;
  96.     }
  98.     public function getDate(): DateTimeInterface
  99.     {
  100.         return $this->date;
  101.     }
  103.     public function setDate(DateTimeInterface $date): self
  104.     {
  105.         $this->date = $date;
  106.         return $this;
  107.     }
  109.     public function getErrorCode(): ?string
  110.     {
  111.         return $this->errorCode;
  112.     }
  114.     public function setErrorCode(?string $errorCode): self
  115.     {
  116.         $this->errorCode = $errorCode;
  117.         return $this;
  118.     }
  120.     public function getErrorMessage(): ?string
  121.     {
  122.         return $this->errorMessage;
  123.     }
  125.     public function setErrorMessage(?string $errorMessage): self
  126.     {
  127.         $this->errorMessage = $errorMessage;
  128.         return $this;
  129.     }
  131.     public function isUnknown(): bool
  132.     {
  133.         if ($this->isAccepted()
  134.             || $this->isFailed()
  135.             || $this->isSent()
  136.             || $this->isDelivered()
  137.             || $this->isRead()) {
  138.             return false;
  139.         }
  140.         return true;
  141.     }
  143.     public function isAccepted(): bool
  144.     {
  145.         if (WhatsappMessageStatusEnum::ACCEPTED === $this->getStatus()) {
  146.             return true;
  147.         }
  148.         return false;
  149.     }
  151.     public function isFailed(): bool
  152.     {
  153.         if (WhatsappMessageStatusEnum::FAILED === $this->getStatus()) {
  154.             return true;
  155.         }
  156.         return false;
  157.     }
  159.     public function isSent(): bool
  160.     {
  161.         if (WhatsappMessageStatusEnum::SENT === $this->getStatus()) {
  162.             return true;
  163.         }
  164.         return false;
  165.     }
  167.     public function isDelivered(): bool
  168.     {
  169.         if (WhatsappMessageStatusEnum::DELIVERED === $this->getStatus()) {
  170.             return true;
  171.         }
  172.         return false;
  173.     }
  175.     public function isRead(): bool
  176.     {
  177.         if (WhatsappMessageStatusEnum::READ === $this->getStatus()) {
  178.             return true;
  179.         }
  180.         return false;
  181.     }
  183. }