src/Entity/SmsSpotHitCampaign.php line 21

Open in your IDE?
  1. <?php
  3. namespace App\Entity;
  5. use App\Entity\Interfaces\SpotHitCampaignInterface;
  6. use App\Traits\DateTrait;
  7. use DateTime;
  8. use Doctrine\ORM\Mapping as ORM;
  9. use InvalidArgumentException;
  10. use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
  11. use Symfony\Component\Validator\Constraints as Assert;
  13. /**
  14. * @ORM\Entity
  15. *
  16. * @ORM\Table(uniqueConstraints={
  17. * @ORM\UniqueConstraint(columns={"nom"})
  18. * })
  19. * @UniqueEntity(fields={"nom"})
  20. */
  21. class SmsSpotHitCampaign implements SpotHitCampaignInterface
  22. {
  23. use DateTrait;
  25. const DESTINATAIRE_TYPE_DATAS = 'datas';
  26. const DESTINATAIRE_TYPE_ALL = 'all';
  27. const DESTINATAIRE_TYPE_GROUPE = 'groupe';
  28. const CAMPAIGN_TYPE_COMMUNICATION = 'communication';
  29. const CAMPAIGN_TYPE_RESET_PASSWORD = 'reset_password';
  30. const CAMPAIGN_TYPE_WELCOME = 'welcome_sms';
  31. const CAMPAIGN_TYPE_ACCEPT_CGU_FIRST = 'accept_cgu_first';
  32. /**
  33. * @var int|null
  34. *
  35. * @ORM\Column(type="integer")
  36. * @ORM\Id
  37. * @ORM\GeneratedValue(strategy="AUTO")
  38. */
  39. protected ?int $id = null;
  40. /**
  41. * @var integer|null
  42. *
  43. * @ORM\Column(type="integer", nullable=true)
  44. *
  45. * @Assert\GreaterThanOrEqual(value = 1)
  46. * @Assert\Type(type="integer")
  47. */
  48. protected ?int $idSpotHit = null;
  49. /**
  50. * @var string
  51. *
  52. * @ORM\Column(type="string")
  53. *
  54. * @Assert\NotBlank(groups={"new", "Default"})
  55. * @Assert\Type(type="string", groups={"new", "Default"})
  56. *
  57. */
  58. protected string $message = '';
  59. /**
  60. * @var array|string[]
  61. *
  62. * @ORM\Column(type="json")
  63. *
  64. * @Assert\NotBlank
  65. */
  66. protected array $destinataires = [];
  67. /**
  68. * @var array|string[]
  69. *
  70. * @ORM\Column(type="json")
  71. */
  72. protected array $stats = [];
  73. /**
  74. * @var string|null
  75. *
  76. * Si vide, l'expéditeur du SMS sera un numéro court à 5 chiffres auxquels les destinataires peuvent répondre
  77. * L’expéditeur doit comporter un minimum de 3 caractères pour être personnalisé et ne doit pas commencer par plus de 3 chiffres consécutifs avant la première lettre.
  78. *
  79. * @ORM\Column(type="string", length=11, nullable=true)
  80. *
  81. * @Assert\Length(min=3, max=11)
  82. * @Assert\Regex("/^(?![0-9]{3})\w+$/")
  83. * @Assert\Type(type="string")
  84. */
  85. protected ?string $expediteur = null;
  86. /**
  87. * @var DateTime|null
  88. *
  89. * @ORM\Column(type="datetime", nullable=true)
  90. *
  91. * @Assert\Type(type="\DateTime")
  92. */
  93. protected ?DateTime $date = null;
  94. /**
  95. * @var boolean
  96. *
  97. * Si true, autorise l'envoi de SMS supérieur à 160 caractères
  98. *
  99. * @ORM\Column(type="boolean")
  100. * @Assert\Type(type="bool")
  101. */
  102. protected bool $smslong = true;
  103. /**
  104. * @var integer|null
  105. *
  106. * Permet de vérifier la taille du SMS long envoyé. Doit correspondre au nombre de caractères su sms, Si le compteur spothit indique un nombre différent, le message sera rejeté.
  107. *
  108. * @ORM\Column(type="integer", nullable=true)
  109. *
  110. * @Assert\GreaterThanOrEqual(value = 1)
  111. * @Assert\Type(type="integer")
  112. */
  113. protected ?int $smslongnbr = null;
  114. /**
  115. * @var boolean
  116. *
  117. * Si true, tronque automatiquement le message à 160 caractères.
  118. *
  119. * @ORM\Column(type="boolean")
  120. * @Assert\Type(type="bool")
  121. */
  122. protected bool $tronque = false;
  123. /**
  124. * @var string|null
  125. *
  126. * "auto" => UTF8, "ucs2" => unicode
  127. *
  128. * @ORM\Column(type="string", nullable=true)
  129. *
  130. * @Assert\Choice({"auto", "ucs2", null})
  131. * @Assert\Type(type="string")
  132. */
  133. protected ?string $encodage = null;
  134. /**
  135. * @var string|null
  136. *
  137. * nom de la campagne
  138. *
  139. * @ORM\Column(type="string", nullable=true)
  140. *
  141. * @Assert\Length(min=1, max=50, groups={"new", "Default"})
  142. * @Assert\Type(type="string", groups={"new", "Default"})
  143. */
  144. protected ?string $nom = null;
  145. /**
  146. * @var string|null
  147. *
  148. * "all" => sélection de tous les contacts du compte
  149. * "groupe" => sélection de tous les contacts des groupes fournis dans le champ « destinataires »
  150. * "datas" => permet d'ajouter des données personnalisées aux « destinataires » pour les utiliser dans votre message (exemple : "Bonjour {nom} {prenom}")
  151. * il faut que le champ « destinataires » soit un tableau de cette forme : ["+33600000001" => ["nom" => "Nom 1", "prenom" => "Prénom 1"], "+33600000002" => ["nom" => "Nom 2", "prenom" => "Prénom 2"] ...]
  152. *
  153. * @ORM\Column(type="string", nullable=true)
  154. *
  155. * @Assert\Choice({"all", "groupe", "datas", null})
  156. * @Assert\Type(type="string")
  157. */
  158. protected ?string $destinatairesType = null;
  159. /**
  160. * @var string|null
  161. *
  162. * Adresse URL de votre serveur pour la réception en "push" des statuts après l'envoi.
  163. * Vous devez déjà avoir une adresse paramétrée sur votre compte pour activer les retours "push".
  164. * Si ce paramètre est renseigné, cette URL sera appelée pour cet envoi sinon l'adresse du compte est utilisée.
  165. *
  166. * @ORM\Column(type="string", nullable=true)
  167. *
  168. * @Assert\Type(type="string")
  169. */
  170. protected ?string $url = null;
  171. /**
  172. * @var DateTime|null
  173. *
  174. * Obligatoire pour l'envoi échelonné
  175. *
  176. * @ORM\Column(type="datetime", nullable=true)
  177. *
  178. * @Assert\Type(type="\DateTime")
  179. */
  180. protected ?DateTime $dateDebut = null;
  181. /**
  182. * @var DateTime|null
  183. *
  184. * Obligatoire pour l'envoi échelonné
  185. *
  186. * @ORM\Column(type="datetime", nullable=true)
  187. *
  188. * @Assert\Type(type="\DateTime")
  189. */
  190. protected ?DateTime $dateFin = null;
  191. /**
  192. * @var array|int[]|null
  193. *
  194. * Obligatoire pour l'envoi échelonné
  195. * Heure(s) d'envois (du lundi au samedi de 8h00 à 22h00 hors jours fériés)
  196. * Tableau avec 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19
  197. * La campagne sera fractionnée proportionnellement aux nombres de créneaux entre le jour et l'heure de démarrage, et le jour et l'heure de fin souhaitée.
  198. *
  199. * @ORM\Column(type="json", nullable=true)
  200. *
  201. * @Assert\All({
  202. * @Assert\Type(type="int"),
  203. * })
  204. *
  205. * @Assert\NotBlank(allowNull=true)
  206. */
  207. protected ?array $creneaux = null;
  208. /**
  209. * @var integer|null
  210. *
  211. * Obligatoire pour l'envoi échelonné
  212. * 1,2,3,4 ou 6
  213. * Nombre d'envoi(s) par heure
  214. *
  215. * @ORM\Column(type="integer", nullable=true)
  216. *
  217. * @Assert\Choice({1, 2, 3, 4, 6})
  218. * @Assert\Type(type="integer")
  219. */
  220. protected ?int $creneauxHeure = null;
  221. /**
  222. * @var integer|null
  223. *
  224. * Obligatoire pour l'envoi échelonné
  225. * Tableau avec 1,2,3,4,5,6
  226. * Jours d'envoi (1 représentant lundi). Pas d'envoi le dimanche.
  227. *
  228. * @ORM\Column(type="integer", nullable=true)
  229. *
  230. * @Assert\Length(min=1, max=6)
  231. * @Assert\Type(type="integer")
  232. */
  233. protected ?int $jours = null;
  234. /**
  235. * @var string|null
  236. *
  237. * Fuseau horaire
  238. *
  239. * @ORM\Column(type="string", nullable=true)
  240. *
  241. * @Assert\Type(type="string")
  242. */
  243. protected ?string $timezone = null;
  244. /**
  245. * @var ContactList|null
  246. *
  247. * @ORM\ManyToOne(targetEntity="ContactList", inversedBy="smsSpotHitCampaigns")
  248. * @ORM\JoinColumn(nullable=true)
  249. *
  250. * @Assert\Valid(groups={"new", "Default"})
  251. * @Assert\Type(type="App\Entity\ContactList", groups={"new", "Default"})
  252. */
  253. protected ?ContactList $contactList = null;
  254. /**
  255. * @var string
  256. *
  257. * @ORM\Column(type="string", nullable=false)
  258. *
  259. * @Assert\Choice({"pending", "processing", "sent", "error", "break"})
  260. * @Assert\Type(type="string")
  261. */
  262. protected string $statut = self::STATUT_EN_ATTENTE;
  263. /**
  264. * @var string|null
  265. *
  266. * Si statut "en_erreur", il s'agit du message en question
  267. *
  268. * @ORM\Column(type="string", nullable=true)
  269. *
  270. * @Assert\Type(type="string")
  271. */
  272. protected ?string $erreur = null;
  273. /**
  274. * @var string
  275. *
  276. * Type de campagne (Campagne créée via inscription d'un user / reset password etc)
  277. *
  278. * @ORM\Column(type="string", nullable=false)
  279. * @Assert\Type(type="string")
  280. */
  281. protected string $campaignType = '';
  283. /**
  284. * @return int|null
  285. */
  286. public function getId(): ?int
  287. {
  288. return $this->id;
  289. }
  291. /**
  292. * @return string
  293. */
  294. public function getMessage(): string
  295. {
  296. return $this->message;
  297. }
  299. /**
  300. * @param string $message
  301. * @param bool $addStop
  302. *
  303. * @return $this
  304. */
  305. public function setMessage(string $message, bool $addStop = true): SmsSpotHitCampaign
  306. {
  307. $this->message = trim($message);
  308. if($addStop) $this->addStop();
  310. return $this;
  311. }
  313. /**
  314. * @return $this
  315. */
  316. public function addStop(): SmsSpotHitCampaign
  317. {
  318. if(strpos($this->message, 'STOP au 36200') === false) $this->message .= ' \n STOP au 36200';
  320. return $this;
  321. }
  323. /**
  324. * @return $this
  325. */
  326. public function removeStop(): SmsSpotHitCampaign
  327. {
  328. $this->message = trim(str_replace('\n STOP au 36200', '', $this->message));
  330. return $this;
  331. }
  333. /**
  334. * @param bool $useType
  335. *
  336. * @return array|string[]|string
  337. */
  338. public function getDestinataires(bool $useType = false)
  339. {
  340. $type = $this->getDestinatairesType();
  342. if(!$useType || $type === self::DESTINATAIRE_TYPE_DATAS) return $this->destinataires;
  343. if(!$type || $type === self::DESTINATAIRE_TYPE_GROUPE) return implode(",", $this->destinataires);
  345. return [];
  346. }
  348. /**
  349. * @return int
  350. */
  351. public function getNbDestinataires(): int
  352. {
  353. return count($this->getDestinataires());
  354. }
  356. /**
  357. * @return int
  358. */
  359. public function getNbUsersList(): int
  360. {
  361. return $this->contactList ? $this->contactList->getUsers()->count() : 0;
  362. }
  364. /**
  365. * @param array $destinataires
  366. *
  367. * @return $this
  368. */
  369. public function setDestinataires(array $destinataires, bool $throwException = true): SmsSpotHitCampaign
  370. {
  371. if($this->destinatairesType === self::DESTINATAIRE_TYPE_ALL)
  372. {
  373. if(!empty($destinataires) && $throwException) throw new InvalidArgumentException("Si le type est '" . self::DESTINATAIRE_TYPE_ALL . "', il n'y a pas de destinataires à renseigner");
  374. $this->destinataires = [];
  375. }
  376. else
  377. {
  378. foreach($destinataires as $key => $val)
  379. {
  380. if($this->destinatairesType === self::DESTINATAIRE_TYPE_DATAS)
  381. {
  382. $numero = $key;
  383. $datas = $val;
  385. if(!is_array($val))
  386. {
  387. if($throwException) throw new InvalidArgumentException("Si le type est '" . self::DESTINATAIRE_TYPE_DATAS . "', le tableau doit est multidimensionnel avec en clef le numero et en valeurs un tableau de datas");
  388. $numero = $val;
  389. $datas = [];
  390. }
  391. }
  392. // groupe ou null
  393. else
  394. {
  395. $numero = $val;
  396. $datas = null;
  398. if(is_array($val))
  399. {
  400. if($throwException) throw new InvalidArgumentException("Si le type n'est pas '" . self::DESTINATAIRE_TYPE_DATAS . "', le tableau doit seulement contenir des numeros ou des groupes");
  401. $numero = $key;
  402. }
  403. }
  405. $this->addDestinataire($numero, $datas, $throwException);
  406. }
  407. }
  409. return $this;
  410. }
  412. /**
  413. * @param string $numero ou groupe
  414. * @param array|null $datas à utiliser seulement si le type de destinataire est "datas"
  415. * @param bool $throwException
  416. *
  417. * @return $this
  418. */
  419. public function addDestinataire(string $numero, ?array $datas = null, bool $throwException = true): SmsSpotHitCampaign
  420. {
  421. $baseNumero = $numero;
  423. switch($this->destinatairesType)
  424. {
  425. case self::DESTINATAIRE_TYPE_DATAS:
  426. if($datas === null)
  427. {
  428. if($throwException) throw new InvalidArgumentException("Si le type est '" . self::DESTINATAIRE_TYPE_DATAS . "', datas doit être un tableau de variables ou vide");
  429. $datas = [];
  430. }
  431. break;
  432. case self::DESTINATAIRE_TYPE_ALL:
  433. if($throwException) throw new InvalidArgumentException("Si le type est '" . self::DESTINATAIRE_TYPE_ALL . "', il est impossible de rajouter des destinataires");
  434. return $this;
  435. default:
  436. if($datas !== null)
  437. {
  438. if($throwException) throw new InvalidArgumentException("Si le type n'est pas '" . self::DESTINATAIRE_TYPE_DATAS . "', datas doit être null");
  439. $datas = null;
  440. }
  441. }
  443. if($this->destinatairesType !== self::DESTINATAIRE_TYPE_GROUPE)
  444. {
  445. if(!$numero = $this->checkMobile($numero))
  446. {
  447. if($throwException) throw new InvalidArgumentException("Le numero '$baseNumero' est invalide");
  448. return $this;
  449. }
  450. }
  452. if(!$datas)
  453. {
  454. if(!in_array($numero, $this->destinataires)) $this->destinataires[] = $numero;
  455. }
  456. else
  457. {
  458. if(!isset($this->destinataires[$numero])) $this->destinataires[$numero] = $datas;
  459. }
  461. return $this;
  462. }
  464. /**
  465. * @param string|null $numero
  466. *
  467. * @return string|false
  468. */
  469. static function checkMobile(?string $numero)
  470. {
  471. if(!$numero) return false;
  472. $numero = trim($numero);
  473. $numero = preg_replace('/[^0-9+]/', '', $numero);
  475. if(!preg_match('/\+[1-9]\d{10,14}/', $numero))
  476. {
  477. $numero = str_replace('+', '', $numero);
  479. while(substr($numero, 0, 1) === '0')
  480. {
  481. $numero = substr($numero, 1, strlen($numero) - 1);
  482. }
  484. $numero = '+33' . $numero;
  485. }
  487. if(!preg_match('/\+[1-9]\d{10,14}/', $numero)) return false;
  489. //validation mobile FR
  490. if(substr($numero, 0, 3) === '+33' && (strlen($numero) !== 12 || (substr($numero, 0, 4) !== '+336' && substr($numero, 0, 4) !== '+337')))
  491. {
  492. return false;
  493. }
  495. return $numero;
  496. }
  498. /**
  499. * @param string $numero
  500. *
  501. * @return $this
  502. */
  503. public function removeDestinataire(string $numero): SmsSpotHitCampaign
  504. {
  505. $numero = $this->checkMobile($numero);
  506. if(!$numero) return $this;
  508. if($this->getDestinatairesType() === self::DESTINATAIRE_TYPE_DATAS)
  509. {
  510. unset($this->destinataires[$numero]);
  511. }
  512. else
  513. {
  514. $key = array_search($numero, $this->destinataires);
  515. unset($this->destinataires[$key]);
  516. }
  518. return $this;
  519. }
  521. /**
  522. * @return string|null
  523. */
  524. public function getExpediteur(): ?string
  525. {
  526. return $this->expediteur;
  527. }
  529. /**
  530. * @param string|null $expediteur
  531. *
  532. * @return $this
  533. */
  534. public function setExpediteur(?string $expediteur): SmsSpotHitCampaign
  535. {
  536. $this->expediteur = $expediteur;
  537. return $this;
  538. }
  540. /**
  541. * @return bool
  542. */
  543. public function isSmslong(): bool
  544. {
  545. return $this->smslong;
  546. }
  548. /**
  549. * @param bool $smslong
  550. *
  551. * @return $this
  552. */
  553. public function setSmslong(bool $smslong): SmsSpotHitCampaign
  554. {
  555. $this->smslong = $smslong;
  556. return $this;
  557. }
  559. /**
  560. * @return int|null
  561. */
  562. public function getSmslongnbr(): ?int
  563. {
  564. return $this->smslongnbr;
  565. }
  567. /**
  568. * @param int|null $smslongnbr
  569. *
  570. * @return $this
  571. */
  572. public function setSmslongnbr(?int $smslongnbr): SmsSpotHitCampaign
  573. {
  574. $this->smslongnbr = $smslongnbr;
  575. return $this;
  576. }
  578. /**
  579. * @return bool
  580. */
  581. public function isTronque(): bool
  582. {
  583. return $this->tronque;
  584. }
  586. /**
  587. * @param bool $tronque
  588. *
  589. * @return $this
  590. */
  591. public function setTronque(bool $tronque): SmsSpotHitCampaign
  592. {
  593. $this->tronque = $tronque;
  594. return $this;
  595. }
  597. /**
  598. * @return string|null
  599. */
  600. public function getEncodage(): ?string
  601. {
  602. return $this->encodage;
  603. }
  605. /**
  606. * @param string|null $encodage
  607. *
  608. * @return $this
  609. */
  610. public function setEncodage(?string $encodage): SmsSpotHitCampaign
  611. {
  612. $this->encodage = $encodage;
  613. return $this;
  614. }
  616. /**
  617. * @return string|null
  618. */
  619. public function getNom(): ?string
  620. {
  621. return $this->nom;
  622. }
  624. /**
  625. * @param string|null $nom
  626. *
  627. * @return $this
  628. */
  629. public function setNom(?string $nom): SmsSpotHitCampaign
  630. {
  631. $this->nom = $nom;
  632. return $this;
  633. }
  635. /**
  636. * @return string|null
  637. */
  638. public function getDestinatairesType(): ?string
  639. {
  640. return $this->destinatairesType;
  641. }
  643. /**
  644. * Le contenu de "destinataires" actuel doit être adapté en fonction du type, en principe il faut définir le type avant "destinataires"
  645. *
  646. * @param string|null $destinatairesType
  647. *
  648. * @return $this
  649. */
  650. public function setDestinatairesType(?string $destinatairesType): SmsSpotHitCampaign
  651. {
  652. if($destinatairesType !== $this->destinatairesType && !empty($this->destinataires))
  653. {
  654. $destinataires = [];
  655. if($destinatairesType === self::DESTINATAIRE_TYPE_ALL) $this->destinataires = [];
  657. if(($destinatairesType === self::DESTINATAIRE_TYPE_GROUPE || !$destinatairesType) && $this->destinatairesType === self::DESTINATAIRE_TYPE_DATAS)
  658. {
  659. foreach($this->destinataires as $numOrGroup => $datas)
  660. {
  661. $destinataires[] = $numOrGroup;
  662. }
  664. $this->destinataires = $destinataires;
  665. }
  667. if($destinatairesType === self::DESTINATAIRE_TYPE_DATAS)
  668. {
  669. foreach($this->destinataires as $numOrGroup)
  670. {
  671. $destinataires[$numOrGroup] = [];
  672. }
  674. $this->destinataires = $destinataires;
  675. }
  676. }
  678. $this->destinatairesType = $destinatairesType;
  680. return $this;
  681. }
  683. /**
  684. * @return string|null
  685. */
  686. public function getUrl(): ?string
  687. {
  688. return $this->url;
  689. }
  691. /**
  692. * @param string|null $url
  693. *
  694. * @return $this
  695. */
  696. public function setUrl(?string $url): SmsSpotHitCampaign
  697. {
  698. $this->url = $url;
  699. return $this;
  700. }
  702. /**
  703. * @return array|int[]|null
  704. */
  705. public function getCreneaux(): ?array
  706. {
  707. return $this->creneaux;
  708. }
  710. /**
  711. * @param array|null $creneaux
  712. *
  713. * @return $this
  714. */
  715. public function setCreneaux(?array $creneaux): SmsSpotHitCampaign
  716. {
  717. $this->creneaux = $creneaux;
  718. return $this;
  719. }
  721. /**
  722. * @return int|null
  723. */
  724. public function getCreneauxHeure(): ?int
  725. {
  726. return $this->creneauxHeure;
  727. }
  729. /**
  730. * @param int|null $creneauxHeure
  731. *
  732. * @return $this
  733. */
  734. public function setCreneauxHeure(?int $creneauxHeure): SmsSpotHitCampaign
  735. {
  736. $this->creneauxHeure = $creneauxHeure;
  737. return $this;
  738. }
  740. /**
  741. * @return int|null
  742. */
  743. public function getJours(): ?int
  744. {
  745. return $this->jours;
  746. }
  748. /**
  749. * @param int|null $jours
  750. *
  751. * @return $this
  752. */
  753. public function setJours(?int $jours): SmsSpotHitCampaign
  754. {
  755. $this->jours = $jours;
  756. return $this;
  757. }
  759. /**
  760. * @return string|null
  761. */
  762. public function getTimezone(): ?string
  763. {
  764. return $this->timezone;
  765. }
  767. /**
  768. * @param string|null $timezone
  769. *
  770. * @return $this
  771. */
  772. public function setTimezone(?string $timezone): SmsSpotHitCampaign
  773. {
  774. $this->timezone = $timezone;
  775. return $this;
  776. }
  778. /**
  779. * @return DateTime|null
  780. */
  781. public function getDate(): ?DateTime
  782. {
  783. return $this->date;
  784. }
  786. /**
  787. * @param DateTime|null $date
  788. *
  789. * @return $this
  790. */
  791. public function setDate(?DateTime $date): SmsSpotHitCampaign
  792. {
  793. $this->date = $date;
  794. return $this;
  795. }
  797. /**
  798. * @return DateTime|null
  799. */
  800. public function getDateDebut(): ?DateTime
  801. {
  802. return $this->dateDebut;
  803. }
  805. /**
  806. * @param DateTime|null $dateDebut
  807. *
  808. * @return $this
  809. */
  810. public function setDateDebut(?DateTime $dateDebut): SmsSpotHitCampaign
  811. {
  812. $this->dateDebut = $dateDebut;
  813. return $this;
  814. }
  816. /**
  817. * @return DateTime|null
  818. */
  819. public function getDateFin(): ?DateTime
  820. {
  821. return $this->dateFin;
  822. }
  824. /**
  825. * @param DateTime|null $dateFin
  826. *
  827. * @return $this
  828. */
  829. public function setDateFin(?DateTime $dateFin): SmsSpotHitCampaign
  830. {
  831. $this->dateFin = $dateFin;
  832. return $this;
  833. }
  835. /**
  836. * @return int|null
  837. */
  838. public function getIdSpotHit(): ?int
  839. {
  840. return $this->idSpotHit;
  841. }
  843. /**
  844. * @param int|null $idSpotHit
  845. *
  846. * @return $this
  847. */
  848. public function setIdSpotHit(?int $idSpotHit): SmsSpotHitCampaign
  849. {
  850. $this->idSpotHit = $idSpotHit;
  851. return $this;
  852. }
  854. /**
  855. * @return string
  856. */
  857. public function getProduit(): string
  858. {
  859. return SpotHitCampaignInterface::PRODUIT_SMS;
  860. }
  862. /**
  863. * @return ContactList|null
  864. */
  865. public function getContactList(): ?ContactList
  866. {
  867. return $this->contactList;
  868. }
  870. /**
  871. * @param ContactList|null $contactList
  872. *
  873. * @return $this
  874. */
  875. public function setContactList(?ContactList $contactList): SmsSpotHitCampaign
  876. {
  877. if($this->contactList === $contactList)
  878. {
  879. return $this;
  880. }
  882. if($this->contactList !== null)
  883. {
  884. $this->contactList->removeSmsSpotHitCampaign($this);
  885. }
  887. $this->contactList = $contactList;
  889. if($contactList !== null && !$contactList->getSmsSpotHitCampaigns()->contains($this))
  890. {
  891. $contactList->addSmsSpotHitCampaign($this);
  892. }
  894. return $this;
  895. }
  897. /**
  898. * @return string
  899. */
  900. public function getStatut(): string
  901. {
  902. return $this->statut;
  903. }
  905. /**
  906. * @param string $statut
  907. *
  908. * @return $this
  909. */
  910. public function setStatut(string $statut): SmsSpotHitCampaign
  911. {
  912. $this->statut = $statut;
  913. return $this;
  914. }
  916. /**
  917. * @return string|null
  918. */
  919. public function getErreur(): ?string
  920. {
  921. return $this->erreur;
  922. }
  924. /**
  925. * @param string|null $erreur
  926. *
  927. * @return $this
  928. */
  929. public function setErreur(?string $erreur): SmsSpotHitCampaign
  930. {
  931. $this->erreur = $erreur;
  932. return $this;
  933. }
  935. /**
  936. * @return array|string[]|string
  937. */
  938. public function getStats(bool $onlyDatas = false, bool $onlyLabels = false, bool $jsonEncode = false)
  939. {
  940. $array = $this->stats;
  942. if($onlyDatas)
  943. {
  944. $array = [];
  945. foreach($this->stats as $label => $data)
  946. {
  947. $array[] = $data;
  948. }
  949. }
  951. if($onlyLabels)
  952. {
  953. $array = [];
  954. foreach($this->stats as $label => $data)
  955. {
  956. $array[] = $label;
  957. }
  958. }
  960. return $jsonEncode ? json_encode($array) : $array;
  961. }
  963. /**
  964. * @param array $stats
  965. *
  966. * @return $this
  967. */
  968. public function setStats(array $stats): SmsSpotHitCampaign
  969. {
  970. $this->stats = $stats;
  971. return $this;
  972. }
  974. /**
  975. * @return bool
  976. */
  977. public function isEditable(): bool
  978. {
  979. return $this->statut === self::STATUT_EN_ATTENTE || $this->statut === self::STATUT_EN_PAUSE;
  980. }
  982. /**
  983. * @return bool
  984. */
  985. public function isEnvoyee(): bool
  986. {
  987. return $this->statut !== self::STATUT_EN_ERREUR && !$this->isEditable();
  988. }
  990. /**
  991. * @return bool
  992. */
  993. public function isTerminee(): bool
  994. {
  995. return $this->statut === self::STATUT_TERMINEE;
  996. }
  998. /**
  999. * @return bool
  1000. */
  1001. public function isErreur(): bool
  1002. {
  1003. return $this->statut === self::STATUT_EN_ERREUR;
  1004. }
  1006. /**
  1007. * @return string
  1008. */
  1009. public function getCampaignType(): string
  1010. {
  1011. return $this->campaignType;
  1012. }
  1014. /**
  1015. * @param string $campaignType
  1016. *
  1017. * @return $this
  1018. */
  1019. public function setCampaignType(string $campaignType): SmsSpotHitCampaign
  1020. {
  1021. $this->campaignType = $campaignType;
  1022. return $this;
  1023. }
  1024. }