src/Entity/Firm.php line 53

Open in your IDE?
  1. <?php
  3. namespace MedBrief\MSR\Entity;
  5. use ApiPlatform\Core\Annotation\ApiResource;
  6. use Doctrine\Common\Collections\ArrayCollection;
  7. use Doctrine\Common\Collections\Collection;
  8. use Doctrine\ORM\Mapping as ORM;
  9. use Gedmo\Mapping\Annotation as Gedmo;
  10. use MedBrief\MSR\Controller\Firm\RotateSecret;
  11. use MedBrief\MSR\Repository\FirmRepository;
  12. use Ramsey\Uuid\UuidInterface;
  13. use Symfony\Component\Security\Core\User\UserInterface;
  15. /**
  16. * A Firm represents an over-arching company or business that comprises one or more
  17. * Client Areas - referred to as Clients on the frontend and {@see Accounts} in the
  18. * code - and is unique in that it has the capability to authenticate itself for
  19. * Machine-to-Machine transactions such as consuming the external API.
  20. *
  21. * This is currently a very rudimentary entity but at a later point we can look at
  22. * migrating some common data shared between multiple client areas to a single source
  23. * of truth here within a Firm.
  24. *
  25. * @author S Honour <[email protected]>
  26. *
  27. * @ApiResource(
  28. * itemOperations={
  29. * "rotate_secret"={
  30. * "method"="POST",
  31. * "path"="/firm/rotate_secret",
  32. * "controller"=RotateSecret::class,
  33. * "deserialize"=false,
  34. * "defaults"={"_api_receive"=false},
  35. * "openapi_context"={
  36. * "summary"="Rotate a Client Secret.",
  37. * "description"="Rotates a client secret for the authenticated API user.",
  38. * "responses"={
  39. * "200"={
  40. * "description"="The new client secret"
  41. * },
  42. * "400"={
  43. * "description"="The authenticated user is not a valid Firm and cannot utilise this endpoint"
  44. * }
  45. * }
  46. * }
  47. * }
  48. * }
  49. * )
  50. *
  51. * @ORM\Entity(repositoryClass=FirmRepository::class)
  52. */
  53. class Firm implements UserInterface
  54. {
  55. /**
  56. * @ORM\Column(name="id", type="uuid")
  57. *
  58. * @ORM\Id
  59. *
  60. * @ORM\GeneratedValue(strategy="CUSTOM")
  61. *
  62. * @ORM\CustomIdGenerator(class="Ramsey\Uuid\Doctrine\UuidGenerator")
  63. */
  64. private ?UuidInterface $id = null;
  66. /**
  67. * @ORM\Column
  68. */
  69. private string $name;
  71. /**
  72. * @Gedmo\Slug(fields={"name"})
  73. *
  74. * @ORM\Column(length=128, unique=true)
  75. */
  76. private ?string $slug;
  78. /**
  79. * @ORM\OneToMany(targetEntity=Account::class, mappedBy="firm", cascade={"persist"})
  80. */
  81. private $clientAreas;
  83. /**
  84. * @ORM\Column
  85. */
  86. private array $roles = [];
  88. /**
  89. * @ORM\Column(type="string", length=255, nullable=true)
  90. */
  91. private ?string $auth0ClientId;
  93. public function __construct()
  94. {
  95. $this->clientAreas = new ArrayCollection();
  96. }
  98. /**
  99. * @return UuidInterface|null
  100. */
  101. public function getId(): ?UuidInterface
  102. {
  103. return $this->id;
  104. }
  106. /**
  107. * @inheritDoc
  108. */
  109. public function getRoles()
  110. {
  111. return $this->roles;
  112. }
  114. /**
  115. * A Firm does not have an associated password. Instead, it is authenticated via
  116. * Bearer tokens through an external authentication system.
  117. */
  118. public function getPassword()
  119. {
  120. return null;
  121. }
  123. /**
  124. * As a Firm does not have a password, there is no need for a salt either
  125. */
  126. public function getSalt()
  127. {
  128. return null;
  129. }
  131. /**
  132. * @inheritDoc
  133. */
  134. public function getUsername()
  135. {
  136. return $this->auth0ClientId;
  137. }
  139. /**
  140. * Imports antigravity
  141. */
  142. public function eraseCredentials()
  143. {
  144. // https://xkcd.com/353/
  145. }
  147. /**
  148. * @return Collection<int, Account>
  149. */
  150. public function getClientAreas(): Collection
  151. {
  152. return $this->clientAreas;
  153. }
  155. public function addClientArea(Account $clientArea): self
  156. {
  157. if (!$this->clientAreas->contains($clientArea)) {
  158. $this->clientAreas[] = $clientArea;
  159. $clientArea->setFirm($this);
  160. }
  162. return $this;
  163. }
  165. public function removeClientArea(Account $clientArea): self
  166. {
  167. if ($this->clientAreas->removeElement($clientArea)) {
  168. // set the owning side to null (unless already changed)
  169. if ($clientArea->getFirm() === $this) {
  170. $clientArea->setFirm(null);
  171. }
  172. }
  174. return $this;
  175. }
  177. public function addRole(string $role): self
  178. {
  179. if (!in_array($role, $this->roles)) {
  180. $this->roles[] = $role;
  181. }
  183. return $this;
  184. }
  186. public function removeRole(string $role): self
  187. {
  188. if (in_array($role, $this->roles)) {
  189. $key = array_search($role, $this->roles);
  190. unset($this->roles[$key]);
  191. }
  193. return $this;
  194. }
  196. public function getAuth0ClientId(): ?string
  197. {
  198. return $this->auth0ClientId;
  199. }
  201. public function setAuth0ClientId(?string $auth0ClientId): self
  202. {
  203. $this->auth0ClientId = $auth0ClientId;
  205. return $this;
  206. }
  208. /**
  209. * @return string
  210. */
  211. public function getName(): string
  212. {
  213. return $this->name;
  214. }
  216. /**
  217. * @param string $name
  218. *
  219. * @return Firm
  220. */
  221. public function setName(string $name): Firm
  222. {
  223. $this->name = $name;
  224. return $this;
  225. }
  227. /**
  228. * @return string|null
  229. */
  230. public function getSlug(): ?string
  231. {
  232. return $this->slug;
  233. }
  235. /**
  236. * @param string|null $slug
  237. *
  238. * @return Firm
  239. */
  240. public function setSlug(?string $slug): Firm
  241. {
  242. $this->slug = $slug;
  243. return $this;
  244. }
  246. public function isApiEnabled(): bool
  247. {
  248. return (bool) $this->auth0ClientId;
  249. }
  250. }