src/Entity/InterpartyDisclosure.php line 16

Open in your IDE?
  1. <?php
  3. namespace MedBrief\MSR\Entity;
  5. use Doctrine\Common\Collections\ArrayCollection;
  6. use Doctrine\Common\Collections\Collection as DoctrineCollection;
  7. use Doctrine\ORM\Mapping as ORM;
  8. use Gedmo\Mapping\Annotation as Gedmo;
  9. use MedBrief\MSR\Repository\InterpartyDisclosureRepository;
  10. use MedBrief\MSR\Traits\FilterableClassConstantsTrait;
  11. use Symfony\Component\Validator\Constraints as Assert;
  13. /**
  14. * @ORM\Entity(repositoryClass=InterpartyDisclosureRepository::class)
  15. */
  16. class InterpartyDisclosure
  17. {
  18. use FilterableClassConstantsTrait;
  20. public const STATUS_DRAFT = 'draft';
  21. public const STATUS_DRAFT__LABEL = 'Draft';
  23. public const STATUS_PENDING = 'pending';
  24. public const STATUS_PENDING__LABEL = 'Pending';
  26. public const STATUS_PROCESSING = 'processing';
  27. public const STATUS_PROCESSING__LABEL = 'Processing';
  29. public const STATUS_FAILED = 'failed';
  30. public const STATUS_FAILED__LABEL = 'Failed';
  32. public const STATUS_ACTIVE = 'active';
  33. public const STATUS_ACTIVE__LABEL = 'Active';
  35. public const STATUS_EXPIRED = 'expired';
  36. public const STATUS_EXPIRED__LABEL = 'Expired';
  38. public const STATUS_REVOKED = 'revoked';
  39. public const STATUS_REVOKED__LABEL = 'Revoked';
  41. public const STATUS_UPDATED = 'updated';
  42. public const STATUS_UPDATED__LABEL = 'Updated';
  44. public const DEFAULT_EXPIRY_DAYS = 30;
  45. public const DEFAULT_EXPIRY_EXTENSION_DAYS = 14;
  47. public const HAS_RADIOLOGY_STUDIES_YES = 'yes';
  48. public const HAS_RADIOLOGY_STUDIES_YES__LABEL = 'Yes';
  50. public const HAS_RADIOLOGY_STUDIES_NO = 'no';
  51. public const HAS_RADIOLOGY_STUDIES_NO__LABEL = 'No';
  53. public const RADIOLOGY_FAILED_DISCS_YES = 'yes';
  54. public const RADIOLOGY_FAILED_DISCS_YES__LABEL = 'Yes';
  56. public const RADIOLOGY_FAILED_DISCS_NO = 'no';
  57. public const RADIOLOGY_FAILED_DISCS_NO__LABEL = 'No';
  59. public const HAS_MEDICAL_RECORDS_YES = 'yes';
  60. public const HAS_MEDICAL_RECORDS_YES__LABEL = 'Yes';
  62. public const HAS_MEDICAL_RECORDS_NO = 'no';
  63. public const HAS_MEDICAL_RECORDS_NO__LABEL = 'No';
  65. /**
  66. * @ORM\Id
  67. *
  68. * @ORM\GeneratedValue
  69. *
  70. * @ORM\Column(type="integer")
  71. */
  72. private ?int $id;
  74. /**
  75. * @ORM\Column(type="string", length=32, options={"default":self::STATUS_ACTIVE})
  76. */
  77. private ?string $status = self::STATUS_ACTIVE;
  79. /**
  80. * @ORM\Column(type="datetime", nullable=true)
  81. */
  82. private ?\DateTime $expiryDate;
  84. /**
  85. * @ORM\Column(type="datetime")
  86. *
  87. * @Gedmo\Timestampable(on="create")
  88. */
  89. private ?\DateTime $created;
  91. /**
  92. * @ORM\Column(type="datetime", nullable=true)
  93. *
  94. * @Gedmo\Timestampable(on="update")
  95. */
  96. private ?\DateTime $updated;
  98. /**
  99. * @ORM\Column(type="datetime", nullable=true)
  100. */
  101. private ?\DateTime $recordsModifiedDate;
  103. /**
  104. * @ORM\ManyToOne(targetEntity=Project::class, inversedBy="interpartyDisclosures")
  105. *
  106. * @ORM\JoinColumn(nullable=false)
  107. */
  108. private ?Project $project;
  110. /**
  111. * @ORM\OneToMany(targetEntity=InterpartyDisclosureRecipientFirm::class, mappedBy="interpartyDisclosure", orphanRemoval=true, cascade={"persist", "remove"})
  112. *
  113. * @Assert\Valid(groups={"third-party"})
  114. *
  115. * @Assert\Count(min=1, minMessage="At least one recipient firm is required.", groups={"third-party"})
  116. */
  117. private ?DoctrineCollection $recipientFirms;
  119. /**
  120. * @ORM\Column(type="datetime", nullable=true)
  121. */
  122. private ?\DateTime $revokeDate;
  124. /**
  125. * @ORM\ManyToOne(targetEntity=User::class)
  126. */
  127. private ?User $createdBy;
  129. /**
  130. * @ORM\ManyToOne(targetEntity=User::class)
  131. */
  132. private ?User $revokedBy;
  134. /**
  135. * @ORM\Column(type="datetime", nullable=true)
  136. */
  137. private ?\DateTime $reactivateDate;
  139. /**
  140. * @ORM\Column(type="json", nullable=true)
  141. */
  142. private $selectedRecordsPayload = [];
  144. /**
  145. * @ORM\Column(type="json", nullable=true)
  146. */
  147. private $recordsSnapshot = [];
  149. /**
  150. * @ORM\OneToMany(targetEntity=InterpartyDisclosureStudy::class, mappedBy="interpartyDisclosure", orphanRemoval=true, cascade={"persist", "remove"})
  151. */
  152. private ?DoctrineCollection $interpartyDisclosureStudies;
  154. /**
  155. * @ORM\OneToMany(targetEntity=InterpartyDisclosureDisc::class, mappedBy="interpartyDisclosure", orphanRemoval=true, cascade={"persist", "remove"})
  156. */
  157. private ?DoctrineCollection $interpartyDisclosureDiscs;
  159. /**
  160. * @ORM\Column(type="integer", options={"default":0})
  161. */
  162. private ?int $medicalRecordsCount = 0;
  164. /**
  165. * @ORM\OneToOne(targetEntity="InterpartyDisclosure", inversedBy="child")
  166. */
  167. private ?InterpartyDisclosure $parent = null;
  169. /**
  170. * @ORM\OneToOne(targetEntity="InterpartyDisclosure", mappedBy="parent")
  171. */
  172. private ?InterpartyDisclosure $child = null;
  174. /**
  175. * Represents a child copy of a disclosure which has not been updated yet.
  176. *
  177. * @ORM\Column(type="boolean", options={"default":false})
  178. */
  179. private ?bool $pureCopy = false;
  181. /**
  182. * @ORM\ManyToOne(targetEntity=Project::class, inversedBy="disclosureSources")
  183. */
  184. private ?Project $disclosureTarget = null;
  186. /**
  187. * @ORM\Column(type="boolean", options={"default":false})
  188. */
  189. private ?bool $savedAsDraft = false;
  191. // Non-mapped property
  192. private bool $isClone = false;
  194. /**
  195. * @ORM\Column(type="boolean", options={"default":false})
  196. */
  197. private ?bool $recordsUpdated = false;
  199. /**
  200. * @ORM\Column(type="boolean", options={"default":false})
  201. */
  202. private ?bool $radiologyUpdated = false;
  204. public function __construct()
  205. {
  206. $this->recipientFirms = new ArrayCollection();
  207. $this->interpartyDisclosureStudies = new ArrayCollection();
  208. $this->interpartyDisclosureDiscs = new ArrayCollection();
  209. }
  211. public function __clone()
  212. {
  213. // Do not clone objects that don't have an identity - Doctrine recommendation.
  214. if ($this->id) {
  215. $this->id = null;
  216. // Mark it as a clone, so we can do some logic against it in the setters e.g. setPureCopy.
  217. $this->isClone = true;
  219. $this->setPureCopy(true);
  220. $this->setSavedAsDraft(false);
  221. $this->setStatus(self::STATUS_DRAFT);
  223. // Auto date fields
  224. $this->setCreatedBy(null);
  225. $this->setUpdated(null);
  227. // Revoked fields
  228. $this->setRevokedBy(null);
  229. $this->setRevokeDate(null);
  231. // Versioning
  232. $this->setParent(null);
  233. $this->setChild(null);
  235. // Other dates
  236. $this->setExpiryDate(null);
  237. $this->setRecordsModifiedDate(null);
  238. $this->setReactivateDate(null);
  240. // Other flags
  241. $this->setRadiologyUpdated(false);
  242. $this->setRecordsUpdated(false);
  244. // Clone firms
  245. $recipientFirms = $this->getRecipientFirms();
  246. $this->recipientFirms = new ArrayCollection();
  247. foreach ($recipientFirms as $recipientFirm) {
  248. $this->addRecipientFirm(clone $recipientFirm);
  249. }
  251. // Clone studies
  252. $interpartyDisclosureStudies = $this->getInterpartyDisclosureStudies();
  253. $this->interpartyDisclosureStudies = new ArrayCollection();
  254. foreach ($interpartyDisclosureStudies as $study) {
  255. $this->addInterpartyDisclosureStudy(clone $study);
  256. }
  258. // Clone discs
  259. $interpartyDisclosureDiscs = $this->getInterpartyDisclosureDiscs();
  260. $this->interpartyDisclosureDiscs = new ArrayCollection();
  261. foreach ($interpartyDisclosureDiscs as $disc) {
  262. $this->addInterpartyDisclosureDisc(clone $disc);
  263. }
  264. }
  265. }
  267. /**
  268. * @return int|null
  269. */
  270. public function getId(): ?int
  271. {
  272. return $this->id;
  273. }
  275. /**
  276. * @return string
  277. */
  278. public function getStatus(): string
  279. {
  280. return $this->status;
  281. }
  283. /**
  284. * @return array
  285. */
  286. public static function getStatusOptions(): array
  287. {
  288. return array_flip(self::getConstantsWithLabelsAsChoices('STATUS'));
  289. }
  291. /**
  292. * @return string
  293. */
  294. public function getStatusLabel(): string
  295. {
  296. $options = self::getStatusOptions();
  297. return $options[$this->getStatus()] ?? '';
  298. }
  300. /**
  301. * @param string $status
  302. *
  303. * @return self
  304. */
  305. public function setStatus(string $status): self
  306. {
  307. // if status is changing to expired, clear the recordsUpdates and radiologyUpdated fields
  308. if ($status === self::STATUS_EXPIRED) {
  309. $this->setRecordsUpdated(false);
  310. $this->setRadiologyUpdated(false);
  311. }
  313. $this->status = $status;
  315. return $this;
  316. }
  318. /**
  319. * @return bool
  320. */
  321. public function isStatusDraft(): bool
  322. {
  323. return $this->getStatus() === self::STATUS_DRAFT;
  324. }
  326. /**
  327. * @return bool
  328. */
  329. public function isStatusPending(): bool
  330. {
  331. return $this->getStatus() === self::STATUS_PENDING;
  332. }
  334. /**
  335. * @return bool
  336. */
  337. public function isStatusProcessing(): bool
  338. {
  339. return $this->getStatus() === self::STATUS_PROCESSING;
  340. }
  342. /**
  343. * @return bool
  344. */
  345. public function isStatusFailed(): bool
  346. {
  347. return $this->getStatus() === self::STATUS_FAILED;
  348. }
  350. /**
  351. * @return bool
  352. */
  353. public function isStatusActive(): bool
  354. {
  355. return $this->getStatus() === self::STATUS_ACTIVE;
  356. }
  358. /**
  359. * @return bool
  360. */
  361. public function isStatusRevoked(): bool
  362. {
  363. return $this->getStatus() === self::STATUS_REVOKED;
  364. }
  366. /**
  367. * @return bool
  368. */
  369. public function isStatusUpdated(): bool
  370. {
  371. return $this->getStatus() === self::STATUS_UPDATED;
  372. }
  374. /**
  375. * @return bool
  376. */
  377. public function isStatusExpired(): bool
  378. {
  379. return $this->getStatus() === self::STATUS_EXPIRED;
  380. }
  382. /**
  383. * @return \DateTime|null
  384. */
  385. public function getExpiryDate(): ?\DateTime
  386. {
  387. return $this->expiryDate;
  388. }
  390. /**
  391. * @param \DateTime|null $expiryDate
  392. *
  393. * @return self
  394. */
  395. public function setExpiryDate(?\DateTime $expiryDate): self
  396. {
  397. $this->expiryDate = $expiryDate;
  399. return $this;
  400. }
  402. /**
  403. * NOTE: Extension is based only on the parent expiry date.
  404. * Extends the expiry date if the remaining days is less than our extension period.
  405. *
  406. * @return self
  407. */
  408. public function extendExpiryDateIfDue(): self
  409. {
  410. if ($this->getParent() === null) {
  411. throw new \InvalidArgumentException('A parent disclosure is expected to extend the expiry date.');
  412. }
  414. $parentExpiryDate = clone $this->getParent()->getExpiryDate();
  415. // If the parent disclosure was set to expire in less than the extension days, extend it further by the extension days.
  416. if ($this->getParent()->getExpiryDate() < new \DateTime(sprintf('+%1$s days', self::DEFAULT_EXPIRY_EXTENSION_DAYS))) {
  417. $this->setExpiryDate($parentExpiryDate->modify(sprintf('+%1$s days', self::DEFAULT_EXPIRY_EXTENSION_DAYS)));
  418. } else {
  419. // Else, give it the original expiry date of the parent.
  420. $this->setExpiryDate($parentExpiryDate);
  421. }
  423. return $this;
  424. }
  426. /**
  427. * Calculates and sets the expiry date.
  428. *
  429. * Important: should be called before any status change of the disclosure.
  430. *
  431. * @return self
  432. */
  433. public function calculateExpiryDate(): self
  434. {
  435. if ($this->getParent() === null || $this->isStatusExpired() === true || $this->isParentExpired()) {
  436. // This is the original disclosure, or the disclosure is expired and we're not updating, give it a normal expiry date.
  437. $this->setExpiryDate(new \DateTime(sprintf('+%1$s days', self::DEFAULT_EXPIRY_DAYS)));
  438. } else {
  439. // else, we're simply updating an existing disclosure and need to extend with the expiry date
  440. // using some additional logic.
  441. $this->extendExpiryDateIfDue();
  442. }
  444. return $this;
  445. }
  447. /**
  448. * @return \DateTimeInterface|null
  449. */
  450. public function getCreated(): ?\DateTimeInterface
  451. {
  452. return $this->created;
  453. }
  455. /**
  456. * @param \DateTimeInterface $created
  457. *
  458. * @return self
  459. */
  460. public function setCreated(\DateTimeInterface $created): self
  461. {
  462. $this->created = $created;
  464. return $this;
  465. }
  467. /**
  468. * @return \DateTimeInterface|null
  469. */
  470. public function getUpdated(): ?\DateTimeInterface
  471. {
  472. return $this->updated;
  473. }
  475. /**
  476. * @param \DateTimeInterface|null $updated
  477. *
  478. * @return self
  479. */
  480. public function setUpdated(?\DateTimeInterface $updated): self
  481. {
  482. $this->updated = $updated;
  484. return $this;
  485. }
  487. /**
  488. * @return Project|null
  489. */
  490. public function getProject(): ?Project
  491. {
  492. return $this->project;
  493. }
  495. /**
  496. * @param Project|null $project
  497. *
  498. * @return self
  499. */
  500. public function setProject(?Project $project): self
  501. {
  502. $this->project = $project;
  504. return $this;
  505. }
  507. /**
  508. * @return DoctrineCollection<int, InterpartyDisclosureRecipientFirm>
  509. */
  510. public function getRecipientFirms(): DoctrineCollection
  511. {
  512. return $this->recipientFirms;
  513. }
  515. /**
  516. * Returns the recipient firms reference number - limited to the first recipient firm.
  517. *
  518. * @return string
  519. */
  520. public function getRecipientFirmReference(): string
  521. {
  522. return $this->getRecipientFirms()->count() > 0 ? $this->getRecipientFirms()->first()->getMatterNumber() : '';
  523. }
  525. /**
  526. * Retrieve a string of Recipient Firm name/s.
  527. * If there are multiple Firms then prefixes each name with a bracketed number.
  528. *
  529. * @return string
  530. */
  531. public function getRecipientFirmsString(): string
  532. {
  533. $firmsArray = $this->getRecipientFirms()->map(function (InterpartyDisclosureRecipientFirm $recipientFirm) {
  534. return $recipientFirm->getName();
  535. })->toArray();
  537. if (count($firmsArray) === 1) {
  538. return $firmsArray[0];
  539. }
  541. $firmsStr = implode(' ', array_map(function (string $currentItem, $currentKey) {
  542. return sprintf('(%1$s) %2$s', $currentKey + 1, $currentItem);
  543. }, $firmsArray, array_keys($firmsArray)));
  545. return $firmsStr;
  546. }
  548. /**
  549. * Retrieve a string of Recipient Firm name/s postfixed with bracketed office field if not empty.
  550. * If there are multiple Firms then prefixes each name with a bracketed number.
  551. *
  552. * @return string
  553. */
  554. public function getRecipientFirmsWithOfficeString(): string
  555. {
  556. $firmsArray = $this->getRecipientFirms()->map(function (InterpartyDisclosureRecipientFirm $recipientFirm) {
  557. $office = is_null($recipientFirm->getOffice()) ? '' : ' (' . $recipientFirm->getOffice() . ')';
  558. return $recipientFirm->getName() . $office;
  559. })->toArray();
  561. if (count($firmsArray) === 1) {
  562. return $firmsArray[0];
  563. }
  565. $firmsStr = implode(' ', array_map(function (string $currentItem, $currentKey) {
  566. return sprintf('(%1$s) %2$s', $currentKey + 1, $currentItem);
  567. }, $firmsArray, array_keys($firmsArray)));
  569. return $firmsStr;
  570. }
  572. /**
  573. * Retrieves all recipient contacts belonging to a disclosure
  574. *
  575. * @return array
  576. */
  577. public function getAllInterpartyDisclosureContacts(): array
  578. {
  579. if ($this->getRecipientFirms()->count() === 0) {
  580. return [];
  581. }
  583. $allContacts = [];
  584. foreach ($this->getRecipientFirms() as $firm) {
  585. foreach ($firm->getRecipientContacts() as $contact) {
  586. $allContacts[] = $contact;
  587. }
  588. }
  590. return $allContacts;
  591. }
  593. /**
  594. * @param InterpartyDisclosureRecipientFirm $recipientFirm
  595. *
  596. * @return self
  597. */
  598. public function addRecipientFirm(InterpartyDisclosureRecipientFirm $recipientFirm): self
  599. {
  600. if (!$this->recipientFirms->contains($recipientFirm)) {
  601. $this->recipientFirms[] = $recipientFirm;
  602. $recipientFirm->setInterpartyDisclosure($this);
  603. }
  605. return $this;
  606. }
  608. /**
  609. * @param InterpartyDisclosureRecipientFirm $recipientFirm
  610. *
  611. * @return self
  612. */
  613. public function removeRecipientFirm(InterpartyDisclosureRecipientFirm $recipientFirm): self
  614. {
  615. if ($this->recipientFirms->removeElement($recipientFirm)) {
  616. // set the owning side to null (unless already changed)
  617. if ($recipientFirm->getInterpartyDisclosure() === $this) {
  618. $recipientFirm->setInterpartyDisclosure(null);
  619. }
  620. }
  622. return $this;
  623. }
  625. /**
  626. * @return \DateTimeInterface|null
  627. */
  628. public function getRevokeDate(): ?\DateTimeInterface
  629. {
  630. return $this->revokeDate;
  631. }
  633. /**
  634. * @param \DateTimeInterface|null $revokeDate
  635. *
  636. * @return self
  637. */
  638. public function setRevokeDate(?\DateTimeInterface $revokeDate): self
  639. {
  640. $this->revokeDate = $revokeDate;
  642. return $this;
  643. }
  645. /**
  646. * @return \DateTimeInterface|null
  647. */
  648. public function getReactivateDate(): ?\DateTimeInterface
  649. {
  650. return $this->reactivateDate;
  651. }
  653. /**
  654. * @param \DateTimeInterface|null $reactivateDate
  655. *
  656. * @return self
  657. */
  658. public function setReactivateDate(?\DateTimeInterface $reactivateDate): self
  659. {
  660. $this->reactivateDate = $reactivateDate;
  662. return $this;
  663. }
  665. /**
  666. * @return User|null
  667. */
  668. public function getRevokedBy(): ?User
  669. {
  670. return $this->revokedBy;
  671. }
  673. /**
  674. * @param User|null $revokedBy
  675. *
  676. * @return self
  677. */
  678. public function setRevokedBy(?User $revokedBy): self
  679. {
  680. $this->revokedBy = $revokedBy;
  682. return $this;
  683. }
  685. /**
  686. * @return DoctrineCollection<int, InterpartyDisclosureStudy>
  687. */
  688. public function getInterpartyDisclosureStudies(): DoctrineCollection
  689. {
  690. return $this->interpartyDisclosureStudies;
  691. }
  693. /**
  694. * @param InterpartyDisclosureStudy $interpartyDisclosureStudy
  695. *
  696. * @return self
  697. */
  698. public function addInterpartyDisclosureStudy(InterpartyDisclosureStudy $interpartyDisclosureStudy): self
  699. {
  700. if (!$this->interpartyDisclosureStudies->contains($interpartyDisclosureStudy)) {
  701. $this->interpartyDisclosureStudies[] = $interpartyDisclosureStudy;
  702. $interpartyDisclosureStudy->setInterpartyDisclosure($this);
  703. }
  705. return $this;
  706. }
  708. /**
  709. * @param InterpartyDisclosureStudy $interpartyDisclosureStudy
  710. *
  711. * @return self
  712. */
  713. public function removeInterpartyDisclosureStudy(InterpartyDisclosureStudy $interpartyDisclosureStudy): self
  714. {
  715. if ($this->interpartyDisclosureStudies->removeElement($interpartyDisclosureStudy)) {
  716. // set the owning side to null (unless already changed)
  717. if ($interpartyDisclosureStudy->getInterpartyDisclosure() === $this) {
  718. $interpartyDisclosureStudy->setInterpartyDisclosure(null);
  719. }
  720. }
  722. return $this;
  723. }
  725. /**
  726. * @return DoctrineCollection<int, Study>
  727. */
  728. public function getStudies(): DoctrineCollection
  729. {
  730. return $this->getInterpartyDisclosureStudies()->map(function (InterpartyDisclosureStudy $disclosureStudy) {
  731. return $disclosureStudy->getStudy();
  732. });
  733. }
  735. /**
  736. * @param Study $study
  737. *
  738. * @return self
  739. */
  740. public function addStudy(Study $study): self
  741. {
  742. $disclosureStudy = new InterpartyDisclosureStudy();
  743. $disclosureStudy->setStudy($study);
  744. $discs = $study->getDiscs();
  746. $disclosureDiscs = $discs->map(function ($disc) {
  747. return [
  748. 'name' => $disc->getName(),
  749. 'id' => $disc->getId(),
  750. ];
  751. });
  753. $disclosureStudy->setPayload(
  754. [
  755. 'date' => $study->getStudyDate(),
  756. 'description' => $study->getStudyDescription(),
  757. 'discs' => $disclosureDiscs,
  758. ]
  759. );
  761. $this->addInterpartyDisclosureStudy($disclosureStudy);
  763. return $this;
  764. }
  766. /**
  767. * @param Study $study
  768. *
  769. * @return self
  770. */
  771. public function removeStudy(Study $study): self
  772. {
  773. foreach ($this->getInterpartyDisclosureStudies() as $disclosureStudy) {
  774. if ($disclosureStudy->getStudy() === $study) {
  775. $this->removeInterpartyDisclosureStudy($disclosureStudy);
  776. }
  777. }
  779. return $this;
  780. }
  782. /**
  783. * @return DoctrineCollection<int, InterpartyDisclosureDisc>
  784. */
  785. public function getInterpartyDisclosureDiscs(): DoctrineCollection
  786. {
  787. return $this->interpartyDisclosureDiscs;
  788. }
  790. /**
  791. * @param InterpartyDisclosureDisc $interpartyDisclosureDisc
  792. *
  793. * @return self
  794. */
  795. public function addInterpartyDisclosureDisc(?InterpartyDisclosureDisc $interpartyDisclosureDisc): self
  796. {
  797. if (!$this->interpartyDisclosureDiscs->contains($interpartyDisclosureDisc)) {
  798. $this->interpartyDisclosureDiscs[] = $interpartyDisclosureDisc;
  799. $interpartyDisclosureDisc->setInterpartyDisclosure($this);
  800. }
  802. return $this;
  803. }
  805. /**
  806. * @param InterpartyDisclosureDisc $interpartyDisclosureDisc
  807. *
  808. * @return self
  809. */
  810. public function removeInterpartyDisclosureDisc(InterpartyDisclosureDisc $interpartyDisclosureDisc): self
  811. {
  812. if ($this->interpartyDisclosureDiscs->removeElement($interpartyDisclosureDisc)) {
  813. // set the owning side to null (unless already changed)
  814. if ($interpartyDisclosureDisc->getInterpartyDisclosure() === $this) {
  815. $interpartyDisclosureDisc->setInterpartyDisclosure(null);
  816. }
  817. }
  819. return $this;
  820. }
  822. /**
  823. * @return DoctrineCollection<int, Disc>
  824. */
  825. public function getDiscs(): DoctrineCollection
  826. {
  827. return $this->getInterpartyDisclosureDiscs()->map(function (InterpartyDisclosureDisc $disclosureDisc) {
  828. return $disclosureDisc->getDisc();
  829. });
  830. }
  832. /**
  833. * @param Disc $disc
  834. *
  835. * @return self
  836. */
  837. public function addDisc(Disc $disc): self
  838. {
  839. $disclosureDisc = new InterpartyDisclosureDisc();
  840. $disclosureDisc->setDisc($disc);
  842. $disclosureDisc->setPayload(
  843. [
  844. 'id' => $disc->getId(),
  845. 'name' => $disc->getName(),
  846. ]
  847. );
  849. $this->addInterpartyDisclosureDisc($disclosureDisc);
  851. return $this;
  852. }
  854. /**
  855. * @param Disc $disc
  856. *
  857. * @return self
  858. */
  859. public function removeDisc(Disc $disc): self
  860. {
  861. foreach ($this->getInterpartyDisclosureDiscs() as $disclosureDisc) {
  862. if ($disclosureDisc->getDisc() === $disc) {
  863. $this->removeInterpartyDisclosureDisc($disclosureDisc);
  864. }
  865. }
  867. return $this;
  868. }
  870. /**
  871. * @return array|null
  872. */
  873. public function getSelectedRecordsPayload(): ?array
  874. {
  875. return $this->selectedRecordsPayload;
  876. }
  878. /**
  879. * @param array|null $selectedRecordsPayload
  880. *
  881. * @return self
  882. */
  883. public function setSelectedRecordsPayload(?array $selectedRecordsPayload): self
  884. {
  885. $this->selectedRecordsPayload = $selectedRecordsPayload;
  887. if ($selectedRecordsPayload === null) {
  888. $this->setMedicalRecordsCount(0);
  889. } else {
  890. $this->setMedicalRecordsCount(count($selectedRecordsPayload));
  891. }
  893. return $this;
  894. }
  896. /**
  897. * @return User|null
  898. */
  899. public function getCreatedBy(): ?User
  900. {
  901. return $this->createdBy;
  902. }
  904. /**
  905. * @param User|null $createdBy
  906. *
  907. * @return self
  908. */
  909. public function setCreatedBy(?User $createdBy): self
  910. {
  911. $this->createdBy = $createdBy;
  913. return $this;
  914. }
  916. /**
  917. * Counts the number of third parties, i.e. recipient firm contacts that have
  918. * access to the interparty disclosure
  919. *
  920. * @return int|null
  921. */
  922. public function getContactPersonCount(): ?int
  923. {
  924. $count = 0;
  925. foreach ($this->getRecipientFirms() as $firm) {
  926. $count += $firm->getRecipientContacts()->count();
  927. }
  929. return $count;
  930. }
  932. /**
  933. * Counts the number of radiology studies that an interparty disclosure has associated
  934. * with it.
  935. *
  936. * @return int|null
  937. */
  938. public function getRadiologyStudyCount(): ?int
  939. {
  940. return $this->getInterpartyDisclosureStudies()->count();
  941. }
  943. /**
  944. * @return array
  945. */
  946. public static function getHasRadiologyStudiesOptions(): array
  947. {
  948. return array_flip(self::getConstantsWithLabelsAsChoices('HAS_RADIOLOGY_STUDIES'));
  949. }
  951. /**
  952. * Counts the number of failed radiology discs that an interparty disclosure
  953. * has associated with it.
  954. *
  955. * @return int|null
  956. */
  957. public function getRadiologyFailedDiscsCount(): ?int
  958. {
  959. return $this->getInterpartyDisclosureDiscs()->count();
  960. }
  962. /**
  963. * @return array
  964. */
  965. public static function getRadiologyFailedDiscsOptions(): array
  966. {
  967. return array_flip(self::getConstantsWithLabelsAsChoices('RADIOLOGY_FAILED_DISCS'));
  968. }
  970. /**
  971. * @return int
  972. */
  973. public function getRadiologyItemTotalCount(): int
  974. {
  975. return $this->getRadiologyStudyCount() + $this->getRadiologyFailedDiscsCount();
  976. }
  978. /**
  979. * @return string|null
  980. */
  981. public function getThirdPartyContacts(): ?string
  982. {
  983. $contactDetails = [];
  985. foreach ($this->getRecipientFirms() as $firm) {
  986. foreach ($firm->getRecipientContacts() as $contact) {
  987. $contactDetails[] = $contact;
  988. }
  989. }
  991. $contactNames = array_map(function ($contact) {
  992. return $contact->getFullName();
  993. }, $contactDetails);
  995. return implode(',', $contactNames);
  996. }
  998. /**
  999. * @return self|null
  1000. */
  1001. public function getParent(): ?self
  1002. {
  1003. return $this->parent;
  1004. }
  1006. /**
  1007. * @param self|null $parent
  1008. *
  1009. * @return self
  1010. */
  1011. public function setParent(?self $parent): self
  1012. {
  1013. $this->parent = $parent;
  1015. return $this;
  1016. }
  1018. /**
  1019. * @return self|null
  1020. */
  1021. public function getChild(): ?self
  1022. {
  1023. return $this->child;
  1024. }
  1026. /**
  1027. * @param self|null $child
  1028. *
  1029. * @return self
  1030. */
  1031. public function setChild(?self $child): self
  1032. {
  1033. // unset the owning side of the relation if necessary
  1034. if ($child === null && $this->child !== null) {
  1035. $this->child->setParent(null);
  1036. }
  1038. // set the owning side of the relation if necessary
  1039. if ($child !== null && $child->getParent() !== $this) {
  1040. $child->setParent($this);
  1041. }
  1043. $this->child = $child;
  1045. return $this;
  1046. }
  1048. /**
  1049. * @return InterpartyDisclosure[]
  1050. */
  1051. public function getPreviousVersions(): array
  1052. {
  1053. $currentElement = $this;
  1054. $previousVersions = [];
  1055. do {
  1056. if ($currentElement->getParent() !== null) {
  1057. $previousVersions[] = $currentElement->getParent();
  1058. }
  1059. $currentElement = $currentElement->getParent();
  1060. } while ($currentElement !== null);
  1062. return $previousVersions;
  1063. }
  1065. /**
  1066. * Returns true if the current disclosure is a previous disclosure of the disclosure passed in as an argument.
  1067. *
  1068. * @param InterpartyDisclosure $latestDisclosure
  1069. *
  1070. * @return bool
  1071. */
  1072. public function isDisclosurePreviousVersionOf(InterpartyDisclosure $latestDisclosure): bool
  1073. {
  1074. return in_array($this, $latestDisclosure->getPreviousVersions());
  1075. }
  1077. /**
  1078. * @return bool
  1079. */
  1080. public function isChildDraft(): bool
  1081. {
  1082. return $this->getParent() instanceof self && $this->isStatusDraft();
  1083. }
  1085. /**
  1086. * @return bool
  1087. */
  1088. public function isParentExpired(): bool
  1089. {
  1090. return $this->getParent() !== null && $this->getParent()->getExpiryDate() <= new \DateTime();
  1091. }
  1093. /**
  1094. * Returns true if the disclosure chain should be considered expired.
  1095. *
  1096. * @return bool
  1097. */
  1098. public function isDisclosureChainExpired(): bool
  1099. {
  1100. return $this->isStatusExpired() || $this->isParentExpired();
  1101. }
  1103. /**
  1104. * @return bool
  1105. */
  1106. public function hasChildDraft(): bool
  1107. {
  1108. return $this->getChild() instanceof self && $this->getChild()->isStatusDraft();
  1109. }
  1111. /**
  1112. * @return bool
  1113. */
  1114. public function canEdit(): bool
  1115. {
  1116. $allowedStatuses = [
  1117. self::STATUS_ACTIVE,
  1118. self::STATUS_DRAFT,
  1119. ];
  1121. return in_array($this->getStatus(), $allowedStatuses);
  1122. }
  1124. /**
  1125. * Returns the ID of the entity that should be used for editing.
  1126. *
  1127. * @return int|null
  1128. */
  1129. public function getEditId(): ?int
  1130. {
  1131. if ($this->hasChildDraft()) {
  1132. return $this->getChild()->getId();
  1133. }
  1135. return $this->getId();
  1136. }
  1138. /**
  1139. * @return bool|null
  1140. */
  1141. public function getPureCopy(): ?bool
  1142. {
  1143. return $this->pureCopy;
  1144. }
  1146. /**
  1147. * @param bool|null $pureCopy
  1148. *
  1149. * @return self
  1150. */
  1151. public function setPureCopy(?bool $pureCopy): self
  1152. {
  1153. if ($pureCopy === true && $this->isChildDraft() === false && $this->isClone === false) {
  1154. throw new \InvalidArgumentException('Only child drafts can be marked as pure copies.');
  1155. }
  1157. $this->pureCopy = $pureCopy;
  1159. return $this;
  1160. }
  1162. /**
  1163. * @return int|null
  1164. */
  1165. public function getMedicalRecordsCount(): ?int
  1166. {
  1167. return $this->medicalRecordsCount;
  1168. }
  1170. /**
  1171. * @param int|null $medicalRecordsCount
  1172. *
  1173. * @return self
  1174. */
  1175. public function setMedicalRecordsCount(?int $medicalRecordsCount): self
  1176. {
  1177. $this->medicalRecordsCount = $medicalRecordsCount;
  1179. return $this;
  1180. }
  1182. /**
  1183. * @return array
  1184. */
  1185. public static function getHasMedicalRecordsOptions(): array
  1186. {
  1187. return array_flip(self::getConstantsWithLabelsAsChoices('HAS_MEDICAL_RECORDS'));
  1188. }
  1190. /**
  1191. * Returns true if the disclosure is the current head of the chain.
  1192. * Child drafts are ignored.
  1193. *
  1194. * @return bool
  1195. */
  1196. public function isCurrentHeadOfChain(): bool
  1197. {
  1198. return $this->getChild() === null || $this->hasChildDraft() === true;
  1199. }
  1201. /**
  1202. * @return Project|null
  1203. */
  1204. public function getDisclosureTarget(): ?Project
  1205. {
  1206. return $this->disclosureTarget;
  1207. }
  1209. /**
  1210. * @param Project|null $disclosureTarget
  1211. *
  1212. * @return self
  1213. */
  1214. public function setDisclosureTarget(?Project $disclosureTarget): self
  1215. {
  1216. $this->disclosureTarget = $disclosureTarget;
  1218. return $this;
  1219. }
  1221. /**
  1222. * @return array|null
  1223. */
  1224. public function getRecordsSnapshot(): ?array
  1225. {
  1226. return $this->recordsSnapshot;
  1227. }
  1229. /**
  1230. * @param array|null $recordsSnapshot
  1231. *
  1232. * @return self
  1233. */
  1234. public function setRecordsSnapshot(?array $recordsSnapshot): self
  1235. {
  1236. $this->recordsSnapshot = $recordsSnapshot;
  1238. return $this;
  1239. }
  1241. /**
  1242. * @return \DateTimeInterface|null
  1243. *
  1244. */
  1245. public function getRecordsModifiedDate(): ?\DateTimeInterface
  1246. {
  1247. return $this->recordsModifiedDate;
  1248. }
  1250. /**
  1251. * @param \DateTimeInterface|null $recordsModifiedDate
  1252. *
  1253. * @return self
  1254. *
  1255. */
  1256. public function setRecordsModifiedDate(?\DateTimeInterface $recordsModifiedDate): self
  1257. {
  1258. $this->recordsModifiedDate = $recordsModifiedDate;
  1260. return $this;
  1261. }
  1263. /**
  1264. * Determines the contacts removed from the child that were in the parent.
  1265. *
  1266. * @return InterpartyDisclosureRecipientContact[]
  1267. */
  1268. public function getContactsRemoved(): array
  1269. {
  1270. // No parent? No contacts removed
  1271. if ($this->getParent() === null) {
  1272. return [];
  1273. }
  1275. // Start by mapping the previous set of contacts to their emails.
  1276. $prevContacts = array_map(function (InterpartyDisclosureRecipientContact $contact) {
  1277. return $contact->getEmail();
  1278. }, $this->getParent()->getAllInterpartyDisclosureContacts());
  1280. $currContacts = array_map(function (InterpartyDisclosureRecipientContact $contact) {
  1281. return $contact->getEmail();
  1282. }, $this->getAllInterpartyDisclosureContacts());
  1284. // Get the elements that are in prevContacts, but not in currContacts
  1285. $removedContacts = array_diff($prevContacts, $currContacts);
  1287. // Nothing, return empty array
  1288. if (empty($removedContacts)) {
  1289. return [];
  1290. }
  1292. // Turn them back into entities and return
  1293. return array_filter($this->getParent()->getAllInterpartyDisclosureContacts(), function (InterpartyDisclosureRecipientContact $contact) use ($removedContacts) {
  1294. return in_array($contact->getEmail(), $removedContacts) === true;
  1295. });
  1296. }
  1298. /**
  1299. * @return bool|null
  1300. */
  1301. public function getSavedAsDraft(): ?bool
  1302. {
  1303. return $this->savedAsDraft;
  1304. }
  1306. /**
  1307. * @param bool $savedAsDraft
  1308. *
  1309. * @return self
  1310. */
  1311. public function setSavedAsDraft(bool $savedAsDraft): self
  1312. {
  1313. $this->savedAsDraft = $savedAsDraft;
  1315. return $this;
  1316. }
  1318. /**
  1319. * Checks if passed-in disclosure is a child and that it has no child draft, then it is the most recent disclosure.
  1320. *
  1321. * @return bool
  1322. */
  1323. public function isDisclosurePreviousVersion(): bool
  1324. {
  1325. return $this->getChild() !== null && $this->hasChildDraft() === false;
  1326. }
  1328. /**
  1329. * @return bool|null
  1330. */
  1331. public function isRecordsUpdated(): ?bool
  1332. {
  1333. return $this->recordsUpdated;
  1334. }
  1336. /**
  1337. * @param bool $recordsUpdated
  1338. *
  1339. * @return self
  1340. */
  1341. public function setRecordsUpdated(bool $recordsUpdated): self
  1342. {
  1343. $this->recordsUpdated = $recordsUpdated;
  1345. return $this;
  1346. }
  1348. /**
  1349. * @return bool|null
  1350. */
  1351. public function isRadiologyUpdated(): ?bool
  1352. {
  1353. return $this->radiologyUpdated;
  1354. }
  1356. /**
  1357. * @param bool $recordsUpdated
  1358. *
  1359. * @return self
  1360. */
  1361. public function setRadiologyUpdated(bool $recordsUpdated): self
  1362. {
  1363. $this->radiologyUpdated = $recordsUpdated;
  1365. return $this;
  1366. }
  1367. }