src/Products/NotificationsBundle/Entity/ContactAttempts/EmailContactAttempt.php line 20

Open in your IDE?
  1. <?php
  3. namespace Products\NotificationsBundle\Entity\ContactAttempts;
  5. use DateTime;
  6. use Doctrine\ORM\Mapping as ORM;
  7. use Products\NotificationsBundle\Entity\AbstractContactAttempt;
  8. use Products\NotificationsBundle\Entity\Recipients\EmailRecipient;
  10. /**
  11.  * Class EmailContactAttempt
  12.  * @package Products\NotificationsBundle\Entity\ContactAttempts
  13.  *
  14.  * @method EmailRecipient getRecipient()
  15.  *
  16.  * @ORM\Entity(
  17.  *     repositoryClass = "Products\NotificationsBundle\Doctrine\Repository\ContactAttempts\EmailContactAttemptRepository",
  18.  * )
  19.  */
  20. class EmailContactAttempt extends AbstractTransactionalContactAttempt
  21. {
  22.     const DISCR = 'email';
  24.     /**
  25.      * @see https://sendgrid.com/docs/for-developers/tracking-events/event/
  26.      */
  27.     const STATUSES = [
  28.         ...self::PENDING_STATUSES,
  29.         ...self::SUCCESSFUL_STATUSES,
  30.         ...self::FAILED_STATUSES,
  31.     ];
  32.     const PENDING_STATUSES = [
  33.         ...AbstractContactAttempt::PENDING_STATUSES,
  34.         'email.processed',
  35.         'email.deferred',
  36.     ];
  37.     const SUCCESSFUL_STATUSES = [
  38.         ...AbstractContactAttempt::SUCCESSFUL_STATUSES,
  39.         'email.delivered',
  40.     ];
  41.     const FAILED_STATUSES = [
  42.         ...AbstractContactAttempt::FAILED_STATUSES,
  43.         'email.dropped',
  44.         'email.bounce',
  45.     ];
  47.     /**
  48.      * @var string|null
  49.      *
  50.      * @ORM\Column(
  51.      *     type = "string",
  52.      *     nullable = true,
  53.      * )
  54.      */
  55.     protected ?string $reason = null;
  57.     /**
  58.      * @var string|null
  59.      *
  60.      * @ORM\Column(
  61.      *     type = "string",
  62.      *     nullable = true,
  63.      * )
  64.      */
  65.     protected ?string $type = null;
  67.     /**
  68.      * @var string|null
  69.      *
  70.      * @ORM\Column(
  71.      *     type = "string",
  72.      *     nullable = true,
  73.      * )
  74.      */
  75.     protected ?string $code = null;
  77.     /**
  78.      * @var string|null
  79.      *
  80.      * @ORM\Column(
  81.      *     type = "string",
  82.      *     nullable = true,
  83.      * )
  84.      */
  85.     protected ?string $response = null;
  87.     /**
  88.      * @var string|null
  89.      *
  90.      * @ORM\Column(
  91.      *     type = "string",
  92.      *     nullable = true,
  93.      * )
  94.      */
  95.     protected ?string $attempt = null;
  97.     /**
  98.      * @var DateTime|null
  99.      *
  100.      * @ORM\Column(
  101.      *     type = "datetime",
  102.      *     nullable = true,
  103.      * )
  104.      */
  105.     protected ?DateTime $openedAt = null;
  107.     /**
  108.      * @var DateTime|null
  109.      *
  110.      * @ORM\Column(
  111.      *     type = "datetime",
  112.      *     nullable = true,
  113.      * )
  114.      */
  115.     protected ?DateTime $spammedAt = null;
  117.     /**
  118.      * @return string|null
  119.      */
  120.     public function getReason(): ?string
  121.     {
  122.         return $this->reason;
  123.     }
  125.     /**
  126.      * @param string $reason
  127.      * @return $this
  128.      */
  129.     public function setReason(string $reason): self
  130.     {
  131.         $this->reason = $reason;
  132.         return $this;
  133.     }
  135.     /**
  136.      * @return string|null
  137.      */
  138.     public function getType(): ?string
  139.     {
  140.         return $this->type;
  141.     }
  143.     /**
  144.      * @param string $type
  145.      * @return $this
  146.      */
  147.     public function setType(string $type): self
  148.     {
  149.         $this->type = $type;
  150.         return $this;
  151.     }
  153.     /**
  154.      * @return string|null
  155.      */
  156.     public function getCode(): ?string
  157.     {
  158.         return $this->code;
  159.     }
  161.     /**
  162.      * @param string $code
  163.      * @return $this
  164.      */
  165.     public function setCode(string $code): self
  166.     {
  167.         $this->code = $code;
  168.         return $this;
  169.     }
  171.     /**
  172.      * @return string|null
  173.      */
  174.     public function getResponse(): ?string
  175.     {
  176.         return $this->response;
  177.     }
  179.     /**
  180.      * @param string $response
  181.      * @return $this
  182.      */
  183.     public function setResponse(string $response): self
  184.     {
  185.         $this->response = $response;
  186.         return $this;
  187.     }
  189.     /**
  190.      * @return string|null
  191.      */
  192.     public function getAttempt(): ?string
  193.     {
  194.         return $this->attempt;
  195.     }
  197.     /**
  198.      * @param string $attempt
  199.      * @return $this
  200.      */
  201.     public function setAttempt(string $attempt): self
  202.     {
  203.         $this->attempt = $attempt;
  204.         return $this;
  205.     }
  207.     /**
  208.      * {@inheritDoc}
  209.      */
  210.     public function getExtras(): array
  211.     {
  212.         return [
  213.             'opened' => $this->getOpenedAt() ? $this->getOpenedAt()->format('Y-m-d h:i:sA') : null,
  214.             'spammed' => $this->getSpammedAt() ? $this->getSpammedAt()->format('Y-m-d h:i:sA') : null,
  215.             'response' => $this->getResponse(),
  216.             'code' => $this->getCode(),
  217.             'type' => $this->getType(),
  218.             'reason' => $this->getReason(),
  219.             'attempt' => $this->getAttempt(),
  220.         ];
  221.     }
  223.     /**
  224.      * @return DateTime|null
  225.      */
  226.     public function getOpenedAt(): ?DateTime
  227.     {
  228.         return $this->openedAt;
  229.     }
  231.     /**
  232.      * @param DateTime|null $openedAt
  233.      * @return self
  234.      */
  235.     public function setOpenedAt(?DateTime $openedAt): self
  236.     {
  237.         $this->openedAt = $openedAt;
  238.         return $this;
  239.     }
  241.     /**
  242.      * @return DateTime|null
  243.      */
  244.     public function getSpammedAt(): ?DateTime
  245.     {
  246.         return $this->spammedAt;
  247.     }
  249.     /**
  250.      * @param DateTime|null $spammedAt
  251.      * @return self
  252.      */
  253.     public function setSpammedAt(?DateTime $spammedAt): self
  254.     {
  255.         $this->spammedAt = $spammedAt;
  256.         return $this;
  257.     }
  258. }