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) {
  309. $this->addStop();
  310. }
  312. return $this;
  313. }
  315. /**
  316. * @return $this
  317. */
  318. public function addStop(): SmsSpotHitCampaign
  319. {
  320. if (strpos($this->message, 'STOP au 36200') === false) {
  321. $this->message .= ' \n STOP au 36200';
  322. }
  324. return $this;
  325. }
  327. /**
  328. * @return $this
  329. */
  330. public function removeStop(): SmsSpotHitCampaign
  331. {
  332. $this->message = trim(str_replace('\n STOP au 36200', '', $this->message));
  334. return $this;
  335. }
  337. /**
  338. * @param bool $useType
  339. *
  340. * @return array|string[]|string
  341. */
  342. public function getDestinataires(bool $useType = false)
  343. {
  344. $type = $this->getDestinatairesType();
  346. if (!$useType || $type === self::DESTINATAIRE_TYPE_DATAS) {
  347. return $this->destinataires;
  348. }
  349. if (!$type || $type === self::DESTINATAIRE_TYPE_GROUPE) {
  350. return implode(",", $this->destinataires);
  351. }
  353. return [];
  354. }
  356. /**
  357. * @return int
  358. */
  359. public function getNbDestinataires(): int
  360. {
  361. return count($this->getDestinataires());
  362. }
  364. /**
  365. * @return int
  366. */
  367. public function getNbUsersList(): int
  368. {
  369. return $this->contactList ? $this->contactList->getUsers()->count() : 0;
  370. }
  372. /**
  373. * @param array $destinataires
  374. *
  375. * @return $this
  376. */
  377. public function setDestinataires(array $destinataires, bool $throwException = true): SmsSpotHitCampaign
  378. {
  379. if ($this->destinatairesType === self::DESTINATAIRE_TYPE_ALL) {
  380. if (!empty($destinataires) && $throwException) {
  381. throw new InvalidArgumentException(
  382. "Si le type est '" . self::DESTINATAIRE_TYPE_ALL . "', il n'y a pas de destinataires à renseigner"
  383. );
  384. }
  385. $this->destinataires = [];
  386. } else {
  387. foreach ($destinataires as $key => $val) {
  388. if ($this->destinatairesType === self::DESTINATAIRE_TYPE_DATAS) {
  389. $numero = $key;
  390. $datas = $val;
  392. if (!is_array($val)) {
  393. if ($throwException) {
  394. throw new InvalidArgumentException(
  395. "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"
  396. );
  397. }
  398. $numero = $val;
  399. $datas = [];
  400. }
  401. } // groupe ou null
  402. else {
  403. $numero = $val;
  404. $datas = null;
  406. if (is_array($val)) {
  407. if ($throwException) {
  408. throw new InvalidArgumentException(
  409. "Si le type n'est pas '" . self::DESTINATAIRE_TYPE_DATAS . "', le tableau doit seulement contenir des numeros ou des groupes"
  410. );
  411. }
  412. $numero = $key;
  413. }
  414. }
  416. $this->addDestinataire($numero, $datas, $throwException);
  417. }
  418. }
  420. return $this;
  421. }
  423. /**
  424. * @param string $numero ou groupe
  425. * @param array|null $datas à utiliser seulement si le type de destinataire est "datas"
  426. * @param bool $throwException
  427. *
  428. * @return $this
  429. */
  430. public function addDestinataire(
  431. string $numero,
  432. ?array $datas = null,
  433. bool $throwException = true
  434. ): SmsSpotHitCampaign {
  435. $baseNumero = $numero;
  437. switch ($this->destinatairesType) {
  438. case self::DESTINATAIRE_TYPE_DATAS:
  439. if ($datas === null) {
  440. if ($throwException) {
  441. throw new InvalidArgumentException(
  442. "Si le type est '" . self::DESTINATAIRE_TYPE_DATAS . "', datas doit être un tableau de variables ou vide"
  443. );
  444. }
  445. $datas = [];
  446. }
  447. break;
  448. case self::DESTINATAIRE_TYPE_ALL:
  449. if ($throwException) {
  450. throw new InvalidArgumentException(
  451. "Si le type est '" . self::DESTINATAIRE_TYPE_ALL . "', il est impossible de rajouter des destinataires"
  452. );
  453. }
  454. return $this;
  455. default:
  456. if ($datas !== null) {
  457. if ($throwException) {
  458. throw new InvalidArgumentException(
  459. "Si le type n'est pas '" . self::DESTINATAIRE_TYPE_DATAS . "', datas doit être null"
  460. );
  461. }
  462. $datas = null;
  463. }
  464. }
  466. if ($this->destinatairesType !== self::DESTINATAIRE_TYPE_GROUPE) {
  467. if (!$numero = $this->checkMobile($numero)) {
  468. if ($throwException) {
  469. throw new InvalidArgumentException("Le numero '$baseNumero' est invalide");
  470. }
  471. return $this;
  472. }
  473. }
  475. if (!$datas) {
  476. if (!in_array($numero, $this->destinataires)) {
  477. $this->destinataires[] = $numero;
  478. }
  479. } else {
  480. if (!isset($this->destinataires[$numero])) {
  481. $this->destinataires[$numero] = $datas;
  482. }
  483. }
  485. return $this;
  486. }
  488. /**
  489. * @param string|null $numero
  490. *
  491. * @return string|false
  492. */
  493. static function checkMobile(?string $numero)
  494. {
  495. if (!$numero) {
  496. return false;
  497. }
  498. $numero = trim($numero);
  499. $numero = preg_replace('/[^0-9+]/', '', $numero);
  501. if (!preg_match('/\+[1-9]\d{10,14}/', $numero)) {
  502. $numero = str_replace('+', '', $numero);
  504. while (substr($numero, 0, 1) === '0') {
  505. $numero = substr($numero, 1, strlen($numero) - 1);
  506. }
  508. $numero = '+33' . $numero;
  509. }
  511. if (!preg_match('/\+[1-9]\d{10,14}/', $numero)) {
  512. return false;
  513. }
  515. //validation mobile FR
  516. if (substr($numero, 0, 3) === '+33' && (strlen($numero) !== 12 || (substr($numero, 0, 4) !== '+336' && substr(
  517. $numero,
  518. 0,
  519. 4
  520. ) !== '+337'))) {
  521. return false;
  522. }
  524. return $numero;
  525. }
  527. /**
  528. * @param string $numero
  529. *
  530. * @return $this
  531. */
  532. public function removeDestinataire(string $numero): SmsSpotHitCampaign
  533. {
  534. $numero = $this->checkMobile($numero);
  535. if (!$numero) {
  536. return $this;
  537. }
  539. if ($this->getDestinatairesType() === self::DESTINATAIRE_TYPE_DATAS) {
  540. unset($this->destinataires[$numero]);
  541. } else {
  542. $key = array_search($numero, $this->destinataires);
  543. unset($this->destinataires[$key]);
  544. }
  546. return $this;
  547. }
  549. /**
  550. * @return string|null
  551. */
  552. public function getExpediteur(): ?string
  553. {
  554. return $this->expediteur;
  555. }
  557. /**
  558. * @param string|null $expediteur
  559. *
  560. * @return $this
  561. */
  562. public function setExpediteur(?string $expediteur): SmsSpotHitCampaign
  563. {
  564. $this->expediteur = $expediteur;
  565. return $this;
  566. }
  568. /**
  569. * @return bool
  570. */
  571. public function isSmslong(): bool
  572. {
  573. return $this->smslong;
  574. }
  576. /**
  577. * @param bool $smslong
  578. *
  579. * @return $this
  580. */
  581. public function setSmslong(bool $smslong): SmsSpotHitCampaign
  582. {
  583. $this->smslong = $smslong;
  584. return $this;
  585. }
  587. /**
  588. * @return int|null
  589. */
  590. public function getSmslongnbr(): ?int
  591. {
  592. return $this->smslongnbr;
  593. }
  595. /**
  596. * @param int|null $smslongnbr
  597. *
  598. * @return $this
  599. */
  600. public function setSmslongnbr(?int $smslongnbr): SmsSpotHitCampaign
  601. {
  602. $this->smslongnbr = $smslongnbr;
  603. return $this;
  604. }
  606. /**
  607. * @return bool
  608. */
  609. public function isTronque(): bool
  610. {
  611. return $this->tronque;
  612. }
  614. /**
  615. * @param bool $tronque
  616. *
  617. * @return $this
  618. */
  619. public function setTronque(bool $tronque): SmsSpotHitCampaign
  620. {
  621. $this->tronque = $tronque;
  622. return $this;
  623. }
  625. /**
  626. * @return string|null
  627. */
  628. public function getEncodage(): ?string
  629. {
  630. return $this->encodage;
  631. }
  633. /**
  634. * @param string|null $encodage
  635. *
  636. * @return $this
  637. */
  638. public function setEncodage(?string $encodage): SmsSpotHitCampaign
  639. {
  640. $this->encodage = $encodage;
  641. return $this;
  642. }
  644. /**
  645. * @return string|null
  646. */
  647. public function getNom(): ?string
  648. {
  649. return $this->nom;
  650. }
  652. /**
  653. * @param string|null $nom
  654. *
  655. * @return $this
  656. */
  657. public function setNom(?string $nom): SmsSpotHitCampaign
  658. {
  659. $this->nom = $nom;
  660. return $this;
  661. }
  663. /**
  664. * @return string|null
  665. */
  666. public function getDestinatairesType(): ?string
  667. {
  668. return $this->destinatairesType;
  669. }
  671. /**
  672. * Le contenu de "destinataires" actuel doit être adapté en fonction du type, en principe il faut définir le type avant "destinataires"
  673. *
  674. * @param string|null $destinatairesType
  675. *
  676. * @return $this
  677. */
  678. public function setDestinatairesType(?string $destinatairesType): SmsSpotHitCampaign
  679. {
  680. if ($destinatairesType !== $this->destinatairesType && !empty($this->destinataires)) {
  681. $destinataires = [];
  682. if ($destinatairesType === self::DESTINATAIRE_TYPE_ALL) {
  683. $this->destinataires = [];
  684. }
  686. if (($destinatairesType === self::DESTINATAIRE_TYPE_GROUPE || !$destinatairesType) && $this->destinatairesType === self::DESTINATAIRE_TYPE_DATAS) {
  687. foreach ($this->destinataires as $numOrGroup => $datas) {
  688. $destinataires[] = $numOrGroup;
  689. }
  691. $this->destinataires = $destinataires;
  692. }
  694. if ($destinatairesType === self::DESTINATAIRE_TYPE_DATAS) {
  695. foreach ($this->destinataires as $numOrGroup) {
  696. $destinataires[$numOrGroup] = [];
  697. }
  699. $this->destinataires = $destinataires;
  700. }
  701. }
  703. $this->destinatairesType = $destinatairesType;
  705. return $this;
  706. }
  708. /**
  709. * @return string|null
  710. */
  711. public function getUrl(): ?string
  712. {
  713. return $this->url;
  714. }
  716. /**
  717. * @param string|null $url
  718. *
  719. * @return $this
  720. */
  721. public function setUrl(?string $url): SmsSpotHitCampaign
  722. {
  723. $this->url = $url;
  724. return $this;
  725. }
  727. /**
  728. * @return array|int[]|null
  729. */
  730. public function getCreneaux(): ?array
  731. {
  732. return $this->creneaux;
  733. }
  735. /**
  736. * @param array|null $creneaux
  737. *
  738. * @return $this
  739. */
  740. public function setCreneaux(?array $creneaux): SmsSpotHitCampaign
  741. {
  742. $this->creneaux = $creneaux;
  743. return $this;
  744. }
  746. /**
  747. * @return int|null
  748. */
  749. public function getCreneauxHeure(): ?int
  750. {
  751. return $this->creneauxHeure;
  752. }
  754. /**
  755. * @param int|null $creneauxHeure
  756. *
  757. * @return $this
  758. */
  759. public function setCreneauxHeure(?int $creneauxHeure): SmsSpotHitCampaign
  760. {
  761. $this->creneauxHeure = $creneauxHeure;
  762. return $this;
  763. }
  765. /**
  766. * @return int|null
  767. */
  768. public function getJours(): ?int
  769. {
  770. return $this->jours;
  771. }
  773. /**
  774. * @param int|null $jours
  775. *
  776. * @return $this
  777. */
  778. public function setJours(?int $jours): SmsSpotHitCampaign
  779. {
  780. $this->jours = $jours;
  781. return $this;
  782. }
  784. /**
  785. * @return string|null
  786. */
  787. public function getTimezone(): ?string
  788. {
  789. return $this->timezone;
  790. }
  792. /**
  793. * @param string|null $timezone
  794. *
  795. * @return $this
  796. */
  797. public function setTimezone(?string $timezone): SmsSpotHitCampaign
  798. {
  799. $this->timezone = $timezone;
  800. return $this;
  801. }
  803. /**
  804. * @return DateTime|null
  805. */
  806. public function getDate(): ?DateTime
  807. {
  808. return $this->date;
  809. }
  811. /**
  812. * @param DateTime|null $date
  813. *
  814. * @return $this
  815. */
  816. public function setDate(?DateTime $date): SmsSpotHitCampaign
  817. {
  818. $this->date = $date;
  819. return $this;
  820. }
  822. /**
  823. * @return DateTime|null
  824. */
  825. public function getDateDebut(): ?DateTime
  826. {
  827. return $this->dateDebut;
  828. }
  830. /**
  831. * @param DateTime|null $dateDebut
  832. *
  833. * @return $this
  834. */
  835. public function setDateDebut(?DateTime $dateDebut): SmsSpotHitCampaign
  836. {
  837. $this->dateDebut = $dateDebut;
  838. return $this;
  839. }
  841. /**
  842. * @return DateTime|null
  843. */
  844. public function getDateFin(): ?DateTime
  845. {
  846. return $this->dateFin;
  847. }
  849. /**
  850. * @param DateTime|null $dateFin
  851. *
  852. * @return $this
  853. */
  854. public function setDateFin(?DateTime $dateFin): SmsSpotHitCampaign
  855. {
  856. $this->dateFin = $dateFin;
  857. return $this;
  858. }
  860. /**
  861. * @return int|null
  862. */
  863. public function getIdSpotHit(): ?int
  864. {
  865. return $this->idSpotHit;
  866. }
  868. /**
  869. * @param int|null $idSpotHit
  870. *
  871. * @return $this
  872. */
  873. public function setIdSpotHit(?int $idSpotHit): SmsSpotHitCampaign
  874. {
  875. $this->idSpotHit = $idSpotHit;
  876. return $this;
  877. }
  879. /**
  880. * @return string
  881. */
  882. public function getProduit(): string
  883. {
  884. return SpotHitCampaignInterface::PRODUIT_SMS;
  885. }
  887. /**
  888. * @return ContactList|null
  889. */
  890. public function getContactList(): ?ContactList
  891. {
  892. return $this->contactList;
  893. }
  895. /**
  896. * @param ContactList|null $contactList
  897. *
  898. * @return $this
  899. */
  900. public function setContactList(?ContactList $contactList): SmsSpotHitCampaign
  901. {
  902. if ($this->contactList === $contactList) {
  903. return $this;
  904. }
  906. if ($this->contactList !== null) {
  907. $this->contactList->removeSmsSpotHitCampaign($this);
  908. }
  910. $this->contactList = $contactList;
  912. if ($contactList !== null && !$contactList->getSmsSpotHitCampaigns()->contains($this)) {
  913. $contactList->addSmsSpotHitCampaign($this);
  914. }
  916. return $this;
  917. }
  919. /**
  920. * @return string
  921. */
  922. public function getStatut(): string
  923. {
  924. return $this->statut;
  925. }
  927. /**
  928. * @param string $statut
  929. *
  930. * @return $this
  931. */
  932. public function setStatut(string $statut): SmsSpotHitCampaign
  933. {
  934. $this->statut = $statut;
  935. return $this;
  936. }
  938. /**
  939. * @return string|null
  940. */
  941. public function getErreur(): ?string
  942. {
  943. return $this->erreur;
  944. }
  946. /**
  947. * @param string|null $erreur
  948. *
  949. * @return $this
  950. */
  951. public function setErreur(?string $erreur): SmsSpotHitCampaign
  952. {
  953. $this->erreur = $erreur;
  954. return $this;
  955. }
  957. /**
  958. * @return array|string[]|string
  959. */
  960. public function getStats(bool $onlyDatas = false, bool $onlyLabels = false, bool $jsonEncode = false)
  961. {
  962. $array = $this->stats;
  964. if ($onlyDatas) {
  965. $array = [];
  966. foreach ($this->stats as $label => $data) {
  967. $array[] = $data;
  968. }
  969. }
  971. if ($onlyLabels) {
  972. $array = [];
  973. foreach ($this->stats as $label => $data) {
  974. $array[] = $label;
  975. }
  976. }
  978. return $jsonEncode ? json_encode($array) : $array;
  979. }
  981. /**
  982. * @param array $stats
  983. *
  984. * @return $this
  985. */
  986. public function setStats(array $stats): SmsSpotHitCampaign
  987. {
  988. $this->stats = $stats;
  989. return $this;
  990. }
  992. /**
  993. * @return bool
  994. */
  995. public function isEditable(): bool
  996. {
  997. return $this->statut === self::STATUT_EN_ATTENTE || $this->statut === self::STATUT_EN_PAUSE;
  998. }
  1000. /**
  1001. * @return bool
  1002. */
  1003. public function isEnvoyee(): bool
  1004. {
  1005. return $this->statut !== self::STATUT_EN_ERREUR && !$this->isEditable();
  1006. }
  1008. /**
  1009. * @return bool
  1010. */
  1011. public function isTerminee(): bool
  1012. {
  1013. return $this->statut === self::STATUT_TERMINEE;
  1014. }
  1016. /**
  1017. * @return bool
  1018. */
  1019. public function isErreur(): bool
  1020. {
  1021. return $this->statut === self::STATUT_EN_ERREUR;
  1022. }
  1024. /**
  1025. * @return string
  1026. */
  1027. public function getCampaignType(): string
  1028. {
  1029. return $this->campaignType;
  1030. }
  1032. /**
  1033. * @param string $campaignType
  1034. *
  1035. * @return $this
  1036. */
  1037. public function setCampaignType(string $campaignType): SmsSpotHitCampaign
  1038. {
  1039. $this->campaignType = $campaignType;
  1040. return $this;
  1041. }
  1042. }