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

Open in your IDE?
  1. <?php
  3. namespace Products\NotificationsBundle\Entity\ContactAttempts;
  5. use Doctrine\ORM\Mapping as ORM;
  6. use Products\NotificationsBundle\Entity\AbstractContactAttempt;
  7. use Products\NotificationsBundle\Entity\Recipients\PhoneRecipient;
  8. use Products\NotificationsBundle\Entity\Recording;
  10. /**
  11.  * Class VoiceContactAttempt
  12.  * @package Products\NotificationsBundle\Entity\ContactAttempts
  13.  *
  14.  * @method PhoneRecipient getRecipient()
  15.  *
  16.  * @ORM\Entity(
  17.  *     repositoryClass = "Products\NotificationsBundle\Doctrine\Repository\ContactAttempts\VoiceContactAttemptRepository",
  18.  * )
  19.  */
  20. class VoiceContactAttempt extends AbstractTransactionalContactAttempt
  21. {
  22.     const DISCR = 'voice';
  24.     /**
  25.      * @see https://support.twilio.com/hc/en-us/articles/223132547-What-are-the-Possible-Call-Statuses-and-What-do-They-Mean-
  26.      * @see https://www.twilio.com/docs/voice/api/call-resource#statuscallback
  27.      * @see https://www.twilio.com/docs/voice/twiml#callstatus-values
  28.      */
  29.     const STATUSES = [
  30.         ...self::PENDING_STATUSES,
  31.         ...self::SUCCESSFUL_STATUSES,
  32.         ...self::FAILED_STATUSES,
  33.     ];
  34.     const PENDING_STATUSES = [
  35.         ...AbstractContactAttempt::PENDING_STATUSES,
  36.         'voice.queued',
  37.         'voice.initiated',
  38.         'voice.ringing',
  39.         'voice.in-progress',
  40.     ];
  41.     const SUCCESSFUL_STATUSES = [
  42.         ...AbstractContactAttempt::SUCCESSFUL_STATUSES,
  43.         'voice.completed',
  44.     ];
  45.     const FAILED_STATUSES = [
  46.         ...AbstractContactAttempt::FAILED_STATUSES,
  47.         'voice.busy',
  48.         'voice.no-answer',
  49.         'voice.canceled',
  50.         'voice.failed',
  51.     ];
  53.     /**
  54.      * @var string|null
  55.      *
  56.      * @ORM\Column(
  57.      *     type = "string",
  58.      *     nullable = true,
  59.      * )
  60.      */
  61.     protected ?string $country = null;
  63.     /**
  64.      * @var string|null
  65.      *
  66.      * @ORM\Column(
  67.      *     type = "string",
  68.      *     nullable = true,
  69.      * )
  70.      */
  71.     protected ?string $state = null;
  73.     /**
  74.      * @var string|null
  75.      *
  76.      * @ORM\Column(
  77.      *     type = "string",
  78.      *     nullable = true,
  79.      * )
  80.      */
  81.     protected ?string $city = null;
  83.     /**
  84.      * @var string|null
  85.      *
  86.      * @ORM\Column(
  87.      *     type = "string",
  88.      *     nullable = true,
  89.      * )
  90.      */
  91.     protected ?string $zip = null;
  93.     /**
  94.      * @var int|null
  95.      *
  96.      * @ORM\Column(
  97.      *     type = "integer",
  98.      *     nullable = true,
  99.      * )
  100.      */
  101.     protected ?int $duration = null;
  103.     /**
  104.      * @var string|null
  105.      *
  106.      * @ORM\Column(
  107.      *     type = "string",
  108.      *     nullable = true,
  109.      * )
  110.      */
  111.     protected ?string $answer = null;
  113.     /**
  114.      * @var int|null
  115.      *
  116.      * @ORM\Column(
  117.      *     type = "integer",
  118.      *     nullable = true,
  119.      * )
  120.      */
  121.     protected ?int $sequenceNumber = null;
  123.     /**
  124.      * @return string|null
  125.      */
  126.     public function getCountry(): ?string
  127.     {
  128.         return $this->country;
  129.     }
  131.     /**
  132.      * @param string|null $country
  133.      * @return $this
  134.      */
  135.     public function setCountry(?string $country): self
  136.     {
  137.         $this->country = $country;
  139.         return $this;
  140.     }
  142.     /**
  143.      * @return string|null
  144.      */
  145.     public function getState(): ?string
  146.     {
  147.         return $this->state;
  148.     }
  150.     /**
  151.      * @param string|null $state
  152.      * @return $this
  153.      */
  154.     public function setState(?string $state): self
  155.     {
  156.         $this->state = $state;
  158.         return $this;
  159.     }
  161.     /**
  162.      * @return string|null
  163.      */
  164.     public function getCity(): ?string
  165.     {
  166.         return $this->city;
  167.     }
  169.     /**
  170.      * @param string|null $city
  171.      * @return $this
  172.      */
  173.     public function setCity(?string $city): self
  174.     {
  175.         $this->city = $city;
  177.         return $this;
  178.     }
  180.     /**
  181.      * @return string|null
  182.      */
  183.     public function getZip(): ?string
  184.     {
  185.         return $this->zip;
  186.     }
  188.     /**
  189.      * @param string|null $zip
  190.      * @return $this
  191.      */
  192.     public function setZip(?string $zip): self
  193.     {
  194.         $this->zip = $zip;
  196.         return $this;
  197.     }
  199.     /**
  200.      * @return int|null
  201.      */
  202.     public function getDuration(): ?int
  203.     {
  204.         return $this->duration;
  205.     }
  207.     /**
  208.      * @param int|null $duration
  209.      * @return $this
  210.      */
  211.     public function setDuration(?int $duration): self
  212.     {
  213.         $this->duration = $duration;
  215.         return $this;
  216.     }
  218.     /**
  219.      * {@inheritDoc}
  220.      */
  221.     public function getExtras(): array
  222.     {
  223.         return [
  224.             'answer' => $this->getAnswer(),
  225.             'duration' => $this->getDuration(),
  226.             'county' => $this->getCountry(),
  227.             'state' => $this->getState(),
  228.             'city' => $this->getCity(),
  229.             'zip' => $this->getZip(),
  230.         ];
  231.     }
  233.     /**
  234.      * @return string|null
  235.      */
  236.     public function getAnswer(): ?string
  237.     {
  238.         return $this->answer;
  239.     }
  241.     /**
  242.      * @param string|null $answer
  243.      * @return $this
  244.      */
  245.     public function setAnswer(?string $answer): self
  246.     {
  247.         $this->answer = $answer;
  249.         return $this;
  250.     }
  252.     /**
  253.      * @return int|null
  254.      */
  255.     public function getSequenceNumber(): ?int
  256.     {
  257.         return $this->sequenceNumber;
  258.     }
  260.     /**
  261.      * @param int|null $sequenceNumber
  262.      * @return $this
  263.      */
  264.     public function setSequenceNumber(?int $sequenceNumber): self
  265.     {
  266.         $this->sequenceNumber = $sequenceNumber;
  268.         return $this;
  269.     }
  271.     /**
  272.      * @return bool
  273.      */
  274.     public function hasRecording(): bool
  275.     {
  276.         $recording = $this->getMessage()->getRecording();
  278.         return $recording instanceof Recording && $recording->isRecorded();
  279.     }
  280. }