src/Entity/Project.php line 72

1. <?php
3. namespace MedBrief\MSR\Entity;
5. use ApiPlatform\Core\Annotation\ApiResource;
6. use DateTime;
7. use DateTimeInterface;
8. use DH\Auditor\Provider\Doctrine\Auditing\Annotation as Audit;
9. use Doctrine\Common\Collections\ArrayCollection;
10. use Doctrine\Common\Collections\Collection as DoctrineCollection;
11. use Doctrine\Common\Collections\Criteria;
12. use Doctrine\ORM\EntityNotFoundException;
13. use Doctrine\ORM\Mapping as ORM;
14. use Doctrine\Persistence\Proxy;
15. use Exception;
16. use Gedmo\Mapping\Annotation as Gedmo;
17. use libphonenumber\PhoneNumber;
18. use MedBrief\MSR\Dto\ClinicalSummaryMatterDto;
19. use MedBrief\MSR\Entity\MatterRequest\MatterRequest;
20. use MedBrief\MSR\Entity\MatterRequest\Patient;
21. use MedBrief\MSR\Entity\Patient as RadiologyPatient;
22. use MedBrief\MSR\Entity\Serviceable\ServiceableInterface;
23. use MedBrief\MSR\Repository\ProjectRepository;
24. use MedBrief\MSR\Service\ClaimCategoryAwareInterface;
25. use MedBrief\MSR\Service\InterpartyDisclosure\Disclose\DisclosureTargetInterface;
26. use MedBrief\MSR\Service\MatterTypeAwareInterface;
27. use MedBrief\MSR\Traits\Disclosure\DisclosureTargetTrait;
28. use MedBrief\MSR\Traits\FilterableClassConstantsTrait;
29. use Symfony\Component\Serializer\Annotation\Groups;
30. use Symfony\Component\Validator\Constraints as Assert;
31. use Symfony\Component\Validator\Context\ExecutionContextInterface;
32. use Symfony\Component\Validator\Mapping\ClassMetadata;
33. use Symfony\Component\Validator\Validation;
35. /**
36. * Note: When using ApiResource groups, if the variable you want to get is snake_case you will need to add the group as an annotation to the getter.
37. *
38. * @ApiResource(
39. * collectionOperations={},
40. * itemOperations={
41. * "get"={
42. * "access_control"="is_granted('READ', object)",
43. * "normalization_context"={"groups"={"project_closure:read"}, "enable_max_depth"=true}
44. * },
45. * "get_clinical_summary_matter"={
46. * "method"="GET",
47. * "path"="/projects/{id}/clinical_summary_matter",
48. * "access_control"="is_granted('READ', object)",
49. * "normalization_context"={"groups"={"clinical_summary_matter:read"}},
50. * "output"=ClinicalSummaryMatterDto::class,
51. * "description"="Resource representing matter details relevant to a clinical summary.",
52. * },
53. * "put"={"access_control"="is_granted('UPDATE', object)"}
54. * },
55. * attributes={
56. * "normalization_context"={"groups"={"project:read"}},
57. * }
58. * )
59. *
60. * @ORM\Table(name="Project", uniqueConstraints={@ORM\UniqueConstraint(name="reference_idx", columns={"account_id", "client_reference", "deletedAt"})})
61. *
62. * @ORM\Entity(repositoryClass=ProjectRepository::class)
63. *
64. * @ORM\HasLifecycleCallbacks
65. *
66. * @Gedmo\SoftDeleteable(fieldName="deletedAt", timeAware=false)
67. *
68. * @Audit\Auditable
69. *
70. * @Audit\Security(view={"ROLE_ALLOWED_TO_AUDIT"})
71. */
72. class Project implements ClaimCategoryAwareInterface, MatterTypeAwareInterface, DisclosureTargetInterface
73. {
74. use FilterableClassConstantsTrait;
76. use DisclosureTargetTrait;
78. public const STATUS_INACTIVE = 1;
79. public const STATUS_ACTIVE = 2;
81. public const LICENSE_LEVEL_STANDARD = 1;
82. public const LICENSE_LEVEL_PROFESSIONAL = 2;
83. public const LICENSE_LEVEL_PREMIUM = 3;
84. public const LICENSE_LEVEL_BASIC = 4;
86. public const ESTIMATED_CLAIM_VALUE_0_25000 = 1;
87. public const ESTIMATED_CLAIM_VALUE_25001_50000 = 2;
88. public const ESTIMATED_CLAIM_VALUE_50001_100000 = 3;
89. public const ESTIMATED_CLAIM_VALUE_100001_250000 = 4;
90. public const ESTIMATED_CLAIM_VALUE_250001_500000 = 5;
91. public const ESTIMATED_CLAIM_VALUE_500001_1000000 = 6;
92. public const ESTIMATED_CLAIM_VALUE_1000001 = 7;
94. public const ESTIMATED_CLAIM_VALUE_0_25000__LABEL = '£0 - £25,000';
95. public const ESTIMATED_CLAIM_VALUE_25001_50000__LABEL = '£25,001 - £50,000';
96. public const ESTIMATED_CLAIM_VALUE_50001_100000__LABEL = '£50,001 - £100,000';
97. public const ESTIMATED_CLAIM_VALUE_100001_250000__LABEL = '£100,001 - £250,000';
98. public const ESTIMATED_CLAIM_VALUE_250001_500000__LABEL = '£250,001 - £500,000';
99. public const ESTIMATED_CLAIM_VALUE_500001_1000000__LABEL = '£500,001 - £1,000,000';
100. public const ESTIMATED_CLAIM_VALUE_1000001__LABEL = '£1,000,000 +';
102. // These are the Archive statuses of a Project
103. public const ARCHIVE_STATUS_PENDING = 1;
104. public const ARCHIVE_STATUS_PENDING__LABEL = 'Pending';
106. public const ARCHIVE_STATUS_PROCESSING = 2;
107. public const ARCHIVE_STATUS_PROCESSING__LABEL = 'Processing';
109. public const ARCHIVE_STATUS_COMPLETE = 3;
110. public const ARCHIVE_STATUS_COMPLETE__LABEL = 'Complete';
112. public const ARCHIVE_STATUS_UNARCHIVE_PROCESSING = 4;
113. public const ARCHIVE_STATUS_UNARCHIVE_PROCESSING__LABEL = 'Unarchiving processing';
115. // The delete statuses of a Project
116. public const DELETE_STATUS_PENDING = 1;
117. public const DELETE_STATUS_PENDING__LABEL = 'Pending Deletion';
119. public const DELETE_STATUS_REMINDER_SENT = 6;
120. public const DELETE_STATUS_REMINDER_SENT__LABEL = 'Reminder Sent';
122. public const DELETE_STATUS_PROCESSING = 2;
123. public const DELETE_STATUS_PROCESSING__LABEL = 'Processing';
125. public const DELETE_STATUS_COMPLETE = 3;
126. public const DELETE_STATUS_COMPLETE__LABEL = 'Complete';
128. public const DELETE_STATUS_DELETE_FAILED = 4;
129. public const DELETE_STATUS_DELETE_FAILED__LABEL = 'Failed';
131. public const DELETE_STATUS_ANONYMISE_FAILED = 5;
132. public const DELETE_STATUS_ANONYMISE_FAILED__LABEL = 'Anonymise Failed';
134. // This status is used to mass set projects to be deleted immediately.
135. public const DELETE_STATUS_PENDING_IMMEDIATE = 7;
136. public const DELETE_STATUS_PENDING_IMMEDIATE__LABEL = 'Pending Immediate Deletion';
138. // The permanent delete status of a Project
139. public const PERMANENT_DELETE_STATUS_PENDING = 'pending';
140. public const PERMANENT_DELETE_STATUS_INPROGRESS = 'inprogress';
141. public const PERMANENT_DELETE_STATUS_COMPLETE = 'complete';
142. public const PERMANENT_DELETE_STATUS_FAILED = 'failed';
144. // Default role options
145. public const DEFAULT_ROLE_EXPERT = 'EXPERT';
146. public const DEFAULT_ROLE_EXPERTVIEWER = 'EXPERTVIEWER';
147. public const DEFAULT_ROLE_SCANNER = 'SCANNER';
148. public const DEFAULT_ROLE_SCANNERDOWNLOAD = 'SCANNERDOWNLOAD';
149. public const DEFAULT_ROLE_PROJECTMANAGER = 'PROJECTMANAGER';
151. public const REFERENCE_ID_PREFIX = 'MSR-';
153. // Case merits analysis options
154. public const CASE_MERITS_ANALYSIS_SUPPORTIVE = 'supportive';
155. public const CASE_MERITS_ANALYSIS_UNSUPPORTIVE = 'unsupportive';
156. public const CASE_MERITS_ANALYSIS_INCONCLUSIVE = 'inconclusive';
158. // Type of letter options
159. public const TYPE_OF_LETTER_LETTER_OF_CLAIM = 'letter_of_claim';
160. public const TYPE_OF_LETTER_LETTER_OF_NOTIFICATION = 'letter_of_notification';
161. public const TYPE_OF_LETTER_SUBJECT_ACCESS_REQUEST = 'subject_access_request';
162. public const TYPE_OF_LETTER_DISCLOSURE_APPLICATION = 'disclosure_application';
164. // Review type options
165. public const REVIEW_TYPE_CASE_MERITS_ANALYSIS = 'case_merits_analysis';
166. public const REVIEW_TYPE_CHRONOLOGY = 'chronology';
168. // The number of hours prior to deletion that a reminder must be sent (currently set to the equivalent of 7 days)
169. public const DELETION_REMINDER_OFFSET_HOURS = 168;
171. // Firm Records Review Constants
172. public const FIRM_RECORDS_REVIEW_STATUS_AWAITING_RECORDS = 'awaiting_records';
173. public const FIRM_RECORDS_REVIEW_STATUS_AWAITING_RECORDS__LABEL = 'Awaiting records';
174. public const FIRM_RECORDS_REVIEW_STATUS_UPLOADED = 'uploaded';
175. public const FIRM_RECORDS_REVIEW_STATUS_UPLOADED__LABEL = 'Uploaded for firm review';
176. public const FIRM_RECORDS_REVIEW_STATUS_COMPLETE_PROCEED = 'complete_proceed';
177. public const FIRM_RECORDS_REVIEW_STATUS_COMPLETE_PROCEED__LABEL = 'Complete - proceed with services';
178. public const FIRM_RECORDS_REVIEW_STATUS_COMPLETE_NO_PROCEED = 'complete_no_proceed';
179. public const FIRM_RECORDS_REVIEW_STATUS_COMPLETE_NO_PROCEED__LABEL = 'Complete - do not proceed with services';
181. // Clinical Summary Unsorted Constants
182. public const CLINICAL_SUMMARY_UNSORTED_STATUS_AWAITING_CONCLUSION = 'awaiting_conclusion';
183. public const CLINICAL_SUMMARY_UNSORTED_STATUS_AWAITING_CONCLUSION__LABEL = 'Awaiting conclusion';
184. public const CLINICAL_SUMMARY_UNSORTED_STATUS_SUPPORTIVE = 'supportive';
185. public const CLINICAL_SUMMARY_UNSORTED_STATUS_SUPPORTIVE__LABEL = 'Supportive - proceed with services';
186. public const CLINICAL_SUMMARY_UNSORTED_STATUS_UNSUPPORTIVE = 'unsupportive';
187. public const CLINICAL_SUMMARY_UNSORTED_STATUS_UNSUPPORTIVE__LABEL = 'Unsupportive - do not proceed with services';
188. public const CLINICAL_SUMMARY_UNSORTED_STATUS_INCONCLUSIVE = 'inconclusive';
189. public const CLINICAL_SUMMARY_UNSORTED_STATUS_INCONCLUSIVE__LABEL = 'Inconclusive';
191. // Radiology migration statuses
192. public const MODERN_RADIOLOGY_MIGRATION_STATUS_PENDING = 'pending';
193. public const MODERN_RADIOLOGY_MIGRATION_STATUS_IN_PROGRESS = 'in_progress';
194. public const MODERN_RADIOLOGY_MIGRATION_STATUS_COMPLETE = 'complete';
195. // Migration is considered failed if a previously active disc is now in a failed state.
196. public const MODERN_RADIOLOGY_MIGRATION_STATUS_FAILED = 'failed';
197. // We use the skipped status to indicate projects that had no discs to migrate, or that were newly created and did not need to be migrated.
198. public const MODERN_RADIOLOGY_MIGRATION_STATUS_SKIPPED = 'skipped';
200. // Represents a matter accessible to the firm which is our client
201. public const TYPE_MATTER_FIRM = 'firm';
202. public const TYPE_MATTER_FIRM__LABEL = 'Matter';
204. // Represents a matter that is intended to disclosure records to a third-party.
205. public const TYPE_MATTER_DISCLOSURE = 'disclosure';
206. public const TYPE_MATTER_DISCLOSURE__LABEL = 'Disclosure';
208. /**
209. * @var int
210. *
211. * @Groups({"project_closure:read", "clinical_summary_matter:read"})
212. *
213. * @ORM\Column(name="id", type="integer")
214. *
215. * @ORM\Id
216. *
217. * @ORM\GeneratedValue(strategy="IDENTITY")
218. */
219. private $id;
221. /**
222. * @var DateTime|null
223. *
224. * @ORM\Column(name="deletedAt", type="datetime", nullable=true)
225. */
226. private $deletedAt;
228. /**
229. * @var string
230. *
231. * @Groups({"project_closure:read", "clinical_summary_matter:read"})
232. *
233. * @ORM\Column(name="name", type="text")
234. */
235. private $name;
237. /**
238. * @var string|null
239. *
240. * @ORM\Column(name="patient_name", type="string", nullable=true)
241. */
242. private $patient_name;
244. /**
245. * @var string|null
246. *
247. * @ORM\Column(name="old_matter_reference", type="string", nullable=true)
248. */
249. private $old_matter_reference;
251. /**
252. * @var int|null
253. *
254. * @ORM\Column(name="pages", type="integer", nullable=true)
255. */
256. private $pages;
258. /**
259. * @var int
260. *
261. * @ORM\Column(name="status", type="integer", nullable=false)
262. */
263. private $status;
265. /**
266. * @var string|null
267. *
268. * @Groups({"project_closure:read", "clinical_summary_matter:read"})
269. *
270. * @ORM\Column(name="client_reference", type="string", nullable=true)
271. */
272. private $client_reference;
274. /**
275. * @var string|null
276. *
277. * @ORM\Column(name="billing_code", type="string", nullable=true)
278. */
279. private $billing_code;
281. /**
282. * @var string|null
283. *
284. * @ORM\Column(name="background", type="text", nullable=true)
285. */
286. private $background;
288. /**
289. * @var string|null
290. *
291. * @ORM\Column(name="reference", type="string", nullable=true)
292. */
293. private $reference;
295. /**
296. * @var string|null
297. *
298. * @ORM\Column(name="millnet_id", type="string", nullable=true)
299. */
300. private $millnet_id;
302. /**
303. * @var int|null
304. *
305. * @ORM\Column(name="hold_settled", type="integer", nullable=true)
306. */
307. private $hold_settled;
309. /**
310. * @var DateTime|null
311. *
312. * @ORM\Column(name="date_created", type="datetime", nullable=true)
313. */
314. private $date_created;
316. /**
317. * @var DateTime|null
318. *
319. * @ORM\Column(name="date_closed", type="datetime", nullable=true)
320. */
321. private $date_closed;
323. /**
324. * @var DateTime|null
325. *
326. * @ORM\Column(name="forcedRenewalCreated", type="datetime", nullable=true)
327. */
328. private ?DateTime $forcedRenewalCreated;
330. /**
331. * @var DateTime|null
332. *
333. * @ORM\Column(name="patient_date_of_birth", type="date", nullable=true)
334. */
335. private $patient_date_of_birth;
337. /**
338. * @var int|null
339. *
340. * @ORM\Column(name="archive_status", type="integer", nullable=true)
341. */
342. private $archive_status;
344. /**
345. * @var DateTime|null
346. *
347. * @ORM\Column(name="archive_status_updated", type="datetime", nullable=true)
348. */
349. private $archive_status_updated;
351. /**
352. * @var int|null
353. *
354. * @ORM\Column(name="deleteStatus", type="integer", nullable=true)
355. */
356. private $deleteStatus;
358. /**
359. * @var DateTime|null
360. *
361. * @ORM\Column(name="deleteStatusUpdated", type="datetime", nullable=true)
362. */
363. private $deleteStatusUpdated;
365. /**
366. * @var DateTime|null
367. *
368. * @ORM\Column(name="future_deletion_date", type="datetime", nullable=true)
369. */
370. private $future_deletion_date;
372. /**
373. * @var string
374. *
375. * @ORM\Column(name="slug", type="text")
376. *
377. * @Gedmo\Slug(fields={"name"}, updatable=false, separator="_")
378. */
379. private $slug;
381. /**
382. * @var DateTime
383. *
384. * @ORM\Column(name="created", type="datetime")
385. *
386. * @Gedmo\Timestampable(on="create")
387. *
388. */
389. private $created;
391. /**
392. * @var DateTime
393. *
394. * @ORM\Column(name="updated", type="datetime")
395. *
396. * @Gedmo\Timestampable(on="update")
397. */
398. private $updated;
400. /**
401. * @var string
402. *
403. * @ORM\Column(name="search_index", type="text", nullable=false)
404. */
405. private $search_index;
407. /**
408. * @var int
409. *
410. * @ORM\Column(name="license_level", type="integer", nullable=false)
411. */
412. private $license_level;
414. /**
415. * @var string|null
416. *
417. * @ORM\Column(name="documents_total_filesize", type="string", nullable=true)
418. */
419. private $documents_total_filesize;
421. /**
422. * @var string|null
423. *
424. * @ORM\Column(name="active_discs_total_archive_filesize", type="string", nullable=true)
425. */
426. private $active_discs_total_archive_filesize;
428. /**
429. * @var DateTime|null
430. *
431. * @ORM\Column(name="limitation_date", type="datetime", nullable=true)
432. */
433. private $limitation_date;
435. /**
436. * @var int|null
437. *
438. * @ORM\Column(name="claim_category", type="integer", nullable=true)
439. */
440. private $claim_category;
442. /**
443. * @var int|null
444. *
445. * @ORM\Column(name="estimated_claim_value", type="integer", nullable=true)
446. */
447. private $estimated_claim_value;
449. /**
450. * @var string|null
451. *
452. * @ORM\Column(name="team", type="string", nullable=true)
453. */
454. private $team;
456. /**
457. * @var string|null
458. *
459. * @ORM\Column(name="default_role", type="string", nullable=true)
460. */
461. private $default_role;
463. /**
464. * UserNotifications disabled for this Project
465. *
466. * @var array|null
467. *
468. * @ORM\Column(name="disabled_notifications", type="array", nullable=true)
469. */
470. private $disabled_notifications;
472. /**
473. * Whether to require the user to enter a password on downloading a document or folder
474. *
475. * @var bool
476. *
477. * @ORM\Column(name="require_password_on_download", type="boolean", options={"default"=false})
478. */
479. private $require_password_on_download = false;
481. /**
482. * Whether to require the user to enter a password when accepting an invitation to join a project
483. *
484. * @var bool
485. *
486. * @ORM\Column(name="inviteUserMustAuthenticate", type="boolean", options={"default"=false})
487. */
488. private $inviteUserMustAuthenticate = false;
490. /**
491. * @var string|null
492. *
493. * @ORM\Column(name="inviteUserPassword", type="string", nullable=true)
494. */
495. private $inviteUserPassword;
497. /**
498. * @var string|null
499. *
500. * @ORM\Column(name="inviteUserContactName", type="string", nullable=true)
501. */
502. private $inviteUserContactName;
504. /**
505. * @var string|null
506. *
507. * @ORM\Column(name="inviteUserContactEmail", type="string", nullable=true)
508. */
509. private $inviteUserContactEmail;
511. /**
512. * @var PhoneNumber|null
513. *
514. * @ORM\Column(name="inviteUserContactPhoneNumber", type="phone_number", nullable=true)
515. */
516. private $inviteUserContactPhoneNumber;
518. /**
519. * @var DateTime|null
520. *
521. * @ORM\Column(name="date_on_letter", type="datetime", nullable=true)
522. */
523. private $date_on_letter;
525. /**
526. * @var string|null
527. *
528. * @ORM\Column(name="case_merits_analysis", type="string", nullable=true)
529. */
530. private $case_merits_analysis;
532. /**
533. * @var string|null
534. *
535. * @ORM\Column(name="claimant_solicitor", type="string", nullable=true)
536. */
537. private $claimant_solicitor;
539. /**
540. * @var string|null
541. *
542. * @ORM\Column(name="type_of_letter", type="string", nullable=true)
543. */
544. private $type_of_letter;
546. /**
547. * @var string|null
548. *
549. * @ORM\Column(name="review_type", type="string", nullable=true)
550. */
551. private $review_type;
553. /**
554. * @var DateTime|null
555. *
556. * @ORM\Column(name="experts_report_date", type="datetime", nullable=true)
557. */
558. private $experts_report_date;
560. /**
561. * @var DateTime|null
562. *
563. * @ORM\Column(name="letter_of_response_and_expert_report_date", type="datetime", nullable=true)
564. */
565. private $letter_of_response_and_expert_report_date;
567. /**
568. * @var DateTime|null
569. *
570. * @ORM\Column(name="letter_of_response_prepared_date", type="datetime", nullable=true)
571. */
572. private $letter_of_response_prepared_date;
574. /**
575. * @var DateTime|null
576. *
577. * @ORM\Column(name="letter_of_response_sent_date", type="datetime", nullable=true)
578. */
579. private $letter_of_response_sent_date;
581. /**
582. * @var DateTime|null
583. *
584. * @ORM\Column(name="dateDeleted", type="datetime", nullable=true)
585. */
586. private $dateDeleted;
588. /**
589. * Determines if users with role Expert and Expert - View Only on a Project/Matter can see
590. * the Unsorted records folder on the Medical Records Screen.
591. *
592. * @var bool|null
593. *
594. * @ORM\Column(name="allowExpertViewUnsortedRecords", type="boolean", nullable=true)
595. */
596. private $allowExpertViewUnsortedRecords;
598. /**
599. * @var ProjectDeletionReport
600. *
601. * @ORM\OneToOne(targetEntity="MedBrief\MSR\Entity\ProjectDeletionReport", inversedBy="project")
602. *
603. * @ORM\JoinColumns({
604. *
605. * @ORM\JoinColumn(name="projectDeletionReport_id", referencedColumnName="id", unique=true)
606. * })
607. */
608. private $projectDeletionReport;
610. /**
611. * @var Collection
612. *
613. * @ORM\OneToOne(targetEntity="MedBrief\MSR\Entity\Collection", inversedBy="projectMedicalRecords", cascade={"all"})
614. *
615. * @ORM\JoinColumns({
616. *
617. * @ORM\JoinColumn(name="medicalRecordsCollection_id", referencedColumnName="id", unique=true)
618. * })
619. */
620. private $medicalRecordsCollection;
622. /**
623. * @var Collection
624. *
625. * @ORM\OneToOne(targetEntity="MedBrief\MSR\Entity\Collection", inversedBy="projectUnsortedRecords", cascade={"all"})
626. *
627. * @ORM\JoinColumns({
628. *
629. * @ORM\JoinColumn(name="unsortedRecordsCollection_id", referencedColumnName="id", unique=true)
630. * })
631. */
632. private $unsortedRecordsCollection;
634. /**
635. * @var Collection
636. *
637. * @ORM\OneToOne(targetEntity="MedBrief\MSR\Entity\Collection", inversedBy="projectPrivate", cascade={"all"})
638. *
639. * @ORM\JoinColumns({
640. *
641. * @ORM\JoinColumn(name="privateCollection_id", referencedColumnName="id", unique=true)
642. * })
643. */
644. private $privateCollection;
646. /**
647. * This collection contains collections specific to a user,
648. * from which they are free to upload and download Documents.
649. *
650. * @var Collection
651. *
652. * @ORM\OneToOne(targetEntity="MedBrief\MSR\Entity\Collection", inversedBy="projectPrivateSandbox", cascade={"all"})
653. *
654. * @ORM\JoinColumns({
655. *
656. * @ORM\JoinColumn(name="privateSandboxCollection_id", referencedColumnName="id", unique=true)
657. * })
658. */
659. private $privateSandboxCollection;
661. /**
662. * @var MatterRequest
663. *
664. * @ORM\OneToOne(targetEntity="MedBrief\MSR\Entity\MatterRequest\MatterRequest", mappedBy="matter", cascade={"persist", "remove"})
665. */
666. private $matterRequest;
668. /**
669. * @var ProjectClosure
670. *
671. * @ORM\OneToOne(targetEntity="MedBrief\MSR\Entity\ProjectClosure", mappedBy="project", cascade={"persist", "remove"})
672. */
673. private $projectClosure;
675. /**
676. * @var DoctrineCollection
677. *
678. * @ORM\OneToMany(targetEntity="MedBrief\MSR\Entity\Document", mappedBy="project", orphanRemoval=true)
679. */
680. private $documents;
682. /**
683. * @var DoctrineCollection
684. *
685. * @ORM\OneToMany(targetEntity="MedBrief\MSR\Entity\ProjectUser", mappedBy="project", cascade={"all"})
686. */
687. private $projectUsers;
689. /**
690. * @var DoctrineCollection
691. *
692. * @ORM\OneToMany(targetEntity="MedBrief\MSR\Entity\Disc", mappedBy="project", cascade={"all"})
693. *
694. * @ORM\OrderBy({
695. * "created"="ASC"
696. * })
697. */
698. private $discs;
700. /**
701. * @var DoctrineCollection
702. *
703. * @ORM\OneToMany(targetEntity="MedBrief\MSR\Entity\RecordsRequest", mappedBy="project", cascade={"all"})
704. */
705. private $recordsRequests;
707. /**
708. * @var DoctrineCollection
709. *
710. * @ORM\OneToMany(targetEntity="MedBrief\MSR\Entity\BatchRequest", mappedBy="project", cascade={"all"})
711. */
712. private $batchRequests;
714. /**
715. * @var DoctrineCollection
716. *
717. * @ORM\OneToMany(targetEntity="MedBrief\MSR\Entity\ChronologyRequest", mappedBy="project", cascade={"all"})
718. */
719. private $chronologyRequests;
721. /**
722. * @var DoctrineCollection
723. *
724. * @ORM\OneToMany(targetEntity="MedBrief\MSR\Entity\AdditionalRequest", mappedBy="project", cascade={"all"})
725. */
726. private $additionalRequests;
728. /**
729. * @var DoctrineCollection
730. *
731. * @ORM\OneToMany(targetEntity="MedBrief\MSR\Entity\SortingSession", mappedBy="project", cascade={"all"})
732. */
733. private $sortingSessions;
735. /**
736. * @var DoctrineCollection
737. *
738. * @ORM\OneToMany(targetEntity="MedBrief\MSR\Entity\Patient", mappedBy="project", cascade={"all"})
739. */
740. private $patients;
742. /**
743. * @var DoctrineCollection
744. *
745. * @ORM\OneToMany(targetEntity="MedBrief\MSR\Entity\Study", mappedBy="project", cascade={"all"})
746. */
747. private $studies;
749. /**
750. * @var DoctrineCollection
751. *
752. * @ORM\OneToMany(targetEntity="MedBrief\MSR\Entity\Series", mappedBy="project", cascade={"all"})
753. */
754. private $series;
756. /**
757. * @var DoctrineCollection
758. *
759. * @ORM\OneToMany(targetEntity="MedBrief\MSR\Entity\DiscImportSession", mappedBy="project", cascade={"all"})
760. */
761. private $discImportSessions;
763. /**
764. * @var DoctrineCollection
765. *
766. * @ORM\OneToMany(targetEntity="MedBrief\MSR\Entity\MatterNote", mappedBy="project", cascade={"persist","remove"}, orphanRemoval=true)
767. */
768. private $matterNotes;
770. /**
771. * @var DoctrineCollection
772. *
773. * @ORM\OneToMany(targetEntity="MedBrief\MSR\Entity\MatterCommunication", mappedBy="project", cascade={"all"})
774. */
775. private $matterCommunications;
777. /**
778. * @var
779. *
780. * @Groups({"clinical_summary_matter:read"})
781. *
782. * @ORM\ManyToOne(targetEntity="MedBrief\MSR\Entity\Account", inversedBy="projects")
783. *
784. * @ORM\JoinColumns({
785. *
786. * @ORM\JoinColumn(name="account_id", referencedColumnName="id", nullable=false)
787. * })
788. */
789. private $account;
791. /**
792. * @var User
793. *
794. * @ORM\ManyToOne(targetEntity="MedBrief\MSR\Entity\User", inversedBy="managedProjects")
795. *
796. * @ORM\JoinColumns({
797. *
798. * @ORM\JoinColumn(name="manager_id", referencedColumnName="id", nullable=true)
799. * })
800. */
801. private $manager;
803. /**
804. * @var DoctrineCollection|null
805. *
806. * @ORM\ManyToMany(targetEntity="MedBrief\MSR\Entity\User")
807. *
808. * @ORM\JoinTable(
809. * name="project_additional_contacts",
810. * joinColumns={@ORM\JoinColumn(name="project_id", referencedColumnName="id", onDelete="CASCADE", nullable=true)},
811. * inverseJoinColumns={@ORM\JoinColumn(name="user_id", referencedColumnName="id", onDelete="CASCADE", nullable=true)}
812. * )
813. */
814. private $additionalContacts;
816. /**
817. * @ORM\OneToMany(targetEntity=Instance::class, mappedBy="project")
818. */
819. private $instances;
821. /**
822. * @ORM\Column(type="string", nullable=true)
823. */
824. private ?string $firmRecordsReviewStatus = null;
826. /**
827. * @ORM\Column(type="datetime", nullable=true)
828. */
829. private ?DateTime $firmRecordsReviewUpdated = null;
831. /**
832. * @ORM\Column(type="string", nullable=true)
833. */
834. private ?string $clinicalSummaryUnsortedStatus = null;
836. /**
837. * @ORM\Column(type="datetime", nullable=true)
838. */
839. private ?DateTime $clinicalSummaryUnsortedUpdated = null;
841. /**
842. * @ORM\OneToMany(targetEntity=InterpartyDisclosure::class, mappedBy="project", orphanRemoval=true, cascade={"persist", "remove"})
843. *
844. * @ORM\OrderBy({"id"="DESC"})
845. */
846. private ?DoctrineCollection $interpartyDisclosures;
848. /**
849. * @ORM\Column(name="matterType", type="string", length=64, nullable=true)
850. *
851. */
852. private ?string $matterType = self::MATTER_TYPE_CLINICAL_NEGLIGENCE;
854. /**
855. * @ORM\Column(type="string", nullable=true)
856. */
857. private ?string $modernRadiologyMigrationStatus;
859. /**
860. * @ORM\Column(type="boolean", nullable=false, options={"default"=false})
861. */
862. private bool $useModernRadiology = false;
864. /**
865. * @ORM\Column(type="string", nullable=false, options={"default"=self::TYPE_MATTER_FIRM})
866. */
867. private ?string $type = self::TYPE_MATTER_FIRM;
869. /**
870. * @ORM\Column(type="boolean", nullable=false, options={"default"=false})
871. */
872. private bool $hideFromInvoicing = false;
874. /**
875. * @ORM\Column(type="datetime", nullable=true)
876. */
877. private ?DateTime $lastRenewalDate = null;
879. /**
880. * @ORM\Column(type="datetime", nullable=true)
881. */
882. private ?DateTime $nextRenewalDate;
884. /**
885. * @ORM\Column(type="json", nullable=true)
886. */
887. private ?array $renewalNotificationSent = [];
889. /**
890. * @ORM\OneToMany(targetEntity=MatterLicenceRenewalLog::class, mappedBy="project")
891. */
892. private ?DoctrineCollection $matterLicenceRenewalLogs;
894. /**
895. * @ORM\Column(type="string", length=255, nullable=true)
896. */
897. private ?string $permanentDeleteStatus = null;
899. /**
900. * @Groups({"clinical_summary_matter:read"})
901. *
902. * @ORM\OneToOne(targetEntity=ClinicalSummary::class, mappedBy="project", cascade={"persist", "remove"})
903. */
904. private ?ClinicalSummary $clinicalSummary;
906. public function __construct()
907. {
908. // default status of INACTIVE
909. $this->setStatus(self::STATUS_INACTIVE);
911. $this->patients = new ArrayCollection();
912. $this->studies = new ArrayCollection();
913. $this->series = new ArrayCollection();
914. $this->discs = new ArrayCollection();
915. $this->recordsRequests = new ArrayCollection();
916. $this->batchRequests = new ArrayCollection();
917. $this->additionalRequests = new ArrayCollection();
918. $this->chronologyRequests = new ArrayCollection();
919. $this->sortingSessions = new ArrayCollection();
920. $this->matterNotes = new ArrayCollection();
921. $this->documents = new ArrayCollection();
922. $this->projectUsers = new ArrayCollection();
923. $this->discImportSessions = new ArrayCollection();
924. $this->matterCommunications = new ArrayCollection();
925. $this->instances = new ArrayCollection();
926. $this->interpartyDisclosures = new ArrayCollection();
927. $this->disclosureSources = new ArrayCollection();
928. $this->matterLicenceRenewalLogs = new ArrayCollection();
930. $this->medicalRecordsCollection = new Collection();
931. $this->medicalRecordsCollection
932. ->setName(Collection::DISPLAY_NAME_MEDICAL_RECORDS)
933. ->setProjectMedicalRecords($this)
934. ;
936. $this->unsortedRecordsCollection = new Collection();
937. $this->unsortedRecordsCollection
938. ->setName(Collection::DISPLAY_NAME_UNSORTED_RECORDS)
939. ->setProjectUnsortedRecords($this)
940. ;
942. // default the date created for matters to the current date
943. $this->setDateCreated(new DateTime());
945. // All matters default to the standard license
946. $this->setLicenseLevel(self::LICENSE_LEVEL_STANDARD);
948. $this->require_password_on_download = false;
950. $this->setInviteUserMustAuthenticate(false);
952. // Set this in the constructor so it only applies to new matters
953. $this->setModernRadiologyMigrationStatus(self::MODERN_RADIOLOGY_MIGRATION_STATUS_SKIPPED);
954. $this->matterLicenceRenewalLogs = new ArrayCollection();
956. $this->additionalContacts = new ArrayCollection();
957. }
959. public function __toString()
960. {
961. return $this->getName();
962. }
964. /**
965. * @return int
966. */
967. public function getId()
968. {
969. return $this->id;
970. }
972. /**
973. * @param string $name
974. *
975. * @return Project
976. */
977. public function setName($name)
978. {
979. $this->name = $name;
981. return $this;
982. }
984. /**
985. * @return string
986. */
987. public function getName()
988. {
989. return $this->name;
990. }
992. /**
993. * @param int $pages
994. *
995. * @return Project
996. */
997. public function setPages($pages)
998. {
999. $this->pages = $pages;
1001. return $this;
1002. }
1004. /**
1005. * @return int
1006. */
1007. public function getPages()
1008. {
1009. return $this->pages;
1010. }
1012. /**
1013. * @param Account|null $account
1014. *
1015. * @return Project
1016. */
1017. public function setAccount(?Account $account = null)
1018. {
1019. $this->account = $account;
1021. return $this;
1022. }
1024. /**
1025. * @return Account
1026. */
1027. public function getAccount()
1028. {
1029. return $this->account;
1030. }
1032. /**
1033. * @param string $slug
1034. *
1035. * @return Project
1036. */
1037. public function setSlug($slug)
1038. {
1039. $this->slug = $slug;
1041. return $this;
1042. }
1044. /**
1045. * @return string
1046. */
1047. public function getSlug()
1048. {
1049. return $this->slug;
1050. }
1052. /**
1053. * @param DateTime $created
1054. *
1055. * @return Project
1056. */
1057. public function setCreated($created)
1058. {
1059. $this->created = $created;
1061. return $this;
1062. }
1064. /**
1065. * @return DateTime
1066. */
1067. public function getCreated()
1068. {
1069. return $this->created;
1070. }
1072. /**
1073. * @param DateTime $updated
1074. *
1075. * @return Project
1076. */
1077. public function setUpdated($updated)
1078. {
1079. $this->updated = $updated;
1081. return $this;
1082. }
1084. /**
1085. * @return DateTime
1086. */
1087. public function getUpdated()
1088. {
1089. return $this->updated;
1090. }
1092. /**
1093. * @param Document $documents
1094. *
1095. * @return Project
1096. */
1097. public function addDocument(Document $documents)
1098. {
1099. $this->documents[] = $documents;
1101. return $this;
1102. }
1104. /**
1105. * @param Document $documents
1106. */
1107. public function removeDocument(Document $documents)
1108. {
1109. $this->documents->removeElement($documents);
1110. }
1112. /**
1113. * @return DoctrineCollection|Document[]
1114. */
1115. public function getDocuments()
1116. {
1117. return $this->documents;
1118. }
1120. /**
1121. * @param Disc $disc
1122. *
1123. * @return Project
1124. */
1125. public function addDisc(Disc $disc)
1126. {
1127. if (!$this->discs->contains($disc)) {
1128. $this->discs[] = $disc;
1129. }
1131. return $this;
1132. }
1134. /**
1135. * @param Disc $discs
1136. *
1137. * @return Project
1138. */
1139. public function removeDisc(Disc $discs)
1140. {
1141. $this->discs->removeElement($discs);
1143. return $this;
1144. }
1146. /**
1147. * @return DoctrineCollection|Disc[]
1148. */
1149. public function getDiscs()
1150. {
1151. return $this->discs;
1152. }
1154. /**
1155. * @return bool
1156. */
1157. public function isAllDiscsPendingUpload(): bool
1158. {
1159. foreach ($this->getDiscs() as $disc) {
1160. if ($disc->getStatus() !== Disc::STATUS_PENDING_UPLOAD) {
1161. return false;
1162. }
1163. }
1165. return true;
1166. }
1168. /**
1169. * Gets Discs for a project with a specific status.
1170. *
1171. * @param mixed $status
1172. *
1173. * @return ArrayCollection | null
1174. */
1175. public function getDiscsByStatus($status)
1176. {
1177. return $this->discs->filter(function (Disc $disc) use ($status) {
1178. return $disc->getStatus() === $status;
1179. });
1180. }
1182. /**
1183. * Get all active Discs for a Project
1184. *
1185. * @return ArrayCollection|null
1186. */
1187. public function getActiveDiscs()
1188. {
1189. return $this->getDiscsByStatus(Disc::STATUS_ACTIVE);
1190. }
1192. /**
1193. * Gets all failed Discs for a Project
1194. *
1195. * @return ArrayCollection|null
1196. */
1197. public function getFailedDiscs()
1198. {
1199. return $this->getDiscs()->filter(function (Disc $disc) {
1200. // return true if disc failed, however exclude discs with status failed virus
1201. // Normally we don't need to check for deletedAt, as the softdeletable filter filters it out,
1202. // but in the case of disclosures, we switch this filter off, to avoid a broken relationship issue.
1203. return $disc->isFailed([Disc::STATUS_FAILED_VIRUS]) && $disc->getDeletedAt() === null;
1204. });
1205. }
1207. /**
1208. * @param int $status
1209. *
1210. * @return Project
1211. */
1212. public function setStatus($status)
1213. {
1214. $this->status = $status;
1216. return $this;
1217. }
1219. /**
1220. * @return int
1221. */
1222. public function getStatus()
1223. {
1224. return $this->status;
1225. }
1227. /**
1228. * Returns true if the Project is inactive.
1229. *
1230. * @return bool
1231. */
1232. public function isInactive()
1233. {
1234. return $this->getStatus() === self::STATUS_INACTIVE;
1235. }
1237. /**
1238. * @param string $clientReference
1239. *
1240. * @return Project
1241. */
1242. public function setClientReference($clientReference)
1243. {
1244. $this->client_reference = $clientReference;
1246. // Update the associated matter request as well, if it exists, and if the values are different,
1247. // to avoid a recursive loop.
1248. if ($this->getMatterRequest() && $this->getMatterRequest()->getMatterReference() != $this->client_reference) {
1249. $this->getMatterRequest()->setMatterReference($this->client_reference);
1250. }
1252. return $this;
1253. }
1255. /**
1256. * @Groups({"project_closure:read"})
1257. *
1258. * @return string
1259. */
1260. public function getClientReference()
1261. {
1262. return $this->client_reference;
1263. }
1265. /**
1266. * @param string $reference
1267. *
1268. * @return Project
1269. */
1270. public function setReference($reference)
1271. {
1272. $this->reference = $reference;
1274. return $this;
1275. }
1277. /**
1278. * @return string
1279. */
1280. public function getReference()
1281. {
1282. return $this->reference;
1283. }
1285. /**
1286. * @param Patient $patients
1287. *
1288. * @return Project
1289. */
1290. public function addPatient(Patient $patients)
1291. {
1292. $this->patients[] = $patients;
1294. return $this;
1295. }
1297. /**
1298. * @param Patient $patients
1299. */
1300. public function removePatient(Patient $patients)
1301. {
1302. $this->patients->removeElement($patients);
1303. }
1305. /**
1306. * @return DoctrineCollection|RadiologyPatient[]
1307. */
1308. public function getPatients()
1309. {
1310. return $this->patients;
1311. }
1313. /**
1314. * @param Study $studies
1315. *
1316. * @return Project
1317. */
1318. public function addStudy(Study $studies)
1319. {
1320. $this->studies[] = $studies;
1322. return $this;
1323. }
1325. /**
1326. * @param Study $studies
1327. */
1328. public function removeStudy(Study $studies)
1329. {
1330. $this->studies->removeElement($studies);
1331. }
1333. /**
1334. * @return DoctrineCollection|Study[]
1335. */
1336. public function getStudies()
1337. {
1338. return $this->studies;
1339. }
1341. /**
1342. * Get Studies with active Discs
1343. *
1344. * @return ArrayCollection|null
1345. */
1346. public function getStudiesWithActiveDiscs()
1347. {
1348. return $this->getStudies()->filter(function (Study $study) {
1349. return $study->getDiscs()->filter(function (Disc $disc) {
1350. // Normally we don't need to check for deletedAt, as the softdeletable filter filters it out,
1351. // but in the case of disclosures, we switch this filter off, to avoid a broken relationship issue.
1352. // Due to the many-to-many relation between Disc and Study, the check for deletedAt isn't ACTUALLY needed,
1353. // but for data integrity, we do the check anyway.
1354. return $disc->isActive() && $disc->getDeletedAt() === null;
1355. })->count();
1356. });
1357. }
1359. /**
1360. * @param Series $series
1361. *
1362. * @return Project
1363. */
1364. public function addSeries(Series $series)
1365. {
1366. $this->series[] = $series;
1368. return $this;
1369. }
1371. /**
1372. * @param Series $series
1373. */
1374. public function removeSeries(Series $series)
1375. {
1376. $this->series->removeElement($series);
1377. }
1379. /**
1380. * @return DoctrineCollection|Series[]
1381. */
1382. public function getSeries()
1383. {
1384. return $this->series;
1385. }
1387. /**
1388. * Returns the MedBrief Matter reference number which is essentially the ClientReference
1389. * of the Project padded with zeros to six figures
1390. *
1391. * @return string
1392. */
1393. public function getReferenceNumber()
1394. {
1395. return str_pad($this->getClientReference(), 6, '0', STR_PAD_LEFT);
1396. }
1398. /**
1399. * @param DateTime $dateCreated
1400. *
1401. * @return Project
1402. */
1403. public function setDateCreated($dateCreated)
1404. {
1405. $this->date_created = $dateCreated;
1407. return $this;
1408. }
1410. /**
1411. * @return DateTime
1412. */
1413. public function getDateCreated()
1414. {
1415. return $this->date_created;
1416. }
1418. /**
1419. * @param DateTime $patientDateOfBirth
1420. *
1421. * @throws Exception
1422. *
1423. * @return Project
1424. */
1425. public function setPatientDateOfBirth($patientDateOfBirth)
1426. {
1427. $this->patient_date_of_birth = $patientDateOfBirth;
1429. // Update the matter request's first patient's date of birth, if different from matter date of birth.
1430. if ($this->getMatterRequest() && $this->getMatterRequest()->getPatients()->count() > 0) {
1431. /** @var Patient $firstPatient */
1432. $firstPatient = $this->getMatterRequest()->getPatients()->first();
1433. if ($firstPatient->getDateOfBirth() != $this->patient_date_of_birth) {
1434. $dateOfBirthImmutable = null;
1435. if ($this->patient_date_of_birth instanceof DateTime) {
1436. $dateOfBirthImmutable = new \DateTimeImmutable($this->patient_date_of_birth->format('Y-m-d'));
1437. }
1438. $firstPatient->setDateOfBirth($dateOfBirthImmutable);
1439. }
1440. }
1442. return $this;
1443. }
1445. /**
1446. * @return DateTime
1447. */
1448. public function getPatientDateOfBirth()
1449. {
1450. return $this->patient_date_of_birth;
1451. }
1453. /**
1454. * @param User|null $manager
1455. *
1456. * @return Project
1457. */
1458. public function setManager(?User $manager = null)
1459. {
1460. $this->manager = $manager;
1462. // Update the associated matter request as well, if it exists, and if the values are different,
1463. // to avoid a recursive loop.
1464. if ($manager && $this->getMatterRequest() && $this->getMatterRequest()->getManager() != $this->manager) {
1465. $this->getMatterRequest()->setManager($this->manager);
1466. }
1468. return $this;
1469. }
1471. /**
1472. * @return Project
1473. */
1474. public function unsetManager()
1475. {
1476. $this->manager = null;
1478. return $this;
1479. }
1481. /**
1482. * retrieves the manager of the project
1483. *
1484. * @return User|null
1485. */
1486. public function getManager(): ?User
1487. {
1488. try {
1489. // If the manager is a Proxy, we need to load it to ensure it is fully initialized.
1490. if ($this->manager instanceof Proxy) {
1491. $this->manager->__load();
1492. }
1494. return $this->manager;
1495. } catch (EntityNotFoundException) {
1496. // If the manager is not found (has been soft deleted), return null.
1497. return null;
1498. }
1499. }
1501. /**
1502. * Returns additional contacts for a matter
1503. *
1504. * @return DoctrineCollection|null
1505. */
1506. public function getAdditionalContacts(): ?DoctrineCollection
1507. {
1508. return $this->additionalContacts;
1509. }
1511. /**
1512. * Sets additional contacts for a matter
1513. *
1514. * @param DoctrineCollection|null $additionalContacts
1515. *
1516. * @return self
1517. */
1518. public function setAdditionalContacts(?DoctrineCollection $additionalContacts): self
1519. {
1520. $this->additionalContacts = $additionalContacts ?: new ArrayCollection();
1522. return $this;
1523. }
1525. /**
1526. * @param RecordsRequest $recordsRequests
1527. *
1528. * @return Project
1529. */
1530. public function addRecordsRequest(RecordsRequest $recordsRequests)
1531. {
1532. $this->recordsRequests[] = $recordsRequests;
1534. return $this;
1535. }
1537. /**
1538. * @param RecordsRequest $recordsRequests
1539. */
1540. public function removeRecordsRequest(RecordsRequest $recordsRequests)
1541. {
1542. $this->recordsRequests->removeElement($recordsRequests);
1543. }
1545. /**
1546. * @return DoctrineCollection|RecordsRequest[]
1547. */
1548. public function getRecordsRequests()
1549. {
1550. return $this->recordsRequests;
1551. }
1553. /**
1554. * @return array
1555. */
1556. public function getRecordsRequestIdsArray(): array
1557. {
1558. // Map the collection of records requests to extract each's ID, then convert it to an array
1559. return $this->recordsRequests->map(function (RecordsRequest $recordsRequest) {
1560. return $recordsRequest->getId();
1561. })->toArray();
1562. }
1564. /**
1565. * Retrieves the counts for RecordsRequests grouped by
1566. * their serviceRequest status.
1567. *
1568. * @param mixed $uninvoicedOnly
1569. *
1570. * @return array
1571. */
1572. public function getRecordsRequestsCountByServiceRequestStatus($uninvoicedOnly = true)
1573. {
1574. return $this->getServiceableCountsByStatus($this->getRecordsRequests()->toArray(), $uninvoicedOnly);
1575. }
1577. /**
1578. * @param Collection|null $medicalRecordsCollection
1579. *
1580. * @return Project
1581. */
1582. public function setMedicalRecordsCollection(?Collection $medicalRecordsCollection = null)
1583. {
1584. $this->medicalRecordsCollection = $medicalRecordsCollection;
1586. return $this;
1587. }
1589. /**
1590. * @return Collection
1591. */
1592. public function getMedicalRecordsCollection()
1593. {
1594. return $this->medicalRecordsCollection;
1595. }
1597. /**
1598. * @param string $billingCode
1599. *
1600. * @return Project
1601. */
1602. public function setBillingCode($billingCode)
1603. {
1604. $this->billing_code = $billingCode;
1606. // Update the associated matter request as well, if it exists, and if the values are different,
1607. // to avoid a recursive loop.
1608. if ($this->getMatterRequest() && $this->getMatterRequest()->getBillingCode() != $this->billing_code) {
1609. $this->getMatterRequest()->setBillingCode($this->billing_code);
1610. }
1612. return $this;
1613. }
1615. /**
1616. * @return string
1617. */
1618. public function getBillingCode()
1619. {
1620. return $this->billing_code;
1621. }
1623. /**
1624. * @param DateTime $deletedAt
1625. *
1626. * @return Project
1627. */
1628. public function setDeletedAt($deletedAt)
1629. {
1630. $this->deletedAt = $deletedAt;
1632. return $this;
1633. }
1635. /**
1636. * @return DateTime
1637. */
1638. public function getDeletedAt()
1639. {
1640. return $this->deletedAt;
1641. }
1643. /**
1644. * Add discImportSession
1645. *
1646. * @param DiscImportSession $discImportSession
1647. *
1648. * @return Project
1649. */
1650. public function addDiscImportSession(DiscImportSession $discImportSession)
1651. {
1652. $this->discImportSessions[] = $discImportSession;
1654. return $this;
1655. }
1657. /**
1658. * Remove discImportSession
1659. *
1660. * @param DiscImportSession $discImportSession
1661. */
1662. public function removeDiscImportSession(DiscImportSession $discImportSession)
1663. {
1664. $this->discImportSessions->removeElement($discImportSession);
1665. }
1667. /**
1668. * @return DoctrineCollection
1669. */
1670. public function getDiscImportSessions()
1671. {
1672. return $this->discImportSessions;
1673. }
1675. /**
1676. * @param string $patientName
1677. *
1678. * @return Project
1679. */
1680. public function setPatientName($patientName)
1681. {
1682. $this->patient_name = $patientName;
1684. return $this;
1685. }
1687. /**
1688. * @return string
1689. */
1690. public function getPatientName()
1691. {
1692. return $this->patient_name;
1693. }
1695. /**
1696. * @param string $oldMatterReference
1697. *
1698. * @return Project
1699. */
1700. public function setOldMatterReference($oldMatterReference)
1701. {
1702. $this->old_matter_reference = $oldMatterReference;
1704. return $this;
1705. }
1707. /**
1708. * @return string
1709. */
1710. public function getOldMatterReference()
1711. {
1712. return $this->old_matter_reference;
1713. }
1715. /**
1716. * @param string $millnetId
1717. *
1718. * @return Project
1719. */
1720. public function setMillnetId($millnetId)
1721. {
1722. $this->millnet_id = $millnetId;
1724. return $this;
1725. }
1727. /**
1728. * @return string
1729. */
1730. public function getMillnetId()
1731. {
1732. return $this->millnet_id;
1733. }
1735. /**
1736. * @param int $holdSettled
1737. *
1738. * @return Project
1739. */
1740. public function setHoldSettled($holdSettled)
1741. {
1742. $this->hold_settled = $holdSettled;
1744. return $this;
1745. }
1747. /**
1748. * @return int
1749. */
1750. public function getHoldSettled()
1751. {
1752. return $this->hold_settled;
1753. }
1755. /**
1756. * @param DateTime $dateClosed
1757. *
1758. * @return Project
1759. */
1760. public function setDateClosed($dateClosed)
1761. {
1762. $this->date_closed = $dateClosed;
1764. return $this;
1765. }
1767. /**
1768. * @return DateTime
1769. */
1770. public function getDateClosed()
1771. {
1772. return $this->date_closed;
1773. }
1775. /**
1776. * @param DateTime|null $forcedRenewalCreated
1777. *
1778. * @return Project
1779. */
1780. public function setForcedRenewalCreated(?DateTime $forcedRenewalCreated = null)
1781. {
1782. $this->forcedRenewalCreated = $forcedRenewalCreated;
1784. return $this;
1785. }
1787. /**
1788. * @return DateTime|null
1789. */
1790. public function getForcedRenewalCreated(): ?DateTime
1791. {
1792. return $this->forcedRenewalCreated;
1793. }
1795. /**
1796. * @param string $searchIndex
1797. *
1798. * @return Project
1799. */
1800. public function setSearchIndex($searchIndex)
1801. {
1802. $this->search_index = $searchIndex;
1804. return $this;
1805. }
1807. /**
1808. * @return string
1809. */
1810. public function getSearchIndex()
1811. {
1812. return $this->search_index;
1813. }
1815. /**
1816. * Updates the Search Index field with internal data. The Search Index Field
1817. * provides an easy way to perform a 'like' query for a generalised search.
1818. *
1819. * @ORM\PrePersist
1820. *
1821. * @ORM\PreUpdate
1822. */
1823. public function updateSearchIndex()
1824. {
1825. $searchIndex
1826. = $this->getName()
1827. . ' '
1828. . $this->getClientReference();
1830. $this->setSearchIndex($searchIndex);
1831. }
1833. /**
1834. * Set licenseLevel
1835. *
1836. * @param int $licenseLevel
1837. *
1838. * @return Project
1839. */
1840. public function setLicenseLevel($licenseLevel)
1841. {
1842. $this->license_level = $licenseLevel;
1844. return $this;
1845. }
1847. /**
1848. * Get licenseLevel
1849. *
1850. * @return int
1851. */
1852. public function getLicenseLevel()
1853. {
1854. return $this->license_level;
1855. }
1857. /**
1858. * Returns an array of permitted values for the license level field and their
1859. * associated labels,
1860. *
1861. * @return array
1862. */
1863. public static function getILicenseLevelOptions()
1864. {
1865. return [
1866. self::LICENSE_LEVEL_BASIC => 'Basic',
1867. self::LICENSE_LEVEL_STANDARD => 'Standard',
1868. self::LICENSE_LEVEL_PROFESSIONAL => 'Professional',
1869. self::LICENSE_LEVEL_PREMIUM => 'Premium',
1870. ];
1871. }
1873. /**
1874. * Returns a human-readable version of the licence level
1875. *
1876. * @return string
1877. */
1878. public function getLicenseLevelName()
1879. {
1880. $options = self::getILicenseLevelOptions();
1882. return
1883. $options[$this->getLicenseLevel()] ?? $this->getLicenseLevel();
1884. }
1886. /**
1887. * Returns the Medical Records Collection for this project in a JSTree
1888. * formatted node tree. Notably, this structure will not include Documents
1889. * under the top most node that also exist in sub nodes.
1890. *
1891. * @param string $replacementRootNodeText
1892. * @param array $additionalLiAttributes Additional attributes for <li> elements
1893. *
1894. * @return array
1895. */
1896. public function getMedicalRecordsAsJsTreeFormattedTree($replacementRootNodeText = null, $additionalLiAttributes = [])
1897. {
1898. $medicalRecordsCollection = $this->getMedicalRecordsCollection();
1900. if ($medicalRecordsCollection === null) {
1901. // Not sure why this Project has no MR Collection so let's create a blank one
1902. $this->medicalRecordsCollection = new Collection();
1903. $this->medicalRecordsCollection
1904. ->setName(Collection::DISPLAY_NAME_MEDICAL_RECORDS)
1905. ->setProjectMedicalRecords($this)
1906. ;
1907. }
1909. // first, grab the node with no children
1910. $node = $this->getMedicalRecordsCollection()
1911. ->getJsTreeFormattedNode(
1912. $replacementRootNodeText,
1913. false,
1914. false,
1915. $additionalLiAttributes
1916. )
1917. ;
1919. // set the children sub array, ready for populating
1920. $node['children'] = [];
1922. // order the children alphabetically
1923. $criteria = Criteria::create()
1924. ->orderBy(['name' => Criteria::ASC])
1925. ;
1927. // add all the sub collections with all their children and document children
1928. /** @var Collection $childCollection */
1929. foreach ($this->getMedicalRecordsCollection()->getChildren()->matching($criteria) as $childCollection) {
1930. $node['children'][] = $childCollection->getJsTreeFormattedNode(null, true, true, $additionalLiAttributes);
1931. }
1933. // all document children also get a collection id sent through, so we know what collection
1934. // the document belongs to
1935. $additionalLiAttributes['data-collection-id'] = $this->medicalRecordsCollection->getId();
1937. // loop through all the document children on this main collection
1938. foreach ($this->getMedicalRecordsCollection()->getDocuments() as $childDocument) {
1939. // Only if the Document is assigned to one collection inside the MedicalRecords collection (this one)...
1940. $collectionCount = $childDocument->getCollections()->filter(function (Collection $collection) {
1941. return $this->getMedicalRecordsCollection()->containsCollectionRecursive($collection);
1942. })->count();
1943. // ... do we include it here, else the Document will show twice in Medical Records.
1944. if ($collectionCount === 1) {
1945. $node['children'][] = $childDocument->getJsTreeFormattedNode(null, $additionalLiAttributes);
1946. }
1947. }
1949. return $node;
1950. }
1952. /**
1953. * Returns the Unsorted Records Collection for this project in a JSTree
1954. * formatted node tree. Notably, this structure will not include Documents
1955. * under the top most node that also exist in sub nodes.
1956. *
1957. * @param string $replacementRootNodeText
1958. * @param array $additionalLiAttributes Additional attributes for <li> elements
1959. *
1960. * @return array
1961. */
1962. public function getUnsortedRecordsAsJsTreeFormattedTree($replacementRootNodeText = null, $additionalLiAttributes = [])
1963. {
1964. // first, grab the node with no children
1965. $node = $this->getUnsortedRecordsCollection()->getJsTreeFormattedNode(
1966. $replacementRootNodeText,
1967. false,
1968. false,
1969. $additionalLiAttributes
1970. );
1972. // set the children sub array, ready for populating
1973. $node['children'] = [];
1975. // order the children alphabetically
1976. $criteria = Criteria::create()
1977. ->orderBy(['name' => Criteria::ASC])
1978. ;
1980. // add all the sub collections with all their children and document children
1981. foreach ($this->getUnsortedRecordsCollection()->getChildren()->matching($criteria) as $childCollection) {
1982. $node['children'][] = $childCollection->getJsTreeFormattedNode(null, true, true, $additionalLiAttributes);
1983. }
1985. // all document children also get a collection id sent through, so we know what collection
1986. // the document belongs to
1987. $additionalLiAttributes['data-collection-id'] = $this->unsortedRecordsCollection->getId();
1989. // loop through all the document children on this main collection
1990. foreach ($this->getUnsortedRecordsCollection()->getDocuments() as $childDocument) {
1991. // Only if the Document is assigned to one collection inside the MedicalRecords collection (this one)...
1992. $collectionCount = $childDocument->getCollections()->filter(function (Collection $collection) {
1993. return $this->getUnsortedRecordsCollection()->containsCollectionRecursive($collection);
1994. })->count();
1995. // ... do we include it here, else the Document will show twice in Medical Records.
1996. if ($collectionCount === 1) {
1997. $node['children'][] = $childDocument->getJsTreeFormattedNode(null, $additionalLiAttributes);
1998. }
1999. }
2001. return $node;
2002. }
2004. /**
2005. * Returns the Medical Records Collection for this project in a JSTree
2006. * formatted node tree. Notably, this structure will not include Documents
2007. * under the top most node that also exist in sub nodes.
2008. *
2009. * @param string $replacementRootNodeText
2010. * @param array $additionalLiAttributes
2011. *
2012. * @return array
2013. */
2014. public function getPrivateCollectionAsJsTreeFormattedTree($replacementRootNodeText = null, $additionalLiAttributes = [])
2015. {
2016. // first, grab the node with no children
2017. // NB! additional attributes MUST be set so that the outer node in the
2018. // private tree has the data-group "private" or copy and move rules
2019. // will not work!
2020. $node = $this->getPrivateCollection()->getJsTreeFormattedNode($replacementRootNodeText, false, false, $additionalLiAttributes);
2022. // set the children sub array, ready for populating
2023. $node['children'] = [];
2025. // order the children alphabetically
2026. $criteria = Criteria::create()
2027. ->orderBy(['name' => Criteria::ASC])
2028. ;
2030. // add all the sub collections with all their children and document children
2031. foreach ($this->getPrivateCollection()->getChildren()->matching($criteria) as $childCollection) {
2032. $node['children'][] = $childCollection->getJsTreeFormattedNode(null, true, true, $additionalLiAttributes);
2033. }
2035. // all document children also get a collection id sent through, so we know what collection
2036. // the document belongs to
2037. $additionalLiAttributes['data-collection-id'] = $this->getId();
2039. // loop through all the document children on this main collection
2040. foreach ($this->getPrivateCollection()->getDocuments() as $childDocument) {
2041. // Only if the Document is assigned to one collection inside the Private collection (this one)...
2042. $collectionCount = $childDocument->getCollections()->filter(function (Collection $collection) {
2043. return $this->getPrivateCollection()->containsCollectionRecursive($collection);
2044. })->count();
2045. // ... do we include it here, else the Document will show twice in Medical Records.
2046. if ($collectionCount === 1) {
2047. $node['children'][] = $childDocument->getJsTreeFormattedNode(null, $additionalLiAttributes);
2048. }
2049. }
2051. return $node;
2052. }
2054. /**
2055. * Add projectUser
2056. *
2057. * @param ProjectUser $projectUser
2058. *
2059. * @return Project
2060. */
2061. public function addProjectUser(ProjectUser $projectUser)
2062. {
2063. $this->projectUsers[] = $projectUser;
2065. return $this;
2066. }
2068. /**
2069. * Remove projectUser
2070. *
2071. * @param ProjectUser $projectUser
2072. */
2073. public function removeProjectUser(ProjectUser $projectUser)
2074. {
2075. $this->projectUsers->removeElement($projectUser);
2076. }
2078. /**
2079. * Get projectUsers
2080. *
2081. * @return DoctrineCollection|ProjectUser[]
2082. */
2083. public function getProjectUsers()
2084. {
2085. return $this->projectUsers;
2086. }
2088. /**
2089. * Set privateCollection
2090. *
2091. * @param Collection|null $privateCollection
2092. *
2093. * @return Project
2094. */
2095. public function setPrivateCollection(?Collection $privateCollection = null)
2096. {
2097. $this->privateCollection = $privateCollection;
2099. return $this;
2100. }
2102. /**
2103. * Get privateCollection
2104. *
2105. * @return Collection
2106. */
2107. public function getPrivateCollection()
2108. {
2109. return $this->privateCollection;
2110. }
2112. /**
2113. * Set background
2114. *
2115. * @param string $background
2116. *
2117. * @return Project
2118. */
2119. public function setBackground($background)
2120. {
2121. $this->background = $background;
2123. // Update the associated matter request as well, if it exists, and if the values are different,
2124. // to avoid a recursive loop.
2125. if ($background !== null && $this->getMatterRequest() && $this->getMatterRequest()->getBackground() != $this->background) {
2126. $this->getMatterRequest()->setBackground($this->background);
2127. }
2129. return $this;
2130. }
2132. /**
2133. * Get background
2134. *
2135. * @return string
2136. */
2137. public function getBackground()
2138. {
2139. return $this->background;
2140. }
2142. /**
2143. * Increases the total documents file size for this Project.
2144. *
2145. * This value should exclude DICOM files.
2146. *
2147. * @param mixed $filesize
2148. *
2149. * @return Project
2150. */
2151. public function increaseDocumentsTotalFilesize($filesize)
2152. {
2153. $this->documents_total_filesize += $filesize;
2155. return $this;
2156. }
2158. /**
2159. * Decreases the total documents file size for this Project.
2160. *
2161. * This value should exclude DICOM files.
2162. *
2163. * @param mixed $filesize
2164. *
2165. * @return Project
2166. */
2167. public function decreaseDocumentsTotalFilesize($filesize)
2168. {
2169. $this->documents_total_filesize -= $filesize;
2171. return $this;
2172. }
2174. /**
2175. * Get documentsTotalFilesize
2176. *
2177. * @return string
2178. */
2179. public function getDocumentsTotalFilesize()
2180. {
2181. return $this->documents_total_filesize;
2182. }
2184. /**
2185. * Set documentsTotalFilesize
2186. *
2187. * @param mixed $documents_total_filesize
2188. *
2189. * @return Project
2190. */
2191. public function setDocumentsTotalFilesize($documents_total_filesize)
2192. {
2193. $this->documents_total_filesize = $documents_total_filesize;
2195. return $this;
2196. }
2198. /**
2199. * Increases the total file size in bytes of active disc archives for
2200. * this project.
2201. *
2202. * @param int $filesize
2203. *
2204. * @return Project
2205. */
2206. public function increaseActiveDiscsTotalArchiveFilesize($filesize)
2207. {
2208. $this->active_discs_total_archive_filesize += $filesize;
2210. return $this;
2211. }
2213. /**
2214. * Decreases the total file size in bytes of active disc archives for
2215. * this project.
2216. *
2217. * @param int $filesize
2218. *
2219. * @return Project
2220. */
2221. public function decreaseActiveDiscsTotalArchiveFilesize($filesize)
2222. {
2223. $this->active_discs_total_archive_filesize -= $filesize;
2225. return $this;
2226. }
2228. /**
2229. * Get activeDiscsTotalArchiveFilesize
2230. *
2231. * @return string
2232. */
2233. public function getActiveDiscsTotalArchiveFilesize()
2234. {
2235. return $this->active_discs_total_archive_filesize;
2236. }
2238. /**
2239. * Set activeDiscsTotalArchiveFilesize
2240. *
2241. * @param mixed $active_discs_total_archive_filesize
2242. *
2243. * @return Project
2244. */
2245. public function setActiveDiscsTotalArchiveFilesize($active_discs_total_archive_filesize)
2246. {
2247. $this->active_discs_total_archive_filesize = $active_discs_total_archive_filesize;
2249. return $this;
2250. }
2252. /**
2253. * Get limitationDate
2254. *
2255. * @return DateTime
2256. */
2257. public function getLimitationDate()
2258. {
2259. return $this->limitation_date;
2260. }
2262. /**
2263. * Set limitationDate
2264. *
2265. * @param DateTime $limitationDate
2266. *
2267. * @return Project
2268. */
2269. public function setLimitationDate($limitationDate)
2270. {
2271. $this->limitation_date = $limitationDate;
2273. // Update the associated matter request as well, if it exists, and if the values are different,
2274. // to avoid a recursive loop.
2275. if ($this->getMatterRequest() && $this->getMatterRequest()->getLimitationDate() != $this->limitation_date) {
2276. $this->getMatterRequest()->setLimitationDate($this->limitation_date);
2277. }
2279. return $this;
2280. }
2282. /**
2283. * Set claimCategory
2284. *
2285. * @param int $claimCategory
2286. *
2287. * @return Project
2288. */
2289. public function setClaimCategory($claimCategory)
2290. {
2291. $this->claim_category = $claimCategory;
2293. // Update the associated matter request as well, if it exists, and if the values are different,
2294. // to avoid a recursive loop.
2295. if ($this->getMatterRequest() && $this->getMatterRequest()->getClaimCategory() != $this->claim_category) {
2296. $this->getMatterRequest()->setClaimCategory($this->claim_category);
2297. }
2299. return $this;
2300. }
2302. /**
2303. * Get claimCategory
2304. *
2305. * @return int
2306. */
2307. public function getClaimCategory()
2308. {
2309. return $this->claim_category;
2310. }
2312. /**
2313. * Returns an array of permitted values for the claim category field and their
2314. * associated labels.
2315. *
2316. * @return array
2317. */
2318. public static function getClaimCategoryOptions()
2319. {
2320. $claimCategoryOptions = self::getConstantsWithLabelsAsChoices('CLAIM_CATEGORY');
2322. ksort($claimCategoryOptions);
2324. return array_flip($claimCategoryOptions);
2325. }
2327. /**
2328. * Returns an array of permitted values for the claim category field and their
2329. * associated labels, in a verbose array structure.
2330. *
2331. * @return array
2332. */
2333. public static function getClaimCategoryOptionsWithLabels()
2334. {
2335. return self::getConstantsWithLabels('CLAIM_CATEGORY');
2336. }
2338. /**
2339. * Returns a human-readable version of the claim_category
2340. *
2341. * @return string
2342. */
2343. public function getClaimCategoryName()
2344. {
2345. $options = self::getClaimCategoryOptions();
2347. return $options[$this->getClaimCategory()] ?? 'Other';
2348. }
2350. /**
2351. * Returns an array of Claim Categories that are Birth Injury cases.
2352. *
2353. * @TODO: We should update how the constants are handled to include this
2354. * there.
2355. *
2356. * @return array|int[]
2357. */
2358. public static function getBirthInjuryClaimCategories(): array
2359. {
2360. return [
2361. self::CLAIM_CATEGORY_OBSTETRICS_RELATING_TO_CHILD,
2362. self::CLAIM_CATEGORY_OBSTETRICS_BRAIN_INJURY_HIE,
2363. self::CLAIM_CATEGORY_OBSTETRICS_GBS_SEPSIS,
2364. self::CLAIM_CATEGORY_OBSTETRICS_KERNICTERUS,
2365. self::CLAIM_CATEGORY_OBSTETRICS_NEONATAL_DEATH,
2366. self::CLAIM_CATEGORY_OBSTETRICS_OTHER_CHILD_INJURY,
2367. self::CLAIM_CATEGORY_OBSTETRICS_SHOULDER_DYSTOCIA,
2368. self::CLAIM_CATEGORY_OBSTETRICS_STILLBIRTH,
2369. self::CLAIM_CATEGORY_OBSTETRICS_WRONGFUL_BIRTH,
2370. ];
2371. }
2373. /**
2374. * Set estimatedClaimValue
2375. *
2376. * @param int $estimatedClaimValue
2377. *
2378. * @return Project
2379. */
2380. public function setEstimatedClaimValue($estimatedClaimValue)
2381. {
2382. $this->estimated_claim_value = $estimatedClaimValue;
2384. // Update the associated matter request as well, if it exists, and if the values are different,
2385. // to avoid a recursive loop.
2386. if ($this->getMatterRequest() && $this->getMatterRequest()->getClaimValue() != $this->estimated_claim_value) {
2387. $this->getMatterRequest()->setClaimValue($this->estimated_claim_value);
2388. }
2390. return $this;
2391. }
2393. /**
2394. * Get estimatedClaimValue
2395. *
2396. * @return int
2397. */
2398. public function getEstimatedClaimValue()
2399. {
2400. return $this->estimated_claim_value;
2401. }
2403. /**
2404. * Returns an array of permitted values for the estimated claim value field and their
2405. * associated labels.
2406. *
2407. * @return array
2408. */
2409. public static function getEstimatedClaimValueOptions()
2410. {
2411. return [
2412. self::ESTIMATED_CLAIM_VALUE_0_25000 => self::ESTIMATED_CLAIM_VALUE_0_25000__LABEL,
2413. self::ESTIMATED_CLAIM_VALUE_25001_50000 => self::ESTIMATED_CLAIM_VALUE_25001_50000__LABEL,
2414. self::ESTIMATED_CLAIM_VALUE_50001_100000 => self::ESTIMATED_CLAIM_VALUE_50001_100000__LABEL,
2415. self::ESTIMATED_CLAIM_VALUE_100001_250000 => self::ESTIMATED_CLAIM_VALUE_100001_250000__LABEL,
2416. self::ESTIMATED_CLAIM_VALUE_250001_500000 => self::ESTIMATED_CLAIM_VALUE_250001_500000__LABEL,
2417. self::ESTIMATED_CLAIM_VALUE_500001_1000000 => self::ESTIMATED_CLAIM_VALUE_500001_1000000__LABEL,
2418. self::ESTIMATED_CLAIM_VALUE_1000001 => self::ESTIMATED_CLAIM_VALUE_1000001__LABEL,
2419. ];
2420. }
2422. /**
2423. * Returns an array of permitted values for the estimated claim value field and their
2424. * associated labels, in a verbose array structure.
2425. *
2426. * @return array
2427. */
2428. public static function getEstimatedClaimValueOptionsWithLabels()
2429. {
2430. return self::getConstantsWithLabels('ESTIMATED_CLAIM_VALUE');
2431. }
2433. /**
2434. * Returns a human-readable version of the estimated_claim_value
2435. *
2436. * @return string
2437. */
2438. public function getEstimatedClaimValueName()
2439. {
2440. $options = self::getEstimatedClaimValueOptions();
2442. return $options[$this->getEstimatedClaimValue()] ?? $this->getEstimatedClaimValue();
2443. }
2445. /**
2446. * Set archiveStatus
2447. *
2448. * @param int|null $archiveStatus
2449. *
2450. * @return Project
2451. */
2452. public function setArchiveStatus(?int $archiveStatus = null)
2453. {
2454. $this->archive_status = $archiveStatus;
2456. // DisclosureProjects are directly associated with their Parent Project
2457. // As a Project may have multiple DisclosureTargets/Projects, update their archiveStatus as well
2458. // To ensure they are included in the archive logic
2459. foreach ($this->getInterpartyDisclosures() as $disclosure) {
2460. if ($disclosure->getDisclosureTarget() !== null) {
2461. $disclosure->getDisclosureTarget()->setArchiveStatus($archiveStatus);
2462. }
2463. }
2465. return $this;
2466. }
2468. /**
2469. * Get archiveStatus
2470. *
2471. * @return int
2472. */
2473. public function getArchiveStatus()
2474. {
2475. return $this->archive_status;
2476. }
2478. /**
2479. * Set archiveStatusUpdated
2480. *
2481. * @param DateTime|null $archiveStatusUpdated
2482. *
2483. * @return Project
2484. */
2485. public function setArchiveStatusUpdated(?DateTime $archiveStatusUpdated = null)
2486. {
2487. $this->archive_status_updated = $archiveStatusUpdated;
2489. // DisclosureProjects are directly associated with their Parent Project
2490. // As a Project may have multiple DisclosureTargets, update their archiveStatusUpdated as well
2491. // To ensure they are included in the archive logic
2492. foreach ($this->getInterpartyDisclosures() as $disclosure) {
2493. if ($disclosure->getDisclosureTarget() !== null) {
2494. $disclosure->getDisclosureTarget()->setArchiveStatusUpdated($archiveStatusUpdated);
2495. }
2496. }
2498. return $this;
2499. }
2501. /**
2502. * Get archiveStatusUpdated
2503. *
2504. * @return DateTime
2505. */
2506. public function getArchiveStatusUpdated()
2507. {
2508. return $this->archive_status_updated;
2509. }
2511. /**
2512. * Set futureDeletionDate
2513. *
2514. * @param DateTime $futureDeletionDate
2515. *
2516. * @return Project
2517. */
2518. public function setFutureDeletionDate($futureDeletionDate)
2519. {
2520. $this->future_deletion_date = $futureDeletionDate;
2522. return $this;
2523. }
2525. /**
2526. * Get futureDeletionDate
2527. *
2528. * @return DateTime
2529. */
2530. public function getFutureDeletionDate()
2531. {
2532. return $this->future_deletion_date;
2533. }
2535. /**
2536. * Set privateSandboxCollection
2537. *
2538. * @param Collection|null $privateSandboxCollection
2539. *
2540. * @return Project
2541. */
2542. public function setPrivateSandboxCollection(?Collection $privateSandboxCollection = null)
2543. {
2544. $this->privateSandboxCollection = $privateSandboxCollection;
2546. return $this;
2547. }
2549. /**
2550. * Get privateSandboxCollection
2551. *
2552. * @return Collection
2553. */
2554. public function getPrivateSandboxCollection()
2555. {
2556. // If no privateSandboxCollection exists, create a new one.
2557. // We do this here, instead of the constructor, so we only create a new
2558. // Collection entity if none already exists.
2559. if ($this->privateSandboxCollection === null) {
2560. $privateSandboxCollection = new Collection();
2561. $privateSandboxCollection->setName('Private Sandbox Folders');
2562. $this->setPrivateSandboxCollection($privateSandboxCollection);
2563. }
2565. return $this->privateSandboxCollection;
2566. }
2568. /**
2569. * Returns the PrivateSandboxCollection for this project in a JSTree
2570. * formatted node tree. Notably, this structure will not include Documents
2571. * under the top most node that also exist in sub nodes.
2572. *
2573. * @param string $replacementRootNodeText
2574. * @param array $additionalLiAttributes
2575. *
2576. * @return array
2577. */
2578. public function getPrivateSandboxCollectionAsJsTreeFormattedTree($replacementRootNodeText = null, $additionalLiAttributes = [])
2579. {
2580. $node = $this->getPrivateSandboxCollection()->getJsTreeFormattedNode($replacementRootNodeText, false, false, $additionalLiAttributes);
2582. // set the children sub array, ready for populating
2583. $node['children'] = [];
2585. // order the children alphabetically
2586. $criteria = Criteria::create()
2587. ->orderBy(['name' => Criteria::ASC])
2588. ;
2590. // add all the sub collections with all their children and document children
2591. foreach ($this->getPrivateSandboxCollection()->getChildren()->matching($criteria) as $childCollection) {
2592. $node['children'][] = $childCollection->getJsTreeFormattedNode(null, true, true, $additionalLiAttributes);
2593. }
2595. // all document children also get a collection id sent through, so we know what collection
2596. // the document belongs to
2597. $additionalLiAttributes['data-collection-id'] = $this->getId();
2599. // loop through all the document children on this main collection
2600. foreach ($this->getPrivateSandboxCollection()->getDocuments() as $childDocument) {
2601. // Only if the Document is assigned to one collection inside the Private Sandbox collection (this one)...
2602. $collectionCount = $childDocument->getCollections()->filter(function (Collection $collection) {
2603. return $this->getPrivateSandboxCollection()->containsCollectionRecursive($collection);
2604. })->count();
2605. // ... do we include it here, else the Document will show twice in Medical Records.
2606. if ($collectionCount === 1) {
2607. $node['children'][] = $childDocument->getJsTreeFormattedNode(null, $additionalLiAttributes);
2608. }
2609. }
2611. return $node;
2612. }
2614. /**
2615. * Add batchRequest
2616. *
2617. * @param BatchRequest $batchRequest
2618. *
2619. * @return Project
2620. */
2621. public function addBatchRequest(BatchRequest $batchRequest)
2622. {
2623. $this->batchRequests[] = $batchRequest;
2625. return $this;
2626. }
2628. /**
2629. * Remove batchRequest
2630. *
2631. * @param BatchRequest $batchRequest
2632. */
2633. public function removeBatchRequest(BatchRequest $batchRequest)
2634. {
2635. $this->batchRequests->removeElement($batchRequest);
2636. }
2638. /**
2639. * Get batchRequests
2640. *
2641. * @return DoctrineCollection|BatchRequest[]
2642. */
2643. public function getBatchRequests()
2644. {
2645. return $this->batchRequests;
2646. }
2648. /**
2649. * Retrieves the counts for BatchRequests grouped by
2650. * their serviceRequest status.
2651. *
2652. * @param mixed $uninvoicedOnly
2653. *
2654. * @return array
2655. */
2656. public function getBatchRequestsCountByServiceRequestStatus($uninvoicedOnly = true)
2657. {
2658. return $this->getServiceableCountsByStatus($this->getBatchRequests()->toArray(), $uninvoicedOnly);
2659. }
2661. /**
2662. * Add additionalRequest
2663. *
2664. * @param AdditionalRequest $additionalRequest
2665. *
2666. * @return Project
2667. */
2668. public function addAdditionalRequest(AdditionalRequest $additionalRequest)
2669. {
2670. $this->additionalRequests[] = $additionalRequest;
2672. return $this;
2673. }
2675. /**
2676. * Remove additionalRequest
2677. *
2678. * @param AdditionalRequest $additionalRequest
2679. */
2680. public function removeAdditionalRequest(AdditionalRequest $additionalRequest)
2681. {
2682. $this->additionalRequests->removeElement($additionalRequest);
2683. }
2685. /**
2686. * Get additionalRequests
2687. *
2688. * @return DoctrineCollection|AdditionalRequest[]
2689. */
2690. public function getAdditionalRequests()
2691. {
2692. return $this->additionalRequests;
2693. }
2695. /**
2696. * Retrieves the counts for AdditionalRequests grouped by
2697. * their serviceRequest status
2698. *
2699. * @param mixed $uninvoicedOnly
2700. *
2701. * @return array
2702. */
2703. public function getAdditionalRequestsCountByServiceRequestStatus($uninvoicedOnly = true)
2704. {
2705. return $this->getServiceableCountsByStatus($this->getAdditionalRequests()->toArray(), $uninvoicedOnly);
2706. }
2708. /**
2709. * Add chronologyRequest
2710. *
2711. * @param ChronologyRequest $chronologyRequest
2712. *
2713. * @return Project
2714. */
2715. public function addChronologyRequest(ChronologyRequest $chronologyRequest)
2716. {
2717. $this->chronologyRequests[] = $chronologyRequest;
2719. return $this;
2720. }
2722. /**
2723. * Remove chronologyRequest
2724. *
2725. * @param ChronologyRequest $chronologyRequest
2726. */
2727. public function removeChronologyRequest(ChronologyRequest $chronologyRequest)
2728. {
2729. $this->chronologyRequests->removeElement($chronologyRequest);
2730. }
2732. /**
2733. * Get chronologyRequests
2734. *
2735. * @return ArrayCollection|ChronologyRequest[]
2736. */
2737. public function getChronologyRequests()
2738. {
2739. return $this->chronologyRequests;
2740. }
2742. /**
2743. * Retrieves the counts for ChronologyRequests grouped by
2744. * their serviceRequest status
2745. *
2746. * @param bool $uninvoicedOnly
2747. *
2748. * @return array
2749. */
2750. public function getChronologyRequestsCountByServiceRequestStatus($uninvoicedOnly = true)
2751. {
2752. return $this->getServiceableCountsByStatus($this->getChronologyRequests()->toArray(), $uninvoicedOnly);
2753. }
2755. /**
2756. * Retrieve a sum of ServiceRequest statuses for all Serviceable entities attached to this Project.
2757. *
2758. * @param bool $uninvoicedOnly
2759. *
2760. * @return array
2761. */
2762. public function getTotalServiceRequestCountsByStatus($uninvoicedOnly = true)
2763. {
2764. return $this->getServiceableCountsByStatus($this->getServiceables(), $uninvoicedOnly);
2765. }
2767. /**
2768. * @return array
2769. */
2770. public function getServiceables(): array
2771. {
2772. $serviceables = [];
2774. // Combine all Serviceable entities on this Project into a single array.
2775. $serviceables = array_merge(
2776. $this->getRecordsRequests()->toArray(),
2777. $this->getBatchRequests()->toArray(),
2778. $this->getChronologyRequests()->toArray(),
2779. $this->getAdditionalRequests()->toArray()
2780. );
2782. return $serviceables;
2783. }
2785. /**
2786. * Gets the total number of ServiceRequest that are in status On Hold.
2787. *
2788. * @return int
2789. */
2790. public function getTotalServiceRequestCountsOnHold()
2791. {
2792. $totals = $this->getTotalServiceRequestCountsByStatus();
2794. return isset($totals[ServiceRequest::STATUS_ON_HOLD]) ? $totals[ServiceRequest::STATUS_ON_HOLD]['count'] : 0;
2795. }
2797. /**
2798. * Gets the total number of ServiceRequest that are in status In Progress.
2799. *
2800. * @return int
2801. */
2802. public function getTotalServiceRequestCountsInProgress()
2803. {
2804. $totals = $this->getTotalServiceRequestCountsByStatus();
2806. $inProgressCount = $totals[ServiceRequest::STATUS_IN_PROGRESS]['count'] ?? 0;
2807. $instructedCount = $totals[ServiceRequest::STATUS_INSTRUCTED]['count'] ?? 0;
2809. return $inProgressCount + $instructedCount;
2810. }
2812. /**
2813. * Gets the total number of ServiceRequest that are in status Complete.
2814. *
2815. * @return int
2816. */
2817. public function getTotalServiceRequestCountsComplete()
2818. {
2819. $totals = $this->getTotalServiceRequestCountsByStatus();
2821. $completeTotal = 0;
2823. $completeTotal += $totals[ServiceRequest::STATUS_COMPLETE]['count'] ?? 0;
2824. $completeTotal += $totals[ServiceRequest::STATUS_BACK_TO_CLIENT]['count'] ?? 0;
2825. $completeTotal += $totals[ServiceRequest::STATUS_RELEASED_TO_CLIENT]['count'] ?? 0;
2827. return $completeTotal;
2828. }
2830. /**
2831. * Gets the total number of ServiceRequest that are in status Awaiting Records.
2832. *
2833. * @return int
2834. */
2835. public function getTotalServiceRequestCountsAwaitingRecords()
2836. {
2837. $totals = $this->getTotalServiceRequestCountsByStatus();
2839. /**
2840. * Combine awaiting records and awaiting records arrival into one total, as they are similar but have slightly
2841. * different meanings for different service requests.
2842. * {@see ServiceRequest::getStatusOptionsBatchRequest} and {@see ServiceRequest::getStatusOptionsChronologyRequest}
2843. */
2844. $awaitingRecordsTotal = isset($totals[ServiceRequest::STATUS_AWAITING_RECORDS]) ? $totals[ServiceRequest::STATUS_AWAITING_RECORDS]['count'] : 0;
2845. $awaitingRecordsArrivalTotal = isset($totals[ServiceRequest::STATUS_AWAITING_RECORDS_ARRIVAL]) ? $totals[ServiceRequest::STATUS_AWAITING_RECORDS_ARRIVAL]['count'] : 0;
2846. $awaitingQuoteApprovalTotal = isset($totals[ServiceRequest::STATUS_AWAITING_QUOTE_APPROVAL]) ? $totals[ServiceRequest::STATUS_AWAITING_QUOTE_APPROVAL]['count'] : 0;
2848. return $awaitingRecordsTotal + $awaitingRecordsArrivalTotal + $awaitingQuoteApprovalTotal;
2849. }
2851. /**
2852. * Gets the amount of Records Requests grouped by their respective statuses
2853. *
2854. * @return array
2855. */
2856. public function getRecordsRequestCountsByStatus()
2857. {
2858. $serviceables = $this->getRecordsRequests()->toArray();
2860. return $this->getServiceableCountsByStatus($serviceables);
2861. }
2863. /**
2864. * Gets the amount of Batch Requests grouped by their respective statuses
2865. *
2866. * @return array
2867. */
2868. public function getBatchRequestCountsByStatus()
2869. {
2870. $serviceables = $this->getBatchRequests()->toArray();
2872. return $this->getServiceableCountsByStatus($serviceables);
2873. }
2875. /**
2876. * Gets the amount of Chronology Requests grouped by their respective statuses
2877. *
2878. * @return array
2879. */
2880. public function getChronologyRequestCountsByStatus()
2881. {
2882. $serviceables = $this->getChronologyRequests()->toArray();
2884. return $this->getServiceableCountsByStatus($serviceables);
2885. }
2887. /**
2888. * Gets the amount of Additional Requests grouped by their respective statuses
2889. *
2890. * @return array
2891. */
2892. public function getAdditionalRequestCountsByStatus()
2893. {
2894. $serviceables = $this->getAdditionalRequests()->toArray();
2896. return $this->getServiceableCountsByStatus($serviceables);
2897. }
2899. /**
2900. * Gets the total of all records request status' with status STATUS_COMPLETE and STATUS_BACK_TO_CLIENT
2901. *
2902. * @return int
2903. */
2904. public function getRecordsRequestCompleteReturnCount()
2905. {
2906. $recordsRequestByStatus = $this->getRecordsRequestCountsByStatus();
2908. $count = 0;
2910. $arrayKeys = array_keys($recordsRequestByStatus);
2912. if (in_array(ServiceRequest::STATUS_BACK_TO_CLIENT, $arrayKeys, true)) {
2913. $count += $recordsRequestByStatus[ServiceRequest::STATUS_BACK_TO_CLIENT]['count'];
2914. }
2916. if (in_array(ServiceRequest::STATUS_COMPLETE, $arrayKeys, true)) {
2917. $count += $recordsRequestByStatus[ServiceRequest::STATUS_COMPLETE]['count'];
2918. }
2920. return $count;
2921. }
2923. /**
2924. * Gets the ServiceRequest counts grouped by their respective statuses and types
2925. *
2926. * @return array
2927. */
2928. public function getServiceRequestStatusCountsByType()
2929. {
2930. return [
2931. 'Records Requests' => $this->getRecordsRequestCountsByStatus(),
2932. 'Batch Requests' => $this->getBatchRequestCountsByStatus(),
2933. 'Chronology Requests' => $this->getChronologyRequestCountsByStatus(),
2934. 'Additional Requests' => $this->getAdditionalRequestCountsByStatus(),
2935. ];
2936. }
2938. // @todo The below functions could probably all be rolled up in to one easy catchall
2939. // like ::getServiceRequestCountByTypeAndStatus( $type, $status ) but only
2940. // thought of it too late ┐('～`；)┌
2942. /**
2943. * Gets a count of all completed ServiceRequests given a specific Type
2944. *
2945. * @param $service_request_type
2946. *
2947. * @throws Exception
2948. *
2949. * @return int|mixed
2950. */
2951. public function getCompleteServiceRequestCountsByType($service_request_type)
2952. {
2953. switch ($service_request_type) {
2954. case ServiceRequest::TYPE_RECORDS_REQUEST:
2955. $serviceables = $this->getRecordsRequestsCountByServiceRequestStatus(false);
2956. break;
2957. case ServiceRequest::TYPE_BATCH_REQUEST:
2958. $serviceables = $this->getBatchRequestsCountByServiceRequestStatus(false);
2959. break;
2960. case ServiceRequest::TYPE_CHRONOLOGY_REQUEST:
2961. $serviceables = $this->getChronologyRequestsCountByServiceRequestStatus(false);
2962. break;
2963. case ServiceRequest::TYPE_ADDITIONAL_REQUEST:
2964. $serviceables = $this->getAdditionalRequestsCountByServiceRequestStatus(false);
2965. break;
2966. default:
2967. throw new Exception('Invalid Service Request Type.');
2968. }
2970. $complete = isset($serviceables[ServiceRequest::STATUS_COMPLETE]) ? $serviceables[ServiceRequest::STATUS_COMPLETE]['count'] : 0;
2971. $releasedToClient = isset($serviceables[ServiceRequest::STATUS_RELEASED_TO_CLIENT]) ? $serviceables[ServiceRequest::STATUS_RELEASED_TO_CLIENT]['count'] : 0;
2973. return $complete + $releasedToClient;
2974. }
2976. /**
2977. * Gets a count of all in progress ServiceRequests given a specific Type
2978. *
2979. * @param $service_request_type
2980. *
2981. * @throws Exception
2982. *
2983. * @return int|mixed
2984. */
2985. public function getInProgressServiceRequestCountsByType($service_request_type)
2986. {
2987. switch ($service_request_type) {
2988. case ServiceRequest::TYPE_RECORDS_REQUEST:
2989. $serviceables = $this->getRecordsRequestsCountByServiceRequestStatus(false);
2990. break;
2991. case ServiceRequest::TYPE_BATCH_REQUEST:
2992. $serviceables = $this->getBatchRequestsCountByServiceRequestStatus(false);
2993. break;
2994. case ServiceRequest::TYPE_CHRONOLOGY_REQUEST:
2995. $serviceables = $this->getChronologyRequestsCountByServiceRequestStatus(false);
2996. break;
2997. case ServiceRequest::TYPE_ADDITIONAL_REQUEST:
2998. $serviceables = $this->getAdditionalRequestsCountByServiceRequestStatus(false);
2999. break;
3000. default:
3001. throw new Exception('Invalid Service Request Type.');
3002. }
3004. return isset($serviceables[ServiceRequest::STATUS_IN_PROGRESS]) ? $serviceables[ServiceRequest::STATUS_IN_PROGRESS]['count'] : 0;
3005. }
3007. /**
3008. * Gets a count of all on hold ServiceRequests given a specific Type
3009. *
3010. * @param $service_request_type
3011. *
3012. * @throws Exception
3013. *
3014. * @return int|mixed
3015. */
3016. public function getOnHoldServiceRequestCountsByType($service_request_type)
3017. {
3018. switch ($service_request_type) {
3019. case ServiceRequest::TYPE_RECORDS_REQUEST:
3020. $serviceables = $this->getRecordsRequestsCountByServiceRequestStatus(false);
3021. break;
3022. case ServiceRequest::TYPE_BATCH_REQUEST:
3023. $serviceables = $this->getBatchRequestsCountByServiceRequestStatus(false);
3024. break;
3025. case ServiceRequest::TYPE_CHRONOLOGY_REQUEST:
3026. $serviceables = $this->getChronologyRequestsCountByServiceRequestStatus(false);
3027. break;
3028. case ServiceRequest::TYPE_ADDITIONAL_REQUEST:
3029. $serviceables = $this->getAdditionalRequestsCountByServiceRequestStatus(false);
3030. break;
3031. default:
3032. throw new Exception('Invalid Service Request Type.');
3033. }
3035. return isset($serviceables[ServiceRequest::STATUS_ON_HOLD]) ? $serviceables[ServiceRequest::STATUS_ON_HOLD]['count'] : 0;
3036. }
3038. /**
3039. * Gets a count of all ServiceRequests awaiting records given a specific Type
3040. *
3041. * @param $service_request_type
3042. *
3043. * @throws Exception
3044. *
3045. * @return int|mixed
3046. */
3047. public function getPendingServiceRequestCountsByType($service_request_type)
3048. {
3049. switch ($service_request_type) {
3050. case ServiceRequest::TYPE_RECORDS_REQUEST:
3051. $serviceables = $this->getRecordsRequestsCountByServiceRequestStatus(false);
3052. break;
3053. case ServiceRequest::TYPE_BATCH_REQUEST:
3054. $serviceables = $this->getBatchRequestsCountByServiceRequestStatus(false);
3055. break;
3056. case ServiceRequest::TYPE_CHRONOLOGY_REQUEST:
3057. $serviceables = $this->getChronologyRequestsCountByServiceRequestStatus(false);
3058. break;
3059. case ServiceRequest::TYPE_ADDITIONAL_REQUEST:
3060. $serviceables = $this->getAdditionalRequestsCountByServiceRequestStatus(false);
3061. break;
3062. default:
3063. throw new Exception('Invalid Service Request Type.');
3064. }
3066. return isset($serviceables[ServiceRequest::STATUS_AWAITING_RECORDS]) ? $serviceables[ServiceRequest::STATUS_AWAITING_RECORDS]['count'] : 0;
3067. }
3069. /**
3070. * Gets a count of all cancelled ServiceRequests given a specific Type
3071. *
3072. * @param $service_request_type
3073. *
3074. * @throws Exception
3075. *
3076. * @return int|mixed
3077. */
3078. public function getCancelledServiceRequestCountsByType($service_request_type)
3079. {
3080. switch ($service_request_type) {
3081. case ServiceRequest::TYPE_RECORDS_REQUEST:
3082. $serviceables = $this->getRecordsRequestsCountByServiceRequestStatus(false);
3083. break;
3084. case ServiceRequest::TYPE_BATCH_REQUEST:
3085. $serviceables = $this->getBatchRequestsCountByServiceRequestStatus(false);
3086. break;
3087. case ServiceRequest::TYPE_CHRONOLOGY_REQUEST:
3088. $serviceables = $this->getChronologyRequestsCountByServiceRequestStatus(false);
3089. break;
3090. case ServiceRequest::TYPE_ADDITIONAL_REQUEST:
3091. $serviceables = $this->getAdditionalRequestsCountByServiceRequestStatus(false);
3092. break;
3093. default:
3094. throw new Exception('Invalid Service Request Type.');
3095. }
3097. return isset($serviceables[ServiceRequest::STATUS_CANCELLED]) ? $serviceables[ServiceRequest::STATUS_CANCELLED]['count'] : 0;
3098. }
3100. /**
3101. * Set team
3102. *
3103. * @param string $team
3104. *
3105. * @return Project
3106. */
3107. public function setTeam($team)
3108. {
3109. $this->team = $team;
3111. // Update the associated matter request as well, if it exists, and if the values are different,
3112. // to avoid a recursive loop.
3113. if ($this->getMatterRequest() && $this->getMatterRequest()->getTeam() != $this->team) {
3114. $this->getMatterRequest()->setTeam($this->team);
3115. }
3117. return $this;
3118. }
3120. /**
3121. * Get team
3122. *
3123. * @return string
3124. */
3125. public function getTeam()
3126. {
3127. return $this->team;
3128. }
3130. /**
3131. * Set defaultRole
3132. *
3133. * @param string $defaultRole
3134. *
3135. * @return Project
3136. */
3137. public function setDefaultRole($defaultRole)
3138. {
3139. $this->default_role = $defaultRole;
3141. return $this;
3142. }
3144. /**
3145. * Get defaultRole
3146. *
3147. * @return string
3148. */
3149. public function getDefaultRole()
3150. {
3151. return $this->default_role;
3152. }
3154. /**
3155. * Get defaultRoleOptions
3156. *
3157. * @return array
3158. */
3159. public static function getDefaultRoleOptions()
3160. {
3161. return [
3162. self::DEFAULT_ROLE_EXPERT => 'Expert',
3163. self::DEFAULT_ROLE_EXPERTVIEWER => 'Expert - View Only',
3164. self::DEFAULT_ROLE_SCANNER => 'Scanner',
3165. self::DEFAULT_ROLE_SCANNERDOWNLOAD => 'Scanner - Download Enabled',
3166. self::DEFAULT_ROLE_PROJECTMANAGER => 'Project Manager',
3167. ];
3168. }
3170. /**
3171. * Get DefaultRoleLabel
3172. *
3173. * @return int
3174. */
3175. public function getDefaultRoleLabel()
3176. {
3177. $options = self::getDefaultRoleOptions();
3178. return $options[$this->getDefaultRole()] ?? '';
3179. }
3181. /**
3182. * Get DefaultRoleLabel
3183. *
3184. * @return string
3185. */
3186. public function getDefaultRoleAsRole()
3187. {
3188. if (!$this->getDefaultRole()) {
3189. return '';
3190. }
3192. return 'ROLE_PROJECT_' . $this->getId() . '_' . $this->getDefaultRole();
3193. }
3195. /**
3196. * Get the disabled UserNotification types
3197. *
3198. * @return array
3199. */
3200. public function getDisabledNotifications()
3201. {
3202. return $this->disabled_notifications ?: [];
3203. }
3205. /**
3206. * @param array $disabled_notifications
3207. *
3208. * @return Project
3209. */
3210. public function setDisabledNotifications($disabled_notifications): Project
3211. {
3212. $this->disabled_notifications = $disabled_notifications;
3214. return $this;
3215. }
3217. /**
3218. * Disable a notification
3219. *
3220. * @param $notification_type
3221. *
3222. * @return Project
3223. */
3224. public function disableNotification($notification_type): Project
3225. {
3226. $this->disabled_notifications[] = $notification_type;
3228. return $this;
3229. }
3231. /**
3232. * Function to determine if the specific UserNotification is disabled for this Entity
3233. *
3234. * @param $notification_type
3235. *
3236. * @return bool
3237. */
3238. public function isNotificationDisabled($notification_type)
3239. {
3240. if (!$this->disabled_notifications || count($this->disabled_notifications) == 0) {
3241. return false;
3242. }
3243. return in_array($notification_type, $this->disabled_notifications) ? true : false;
3244. }
3246. /**
3247. * Add sortingSession
3248. *
3249. * @param SortingSession $sortingSession
3250. *
3251. * @return Project
3252. */
3253. public function addSortingSession(SortingSession $sortingSession)
3254. {
3255. $this->sortingSessions[] = $sortingSession;
3257. return $this;
3258. }
3260. /**
3261. * Remove sortingSession
3262. *
3263. * @param SortingSession $sortingSession
3264. */
3265. public function removeSortingSession(SortingSession $sortingSession)
3266. {
3267. $this->sortingSessions->removeElement($sortingSession);
3268. }
3270. /**
3271. * Get sortingSessions
3272. *
3273. * @return DoctrineCollection|SortingSession[]
3274. */
3275. public function getSortingSessions()
3276. {
3277. return $this->sortingSessions;
3278. }
3280. /**
3281. * Get completedSortingSessions
3282. *
3283. * @return ArrayCollection|DoctrineCollection|Collection
3284. */
3285. public function getCompletedSortingSessions()
3286. {
3287. return $this->getSortingSessions()->filter(
3288. function ($sortingSession) {
3289. return $sortingSession->hasBeenCompleted();
3290. }
3291. );
3292. }
3294. /**
3295. * @return bool
3296. */
3297. public function hasIncompleteSortingSessions(): bool
3298. {
3299. foreach ($this->getSortingSessions() as $sortingSession) {
3300. if (!$sortingSession->hasBeenCompleted() && !$sortingSession->isSortStatusDownloaded()) {
3301. return true;
3302. }
3303. }
3305. return false;
3306. }
3308. /**
3309. * Returns true if there are any incomplete serviceables on the project.
3310. * This is used to block a project from being archived or deleted when work is still on-going.
3311. *
3312. * @return bool
3313. */
3314. public function hasIncompleteServiceables(): bool
3315. {
3316. foreach ($this->getRecordsRequests() as $recordsRequest) {
3317. $incompleteStatuses = [
3318. ServiceRequest::STATUS_IN_PROGRESS,
3319. ServiceRequest::STATUS_ON_HOLD,
3320. ];
3321. if ($recordsRequest->getServiceRequest() && in_array($recordsRequest->getServiceRequest()->getStatus(), $incompleteStatuses)) {
3322. return true;
3323. }
3324. }
3326. foreach ($this->getBatchRequests() as $batchRequest) {
3327. $incompleteStatuses = [
3328. ServiceRequest::STATUS_IN_PROGRESS,
3329. ServiceRequest::STATUS_AWAITING_RECORDS,
3330. ServiceRequest::STATUS_ON_HOLD,
3331. ];
3332. if ($batchRequest->getServiceRequest() && in_array($batchRequest->getServiceRequest()->getStatus(), $incompleteStatuses)) {
3333. return true;
3334. }
3335. }
3337. foreach ($this->getChronologyRequests() as $chronologyRequest) {
3338. $incompleteStatuses = [
3339. ServiceRequest::STATUS_INSTRUCTED,
3340. ServiceRequest::STATUS_IN_PROGRESS,
3341. ServiceRequest::STATUS_ON_HOLD,
3342. ];
3343. if ($chronologyRequest->getServiceRequest() && in_array($chronologyRequest->getServiceRequest()->getStatus(), $incompleteStatuses)) {
3344. return true;
3345. }
3346. }
3348. foreach ($this->getAdditionalRequests() as $additionalRequest) {
3349. $incompleteStatuses = [
3350. ServiceRequest::STATUS_IN_PROGRESS,
3351. ServiceRequest::STATUS_ON_HOLD,
3352. ];
3353. if ($additionalRequest->getServiceRequest() && in_array($additionalRequest->getServiceRequest()->getStatus(), $incompleteStatuses)) {
3354. return true;
3355. }
3356. }
3358. // Finally, we check if there are incomplete sorting sessions.
3359. return $this->hasIncompleteSortingSessions();
3360. }
3362. /**
3363. * Add matterNote
3364. *
3365. * @param MatterNote $matterNote
3366. *
3367. * @return Project
3368. */
3369. public function addMatterNote(MatterNote $matterNote)
3370. {
3371. $this->matterNotes[] = $matterNote;
3372. $matterNote->setProject($this);
3374. return $this;
3375. }
3377. /**
3378. * Remove matterNote
3379. *
3380. * @param MatterNote $matterNote
3381. */
3382. public function removeMatterNote(MatterNote $matterNote)
3383. {
3384. $this->matterNotes->removeElement($matterNote);
3385. }
3387. /**
3388. * Get matterNotes
3389. *
3390. * @return DoctrineCollection|MatterNote[]
3391. */
3392. public function getMatterNotes()
3393. {
3394. return $this->matterNotes;
3395. }
3397. /**
3398. * @return array
3399. */
3400. public function getNoteCounts(): array
3401. {
3402. $noteCounts = [];
3404. foreach ($this->getMatterNotes() as $note) {
3405. if (!isset($noteCounts[$note->getType()])) {
3406. $noteCounts[$note->getType()] = 0;
3407. }
3408. $noteCounts[$note->getType()]++;
3409. }
3411. return $noteCounts;
3412. }
3414. /**
3415. * Set unsortedRecordsCollection.
3416. *
3417. * @param Collection|null $unsortedRecordsCollection
3418. *
3419. * @return Project
3420. */
3421. public function setUnsortedRecordsCollection(?Collection $unsortedRecordsCollection = null)
3422. {
3423. $this->unsortedRecordsCollection = $unsortedRecordsCollection;
3425. return $this;
3426. }
3428. /**
3429. * Set requirePasswordOnDownload.
3430. *
3431. * @param bool $requirePasswordOnDownload
3432. *
3433. * @return Project
3434. */
3435. public function setRequirePasswordOnDownload($requirePasswordOnDownload)
3436. {
3437. $this->require_password_on_download = $requirePasswordOnDownload;
3439. return $this;
3440. }
3442. /**
3443. * Get unsortedRecordsCollection.
3444. *
3445. * @return Collection|null
3446. */
3447. public function getUnsortedRecordsCollection()
3448. {
3449. return $this->unsortedRecordsCollection;
3450. }
3452. /**
3453. * Get requirePasswordOnDownload.
3454. *
3455. * @return bool
3456. */
3457. public function getRequirePasswordOnDownload()
3458. {
3459. return $this->require_password_on_download;
3460. }
3462. /**
3463. * Set inviteUserMustAuthenticate.
3464. *
3465. * @param bool $inviteUserMustAuthenticate
3466. *
3467. * @return Project
3468. */
3469. public function setInviteUserMustAuthenticate($inviteUserMustAuthenticate)
3470. {
3471. $this->inviteUserMustAuthenticate = $inviteUserMustAuthenticate;
3473. return $this;
3474. }
3476. /**
3477. * Get inviteUserMustAuthenticate.
3478. *
3479. * @return bool
3480. */
3481. public function getInviteUserMustAuthenticate()
3482. {
3483. return $this->inviteUserMustAuthenticate;
3484. }
3486. /**
3487. * Set inviteUserPassword.
3488. *
3489. * @param string $inviteUserPassword
3490. *
3491. * @return Project
3492. */
3493. public function setInviteUserPassword($inviteUserPassword)
3494. {
3495. $this->inviteUserPassword = $inviteUserPassword;
3497. return $this;
3498. }
3500. /**
3501. * Get inviteUserPassword.
3502. *
3503. * @return string
3504. */
3505. public function getInviteUserPassword()
3506. {
3507. return $this->inviteUserPassword;
3508. }
3510. /**
3511. * Set inviteUserContactName.
3512. *
3513. * @param string|null $inviteUserContactName
3514. *
3515. * @return Project
3516. */
3517. public function setInviteUserContactName($inviteUserContactName = null)
3518. {
3519. $this->inviteUserContactName = $inviteUserContactName;
3521. return $this;
3522. }
3524. /**
3525. * Get inviteUserContactName.
3526. *
3527. * @return string|null
3528. */
3529. public function getInviteUserContactName()
3530. {
3531. return $this->inviteUserContactName;
3532. }
3534. /**
3535. * Set inviteUserContactEmail.
3536. *
3537. * @param string|null $inviteUserContactEmail
3538. *
3539. * @return Project
3540. */
3541. public function setInviteUserContactEmail($inviteUserContactEmail = null)
3542. {
3543. $this->inviteUserContactEmail = $inviteUserContactEmail;
3545. return $this;
3546. }
3548. /**
3549. * Get inviteUserContactEmail.
3550. *
3551. * @return string|null
3552. */
3553. public function getInviteUserContactEmail()
3554. {
3555. return $this->inviteUserContactEmail;
3556. }
3558. /**
3559. * Set inviteUserContactPhoneNumber.
3560. *
3561. * @param string|null $inviteUserContactPhoneNumber
3562. *
3563. * @return Project
3564. */
3565. public function setInviteUserContactPhoneNumber($inviteUserContactPhoneNumber = null)
3566. {
3567. $this->inviteUserContactPhoneNumber = $inviteUserContactPhoneNumber;
3569. return $this;
3570. }
3572. /**
3573. * Get inviteUserContactPhoneNumber.
3574. *
3575. * @return string|null
3576. */
3577. public function getInviteUserContactPhoneNumber()
3578. {
3579. return $this->inviteUserContactPhoneNumber;
3580. }
3582. /**
3583. * Tells if the contact type is Email.
3584. *
3585. * @return bool
3586. */
3587. public function isInviteUserContactTypeEmail()
3588. {
3589. return !is_null($this->getInviteUserContactEmail());
3590. }
3592. /**
3593. * Tells if the contact type is Phone.
3594. *
3595. * @return bool
3596. */
3597. public function isInviteUserContactTypePhone()
3598. {
3599. return !is_null($this->getInviteUserContactPhoneNumber());
3600. }
3602. /**
3603. * Set dateOnLetter.
3604. *
3605. * @param DateTime|null $dateOnLetter
3606. *
3607. * @return Project
3608. */
3609. public function setDateOnLetter($dateOnLetter = null)
3610. {
3611. $this->date_on_letter = $dateOnLetter;
3613. return $this;
3614. }
3616. /**
3617. * Get dateOnLetter.
3618. *
3619. * @return DateTime|null
3620. */
3621. public function getDateOnLetter()
3622. {
3623. return $this->date_on_letter;
3624. }
3626. /**
3627. * Set caseMeritsAnalysis.
3628. *
3629. * @param string|null $caseMeritsAnalysis
3630. *
3631. * @return Project
3632. */
3633. public function setCaseMeritsAnalysis($caseMeritsAnalysis = null)
3634. {
3635. $this->case_merits_analysis = $caseMeritsAnalysis;
3637. return $this;
3638. }
3640. /**
3641. * Get caseMeritsAnalysis.
3642. *
3643. * @return string|null
3644. */
3645. public function getCaseMeritsAnalysis()
3646. {
3647. return $this->case_merits_analysis;
3648. }
3650. /**
3651. * Returns an array of permitted values for the case_merits_analysis field and their
3652. * associated labels.
3653. *
3654. * @return array
3655. */
3656. public static function getCaseMeritsAnalysisOptions()
3657. {
3658. return [
3659. self::CASE_MERITS_ANALYSIS_SUPPORTIVE => 'Supportive',
3660. self::CASE_MERITS_ANALYSIS_UNSUPPORTIVE => 'Unsupportive',
3661. self::CASE_MERITS_ANALYSIS_INCONCLUSIVE => 'Inconclusive',
3662. ];
3663. }
3665. /**
3666. * Returns a human-readable version of the case_merits_analysis
3667. *
3668. * @return string
3669. */
3670. public function getCaseMeritsAnalysisName()
3671. {
3672. $options = self::getCaseMeritsAnalysisOptions();
3674. return
3675. $options[$this->getCaseMeritsAnalysis()] ?? $this->getCaseMeritsAnalysis();
3676. }
3678. /**
3679. * Set claimantSolicitor.
3680. *
3681. * @param string|null $claimantSolicitor
3682. *
3683. * @return Project
3684. */
3685. public function setClaimantSolicitor($claimantSolicitor = null)
3686. {
3687. $this->claimant_solicitor = $claimantSolicitor;
3689. return $this;
3690. }
3692. /**
3693. * Get claimantSolicitor.
3694. *
3695. * @return string|null
3696. */
3697. public function getClaimantSolicitor()
3698. {
3699. return $this->claimant_solicitor;
3700. }
3702. /**
3703. * Set typeOfLetter.
3704. *
3705. * @param string|null $typeOfLetter
3706. *
3707. * @return Project
3708. */
3709. public function setTypeOfLetter($typeOfLetter = null)
3710. {
3711. $this->type_of_letter = $typeOfLetter;
3713. return $this;
3714. }
3716. /**
3717. * Get typeOfLetter.
3718. *
3719. * @return string|null
3720. */
3721. public function getTypeOfLetter()
3722. {
3723. return $this->type_of_letter;
3724. }
3726. /**
3727. * Returns an array of permitted values for the type_of_letter field and their
3728. * associated labels.
3729. *
3730. * @return array
3731. */
3732. public static function getTypeOfLetterOptions()
3733. {
3734. return [
3735. self::TYPE_OF_LETTER_LETTER_OF_CLAIM => 'Letter of claim',
3736. self::TYPE_OF_LETTER_LETTER_OF_NOTIFICATION => 'Letter of notification',
3737. self::TYPE_OF_LETTER_SUBJECT_ACCESS_REQUEST => 'Subject access request',
3738. self::TYPE_OF_LETTER_DISCLOSURE_APPLICATION => 'Disclosure application',
3739. ];
3740. }
3742. /**
3743. * Returns a human-readable version of the type_of_letter
3744. *
3745. * @return string
3746. */
3747. public function getTypeOfLetterName()
3748. {
3749. $options = self::getTypeOfLetterOptions();
3751. return
3752. $options[$this->getTypeOfLetter()] ?? $this->getTypeOfLetter();
3753. }
3755. /**
3756. * Set reviewType.
3757. *
3758. * @param string|null $reviewType
3759. *
3760. * @return Project
3761. */
3762. public function setReviewType($reviewType = null)
3763. {
3764. $this->review_type = $reviewType;
3766. return $this;
3767. }
3769. /**
3770. * Get reviewType.
3771. *
3772. * @return string|null
3773. */
3774. public function getReviewType()
3775. {
3776. return $this->review_type;
3777. }
3779. /**
3780. * Returns an array of permitted values for the review_type field and their
3781. * associated labels.
3782. *
3783. * @return array
3784. */
3785. public static function getReviewTypeOptions()
3786. {
3787. return [
3788. self::REVIEW_TYPE_CASE_MERITS_ANALYSIS => 'Case merits analysis',
3789. self::REVIEW_TYPE_CHRONOLOGY => 'Chronology',
3790. ];
3791. }
3793. /**
3794. * Returns a human-readable version of the review_type
3795. *
3796. * @return string
3797. */
3798. public function getReviewTypeName()
3799. {
3800. $options = self::getReviewTypeOptions();
3802. return
3803. $options[$this->getReviewType()] ?? $this->getReviewType();
3804. }
3806. /**
3807. * Set expertsReportDate.
3808. *
3809. * @param DateTime|null $expertsReportDate
3810. *
3811. * @return Project
3812. */
3813. public function setExpertsReportDate($expertsReportDate = null)
3814. {
3815. $this->experts_report_date = $expertsReportDate;
3817. return $this;
3818. }
3820. /**
3821. * Get expertsReportDate.
3822. *
3823. * @return DateTime|null
3824. */
3825. public function getExpertsReportDate()
3826. {
3827. return $this->experts_report_date;
3828. }
3830. /**
3831. * Set letterOfResponseAndExpertReportDate.
3832. *
3833. * @param DateTime|null $letterOfResponseAndExpertReportDate
3834. *
3835. * @return Project
3836. */
3837. public function setLetterOfResponseAndExpertReportDate($letterOfResponseAndExpertReportDate = null)
3838. {
3839. $this->letter_of_response_and_expert_report_date = $letterOfResponseAndExpertReportDate;
3841. return $this;
3842. }
3844. /**
3845. * Get letterOfResponseAndExpertReportDate.
3846. *
3847. * @return DateTime|null
3848. */
3849. public function getLetterOfResponseAndExpertReportDate()
3850. {
3851. return $this->letter_of_response_and_expert_report_date;
3852. }
3854. /**
3855. * Set letterOfResponsePreparedDate.
3856. *
3857. * @param DateTime|null $letterOfResponsePreparedDate
3858. *
3859. * @return Project
3860. */
3861. public function setLetterOfResponsePreparedDate($letterOfResponsePreparedDate = null)
3862. {
3863. $this->letter_of_response_prepared_date = $letterOfResponsePreparedDate;
3865. return $this;
3866. }
3868. /**
3869. * Get letterOfResponsePreparedDate.
3870. *
3871. * @return DateTime|null
3872. */
3873. public function getLetterOfResponsePreparedDate()
3874. {
3875. return $this->letter_of_response_prepared_date;
3876. }
3878. /**
3879. * Set letterOfResponseSentDate.
3880. *
3881. * @param DateTime|null $letterOfResponseSentDate
3882. *
3883. * @return Project
3884. */
3885. public function setLetterOfResponseSentDate($letterOfResponseSentDate = null)
3886. {
3887. $this->letter_of_response_sent_date = $letterOfResponseSentDate;
3889. return $this;
3890. }
3892. /**
3893. * Get letterOfResponseSentDate.
3894. *
3895. * @return DateTime|null
3896. */
3897. public function getLetterOfResponseSentDate()
3898. {
3899. return $this->letter_of_response_sent_date;
3900. }
3902. public static function loadValidatorMetadata(ClassMetadata $metadata)
3903. {
3904. $metadata->addConstraint(new Assert\Callback('validate'));
3905. }
3907. public function validate(ExecutionContextInterface $context, $payload)
3908. {
3909. if ($this->getInviteUserMustAuthenticate()) {
3910. $password = $this->getinviteUserPassword();
3911. // If the password has not already been set, validate the plainPassword.
3912. if (is_null($password)) {
3913. $plainPassword = $this->getinviteUserPlainPassword();
3914. $constraints = [
3915. new Assert\Regex([
3916. 'pattern' => '/(?=.*[A-Z])(?=.*[a-z])(?=.*[0-9])(?=.*[\d])(?=.*[\W]).{8,}/',
3917. 'message' => 'Please ensure you use a strong password of at least 8 characters, including at least one each of the following: lowercase, uppercase, number, symbol.',
3918. ]),
3919. new Assert\NotBlank([]),
3920. new Assert\Length([
3921. 'min' => 8,
3922. 'max' => 255,
3923. 'minMessage' => 'Your password must have at least {{ limit }} characters.',
3924. 'maxMessage' => 'The password is too long.',
3925. ]),
3926. ];
3927. $validator = Validation::createValidator();
3928. foreach ($constraints as $constraint) {
3929. $errors = $validator->validate(
3930. $plainPassword,
3931. $constraint
3932. );
3933. if (0 !== count($errors)) {
3934. $errorMessage = $errors[0]->getMessage();
3935. $context->buildViolation($errorMessage)
3936. ->atPath('inviteUserPlainPassword')
3937. ->addViolation()
3938. ;
3939. }
3940. }
3941. }
3942. if (is_null($this->getInviteUserContactName())) {
3943. $errorMessage = 'Contact name required.';
3944. $context->buildViolation($errorMessage)
3945. ->atPath('inviteUserContactName')
3946. ->addViolation()
3947. ;
3948. }
3949. if (is_null($this->getInviteUserContactEmail())
3950. && is_null($this->getInviteUserContactPhoneNumber())
3951. ) {
3952. $errorMessage = 'Contact email address or phone number required.';
3953. $context->buildViolation($errorMessage)
3954. ->atPath('inviteUserContactEmail')
3955. ->addViolation()
3956. ;
3957. $context->buildViolation($errorMessage)
3958. ->atPath('inviteUserContactPhoneNumber')
3959. ->addViolation()
3960. ;
3961. }
3962. }
3963. }
3965. /**
3966. * Set matterRequest.
3967. *
3968. * @param MatterRequest|null $matterRequest
3969. *
3970. * @return Project
3971. */
3972. public function setMatterRequest(?MatterRequest $matterRequest = null)
3973. {
3974. $this->matterRequest = $matterRequest;
3976. return $this;
3977. }
3979. /**
3980. * Get matterRequest.
3981. *
3982. * @return MatterRequest|null
3983. */
3984. public function getMatterRequest()
3985. {
3986. return $this->matterRequest;
3987. }
3989. /**
3990. * Returns a radiology schedule array grouped by study of all related radiology on a project.
3991. *
3992. * @return array
3993. */
3994. public function getRadiologyScheduleArray()
3995. {
3996. $data = [];
3997. $serieses = $this->getSeries();
3999. /** @var Series $series */
4000. foreach ($serieses as $series) {
4001. // Grab the Study this Series is in
4002. $study = $series->getStudy();
4003. if ($study) {
4004. // Having named keys here isn't really necessary but we might want them later for something
4005. // If we have Discs, we can fill out the `source` and `number` fields
4006. $data[$study->getId()] = [
4007. 'id' => $study->getId(),
4008. 'matter' => $this->getClientReference(),
4009. 'patient' => $study->getPatient()->getDicomPatientName(),
4010. 'date' => $study->getStudyDate(),
4011. 'description' => $study->getStudyDescription(),
4012. 'centre' => $study->getStudyInstituteName(),
4013. 'discs' => $study->getDiscs(),
4014. 'longDescription' => $study->__toString(),
4015. ];
4016. }
4017. }
4019. usort($data, function ($a, $b) {
4020. return strcmp($a['longDescription'], $b['longDescription']);
4021. });
4023. return $data;
4024. }
4026. /**
4027. * Add matterCommunication.
4028. *
4029. * @param MatterCommunication $matterCommunication
4030. *
4031. * @return Project
4032. */
4033. public function addMatterCommunication(MatterCommunication $matterCommunication)
4034. {
4035. $this->matterCommunications[] = $matterCommunication;
4037. return $this;
4038. }
4040. /**
4041. * Remove matterCommunication.
4042. *
4043. * @param MatterCommunication $matterCommunication
4044. *
4045. * @return bool TRUE if this collection contained the specified element, FALSE otherwise.
4046. */
4047. public function removeMatterCommunication(MatterCommunication $matterCommunication)
4048. {
4049. return $this->matterCommunications->removeElement($matterCommunication);
4050. }
4052. /**
4053. * Get matterCommunications.
4054. *
4055. * @return DoctrineCollection|MatterCommunication[]
4056. */
4057. public function getMatterCommunications()
4058. {
4059. return $this->matterCommunications;
4060. }
4062. /**
4063. * Set deleteStatus
4064. *
4065. * @param int $deleteStatus
4066. *
4067. * @return Project
4068. */
4069. public function setDeleteStatus(?int $deleteStatus = null)
4070. {
4071. if ($this->deleteStatus !== $deleteStatus) {
4072. $this->setDeleteStatusUpdated(new DateTime());
4073. }
4074. $this->deleteStatus = $deleteStatus;
4076. return $this;
4077. }
4079. /**
4080. * Get deleteStatus
4081. *
4082. * @return int
4083. */
4084. public function getDeleteStatus()
4085. {
4086. return $this->deleteStatus;
4087. }
4089. /**
4090. * Return true if deletestatus is equal to the constants below
4091. *
4092. * @return bool
4093. */
4094. public function hasDeleteStatus()
4095. {
4096. $statuses = [
4097. self::DELETE_STATUS_PENDING,
4098. self::DELETE_STATUS_REMINDER_SENT,
4099. self::DELETE_STATUS_PROCESSING,
4100. self::DELETE_STATUS_COMPLETE,
4102. ];
4104. return in_array($this->getDeleteStatus(), $statuses);
4105. }
4107. /**
4108. * Set deleteStatusUpdated
4109. *
4110. * @param DateTime $deleteStatusUpdated
4111. *
4112. * @return Project
4113. */
4114. public function setDeleteStatusUpdated(?DateTime $deleteStatusUpdated = null)
4115. {
4116. $this->deleteStatusUpdated = $deleteStatusUpdated;
4118. return $this;
4119. }
4121. /**
4122. * Get deleteStatusUpdated
4123. *
4124. * @return DateTime
4125. */
4126. public function getDeleteStatusUpdated()
4127. {
4128. return $this->deleteStatusUpdated;
4129. }
4131. /**
4132. * Get archiveStatus as Label
4133. *
4134. * @return string
4135. */
4136. public function getArchiveStatusLabel()
4137. {
4138. $archiveStatusOptions = array_flip(static::getConstantsWithLabelsAsChoices('ARCHIVE_STATUS'));
4140. return $archiveStatusOptions[$this->getArchiveStatus()] ?? '';
4141. }
4143. /**
4144. * @return array
4145. */
4146. public static function getArchiveStatusChoices()
4147. {
4148. return static::getConstantsWithLabelsAsChoices('ARCHIVE_STATUS');
4149. }
4151. /**
4152. * @return array
4153. */
4154. public static function getDeleteStatusChoices()
4155. {
4156. return static::getConstantsWithLabelsAsChoices('DELETE_STATUS');
4157. }
4159. /**
4160. * Return true if matter is in the process of being deleted/archived, or is deleted or archived
4161. *
4162. * @return bool
4163. */
4164. public function isCloseInProgressOrComplete()
4165. {
4166. $archiveStatuses = [
4167. self::ARCHIVE_STATUS_PENDING,
4168. self::ARCHIVE_STATUS_PROCESSING,
4169. self::ARCHIVE_STATUS_UNARCHIVE_PROCESSING,
4170. self::ARCHIVE_STATUS_COMPLETE,
4171. ];
4173. $deleteStatuses = [
4174. self::DELETE_STATUS_PENDING,
4175. self::DELETE_STATUS_REMINDER_SENT,
4176. self::DELETE_STATUS_PROCESSING,
4177. self::DELETE_STATUS_COMPLETE,
4178. self::DELETE_STATUS_DELETE_FAILED,
4179. self::DELETE_STATUS_ANONYMISE_FAILED,
4180. ];
4182. return in_array($this->getArchiveStatus(), $archiveStatuses, true) || in_array($this->getDeleteStatus(), $deleteStatuses, true);
4183. }
4185. /**
4186. * Return true if project status is active
4187. *
4188. * @return bool
4189. */
4190. public function isStatusActive()
4191. {
4192. return $this->getStatus() === self::STATUS_ACTIVE;
4193. }
4195. /**
4196. * Return true if project archive status is pending
4197. *
4198. * @return bool
4199. */
4200. public function isArchiveStatusPending()
4201. {
4202. return $this->getArchiveStatus() === self::ARCHIVE_STATUS_PENDING;
4203. }
4205. /**
4206. * Return true if project archive status is processing
4207. *
4208. * @return bool
4209. */
4210. public function isArchiveStatusProcessing()
4211. {
4212. return $this->getArchiveStatus() === self::ARCHIVE_STATUS_PROCESSING;
4213. }
4215. /**
4216. * Return true if project archive status is complete
4217. *
4218. * @return bool
4219. */
4220. public function isArchiveStatusComplete()
4221. {
4222. return $this->getArchiveStatus() === self::ARCHIVE_STATUS_COMPLETE;
4223. }
4225. /**
4226. * Return true if project archive status is unarchive in process
4227. *
4228. * @return bool
4229. */
4230. public function isArchiveStatusUnarchiveProcessing()
4231. {
4232. return $this->getArchiveStatus() === self::ARCHIVE_STATUS_UNARCHIVE_PROCESSING;
4233. }
4235. /**
4236. * Return true if matter is in the process of being deleted/archived
4237. *
4238. * @return bool
4239. */
4240. public function isQueuedForArchiveOrDeletion(): bool
4241. {
4242. $archiveStatuses = [
4243. self::ARCHIVE_STATUS_PENDING,
4244. self::ARCHIVE_STATUS_PROCESSING,
4245. self::ARCHIVE_STATUS_UNARCHIVE_PROCESSING,
4246. ];
4248. $deleteStatuses = [
4249. self::DELETE_STATUS_PENDING,
4250. self::DELETE_STATUS_REMINDER_SENT,
4251. self::DELETE_STATUS_PROCESSING,
4252. ];
4254. return in_array($this->getArchiveStatus(), $archiveStatuses, true) || in_array($this->getDeleteStatus(), $deleteStatuses, true);
4255. }
4257. /**
4258. * Return true if archive status is equal to the constants below
4259. *
4260. * @return bool
4261. */
4262. public function hasArchiveStatus(): bool
4263. {
4264. $statuses = [
4265. self::ARCHIVE_STATUS_PENDING,
4266. self::ARCHIVE_STATUS_PROCESSING,
4267. self::ARCHIVE_STATUS_COMPLETE,
4268. self::ARCHIVE_STATUS_UNARCHIVE_PROCESSING,
4269. ];
4271. return in_array($this->getArchiveStatus(), $statuses);
4272. }
4274. /**
4275. * Get deleteStatus as Label
4276. *
4277. * @return string
4278. */
4279. public function getDeleteStatusLabel()
4280. {
4281. $deleteStatusOptions = array_flip(static::getConstantsWithLabelsAsChoices('DELETE_STATUS'));
4283. return $deleteStatusOptions[$this->getDeleteStatus()] ?? '';
4284. }
4286. /**
4287. * Return true if project delete status is pending
4288. *
4289. * @return bool
4290. */
4291. public function isDeleteStatusPending()
4292. {
4293. return $this->getDeleteStatus() === self::DELETE_STATUS_PENDING;
4294. }
4296. /**
4297. * Return true if project delete status is pending immediate deletion.
4298. *
4299. * @return bool
4300. */
4301. public function isDeleteStatusPendingImmediate()
4302. {
4303. return $this->getDeleteStatus() === self::DELETE_STATUS_PENDING_IMMEDIATE;
4304. }
4306. /**
4307. * Return true if project delete status is reminder sent
4308. *
4309. * @return bool
4310. */
4311. public function isDeleteStatusReminderSent()
4312. {
4313. return $this->getDeleteStatus() === self::DELETE_STATUS_REMINDER_SENT;
4314. }
4316. /**
4317. * Return true if project delete status is processing
4318. *
4319. * @return bool
4320. */
4321. public function isDeleteStatusProcessing()
4322. {
4323. return $this->getDeleteStatus() === self::DELETE_STATUS_PROCESSING;
4324. }
4326. /**
4327. * Return true if project delete status is complete
4328. *
4329. * @return bool
4330. */
4331. public function isDeleteStatusComplete()
4332. {
4333. return $this->getDeleteStatus() === self::DELETE_STATUS_COMPLETE;
4334. }
4336. /**
4337. * Return true if project delete status is failed
4338. *
4339. * @return bool
4340. */
4341. public function isDeleteStatusFailed()
4342. {
4343. return $this->getDeleteStatus() === self::DELETE_STATUS_DELETE_FAILED;
4344. }
4346. /**
4347. * Return true if the Project can be deleted.
4348. *
4349. * @return bool
4350. */
4351. public function canBeDeleted(): bool
4352. {
4353. return $this->isDeleteStatusReminderSent() || $this->isDeleteStatusProcessing();
4354. }
4356. /**
4357. * Returns true if the project is queued for deletion.
4358. *
4359. * @return bool
4360. */
4361. public function isQueuedForDeletion(): bool
4362. {
4363. return $this->isDeleteStatusPending() || $this->isDeleteStatusReminderSent() || $this->isDeleteStatusPendingImmediate();
4364. }
4366. /**
4367. * Return true if matter is in the process of being deleted/archived, and is not in the queue to be closed
4368. *
4369. * @return bool
4370. */
4371. public function isCloseInProgress()
4372. {
4373. $archiveStatuses = [
4374. self::ARCHIVE_STATUS_PROCESSING,
4375. self::ARCHIVE_STATUS_UNARCHIVE_PROCESSING,
4376. ];
4378. $deleteStatuses = [
4379. self::DELETE_STATUS_PROCESSING,
4380. ];
4382. return in_array($this->getArchiveStatus(), $archiveStatuses, true) || in_array($this->getDeleteStatus(), $deleteStatuses, true);
4383. }
4385. /**
4386. * Return true if matter deletion is complete
4387. *
4388. * @return bool
4389. */
4390. public function isDeleteComplete()
4391. {
4392. return $this->getDeleteStatus() === self::DELETE_STATUS_COMPLETE;
4393. }
4395. /**
4396. * Returns the User that requested the deletion.
4397. *
4398. * @return User
4399. */
4400. public function getDeletionRequestedBy(): ?User
4401. {
4402. return $this->getProjectClosure() ? $this->getProjectClosure()->getClosedBy() : null;
4403. }
4405. /**
4406. * getAllowExpertViewUnsortedRecords
4407. *
4408. * @return bool
4409. */
4410. public function getAllowExpertViewUnsortedRecords(): ?bool
4411. {
4412. return $this->allowExpertViewUnsortedRecords;
4413. }
4415. /**
4416. * setAllowExpertViewUnsortedRecords
4417. *
4418. * @param bool $allowExpertViewUnsortedRecords
4419. *
4420. * @return self
4421. */
4422. public function setAllowExpertViewUnsortedRecords(?bool $allowExpertViewUnsortedRecords = null): self
4423. {
4424. $this->allowExpertViewUnsortedRecords = $allowExpertViewUnsortedRecords;
4426. return $this;
4427. }
4429. /**
4430. * Get the value of dateDeleted
4431. *
4432. * @return DateTime
4433. */
4434. public function getDateDeleted()
4435. {
4436. return $this->dateDeleted;
4437. }
4439. /**
4440. * Set the value of dateDeleted
4441. *
4442. * @param DateTime|null $dateDeleted
4443. *
4444. * @return self
4445. */
4446. public function setDateDeleted(?DateTime $dateDeleted)
4447. {
4448. $this->dateDeleted = $dateDeleted;
4450. return $this;
4451. }
4453. /**
4454. * Get the value of projectDeletionReport
4455. */
4456. public function getProjectDeletionReport()
4457. {
4458. return $this->projectDeletionReport;
4459. }
4461. /**
4462. * Set the value of projectDeletionReport
4463. *
4464. * @param ProjectDeletionReport|null $projectDeletionReport
4465. *
4466. * @return self
4467. */
4468. public function setProjectDeletionReport(?ProjectDeletionReport $projectDeletionReport)
4469. {
4470. $this->projectDeletionReport = $projectDeletionReport;
4472. return $this;
4473. }
4475. /**
4476. * Transforms matter Request entity into a usable array structure
4477. *
4478. * @return array
4479. */
4480. public function getDeletionSummaryArray(): array
4481. {
4482. $deletionReport = $this->getProjectDeletionReport();
4484. if ($deletionReport === null) {
4485. throw new Exception('Project deletion report has not been stored.');
4486. }
4488. return [
4489. 'project' => $this,
4490. 'patientDob' => $deletionReport->getPatientDateOfBirth(),
4491. 'userWhoCompletedClosureWizard' => $this->getDeletionRequestedBy() ? $this->getDeletionRequestedBy()->getFullName() : '',
4492. 'dateDeletionCompleted' => $deletionReport->getCreated(),
4493. 'documents' => $deletionReport->getDocuments(),
4494. ];
4495. }
4497. /**
4498. * Sets the project delete status to failed.
4499. *
4500. * @return self
4501. */
4502. public function setDeleteStatusFailed(): self
4503. {
4504. $this->setDeleteStatus(self::DELETE_STATUS_DELETE_FAILED);
4506. return $this;
4507. }
4509. /**
4510. * Sets the project delete status to anonymise failed.
4511. *
4512. * @return self
4513. */
4514. public function setDeleteStatusAnonymiseFailed(): self
4515. {
4516. $this->setDeleteStatus(self::DELETE_STATUS_ANONYMISE_FAILED);
4518. return $this;
4519. }
4521. /**
4522. * Sets the project delete status to complete.
4523. *
4524. * @return self
4525. */
4526. public function setDeleteStatusComplete(): self
4527. {
4528. $this->setDeleteStatus(self::DELETE_STATUS_COMPLETE);
4530. return $this;
4531. }
4533. /**
4534. * Sets the project delete status to complete.
4535. *
4536. * @return self
4537. */
4538. public function setDeleteStatusProcessing(): self
4539. {
4540. $this->setDeleteStatus(self::DELETE_STATUS_PROCESSING);
4542. return $this;
4543. }
4545. /**
4546. * @return ProjectClosure|null
4547. */
4548. public function getProjectClosure(): ?ProjectClosure
4549. {
4550. return $this->projectClosure;
4551. }
4553. /**
4554. * @param ProjectClosure|null $projectClosure
4555. *
4556. * @return self
4557. */
4558. public function setProjectClosure(?ProjectClosure $projectClosure): self
4559. {
4560. // unset the owning side of the relation if necessary
4561. if ($projectClosure === null && $this->projectClosure !== null) {
4562. $this->projectClosure->setProject(null);
4563. }
4565. // set the owning side of the relation if necessary
4566. if ($projectClosure !== null && $projectClosure->getProject() !== $this) {
4567. $projectClosure->setProject($this);
4568. }
4570. $this->projectClosure = $projectClosure;
4572. return $this;
4573. }
4575. /**
4576. * Returns all the root collections for a project. These are the root folders on the MedicalRecords page.
4577. *
4578. * @return Collection[]
4579. */
4580. public function getRootCollections(): array
4581. {
4582. $rootCollections = [];
4584. if ($this->getMedicalRecordsCollection()) {
4585. $rootCollections[] = $this->getMedicalRecordsCollection();
4586. }
4588. if ($this->getPrivateCollection()) {
4589. $rootCollections[] = $this->getPrivateCollection();
4590. }
4592. if ($this->getPrivateSandboxCollection()) {
4593. $rootCollections[] = $this->getPrivateSandboxCollection();
4594. }
4596. if ($this->getUnsortedRecordsCollection()) {
4597. $rootCollections[] = $this->getUnsortedRecordsCollection();
4598. }
4600. return $rootCollections;
4601. }
4603. /**
4604. * Return true if deleteStatus is PROCESSING or COMPLETE
4605. *
4606. * @return bool
4607. */
4608. public function isDeleteProcessingOrComplete()
4609. {
4610. $statuses = [
4611. self::DELETE_STATUS_PROCESSING,
4612. self::DELETE_STATUS_COMPLETE,
4613. ];
4615. return in_array($this->getDeleteStatus(), $statuses);
4616. }
4618. /**
4619. * @Groups({"project_closure:read"})
4620. *
4621. * @return bool
4622. */
4623. public function getClosureQuestionsOptional(): bool
4624. {
4625. return $this->getAccount()->getMatterClosureQuestionsOptional();
4626. }
4628. /**
4629. * @return string|null
4630. */
4631. public function getClosureStatusLabel(): ?string
4632. {
4633. if ($this->getArchiveStatus()) {
4634. return 'Archived';
4635. }
4636. if ($this->getDeleteStatus()) {
4637. return 'Deleted';
4638. }
4640. return null;
4641. }
4643. /**
4644. * @return string|null
4645. */
4646. public function getFirmRecordsReviewStatus(): ?string
4647. {
4648. return $this->firmRecordsReviewStatus;
4649. }
4651. /**
4652. * @param string|null $firmRecordsReviewStatus
4653. *
4654. * @return self
4655. */
4656. public function setFirmRecordsReviewStatus(?string $firmRecordsReviewStatus): self
4657. {
4658. if ($this->firmRecordsReviewStatus !== $firmRecordsReviewStatus) {
4659. $this->setFirmRecordsReviewUpdated(new DateTime());
4660. }
4662. $this->firmRecordsReviewStatus = $firmRecordsReviewStatus;
4664. return $this;
4665. }
4667. /**
4668. * @return array
4669. */
4670. public static function getFirmRecordsReviewStatusOptions(): array
4671. {
4672. return static::getConstantsWithLabelsAsChoices('FIRM_RECORDS_REVIEW_STATUS');
4673. }
4675. /**
4676. * @return string
4677. */
4678. public function getFirmRecordsReviewStatusLabel(): string
4679. {
4680. $options = array_flip($this->getFirmRecordsReviewStatusOptions());
4682. return $options[$this->firmRecordsReviewStatus] ?? '';
4683. }
4685. /**
4686. * @return bool
4687. */
4688. public function showFirmRecordsReviewAdditionalInstruction(): bool
4689. {
4690. $statuses = [
4691. self::FIRM_RECORDS_REVIEW_STATUS_AWAITING_RECORDS,
4692. self::FIRM_RECORDS_REVIEW_STATUS_UPLOADED,
4693. ];
4695. return in_array($this->getFirmRecordsReviewStatus(), $statuses);
4696. }
4698. /**
4699. * @return DateTimeInterface|null
4700. */
4701. public function getFirmRecordsReviewUpdated(): ?DateTimeInterface
4702. {
4703. return $this->firmRecordsReviewUpdated;
4704. }
4706. /**
4707. * @param DateTimeInterface|null $firmRecordsReviewUpdated
4708. *
4709. * @return self
4710. */
4711. public function setFirmRecordsReviewUpdated(?DateTimeInterface $firmRecordsReviewUpdated): self
4712. {
4713. $this->firmRecordsReviewUpdated = $firmRecordsReviewUpdated;
4715. return $this;
4716. }
4718. /**
4719. * @return string|null
4720. */
4721. public function getClinicalSummaryUnsortedStatus(): ?string
4722. {
4723. return $this->clinicalSummaryUnsortedStatus;
4724. }
4726. /**
4727. * @param string|null $clinicalSummaryUnsortedStatus
4728. *
4729. * @return self
4730. */
4731. public function setClinicalSummaryUnsortedStatus(?string $clinicalSummaryUnsortedStatus): self
4732. {
4733. if ($this->clinicalSummaryUnsortedStatus !== $clinicalSummaryUnsortedStatus) {
4734. $this->setClinicalSummaryUnsortedUpdated(new DateTime());
4735. }
4737. $this->clinicalSummaryUnsortedStatus = $clinicalSummaryUnsortedStatus;
4739. return $this;
4740. }
4742. /**
4743. * @return array
4744. */
4745. public static function getClinicalSummaryUnsortedStatusOptions(): array
4746. {
4747. return static::getConstantsWithLabelsAsChoices('CLINICAL_SUMMARY_UNSORTED_STATUS');
4748. }
4750. /**
4751. * @return string
4752. */
4753. public function getClinicalSummaryUnsortedStatusLabel(): string
4754. {
4755. $options = array_flip($this->getClinicalSummaryUnsortedStatusOptions());
4757. return $options[$this->clinicalSummaryUnsortedStatus] ?? '';
4758. }
4760. /**
4761. * @return DateTimeInterface|null
4762. */
4763. public function getClinicalSummaryUnsortedUpdated(): ?DateTimeInterface
4764. {
4765. return $this->clinicalSummaryUnsortedUpdated;
4766. }
4768. /**
4769. * @param DateTimeInterface|null $clinicalSummaryUnsortedUpdated
4770. *
4771. * @return self
4772. */
4773. public function setClinicalSummaryUnsortedUpdated(?DateTimeInterface $clinicalSummaryUnsortedUpdated): self
4774. {
4775. $this->clinicalSummaryUnsortedUpdated = $clinicalSummaryUnsortedUpdated;
4777. return $this;
4778. }
4780. /**
4781. * @return bool
4782. */
4783. public function showClinicalSummaryUnsortedAdditionalInstruction(): bool
4784. {
4785. $statuses = [
4786. self::CLINICAL_SUMMARY_UNSORTED_STATUS_AWAITING_CONCLUSION,
4787. self::CLINICAL_SUMMARY_UNSORTED_STATUS_INCONCLUSIVE,
4788. ];
4790. return in_array($this->getClinicalSummaryUnsortedStatus(), $statuses);
4791. }
4793. /**
4794. * @param Instance $instance
4795. *
4796. * @return $this
4797. */
4798. public function addInstance(Instance $instance): Project
4799. {
4800. if (!$this->instances->contains($instance)) {
4801. $this->instances[] = $instance;
4802. }
4804. return $this;
4805. }
4807. /**
4808. * @param Instance $instance
4809. *
4810. * @return $this
4811. */
4812. public function removeInstance(Instance $instance): Project
4813. {
4814. $this->instances->removeElement($instance);
4816. return $this;
4817. }
4819. /**
4820. * @return DoctrineCollection<int, InterpartyDisclosure>
4821. */
4822. public function getInterpartyDisclosures(): DoctrineCollection
4823. {
4824. return $this->interpartyDisclosures;
4825. }
4827. /**
4828. * This function name is no longer very descriptive as we include drafts that
4829. * were saved intentionally as drafts for review.
4830. *
4831. * @return DoctrineCollection<int, InterpartyDisclosure>
4832. */
4833. public function getNonDraftInterpartyDisclosures(): DoctrineCollection
4834. {
4835. return $this->interpartyDisclosures->filter(function (InterpartyDisclosure $disclosure) {
4836. return ($disclosure->isStatusDraft() === false || $disclosure->getSavedAsDraft() === true) && $disclosure->isCurrentHeadOfChain() === true;
4837. });
4838. }
4840. /**
4841. * Returns a unique array of matter numbers that have already been used as recipient firm
4842. * matter numbers for disclosures on this project.
4843. *
4844. * @param ?InterpartyDisclosure $excludeDisclosure - Optionally exclude a specific disclosure from the list.
4845. * @param bool $excludePreviousVersions
4846. *
4847. * @return array
4848. */
4849. public function getInterpartyDisclosureRecipientMatterNumbers(?InterpartyDisclosure $excludeDisclosure = null, bool $excludePreviousVersions = false): array
4850. {
4851. $matterNumbers = [];
4853. foreach ($this->getInterpartyDisclosures() as $disclosure) {
4854. if (
4855. $excludeDisclosure === $disclosure
4856. || ($excludePreviousVersions === true && $disclosure->isDisclosurePreviousVersionOf($excludeDisclosure))
4857. || $disclosure->isStatusDraft()
4858. || $disclosure->isStatusRevoked()
4859. || $disclosure->isStatusFailed()
4860. ) {
4861. continue;
4862. }
4864. foreach ($disclosure->getRecipientFirms() as $recipientFirm) {
4865. $matterNumbers[] = $recipientFirm->getMatterNumber();
4866. }
4867. }
4869. // Don't call array unique here as it messes with the keys of the array.
4870. return $matterNumbers;
4871. }
4873. /**
4874. * @return bool
4875. */
4876. public function hasActiveInterpartyDisclosures(): bool
4877. {
4878. foreach ($this->getInterpartyDisclosures() as $disclosure) {
4879. if ($disclosure->isStatusActive()) {
4880. return true;
4881. }
4882. }
4884. return false;
4885. }
4887. /**
4888. * @return bool
4889. */
4890. public function hasExpiredInterpartyDisclosures(): bool
4891. {
4892. foreach ($this->getInterpartyDisclosures() as $disclosure) {
4893. if ($disclosure->isStatusExpired()) {
4894. return true;
4895. }
4896. }
4898. return false;
4899. }
4901. /**
4902. * @param InterpartyDisclosure $interpartyDisclosure
4903. *
4904. * @return self
4905. */
4906. public function addInterpartyDisclosure(InterpartyDisclosure $interpartyDisclosure): self
4907. {
4908. if (!$this->interpartyDisclosures->contains($interpartyDisclosure)) {
4909. $this->interpartyDisclosures[] = $interpartyDisclosure;
4910. $interpartyDisclosure->setProject($this);
4911. }
4913. return $this;
4914. }
4916. /**
4917. * @param InterpartyDisclosure $interpartyDisclosure
4918. *
4919. * @return self
4920. */
4921. public function removeInterpartyDisclosure(InterpartyDisclosure $interpartyDisclosure): self
4922. {
4923. if ($this->interpartyDisclosures->removeElement($interpartyDisclosure)) {
4924. // set the owning side to null (unless already changed)
4925. if ($interpartyDisclosure->getProject() === $this) {
4926. $interpartyDisclosure->setProject(null);
4927. }
4928. }
4930. return $this;
4931. }
4933. /**
4934. * Return the count of active disclosures relating to the current project.
4935. *
4936. * @return int
4937. */
4938. public function getActiveDisclosuresCount(): int
4939. {
4940. $interpartyDisclosuresArray = $this->getInterpartyDisclosures()->toArray();
4941. $activeCount = array_reduce(
4942. $interpartyDisclosuresArray,
4943. function ($activeTotal, $disclosure) {
4944. return $activeTotal + $disclosure->isStatusActive();
4945. },
4946. 0
4947. );
4948. return $activeCount;
4949. }
4951. /**
4952. * @return string|null
4953. *
4954. */
4955. public function getMatterType(): ?string
4956. {
4957. return $this->matterType;
4958. }
4960. /**
4961. * @param string|null $matterType
4962. *
4963. * @return self
4964. */
4965. public function setMatterType(?string $matterType): self
4966. {
4967. $this->matterType = $matterType;
4969. return $this;
4970. }
4972. /**
4973. * @return array
4974. */
4975. public static function getMatterTypeOptions(): array
4976. {
4977. return self::getConstantsWithLabelsAsChoices('MATTER_TYPE');
4978. }
4980. /**
4981. * @return string
4982. */
4983. public function getMatterTypeLabel(): string
4984. {
4985. if ($this->getMatterType() === null) {
4986. return '';
4987. }
4988. $options = array_flip(self::getMatterTypeOptions());
4990. return $options[$this->getMatterType()] ?? '';
4991. }
4993. /**
4994. * @return bool
4995. */
4996. public function isClinicalNegligenceMatterType(): bool
4997. {
4998. return $this->getMatterType() === self::MATTER_TYPE_CLINICAL_NEGLIGENCE;
4999. }
5001. /**
5002. * Get the value of useModernRadiology
5003. */
5004. public function getUseModernRadiology(): ?bool
5005. {
5006. return $this->useModernRadiology;
5007. }
5009. /**
5010. * Set the value of useModernRadiology
5011. *
5012. * @param bool|null $useModernRadiology
5013. *
5014. * @return self
5015. */
5016. public function setUseModernRadiology(?bool $useModernRadiology)
5017. {
5018. $this->useModernRadiology = $useModernRadiology;
5020. return $this;
5021. }
5023. /**
5024. * Get the value of modernRadiologyMigrationStatus
5025. */
5026. public function getModernRadiologyMigrationStatus(): ?string
5027. {
5028. return $this->modernRadiologyMigrationStatus;
5029. }
5031. /**
5032. * Set the value of modernRadiologyMigrationStatus
5033. *
5034. * @param mixed $modernRadiologyMigrationStatus
5035. *
5036. * @return self
5037. */
5038. public function setModernRadiologyMigrationStatus(?string $modernRadiologyMigrationStatus)
5039. {
5040. $this->modernRadiologyMigrationStatus = $modernRadiologyMigrationStatus;
5041. // Once the migration completes, flick the switch that we should now use modern radiology.
5042. if ($modernRadiologyMigrationStatus === self::MODERN_RADIOLOGY_MIGRATION_STATUS_COMPLETE
5043. || $modernRadiologyMigrationStatus === self::MODERN_RADIOLOGY_MIGRATION_STATUS_SKIPPED) {
5044. $this->setUseModernRadiology(true);
5045. }
5047. return $this;
5048. }
5050. /**
5051. * @return bool
5052. */
5053. public function isModernRadiologyMigrationInProgress(): bool
5054. {
5055. return $this->getModernRadiologyMigrationStatus() === self::MODERN_RADIOLOGY_MIGRATION_STATUS_IN_PROGRESS;
5056. }
5058. /**
5059. * @return string|null
5060. */
5061. public function getType(): ?string
5062. {
5063. return $this->type;
5064. }
5066. /**
5067. * @param string|null $type
5068. *
5069. * @return self
5070. */
5071. public function setType(?string $type): self
5072. {
5073. $this->type = $type;
5075. return $this;
5076. }
5078. /**
5079. * @return bool
5080. */
5081. public function isTypeDisclosure(): bool
5082. {
5083. return $this->type === self::TYPE_MATTER_DISCLOSURE;
5084. }
5086. /**
5087. * Returns an array of permitted values for the Matter Type field and their
5088. * associated labels.
5089. *
5090. * @return array
5091. */
5092. public static function getTypeOptions()
5093. {
5094. $typeOptions = self::getConstantsWithLabelsAsChoices('TYPE_MATTER');
5096. return $typeOptions;
5097. }
5099. /**
5100. * Returns a human readable version of the type
5101. *
5102. * @return string
5103. */
5104. public function getTypeLabel()
5105. {
5106. return self::getConstantsWithLabels('TYPE_MATTER');
5107. }
5109. /**
5110. * @return bool
5111. */
5112. public function hasNoRecordsForDisclosure(): bool
5113. {
5114. if ($this->getMedicalRecordsCollection() === null) {
5115. return false;
5116. }
5118. return $this->getMedicalRecordsCollection()->getDocuments()->isEmpty() && $this->getUnsortedRecordsCollection()->getDocuments()->isEmpty();
5119. }
5121. /**
5122. * @return bool
5123. */
5124. public function hasNoRadiologyForDisclosure(): bool
5125. {
5126. // Get failed discs too for this consideration, as you can disclose failed discs.
5127. return $this->getFailedDiscs()->isEmpty() && $this->getActiveDiscs()->isEmpty() && $this->getStudies()->isEmpty();
5128. }
5130. /**
5131. * Returns true if the project has no items for disclosure (records and radiology)
5132. *
5133. * @return bool
5134. */
5135. public function hasNoItemsForDisclosure(): bool
5136. {
5137. $hasNoRecords = $this->hasNoRecordsForDisclosure();
5138. $hasNoRadiology = $this->hasNoRadiologyForDisclosure();
5140. return $hasNoRecords === true && $hasNoRadiology === true;
5141. }
5143. /**
5144. * Returns true if one of the project's discs does not have the same status as it had pre-migration.
5145. *
5146. * @return bool
5147. */
5148. public function hasProjectFailedDiscMigration(): bool
5149. {
5150. foreach ($this->getDiscs() as $disc) {
5151. if ($disc->hasDiscFailedMigration()) {
5152. return true;
5153. }
5154. }
5155. return false;
5156. }
5158. /**
5159. * @return bool|null
5160. */
5161. public function getHideFromInvoicing(): ?bool
5162. {
5163. return $this->hideFromInvoicing;
5164. }
5166. /**
5167. * @param bool|null $hideFromInvoicing
5168. *
5169. * @return self
5170. */
5171. public function setHideFromInvoicing(?bool $hideFromInvoicing): self
5172. {
5173. $this->hideFromInvoicing = $hideFromInvoicing;
5175. return $this;
5176. }
5178. /**
5179. * @return DateTimeInterface|null
5180. */
5181. public function getLastRenewalDate(): ?DateTimeInterface
5182. {
5183. return $this->lastRenewalDate;
5184. }
5186. /**
5187. * @param DateTimeInterface|null $lastRenewalDate
5188. *
5189. * @return self
5190. */
5191. public function setLastRenewalDate(?DateTimeInterface $lastRenewalDate): self
5192. {
5193. $this->lastRenewalDate = $lastRenewalDate;
5195. return $this;
5196. }
5198. /**
5199. * @return DateTimeInterface|null
5200. */
5201. public function getNextRenewalDate(): ?DateTimeInterface
5202. {
5203. return $this->nextRenewalDate;
5204. }
5206. /**
5207. * @param DateTimeInterface|null $nextRenewalDate
5208. *
5209. * @return self
5210. */
5211. public function setNextRenewalDate(?DateTimeInterface $nextRenewalDate): self
5212. {
5213. $this->nextRenewalDate = $nextRenewalDate;
5215. return $this;
5216. }
5218. /**
5219. * @return array|null
5220. */
5221. public function getRenewalNotificationSent(): ?array
5222. {
5223. return $this->renewalNotificationSent;
5224. }
5226. /**
5227. * @param array|null $renewalNotificationSent
5228. *
5229. * @return self
5230. */
5231. public function setRenewalNotificationSent(?array $renewalNotificationSent): self
5232. {
5233. $this->renewalNotificationSent = $renewalNotificationSent;
5235. return $this;
5236. }
5238. /**
5239. * @return DoctrineCollection<int, MatterLicenceRenewalLog>
5240. */
5241. public function getMatterLicenceRenewalLogs(): DoctrineCollection
5242. {
5243. return $this->matterLicenceRenewalLogs;
5244. }
5246. /**
5247. * @param MatterLicenceRenewalLog $matterLicenceRenewalLog
5248. *
5249. * @return self
5250. */
5251. public function addMatterLicenceRenewalLog(MatterLicenceRenewalLog $matterLicenceRenewalLog): self
5252. {
5253. if (!$this->matterLicenceRenewalLogs->contains($matterLicenceRenewalLog)) {
5254. $this->matterLicenceRenewalLogs[] = $matterLicenceRenewalLog;
5255. $matterLicenceRenewalLog->setProject($this);
5256. }
5258. return $this;
5259. }
5261. /**
5262. * @param MatterLicenceRenewalLog $matterLicenceRenewalLog
5263. *
5264. * @return self
5265. */
5266. public function removeMatterLicenceRenewalLog(MatterLicenceRenewalLog $matterLicenceRenewalLog): self
5267. {
5268. if ($this->matterLicenceRenewalLogs->removeElement($matterLicenceRenewalLog)) {
5269. // set the owning side to null (unless already changed)
5270. if ($matterLicenceRenewalLog->getProject() === $this) {
5271. $matterLicenceRenewalLog->setProject(null);
5272. }
5273. }
5275. return $this;
5276. }
5278. /**
5279. * Get a valid Licence Renewal Term belonging to the Project
5280. * For a term to be valid the Project's created date must fall between the effective renewal date and effective renewal end date
5281. *
5282. * @return LicenceRenewalTerm|null
5283. */
5284. public function getLicenceRenewalTerm(): ?LicenceRenewalTerm
5285. {
5286. $terms = $this->getAccount()->getLicenceRenewalTerms();
5288. // if the Account doesn't have any associated terms return
5289. if (empty($terms)) {
5290. return null;
5291. }
5293. // find only the applicable term for this project
5294. foreach ($terms as $term) {
5295. // If we have an artificial created date to slot it into the renewal period, use that instead.
5296. if ($this->getForcedRenewalCreated()) {
5297. $validStartCriteria = $this->getForcedRenewalCreated() >= $term->getEffectiveDate();
5298. $validEndCriteria = $term->getEffectiveEndDate() === null || ($this->getForcedRenewalCreated() <= $term->getEffectiveEndDate());
5299. } else {
5300. $validStartCriteria = $this->getCreated() >= $term->getEffectiveDate();
5301. $validEndCriteria = $term->getEffectiveEndDate() === null || ($this->getCreated() <= $term->getEffectiveEndDate());
5302. }
5304. // return the qualifying term, effectiveEndDate of null indicates the last term, thus a recurring term
5305. if ($validStartCriteria && $validEndCriteria) {
5306. return $term;
5307. }
5308. };
5310. return null;
5311. }
5313. /**
5314. * @return string|null
5315. */
5316. public function getPermanentDeleteStatus(): ?string
5317. {
5318. return $this->permanentDeleteStatus;
5319. }
5321. /**
5322. * @param string|null $permanentDeleteStatus
5323. *
5324. * @return self
5325. */
5326. public function setPermanentDeleteStatus(?string $permanentDeleteStatus): self
5327. {
5328. $this->permanentDeleteStatus = $permanentDeleteStatus;
5330. return $this;
5331. }
5333. /**
5334. * If there is a renewal date, it calculates the difference in days between it and today's date.
5335. *
5336. * @return int|null Number of days until renewal, or null if there's no renewal date.
5337. */
5338. public function getNumberOfDaysTillRenewal(): ?int
5339. {
5340. $nextRenewalDate = $this->getNextRenewalDate();
5342. if ($nextRenewalDate !== null) {
5344. $currentDate = (new DateTime())->setTime(0, 0, 0);
5346. // Calculate the difference in days
5347. $dueForRenewalInDays = $nextRenewalDate->diff($currentDate, false)->days;
5349. $dueForRenewalInDays = max(0, $dueForRenewalInDays);
5351. return $dueForRenewalInDays;
5352. }
5353. return null;
5354. }
5356. /**
5357. * @return ClinicalSummary|null
5358. */
5359. public function getClinicalSummary(): ?ClinicalSummary
5360. {
5361. return $this->clinicalSummary;
5362. }
5364. /**
5365. * @param ClinicalSummary|null $clinicalSummary
5366. *
5367. * @return self
5368. */
5369. public function setClinicalSummary(?ClinicalSummary $clinicalSummary): self
5370. {
5371. $this->clinicalSummary = $clinicalSummary;
5373. return $this;
5374. }
5376. /**
5377. * Retrieves the counts of an array of Serviceable entities, grouped by their ServiceRequest status.
5378. *
5379. * @param array $serviceables
5380. * @param bool $uninvoicedOnly
5381. *
5382. * @return array
5383. */
5384. private function getServiceableCountsByStatus(array $serviceables, $uninvoicedOnly = true)
5385. {
5386. $serviceableCounts = [];
5388. // Go through each serviceable entity
5389. foreach ($serviceables as $serviceable) {
5390. // Check that it is in fact a Serviceable entity, and that it has a ServiceRequest
5391. // attached to it.
5392. if ($serviceable instanceof ServiceableInterface && $serviceable->getServiceRequest()) {
5393. // If we are only looking for uninvoiced, and this serviceable entity has been billed for,
5394. // continue to next element of the array.
5395. if ($uninvoicedOnly && $serviceable->isBilled()) {
5396. continue;
5397. }
5399. // Use the status integer as the key
5400. $key = $serviceable->getServiceRequest()->getStatus();
5401. // If the array element does not already exist, setup the defaults for it.
5402. if (!isset($serviceableCounts[$key])) {
5403. // Place the count and label as two separate elements of the array
5404. // so we can easily access them using the status integer key
5405. $serviceableCounts[$key] = [
5406. 'label' => $serviceable->getServiceRequest()->getStatusLabel(),
5407. 'count' => 0,
5408. ];
5409. }
5411. // Increment the count for the status
5412. $serviceableCounts[$key]['count']++;
5413. }
5414. }
5416. // Sort the elements by key (status)
5417. ksort($serviceableCounts);
5419. return $serviceableCounts;
5420. }
5421. }