src/Entity/Core/AppSettings.php line 32

Open in your IDE?
  1. <?php
  3. namespace App\Entity\Core;
  5. use Doctrine\ORM\Mapping as ORM;
  7. /**
  8. * ══════════════════════════════════════════════════════════════════════════
  9. * RÉGLAGES DE L'APPLICATION — clé / valeur
  10. * ══════════════════════════════════════════════════════════════════════════
  11. *
  12. * Table générique, pour tout ce qui doit se changer depuis le backoffice
  13. * sans déploiement. Premier usage : la configuration Stripe.
  14. *
  15. * ── `secret` : LA COLONNE QUI COMPTE ───────────────────────────────────
  16. *
  17. * Une valeur marquée `secret` n'est JAMAIS renvoyée au navigateur. Le
  18. * formulaire affiche `sk_live_••••4242` et poste une chaîne vide quand on
  19. * n'y touche pas.
  20. *
  21. * Sans ça, la clé secrète Stripe se retrouverait dans le HTML du
  22. * backoffice — donc dans le cache du navigateur, dans les captures
  23. * d'écran, dans les journaux de tout proxy sur le trajet. Une clé
  24. * `sk_live_` permet d'émettre des remboursements et de lire la totalité
  25. * des paiements du compte.
  26. *
  27. * @ORM\Entity(repositoryClass="App\Repository\Core\AppSettingsRepository")
  28. * @ORM\Table(name="app_settings", uniqueConstraints={
  29. * @ORM\UniqueConstraint(name="uniq_app_settings_key", columns={"setting_key"})
  30. * })
  31. */
  32. class AppSettings
  33. {
  34. /**
  35. * @ORM\Id
  36. * @ORM\GeneratedValue
  37. * @ORM\Column(type="integer")
  38. */
  39. private $id;
  41. /**
  42. * @ORM\Column(name="setting_key", type="string", length=100)
  43. */
  44. private $settingKey;
  46. /**
  47. * `text` et pas `string` : une clé de webhook ou un JSON de
  48. * configuration dépasse vite 255 caractères.
  49. *
  50. * @ORM\Column(name="setting_value", type="text", nullable=true)
  51. */
  52. private $settingValue;
  54. /**
  55. * Regroupement d'affichage dans le backoffice (`stripe`, `mail`, …).
  56. *
  57. * @ORM\Column(name="setting_group", type="string", length=50)
  58. */
  59. private $settingGroup = 'general';
  61. /**
  62. * Valeur sensible : masquée à l'affichage, jamais renvoyée en clair.
  63. *
  64. * @ORM\Column(name="is_secret", type="boolean")
  65. */
  66. private $isSecret = false;
  68. /**
  69. * @ORM\Column(name="updated_at", type="datetime", nullable=true)
  70. */
  71. private $updatedAt;
  73. /**
  74. * Qui a modifié, et quand. Une clé d'API qui change sans trace, c'est
  75. * une panne de paiement qu'on met une journée à expliquer.
  76. *
  77. * @ORM\Column(name="updated_by", type="string", length=180, nullable=true)
  78. */
  79. private $updatedBy;
  81. public function getId(): ?int
  82. {
  83. return $this->id;
  84. }
  86. public function getSettingKey(): ?string
  87. {
  88. return $this->settingKey;
  89. }
  91. public function setSettingKey(string $k): self
  92. {
  93. $this->settingKey = $k;
  95. return $this;
  96. }
  98. public function getSettingValue(): ?string
  99. {
  100. return $this->settingValue;
  101. }
  103. public function setSettingValue(?string $v): self
  104. {
  105. $this->settingValue = $v;
  107. return $this;
  108. }
  110. public function getSettingGroup(): ?string
  111. {
  112. return $this->settingGroup;
  113. }
  115. public function setSettingGroup(string $g): self
  116. {
  117. $this->settingGroup = $g;
  119. return $this;
  120. }
  122. public function isSecret(): bool
  123. {
  124. return (bool) $this->isSecret;
  125. }
  127. public function setIsSecret(bool $s): self
  128. {
  129. $this->isSecret = $s;
  131. return $this;
  132. }
  134. public function getUpdatedAt(): ?\DateTimeInterface
  135. {
  136. return $this->updatedAt;
  137. }
  139. public function setUpdatedAt(?\DateTimeInterface $d): self
  140. {
  141. $this->updatedAt = $d;
  143. return $this;
  144. }
  146. public function getUpdatedBy(): ?string
  147. {
  148. return $this->updatedBy;
  149. }
  151. public function setUpdatedBy(?string $u): self
  152. {
  153. $this->updatedBy = $u;
  155. return $this;
  156. }
  158. /**
  159. * La valeur telle qu'on peut l'afficher : masquée si elle est secrète.
  160. *
  161. * On garde les 4 derniers caractères — c'est ce qui permet de vérifier
  162. * d'un coup d'œil qu'on a bien la bonne clé, sans la révéler. Même
  163. * convention que les numéros de carte.
  164. */
  165. public function getMaskedValue(): ?string
  166. {
  167. if (!$this->settingValue) {
  168. return null;
  169. }
  171. if (!$this->isSecret()) {
  172. return $this->settingValue;
  173. }
  175. $v = $this->settingValue;
  176. $len = strlen($v);
  178. /* Trop courte pour être masquée utilement : on ne montre rien. */
  179. if ($len <= 8) {
  180. return str_repeat('•', 8);
  181. }
  183. /* Le préfixe Stripe (`sk_live_`, `whsec_`) est public et permet de
  184. voir immédiatement si on est en test ou en production. */
  185. $prefixe = '';
  187. if (preg_match('/^(sk_live_|sk_test_|pk_live_|pk_test_|whsec_|price_|prod_)/', $v, $m)) {
  188. $prefixe = $m[1];
  189. }
  191. return $prefixe . str_repeat('•', 8) . substr($v, -4);
  192. }
  193. }