src/Entity/MatterRequest/MatterRequest.php line 134

Open in your IDE?
  1. <?php
  3. namespace MedBrief\MSR\Entity\MatterRequest;
  5. use ApiPlatform\Core\Annotation\ApiResource;
  6. use ApiPlatform\Core\Annotation\ApiSubresource;
  7. use DH\Auditor\Provider\Doctrine\Auditing\Annotation as Audit;
  8. use Doctrine\Common\Collections\ArrayCollection;
  9. use Doctrine\Common\Collections\Collection;
  10. use Doctrine\ORM\EntityNotFoundException;
  11. use Doctrine\ORM\Mapping as ORM;
  12. use Doctrine\Persistence\Proxy;
  13. use Gedmo\Mapping\Annotation as Gedmo;
  14. use MedBrief\MSR\Controller\MatterRequest\CaseTypes;
  15. use MedBrief\MSR\Controller\MatterRequest\ClaimValues;
  16. use MedBrief\MSR\Controller\MatterRequest\CreateMatter;
  17. use MedBrief\MSR\Dto\MatterRequestFullDto;
  18. use MedBrief\MSR\Entity\Account;
  19. use MedBrief\MSR\Entity\MatterRequest\Details\Chronology;
  20. use MedBrief\MSR\Entity\MatterRequest\Details\PostProcessing;
  21. use MedBrief\MSR\Entity\MatterRequest\Details\Review;
  22. use MedBrief\MSR\Entity\MatterRequest\Details\ServiceSelection;
  23. use MedBrief\MSR\Entity\MatterRequest\Details\Sort;
  24. use MedBrief\MSR\Entity\Project;
  25. use MedBrief\MSR\Entity\User;
  26. use MedBrief\MSR\Repository\MatterRequestRepository;
  27. use MedBrief\MSR\Service\ErrorHandling\ApiErrorCodeAwareInterface;
  28. use MedBrief\MSR\Traits\FilterableClassConstantsTrait;
  29. use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
  30. use Symfony\Component\Serializer\Annotation\Groups;
  31. use Symfony\Component\Validator\Constraints as Assert;
  33. /**
  34. * @ApiResource(
  35. * collectionOperations={
  36. * "post"={"access_control"="is_granted('CREATE', object)"},
  37. * "matter_request_full_create"={
  38. * "method"="POST",
  39. * "input"=MatterRequestFullDto::class,
  40. * "output"=MatterRequestFullDto::class,
  41. * "path"="/matter_requests/matter_request_full",
  42. * "normalization_context"={"groups"={"matter_request_full:read"}},
  43. * "denormalization_context"={"groups"={"matter_request_full:create"}},
  44. * "validation_groups"={"Default", "matter_request_full:create"},
  45. * "openapi_context"={
  46. * "summary"="Create a Matter Request.",
  47. * "description"="Use this call to create a new matter request and associated matter. See [Create Matter](/docs/api/detail#create-matter)"
  48. * }
  49. * },
  50. * "matter_request_full_update"={
  51. * "method"="POST",
  52. * "input"=MatterRequestFullDto::class,
  53. * "output"=MatterRequestFullDto::class,
  54. * "path"="/matter_requests/matter_request_full/update",
  55. * "normalization_context"={"groups"={"matter_request_full:read"}},
  56. * "denormalization_context"={"groups"={"matter_request_full:update"}},
  57. * "validation_groups"={"Default", "matter_request_full:update"},
  58. * "openapi_context"={
  59. * "summary"="Update a Matter Request and related Matter.",
  60. * "description"="Use this call to update/re-open an existing matter. See [Update/Re-Open Matter](/docs/api/detail#update-matter)",
  61. * "external_docs"={"url"="/docs/api/detail#update-matter", "description"="Read Documentation"}
  62. * }
  63. * },
  64. * "case_types"={
  65. * "access_control"="is_granted('CREATE_MATTER_REQUEST')",
  66. * "method"="GET",
  67. * "path"="/matter_requests/case_types",
  68. * "controller"=CaseTypes::class,
  69. * "defaults"={"_api_receive"=false},
  70. * "openapi_context"={
  71. * "summary"="Return all Case Type options.",
  72. * "description"="Return all Case Type options. See [Case Types](/docs/api/detail#case-types)",
  73. * "responses"={
  74. * "200"={
  75. * "description"="A list of Case Types options.",
  76. * }
  77. * }
  78. * }
  79. * },
  80. * "claim_values"={
  81. * "access_control"="is_granted('CREATE_MATTER_REQUEST')",
  82. * "method"="GET",
  83. * "path"="/matter_requests/claim_values",
  84. * "controller"=ClaimValues::class,
  85. * "defaults"={"_api_receive"=false},
  86. * "openapi_context"={
  87. * "summary"="Return all Claim Value options.",
  88. * "description"="Return all Claim Value options. The 'value' value is to be used in the claimValue field when creating a Matter Request.",
  89. * "responses"={
  90. * "200"={
  91. * "description"="A list of Claim Value options.",
  92. * }
  93. * }
  94. * }
  95. * }
  96. * },
  97. * itemOperations={
  98. * "get"={
  99. * "access_control"="is_granted('READ', object)",
  100. * "normalization_context"={"groups"={"matter_request:read"}, "enable_max_depth"=true}
  101. * },
  102. * "put"={"access_control"="is_granted('UPDATE', object)"},
  103. * "create_matter"={
  104. * "method"="POST",
  105. * "path"="/matter_requests/{id}/create_matter",
  106. * "controller"=CreateMatter::class,
  107. * "deserialize"=false,
  108. * "defaults"={"_api_receive"=false},
  109. * "swagger_context"={
  110. * "summary"="Create the matter associated with the MatterRequest.",
  111. * "parameters" = {
  112. * {"name" = "id","in" = "path","description" = "id","required" = "true","type" : "integer"}
  113. * }
  114. * }
  115. * }
  116. * },
  117. * attributes={
  118. * "validation_groups"={MatterRequest::class, "validationGroups"},
  119. * "denormalization_context"={"skip_null_values"=true},
  120. * },
  121. * )
  122. *
  123. * @Audit\Auditable
  124. *
  125. * @Audit\Security(view={"ROLE_ALLOWED_TO_AUDIT"})
  126. *
  127. * @UniqueEntity({"matterReference", "firm"}, groups={"Default", "md_step1"}, repositoryMethod="findByProjectClientReference", payload={"error_code": ApiErrorCodeAwareInterface::INVALID_MATTER_REFERENCE__ALREADY_USED})
  128. * @UniqueEntity({"matterReference", "firm"}, groups={"Default", "md_step1"}, payload={"error_code": ApiErrorCodeAwareInterface::INVALID_MATTER_REFERENCE__ALREADY_USED})
  129. *
  130. * @ORM\Table(name="MatterRequest")
  131. *
  132. * @ORM\Entity(repositoryClass=MatterRequestRepository::class)
  133. */
  134. class MatterRequest
  135. {
  136. use FilterableClassConstantsTrait;
  138. public const DEFENDANT_SEPARATOR = '#';
  140. // selectedServiceGroup constants
  141. public const SERVICE_GROUP_HOSTING_ONLY = 'hostingOnlyGroup';
  142. public const SERVICE_GROUP_HOSTING_ONLY__LABEL = 'Hosting Only';
  143. public const SERVICE_GROUP_EXTENDED = 'extendedServicesGroup';
  144. public const SERVICE_GROUP_EXTENDED__LABEL = 'Extended Services';
  146. // Status constants
  147. public const STATUS_INCOMPLETE = 'incomplete';
  148. public const STATUS_INCOMPLETE__LABEL = 'Incomplete';
  150. public const STATUS_INSTRUCTED = 'instructed';
  151. public const STATUS_INSTRUCTED__LABEL = 'Instructed';
  153. public const STATUS_IN_PROGRESS = 'in_progress';
  154. public const STATUS_IN_PROGRESS__LABEL = 'In Progress';
  156. public const STATUS_QUERY_WITH_CLIENT = 'query_with_client';
  157. public const STATUS_QUERY_WITH_CLIENT__LABEL = 'Query with client';
  159. public const STATUS_QA = 'qa';
  160. public const STATUS_QA__LABEL = 'QA';
  162. public const STATUS_COMPLETED = 'completed';
  163. public const STATUS_COMPLETED__LABEL = 'Completed';
  165. public const STATUS_CANCELLED = 'canceled';
  166. public const STATUS_CANCELLED__LABEL = 'Cancelled';
  168. // Used when changes have been requested to the matter request at a future date
  169. // Currently, only used when a case is re-opened via the API
  170. public const STATUS_RE_INSTRUCTED = 're_instructed';
  171. public const STATUS_RE_INSTRUCTED__LABEL = 'Re-Instructed';
  173. // Indicates the source of the matter request
  174. public const SOURCE_WEBSITE = 'website';
  175. public const SOURCE_WEBSITE__LABEL = 'Website';
  177. public const SOURCE_API = 'api';
  178. public const SOURCE_API__LABEL = 'Api';
  180. /**
  181. * @var int
  182. *
  183. * @Groups({"matter_request:read"})
  184. *
  185. * @ORM\Column(name="id", type="integer")
  186. *
  187. * @ORM\Id
  188. *
  189. * @ORM\GeneratedValue(strategy="IDENTITY")
  190. */
  191. protected $id;
  193. /**
  194. * A unique reference number for this Matter.
  195. *
  196. * @var string
  197. *
  198. * @Assert\NotBlank(groups={"Default", "md_step1"}, message="Please complete this field.")
  199. *
  200. * @Groups({"matter_request:read", "matter_request:create_full"})
  201. *
  202. * @ORM\Column(name="matterReference", type="string")
  203. */
  204. protected $matterReference;
  206. /**
  207. * DateTime the MatterRequest was created.
  208. *
  209. * @var \DateTimeImmutable
  210. *
  211. * @Groups({"matter_request:read"})
  212. *
  213. * @ORM\Column(name="created", type="datetime_immutable")
  214. *
  215. * @Gedmo\Timestampable(on="create")
  216. */
  217. protected $created;
  219. /**
  220. * Last update time of this MatterRequest.
  221. *
  222. * @var \DateTime
  223. *
  224. * @Groups({"matter_request:read"})
  225. *
  226. * @ORM\Column(name="updated", type="datetime")
  227. *
  228. * @Gedmo\Timestampable(on="update")
  229. */
  230. protected $updated;
  232. /**
  233. * One or more Claimants to whom this MatterRequest relates.
  234. *
  235. * @var string
  236. *
  237. * @Assert\NotBlank(groups={"Default", "md_step3"})
  238. *
  239. * @Groups({"matter_request:read", "matter_request:create_full"})
  240. *
  241. * @ORM\Column(name="claimant", type="string", nullable=true)
  242. */
  243. protected $claimant;
  245. /**
  246. * Any Defendants to whom this MatterRequest relates.
  247. *
  248. * @var string
  249. *
  250. * @Assert\Expression(
  251. * "value != '' or this.getDefendantUnknown() === true",
  252. * message="Please specify at least one defendant, or indicate 'Not Sure'.",
  253. * groups={"Default", "md_step3"}
  254. * )
  255. *
  256. * @Groups({"matter_request:read", "matter_request:create_full"})
  257. *
  258. * @ORM\Column(name="defendant", type="text", nullable=true)
  259. */
  260. protected $defendant;
  262. /**
  263. * Any Defendants to whom this MatterRequest relates.
  264. *
  265. * @var bool
  266. *
  267. * @Groups({"matter_request:read", "matter_request:create_full"})
  268. *
  269. * @ORM\Column(name="defendantUnknown", type="boolean", nullable=true, options={"default"=false})
  270. */
  271. protected $defendantUnknown = false;
  273. /**
  274. * The Team handling this Matter, where applicable.
  275. *
  276. * @var null|string
  277. *
  278. * @Groups({"matter_request:read", "matter_request:create_full"})
  279. *
  280. * @ORM\Column(name="team", type="string", nullable=true)
  281. */
  282. protected $team;
  284. /**
  285. * The Billing Code to be used for this Matter.
  286. *
  287. * @var null|string
  288. *
  289. * @Assert\Expression(
  290. * "(this.getFirm() and !this.getFirm().getMatterRequestDefaults()) or (this.getFirm() and this.getFirm().getMatterRequestDefaults() and !this.getFirm().getMatterRequestDefaults().isFieldForceCompulsory('billingCode')) or value != ''",
  291. * message="Please complete this field.",
  292. * groups={"Default", "md_step1"}
  293. *)
  294. *
  295. * @Groups({"matter_request:read", "matter_request:create_full"})
  296. *
  297. * @ORM\Column(name="billingCode", type="string", nullable=true)
  298. */
  299. protected $billingCode;
  301. /**
  302. * An indication of the estimated claim value for this Matter, if known.
  303. *
  304. * @var null|int
  305. *
  306. * @Assert\Expression(
  307. * "(this.getFirm() and this.getFirm().getMatterRequestDefaults() and this.getFirm().getMatterRequestDefaults().isFieldForceOptional('claimValue')) or value != ''",
  308. * message="This value should not be blank.",
  309. * groups={"Default", "md_step2"}
  310. *)
  311. *
  312. * @Groups({"matter_request:read", "matter_request:create_full"})
  313. *
  314. * @ORM\Column(name="claimValue", type="integer", nullable=true)
  315. */
  316. protected $claimValue;
  318. /**
  319. * The key allegations applicable to this Matter, if known.
  320. *
  321. * @var array|null
  322. *
  323. * @Assert\NotNull(groups={"Default", "md_step2"})})
  324. *
  325. * @Assert\Expression(
  326. * "(this.getFirm() and this.getFirm().getMatterRequestDefaults() and this.getFirm().getMatterRequestDefaults().isFieldForceOptional('keyAllegations')) or this.hasKeyAllegations()",
  327. * message="Please enter an allegation.",
  328. * groups={"Default", "md_step2"}
  329. * )
  330. *
  331. * @Groups({"matter_request:read", "matter_request:create_full"})
  332. *
  333. * @ORM\Column(name="keyAllegations", type="array")
  334. */
  335. protected $keyAllegations = [];
  337. /**
  338. * The date of alleged negligence applicable to this Matter, if known.
  339. *
  340. * @var null|\DateTime
  341. *
  342. * @Assert\Expression(
  343. * "(this.getFirm() and this.getFirm().getMatterRequestDefaults() and this.getFirm().getMatterRequestDefaults().isFieldForceOptional('negligenceDate')) or value != ''",
  344. * message="This value should not be blank.",
  345. * groups={"Default", "md_step2"}
  346. *)
  347. *
  348. * @Groups({"matter_request:read", "matter_request:create_full"})
  349. *
  350. * @ORM\Column(name="negligenceDate", type="datetime", nullable=true)
  351. */
  352. protected $negligenceDate;
  354. /**
  355. * The date of knowledge applicable to this Matter.
  356. *
  357. * @var null|\DateTime
  358. *
  359. * @Groups({"matter_request:read", "matter_request:create_full"})
  360. *
  361. * @ORM\Column(name="knowledgeDate", type="datetime", nullable=true)
  362. */
  363. protected $knowledgeDate;
  365. /**
  366. * The limitation date applicable to this Matter, if known.
  367. *
  368. * @var null|\DateTime
  369. *
  370. * @Assert\Expression(
  371. * "(this.getFirm() and this.getFirm().getMatterRequestDefaults() and this.getFirm().getMatterRequestDefaults().isFieldForceOptional('limitationDate')) or value != ''",
  372. * message="This value should not be blank.",
  373. * groups={"Default", "md_step2"}
  374. *)
  375. *
  376. * @Groups({"matter_request:read", "matter_request:create_full"})
  377. *
  378. * @ORM\Column(name="limitationDate", type="datetime", nullable=true)
  379. */
  380. protected $limitationDate;
  382. /**
  383. * The category to which this Matter belongs.
  384. *
  385. * @var int
  386. *
  387. * @Assert\Expression(
  388. * "(this.getFirm() and this.getFirm().getMatterRequestDefaults() and this.getFirm().getMatterRequestDefaults().isFieldForceOptional('claimCategory')) or value != ''",
  389. * message="This value should not be blank.",
  390. * groups={"Default", "md_step2"}
  391. *)
  392. *
  393. * @Groups({"matter_request:read", "matter_request:create_full"})
  394. *
  395. * @ORM\Column(name="claimCategory", type="integer", nullable=true)
  396. */
  397. protected $claimCategory;
  399. /**
  400. * The background to the matter.
  401. *
  402. * @var string
  403. *
  404. * @Assert\NotBlank(groups={"Default", "md_step2"})
  405. *
  406. * @Groups({"matter_request:read", "matter_request:create_full"})
  407. *
  408. * @ORM\Column(name="background", type="text", nullable=true)
  409. */
  410. protected $background;
  412. /**
  413. * The current step of the Matter Creation Form, so we can
  414. * return the user to edit the form, as well apply validation specific to the step.
  415. *
  416. * @var string
  417. *
  418. * @Groups({"matter_request:read"})
  419. *
  420. * @ORM\Column(name="currentFormStep", type="string", nullable=true)
  421. */
  422. protected $currentFormStep;
  424. /**
  425. * The selected service group passed through from the form.
  426. *
  427. * @var string
  428. *
  429. * @Groups({"matter_request:read"})
  430. *
  431. * @ORM\Column(name="selectedServiceGroup", type="string", nullable=true)
  432. */
  433. protected $selectedServiceGroup;
  435. /**
  436. * The Client/Firm initiating this MatterRequest.
  437. *
  438. * @var Account
  439. *
  440. * @Assert\NotNull(groups={"Default", "md_step1"}, message="Please select a storage area for this matter.")
  441. *
  442. * @Groups({"matter_request:read", "matter_request:create_full"})
  443. *
  444. * @ORM\ManyToOne(targetEntity="MedBrief\MSR\Entity\Account")
  445. *
  446. * @ORM\JoinColumns({
  447. *
  448. * @ORM\JoinColumn(name="firm_id", referencedColumnName="id")
  449. * })
  450. */
  451. protected $firm;
  453. /**
  454. * The Fee Earner for this Matter.
  455. *
  456. * @var User
  457. *
  458. * @Assert\NotNull(groups={"Default", "md_step1"}, message="Please select an option.")
  459. *
  460. * @ApiSubresource()
  461. *
  462. * @Groups({"matter_request:read", "matter_request:create_full"})
  463. *
  464. * @ORM\ManyToOne(targetEntity="MedBrief\MSR\Entity\User")
  465. *
  466. * @ORM\JoinColumns({
  467. *
  468. * @ORM\JoinColumn(name="manager_id", referencedColumnName="id")
  469. * })
  470. */
  471. protected $manager;
  473. /**
  474. * @var null|Collection|User[]
  475. *
  476. * @Groups({"matter_request:read", "matter_request:create_full"})
  477. *
  478. * @ORM\ManyToMany(targetEntity=User::class, cascade={"persist"}, fetch="EAGER")
  479. *
  480. * @ORM\JoinTable(name="matter_request_additional_contacts",
  481. * joinColumns={@ORM\JoinColumn(name="matter_request_id", referencedColumnName="id", nullable=true)},
  482. * inverseJoinColumns={@ORM\JoinColumn(name="user_id", referencedColumnName="id", nullable=true)}
  483. * )
  484. *
  485. * @Assert\Expression(
  486. * "this.hasAdditionalContactsEmpty()",
  487. * message="All additional contacts must be fully completed or removed.",
  488. * groups={"Default", "md_step1"}
  489. * )
  490. */
  491. protected $additionalContacts;
  493. /**
  494. * The Project to which this MatterRequest relates.
  495. *
  496. * @var null|Project
  497. *
  498. * @ORM\OneToOne(targetEntity="MedBrief\MSR\Entity\Project", inversedBy="matterRequest")
  499. *
  500. * @ORM\JoinColumns({
  501. *
  502. * @ORM\JoinColumn(name="matter_id", referencedColumnName="id", unique=true)
  503. * })
  504. */
  505. protected $matter;
  507. /**
  508. * The Project ID to which this MatterRequest relates.
  509. *
  510. * Not mapped, used only for API.
  511. *
  512. * @Groups({"matter_request:read"})
  513. *
  514. * @var null|int
  515. */
  516. protected $matterId;
  518. /**
  519. * The Patients associated to this Matter.
  520. *
  521. * @var Collection
  522. *
  523. * @ApiSubresource()
  524. *
  525. * @Groups({"matter_request:read", "matter_request:create_full"})
  526. *
  527. * @ORM\OneToMany(targetEntity="MedBrief\MSR\Entity\MatterRequest\Patient", mappedBy="matterRequest", orphanRemoval=true, cascade={"persist"})
  528. */
  529. protected $patients;
  531. /**
  532. * The Trust Centres associated to this Matter.
  533. *
  534. * @var Collection
  535. *
  536. * @ApiSubresource()
  537. *
  538. * @Assert\Count(
  539. * min = 1,
  540. * minMessage = "You must specify at least one Trust Centre",
  541. * groups={"rr_step1"}
  542. * )
  543. *
  544. * @Groups({"matter_request:read"})
  545. *
  546. * @ORM\OneToMany(targetEntity="MedBrief\MSR\Entity\MatterRequest\TrustCentre", mappedBy="matterRequest", orphanRemoval=true, cascade={"persist"})
  547. */
  548. protected $trustCentres;
  550. /**
  551. * @var null|PostProcessing
  552. *
  553. * @ApiSubresource()
  554. *
  555. * @Groups({"matter_request:read"})
  556. *
  557. * @ORM\OneToOne(targetEntity="MedBrief\MSR\Entity\MatterRequest\Details\PostProcessing", inversedBy="matterRequest", orphanRemoval=true, cascade={"persist"})
  558. *
  559. * @ORM\JoinColumns({
  560. *
  561. * @ORM\JoinColumn(name="postProcessingDetails_id", referencedColumnName="id", unique=true)
  562. * })
  563. */
  564. protected $postProcessingDetails;
  566. /**
  567. * @var null|Chronology
  568. *
  569. * @ApiSubresource()
  570. *
  571. * @Groups({"matter_request:read"})
  572. *
  573. * @ORM\OneToOne(targetEntity="MedBrief\MSR\Entity\MatterRequest\Details\Chronology", inversedBy="matterRequest", orphanRemoval=true, cascade={"persist"})
  574. *
  575. * @ORM\JoinColumns({
  576. *
  577. * @ORM\JoinColumn(name="chronologyDetails_id", referencedColumnName="id", unique=true)
  578. * })
  579. */
  580. protected $chronologyDetails;
  582. /**
  583. * @var null|Review
  584. *
  585. * @ApiSubresource()
  586. *
  587. * @Groups({"matter_request:read"})
  588. *
  589. * @ORM\OneToOne(targetEntity="MedBrief\MSR\Entity\MatterRequest\Details\Review", inversedBy="matterRequest", orphanRemoval=true, cascade={"persist"})
  590. *
  591. * @ORM\JoinColumns({
  592. *
  593. * @ORM\JoinColumn(name="reviewDetails_id", referencedColumnName="id", unique=true)
  594. * })
  595. */
  596. protected $reviewDetails;
  598. /**
  599. * @var null|Sort
  600. *
  601. * @ApiSubresource()
  602. *
  603. * @Groups({"matter_request:read"})
  604. *
  605. * @ORM\OneToOne(targetEntity="MedBrief\MSR\Entity\MatterRequest\Details\Sort", inversedBy="matterRequest", orphanRemoval=true, cascade={"persist"})
  606. *
  607. * @ORM\JoinColumns({
  608. *
  609. * @ORM\JoinColumn(name="sortDetails_id", referencedColumnName="id", unique=true)
  610. * })
  611. */
  612. protected $sortDetails;
  614. /**
  615. * @var null|ServiceSelection
  616. *
  617. * @ApiSubresource()
  618. *
  619. * @Groups({"matter_request:read"})
  620. *
  621. * @ORM\OneToOne(targetEntity="MedBrief\MSR\Entity\MatterRequest\Details\ServiceSelection", inversedBy="matterRequest", orphanRemoval=true, cascade={"persist"})
  622. *
  623. * @ORM\JoinColumns({
  624. *
  625. * @ORM\JoinColumn(name="serviceSelectionDetails_id", referencedColumnName="id", unique=true)
  626. * })
  627. */
  628. protected $serviceSelectionDetails;
  630. /**
  631. * @var string
  632. *
  633. * @ORM\Column(name="status", type="string", nullable=true)
  634. */
  635. protected $status;
  637. /**
  638. * @var User
  639. *
  640. * @ORM\ManyToOne(targetEntity="MedBrief\MSR\Entity\User")
  641. *
  642. * @ORM\JoinColumns({
  643. *
  644. * @ORM\JoinColumn(name="creator_id", referencedColumnName="id")
  645. * })
  646. */
  647. protected $creator;
  649. /**
  650. * @ORM\Column(name="source", type="string", options={"default"=self::SOURCE_WEBSITE})
  651. */
  652. protected string $source = self::SOURCE_WEBSITE;
  654. /**
  655. * @ORM\Column(name="historicalApiValues", type="json", nullable=true)
  656. */
  657. protected ?array $historicalApiValues = null;
  659. /**
  660. * @return void
  661. */
  662. public function __construct()
  663. {
  664. $this->patients = new ArrayCollection();
  665. $this->trustCentres = new ArrayCollection();
  666. $this->status = self::STATUS_INCOMPLETE;
  667. $this->source = self::SOURCE_WEBSITE;
  668. $this->additionalContacts = new ArrayCollection();
  669. }
  671. /**
  672. * __toString
  673. *
  674. * @return string
  675. */
  676. public function __toString(): string
  677. {
  678. return (string) ($this->getId() ?? 'Unknown');
  679. }
  681. /**
  682. * Determines the validation group to use, based on the currentFormStep for the
  683. * matterRequest.
  684. *
  685. * @param MatterRequest $matterRequest
  686. *
  687. * @return array
  688. */
  689. public static function validationGroups(MatterRequest $matterRequest): array
  690. {
  691. switch ($matterRequest->getCurrentFormStep()) {
  692. case 'md.step1':
  693. return ['md_step1'];
  694. case 'md.step2':
  695. return ['md_step2'];
  696. case 'md.step3':
  697. return ['md_step3'];
  698. case 'rr.step1':
  699. return ['rr_step1'];
  700. default:
  701. return ['Default'];
  702. }
  703. }
  705. /**
  706. * @return int
  707. */
  708. public function getId(): ?int
  709. {
  710. return $this->id;
  711. }
  713. /**
  714. * Set matterReference.
  715. *
  716. * @param string $matterReference
  717. *
  718. * @return MatterRequest
  719. */
  720. public function setMatterReference($matterReference)
  721. {
  722. $this->matterReference = $matterReference;
  724. // Update the associated matter as well, if it exists, and if the values are different,
  725. // to avoid a recursive loop.
  726. if ($this->getMatter() && $this->getMatter()->getClientReference() != $this->matterReference) {
  727. $this->getMatter()->setClientReference($this->matterReference);
  728. }
  730. return $this;
  731. }
  733. /**
  734. * Get matterReference.
  735. *
  736. * @return string
  737. */
  738. public function getMatterReference()
  739. {
  740. return $this->matterReference;
  741. }
  743. /**
  744. * Set created.
  745. *
  746. * @param \DateTimeImmutable $created
  747. *
  748. * @return MatterRequest
  749. */
  750. public function setCreated($created)
  751. {
  752. $this->created = $created;
  754. return $this;
  755. }
  757. /**
  758. * Get created.
  759. *
  760. * @return \DateTimeImmutable
  761. */
  762. public function getCreated()
  763. {
  764. return $this->created;
  765. }
  767. /**
  768. * Set updated.
  769. *
  770. * @param \DateTime $updated
  771. *
  772. * @return MatterRequest
  773. */
  774. public function setUpdated($updated)
  775. {
  776. $this->updated = $updated;
  778. return $this;
  779. }
  781. /**
  782. * Get updated.
  783. *
  784. * @return \DateTime
  785. */
  786. public function getUpdated()
  787. {
  788. return $this->updated;
  789. }
  791. /**
  792. * @return string
  793. */
  794. public function getClaimant(): ?string
  795. {
  796. return $this->claimant;
  797. }
  799. /**
  800. * @param string $claimant
  801. *
  802. * @return MatterRequest
  803. */
  804. public function setClaimant(string $claimant): MatterRequest
  805. {
  806. $this->claimant = $claimant;
  808. if ($this->getMatter()) {
  809. $this->getMatter()->setName($this->generateMatterName());
  810. }
  812. return $this;
  813. }
  815. /**
  816. * @return string|null
  817. */
  818. public function getDefendant(): ?string
  819. {
  820. return $this->defendant;
  821. }
  823. /**
  824. * @return array
  825. */
  826. public function getDefendantArray(): array
  827. {
  828. return explode(MatterRequest::DEFENDANT_SEPARATOR, $this->getDefendant());
  829. }
  831. /**
  832. * @param string|null $defendant
  833. *
  834. * @return MatterRequest
  835. */
  836. public function setDefendant(?string $defendant = null): MatterRequest
  837. {
  838. $this->defendant = $defendant;
  840. if ($this->getMatter()) {
  841. $this->getMatter()->setName($this->generateMatterName());
  842. }
  844. return $this;
  845. }
  847. /**
  848. * @param ?array $defendant
  849. *
  850. * @return MatterRequest
  851. */
  852. public function setDefendantArray(?array $defendant = null): MatterRequest
  853. {
  854. if ($defendant === null || empty($defendant)) {
  855. $this->setDefendant(null);
  856. }
  858. $this->setDefendant(implode(MatterRequest::DEFENDANT_SEPARATOR, $defendant));
  860. return $this;
  861. }
  863. /**
  864. * @return string|null
  865. */
  866. public function getTeam(): ?string
  867. {
  868. return $this->team;
  869. }
  871. /**
  872. * @param string $team
  873. *
  874. * @return MatterRequest
  875. */
  876. public function setTeam(?string $team = null): MatterRequest
  877. {
  878. $this->team = $team;
  880. // Update the associated matter as well, if it exists, and if the values are different,
  881. // to avoid a recursive loop.
  882. if ($this->getMatter() && $this->getMatter()->getTeam() != $this->team) {
  883. $this->getMatter()->setTeam($this->team);
  884. }
  886. return $this;
  887. }
  889. /**
  890. * @return string|null
  891. */
  892. public function getBillingCode(): ?string
  893. {
  894. return $this->billingCode;
  895. }
  897. /**
  898. * @param string $billingCode
  899. *
  900. * @return MatterRequest
  901. */
  902. public function setBillingCode(?string $billingCode = null): MatterRequest
  903. {
  904. $this->billingCode = $billingCode;
  906. // Update the associated matter as well, if it exists, and if the values are different,
  907. // to avoid a recursive loop.
  908. if ($this->getMatter() && $this->getMatter()->getBillingCode() != $this->billingCode) {
  909. $this->getMatter()->setBillingCode($this->billingCode);
  910. }
  912. return $this;
  913. }
  915. /**
  916. * @return null|int
  917. */
  918. public function getClaimValue(): ?int
  919. {
  920. return $this->claimValue;
  921. }
  923. /**
  924. * @return string
  925. */
  926. public function getClaimValueLabel(): string
  927. {
  928. $claimValues = array_flip(Project::getConstantsWithLabelsAsChoices('ESTIMATED_CLAIM_VALUE'));
  930. return $claimValues[$this->claimValue] ?? '';
  931. }
  933. /**
  934. * @param int $claimValue
  935. *
  936. * @return MatterRequest
  937. */
  938. public function setClaimValue(?int $claimValue = null): MatterRequest
  939. {
  940. $this->claimValue = $claimValue;
  942. // Update the associated matter as well, if it exists, and if the values are different,
  943. // to avoid a recursive loop.
  944. if ($this->getMatter() && $this->getMatter()->getEstimatedClaimValue() != $this->claimValue) {
  945. $this->getMatter()->setEstimatedClaimValue($this->claimValue);
  946. }
  948. return $this;
  949. }
  951. /**
  952. * @param int|null $rawAmount
  953. *
  954. * @return self
  955. */
  956. public function setClaimValueFromRawAmount(?int $rawAmount = null): self
  957. {
  958. if ($rawAmount === null) {
  959. $this->setClaimValue(null);
  960. return $this;
  961. }
  963. switch (true) {
  964. case $rawAmount >= 0 && $rawAmount <= 25000:
  965. $this->setClaimValue(Project::ESTIMATED_CLAIM_VALUE_0_25000);
  966. break;
  967. case $rawAmount >= 25001 && $rawAmount <= 50000:
  968. $this->setClaimValue(Project::ESTIMATED_CLAIM_VALUE_25001_50000);
  969. break;
  970. case $rawAmount >= 50001 && $rawAmount <= 100000:
  971. $this->setClaimValue(Project::ESTIMATED_CLAIM_VALUE_50001_100000);
  972. break;
  973. case $rawAmount >= 100001 && $rawAmount <= 250000:
  974. $this->setClaimValue(Project::ESTIMATED_CLAIM_VALUE_100001_250000);
  975. break;
  976. case $rawAmount >= 250001 && $rawAmount <= 500000:
  977. $this->setClaimValue(Project::ESTIMATED_CLAIM_VALUE_250001_500000);
  978. break;
  979. case $rawAmount >= 500001 && $rawAmount <= 1000000:
  980. $this->setClaimValue(Project::ESTIMATED_CLAIM_VALUE_500001_1000000);
  981. break;
  982. case $rawAmount >= 1000000:
  983. $this->setClaimValue(Project::ESTIMATED_CLAIM_VALUE_1000001);
  984. break;
  985. }
  987. return $this;
  988. }
  990. /**
  991. * @return null|\DateTime
  992. */
  993. public function getNegligenceDate(): ?\DateTime
  994. {
  995. return $this->negligenceDate;
  996. }
  998. /**
  999. * @param \DateTime $negligenceDate
  1000. *
  1001. * @return MatterRequest
  1002. */
  1003. public function setNegligenceDate(?\DateTime $negligenceDate = null): MatterRequest
  1004. {
  1005. $this->negligenceDate = $negligenceDate;
  1006. return $this;
  1007. }
  1009. /**
  1010. * @return null|\DateTime
  1011. */
  1012. public function getKnowledgeDate(): ?\DateTime
  1013. {
  1014. return $this->knowledgeDate;
  1015. }
  1017. /**
  1018. * @param \DateTime $knowledgeDate
  1019. *
  1020. * @return MatterRequest
  1021. */
  1022. public function setKnowledgeDate(?\DateTime $knowledgeDate = null): MatterRequest
  1023. {
  1024. $this->knowledgeDate = $knowledgeDate;
  1025. return $this;
  1026. }
  1028. /**
  1029. * @return null|\DateTime
  1030. */
  1031. public function getLimitationDate(): ?\DateTime
  1032. {
  1033. return $this->limitationDate;
  1034. }
  1036. /**
  1037. * @param \DateTime $limitationDate
  1038. *
  1039. * @return MatterRequest
  1040. */
  1041. public function setLimitationDate(?\DateTime $limitationDate = null): MatterRequest
  1042. {
  1043. $this->limitationDate = $limitationDate;
  1045. // Update the associated matter as well, if it exists, and if the values are different,
  1046. // to avoid a recursive loop.
  1047. if ($this->getMatter() && $this->getMatter()->getLimitationDate() != $this->limitationDate) {
  1048. $this->getMatter()->setLimitationDate($this->limitationDate);
  1049. }
  1051. return $this;
  1052. }
  1054. /**
  1055. * @return int
  1056. */
  1057. public function getClaimCategory(): ?int
  1058. {
  1059. return $this->claimCategory;
  1060. }
  1062. /**
  1063. * @return string
  1064. */
  1065. public function getClaimCategoryLabel(): string
  1066. {
  1067. $claimCategories = array_flip(Project::getConstantsWithLabelsAsChoices('CLAIM_CATEGORY'));
  1069. return $claimCategories[$this->claimCategory] ?? 'Other';
  1070. }
  1072. /**
  1073. * @return bool
  1074. */
  1075. public function isClaimCategoryBirthInjury(): bool
  1076. {
  1077. return in_array($this->getClaimCategory(), Project::getBirthInjuryClaimCategories());
  1078. }
  1080. /**
  1081. * @param int $claimCategory
  1082. *
  1083. * @return MatterRequest
  1084. */
  1085. public function setClaimCategory(?int $claimCategory = null): MatterRequest
  1086. {
  1087. $this->claimCategory = $claimCategory;
  1089. // Update the associated matter as well, if it exists, and if the values are different,
  1090. // to avoid a recursive loop.
  1091. if ($this->getMatter() && $this->getMatter()->getClaimCategory() != $this->claimCategory) {
  1092. $this->getMatter()->setClaimCategory($this->claimCategory);
  1093. }
  1095. return $this;
  1096. }
  1098. /**
  1099. * @return Collection|Patient[]
  1100. */
  1101. public function getPatients(): Collection
  1102. {
  1103. return $this->patients;
  1104. }
  1106. /**
  1107. * @param Collection $patients
  1108. *
  1109. * @return MatterRequest
  1110. */
  1111. public function setPatients(Collection $patients): MatterRequest
  1112. {
  1113. $this->patients = $patients;
  1114. return $this;
  1115. }
  1117. public function addPatient(Patient $patient): MatterRequest
  1118. {
  1119. $patient->setMatterRequest($this);
  1121. $this->patients[] = $patient;
  1123. return $this;
  1124. }
  1126. /**
  1127. * @return Collection
  1128. */
  1129. public function getTrustCentres(): Collection
  1130. {
  1131. return $this->trustCentres;
  1132. }
  1134. /**
  1135. * @param Collection $trustCentres
  1136. *
  1137. * @return MatterRequest
  1138. */
  1139. public function setTrustCentres(Collection $trustCentres): MatterRequest
  1140. {
  1141. $this->trustCentres = $trustCentres;
  1142. return $this;
  1143. }
  1145. public function addTrustCentre(TrustCentre $trustCentre): MatterRequest
  1146. {
  1147. $trustCentre->setMatterRequest($this);
  1149. $this->trustCentres[] = $trustCentre;
  1151. return $this;
  1152. }
  1154. /**
  1155. * @return PostProcessing|null
  1156. */
  1157. public function getPostProcessingDetails(): ?PostProcessing
  1158. {
  1159. return $this->postProcessingDetails;
  1160. }
  1162. /**
  1163. * @param PostProcessing|null $postProcessingDetails
  1164. *
  1165. * @return MatterRequest
  1166. */
  1167. public function setPostProcessingDetails(?PostProcessing $postProcessingDetails): MatterRequest
  1168. {
  1169. $this->postProcessingDetails = $postProcessingDetails;
  1170. return $this;
  1171. }
  1173. /**
  1174. * @return Chronology|null
  1175. */
  1176. public function getChronologyDetails(): ?Chronology
  1177. {
  1178. return $this->chronologyDetails;
  1179. }
  1181. /**
  1182. * @param Chronology|null $chronologyDetails
  1183. *
  1184. * @return MatterRequest
  1185. */
  1186. public function setChronologyDetails(?Chronology $chronologyDetails): MatterRequest
  1187. {
  1188. $this->chronologyDetails = $chronologyDetails;
  1189. return $this;
  1190. }
  1192. /**
  1193. * @return Review|null
  1194. */
  1195. public function getReviewDetails(): ?Review
  1196. {
  1197. return $this->reviewDetails;
  1198. }
  1200. /**
  1201. * @param Review|null $reviewDetails
  1202. *
  1203. * @return MatterRequest
  1204. */
  1205. public function setReviewDetails(?Review $reviewDetails): MatterRequest
  1206. {
  1207. $this->reviewDetails = $reviewDetails;
  1208. return $this;
  1209. }
  1211. /**
  1212. * @return Sort|null
  1213. */
  1214. public function getSortDetails(): ?Sort
  1215. {
  1216. return $this->sortDetails;
  1217. }
  1219. /**
  1220. * @param Sort|null $sortDetails
  1221. *
  1222. * @return MatterRequest
  1223. */
  1224. public function setSortDetails(?Sort $sortDetails): MatterRequest
  1225. {
  1226. $this->sortDetails = $sortDetails;
  1227. return $this;
  1228. }
  1230. /**
  1231. * @return Account
  1232. */
  1233. public function getFirm(): ?Account
  1234. {
  1235. return $this->firm;
  1236. }
  1238. /**
  1239. * @param Account|null $firm
  1240. *
  1241. * @return MatterRequest
  1242. */
  1243. public function setFirm(?Account $firm = null): MatterRequest
  1244. {
  1245. $this->firm = $firm;
  1246. return $this;
  1247. }
  1249. /**
  1250. * retrieves the manager of the project
  1251. *
  1252. * @return User|null
  1253. */
  1254. public function getManager(): ?User
  1255. {
  1256. try {
  1257. // If the manager is a Proxy, we need to load it to ensure it is fully initialized.
  1258. if ($this->manager instanceof Proxy) {
  1259. $this->manager->__load();
  1260. }
  1262. return $this->manager;
  1263. } catch (EntityNotFoundException $e) {
  1264. // If the manager is not found (has been soft/hard deleted), return null.
  1265. return null;
  1266. }
  1267. }
  1269. /**
  1270. * @param User|null $manager
  1271. *
  1272. * @return MatterRequest
  1273. */
  1274. public function setManager(?User $manager = null): MatterRequest
  1275. {
  1276. $this->manager = $manager;
  1278. // Update the associated matter as well, if it exists, and if the values are different,
  1279. // to avoid a recursive loop.
  1280. if ($this->getMatter() && $this->getMatter()->getManager() != $this->manager) {
  1281. $this->getMatter()->setManager($this->manager);
  1282. }
  1284. return $this;
  1285. }
  1287. /**
  1288. * @return Project|null
  1289. */
  1290. public function getMatter(): ?Project
  1291. {
  1292. return $this->matter;
  1293. }
  1295. /**
  1296. * @param Project|null $matter
  1297. *
  1298. * @return MatterRequest
  1299. */
  1300. public function setMatter(?Project $matter): MatterRequest
  1301. {
  1302. $this->matter = $matter;
  1303. return $this;
  1304. }
  1306. /**
  1307. * @return array|null
  1308. */
  1309. public function getKeyAllegations(): ?array
  1310. {
  1311. return $this->keyAllegations;
  1312. }
  1314. /**
  1315. * @return bool
  1316. */
  1317. public function hasKeyAllegations(): bool
  1318. {
  1319. return count($this->keyAllegations) > 0 && !in_array('', $this->keyAllegations);
  1320. }
  1322. /**
  1323. * @param array|null $keyAllegations
  1324. *
  1325. * @return MatterRequest
  1326. */
  1327. public function setKeyAllegations(?array $keyAllegations = null): MatterRequest
  1328. {
  1329. $this->keyAllegations = $keyAllegations;
  1330. return $this;
  1331. }
  1333. /**
  1334. * Validates key allegations.
  1335. *
  1336. * @return bool
  1337. */
  1338. public function validateKeyAllegations(): bool
  1339. {
  1340. if (count((array) $this->getKeyAllegations())) {
  1341. return false;
  1342. }
  1343. foreach ($this->getKeyAllegations() as $keyAllegation) {
  1344. if ($keyAllegation == '') {
  1345. return false;
  1346. }
  1347. }
  1349. return true;
  1350. }
  1352. /**
  1353. * @return bool
  1354. */
  1355. public function hasAdditionalContactsEmpty(): bool
  1356. {
  1357. if (count($this->getAdditionalContacts()) > 1) {
  1358. return !in_array('', $this->getAdditionalContacts()->toArray(), true);
  1359. }
  1360. return true;
  1362. }
  1364. /**
  1365. * @return string
  1366. */
  1367. public function getBackground(): ?string
  1368. {
  1369. return $this->background;
  1370. }
  1372. /**
  1373. * @param string $background
  1374. *
  1375. * @return MatterRequest
  1376. */
  1377. public function setBackground(string $background): MatterRequest
  1378. {
  1379. $this->background = $background;
  1381. // Update the associated matter as well, if it exists, and if the values are different,
  1382. // to avoid a recursive loop.
  1383. if ($this->getMatter() && $this->getMatter()->getBackground() != $this->background) {
  1384. $this->getMatter()->setBackground($this->background);
  1385. }
  1387. return $this;
  1388. }
  1390. /**
  1391. * Set currentFormStep.
  1392. *
  1393. * @param string|null $currentFormStep
  1394. *
  1395. * @return MatterRequest
  1396. */
  1397. public function setCurrentFormStep($currentFormStep = null)
  1398. {
  1399. $this->currentFormStep = $currentFormStep;
  1401. return $this;
  1402. }
  1404. /**
  1405. * Get currentFormStep.
  1406. *
  1407. * @return string|null
  1408. */
  1409. public function getCurrentFormStep()
  1410. {
  1411. return $this->currentFormStep;
  1412. }
  1414. /**
  1415. * Set selectedServiceGroup.
  1416. *
  1417. * @param string|null $selectedServiceGroup
  1418. *
  1419. * @return MatterRequest
  1420. */
  1421. public function setSelectedServiceGroup($selectedServiceGroup = null)
  1422. {
  1423. $this->selectedServiceGroup = $selectedServiceGroup;
  1425. return $this;
  1426. }
  1428. /**
  1429. * Get selectedServiceGroup.
  1430. *
  1431. * @return string|null
  1432. */
  1433. public function getSelectedServiceGroup()
  1434. {
  1435. return $this->selectedServiceGroup;
  1436. }
  1438. /**
  1439. * @return string
  1440. */
  1441. public function getSelectedServiceGroupLabel()
  1442. {
  1443. $serviceGroups = array_flip(static::getConstantsWithLabelsAsChoices('SERVICE_GROUP'));
  1445. return $serviceGroups[$this->selectedServiceGroup] ?? '';
  1446. }
  1448. /**
  1449. * Set serviceSelectionDetails.
  1450. *
  1451. * @param ServiceSelection|null $serviceSelectionDetails
  1452. *
  1453. * @return MatterRequest
  1454. */
  1455. public function setServiceSelectionDetails(?ServiceSelection $serviceSelectionDetails = null)
  1456. {
  1457. $this->serviceSelectionDetails = $serviceSelectionDetails;
  1459. return $this;
  1460. }
  1462. /**
  1463. * Get serviceSelectionDetails.
  1464. *
  1465. * @return ServiceSelection|null
  1466. */
  1467. public function getServiceSelectionDetails()
  1468. {
  1469. return $this->serviceSelectionDetails;
  1470. }
  1472. /**
  1473. * Returns true if one of the patients on the matter request has an additional supporting document added.
  1474. *
  1475. * @return bool
  1476. */
  1477. public function hasAdditionalSupportingDocuments(): bool
  1478. {
  1479. $patients = $this->getPatients()->filter(function (Patient $patient) {
  1480. $additionalSupportDocuments = $patient->getSupportingDocuments()->filter(function (SupportingDocument $supportingDocument) {
  1481. return $supportingDocument->isAdditionalDocumentType();
  1482. });
  1483. return $additionalSupportDocuments->count();
  1484. });
  1485. return $patients->count();
  1486. }
  1488. /**
  1489. * Set defendantUnknown.
  1490. *
  1491. * @param bool|null $defendantUnknown
  1492. *
  1493. * @return MatterRequest
  1494. */
  1495. public function setDefendantUnknown(?bool $defendantUnknown = null)
  1496. {
  1497. $this->defendantUnknown = $defendantUnknown;
  1499. return $this;
  1500. }
  1502. /**
  1503. * Get defendantUnknown.
  1504. *
  1505. * @return bool|null
  1506. */
  1507. public function getDefendantUnknown()
  1508. {
  1509. return $this->defendantUnknown;
  1510. }
  1512. /**
  1513. * Generates the string representation for the matter name.
  1514. *
  1515. * @return string
  1516. */
  1517. public function generateMatterName(): string
  1518. {
  1519. // If the defendant was marked as unknown, return just the claimant name for the matter name.
  1520. if ($this->getDefendantUnknown()) {
  1521. return $this->getClaimant();
  1522. } elseif (strpos($this->getDefendant() ?? '', self::DEFENDANT_SEPARATOR) === false) {
  1523. // else, if there's no comma, we only have one defendant.
  1524. $projectDefendantStr = $this->getDefendant();
  1525. } else {
  1526. // If there is comma, we have more than one, and need to format them.
  1527. $defendantArray = $this->getDefendantArray();
  1528. $projectDefendantStr = implode(' ', array_map(function (string $currentItem, $currentKey) {
  1529. return sprintf('(%1$s) %2$s', $currentKey + 1, $currentItem);
  1530. }, $defendantArray, array_keys($defendantArray)));
  1531. }
  1533. return sprintf('%1$s -v- %2$s', $this->getClaimant(), $projectDefendantStr);
  1534. }
  1536. /**
  1537. * Returns a string representation of all patient names.
  1538. *
  1539. * @return void
  1540. */
  1541. public function getPatientNamesStr()
  1542. {
  1543. return implode(', ', $this->getPatients()->map(function (Patient $patient) {
  1544. return $patient->getName();
  1545. })->toArray());
  1546. }
  1548. /**
  1549. * Returns the associated matter ID.
  1550. *
  1551. * @return int|null
  1552. */
  1553. public function getMatterId(): ?int
  1554. {
  1555. return $this->getMatter() ? $this->getMatter()->getId() : null;
  1556. }
  1558. /**
  1559. * Set status.
  1560. *
  1561. * @param string|null $status
  1562. *
  1563. * @return MatterRequest
  1564. */
  1565. public function setStatus(?string $status = null): MatterRequest
  1566. {
  1567. $this->status = $status;
  1569. return $this;
  1570. }
  1572. /**
  1573. * Get status.
  1574. *
  1575. * @return string|null
  1576. */
  1577. public function getStatus()
  1578. {
  1579. return $this->status;
  1580. }
  1582. /**
  1583. * @return string
  1584. */
  1585. public function getStatusLabel(): string
  1586. {
  1587. $statuses = array_flip(static::getConstantsWithLabelsAsChoices('STATUS'));
  1589. return $statuses[$this->status] ?? '';
  1590. }
  1592. /**
  1593. * Returns true if the status incomplete.
  1594. *
  1595. * @return bool
  1596. */
  1597. public function isStatusIncomplete(): bool
  1598. {
  1599. return $this->status === self::STATUS_INCOMPLETE;
  1600. }
  1602. /**
  1603. * Remove patient.
  1604. *
  1605. * @param Patient $patient
  1606. *
  1607. * @return bool TRUE if this collection contained the specified element, FALSE otherwise.
  1608. */
  1609. public function removePatient(Patient $patient)
  1610. {
  1611. return $this->patients->removeElement($patient);
  1612. }
  1614. /**
  1615. * Remove trustCentre.
  1616. *
  1617. * @param TrustCentre $trustCentre
  1618. *
  1619. * @return bool TRUE if this collection contained the specified element, FALSE otherwise.
  1620. */
  1621. public function removeTrustCentre(TrustCentre $trustCentre)
  1622. {
  1623. return $this->trustCentres->removeElement($trustCentre);
  1624. }
  1626. /**
  1627. * Set creator.
  1628. *
  1629. * @param User|null $creator
  1630. *
  1631. * @return MatterRequest
  1632. */
  1633. public function setCreator(?User $creator = null)
  1634. {
  1635. $this->creator = $creator;
  1637. return $this;
  1638. }
  1640. /**
  1641. * Get creator.
  1642. *
  1643. * @return User|null
  1644. */
  1645. public function getCreator()
  1646. {
  1647. return $this->creator;
  1648. }
  1650. /**
  1651. * Get String of Defendants separated by & and not a #
  1652. *
  1653. * @return string
  1654. */
  1655. public function getDefendantFormatted(): string
  1656. {
  1657. return implode(' & ', $this->getDefendantArray());
  1658. }
  1660. /**
  1661. * @return bool
  1662. */
  1663. public function isHostingOnlyMatter(): bool
  1664. {
  1665. return $this->getSelectedServiceGroup() === self::SERVICE_GROUP_HOSTING_ONLY;
  1666. }
  1668. /**
  1669. * @return string|null
  1670. */
  1671. public function getSource(): ?string
  1672. {
  1673. return $this->source;
  1674. }
  1676. /**
  1677. * @param string $source
  1678. *
  1679. * @return self
  1680. */
  1681. public function setSource(string $source): self
  1682. {
  1683. $this->source = $source;
  1685. return $this;
  1686. }
  1688. /**
  1689. * @return array
  1690. */
  1691. public static function getSourceOptions(): array
  1692. {
  1693. return static::getConstantsWithLabelsAsChoices('SOURCE');
  1694. }
  1696. /**
  1697. * @return string
  1698. */
  1699. public function getSourceLabel(): string
  1700. {
  1701. $options = array_flip(static::getSourceOptions());
  1703. return $options[$this->source] ?? '';
  1704. }
  1706. /**
  1707. * Represented by a multi-dimensional array of field changes.
  1708. *
  1709. * @return array|null
  1710. */
  1711. public function getHistoricalApiValues(): ?array
  1712. {
  1713. return $this->historicalApiValues;
  1714. }
  1716. /**
  1717. *
  1718. * @param \DateTime|null $archivedDate
  1719. * @param string|null $oldBillingCode
  1720. * @param string|null $oldMatterNumber
  1721. * @param bool $wasArchived
  1722. *
  1723. * @return self
  1724. */
  1725. public function addHistoricalApiValues(
  1726. ?\DateTime $archivedDate,
  1727. ?string $oldBillingCode,
  1728. ?string $oldMatterNumber,
  1729. bool $wasArchived = false
  1730. ): self {
  1731. $historicalApiValues = $this->getHistoricalApiValues() ?? [];
  1733. $historicalApiValues[] = [
  1734. 'oldBillingCode' => $oldBillingCode ?? 'NA',
  1735. 'oldMatterNumber' => $oldMatterNumber ?? 'NA',
  1736. 'wasArchived' => $wasArchived,
  1737. 'archivedDate' => $archivedDate ?? 'NA',
  1738. 'modified' => new \DateTime(),
  1739. ];
  1741. $this->setHistoricalApiValues($historicalApiValues);
  1743. return $this;
  1744. }
  1746. /**
  1747. * Get additional contacts
  1748. *
  1749. * @return null|Collection|User[]
  1750. */
  1751. public function getAdditionalContacts(): ?Collection
  1752. {
  1753. return $this->additionalContacts;
  1754. }
  1756. /**
  1757. * Set additional contacts
  1758. *
  1759. * @param null|Collection|User[] $additionalContacts
  1760. *
  1761. * @return self
  1762. */
  1763. public function setAdditionalContacts(?Collection $additionalContacts): self
  1764. {
  1765. $this->additionalContacts = $additionalContacts;
  1767. return $this;
  1768. }
  1770. /**
  1771. * Add an additional contact
  1772. *
  1773. * @param User $user
  1774. *
  1775. * @return self
  1776. */
  1777. public function addAdditionalContact(User $user): self
  1778. {
  1779. if (!$this->additionalContacts->contains($user)) {
  1780. $this->additionalContacts[] = $user;
  1781. }
  1783. return $this;
  1784. }
  1786. /**
  1787. * Remove an additional contact
  1788. *
  1789. * @param User $user
  1790. *
  1791. * @return self
  1792. */
  1793. public function removeAdditionalContact(User $user): self
  1794. {
  1795. $this->additionalContacts->removeElement($user);
  1797. return $this;
  1798. }
  1800. // get a string of additional contacts by looping through the collection
  1801. /**
  1802. * Get a formatted string of additional contacts' full names.
  1803. *
  1804. * @return string
  1805. */
  1806. public function getAdditionalContactsFormatted(): string
  1807. {
  1808. $names = [];
  1810. foreach ($this->additionalContacts as $user) {
  1811. $names[] = $user->getFullName();
  1812. }
  1814. return implode(', ', $names);
  1815. }
  1817. /**
  1818. * Represented by a multi-dimensional array of field changes.
  1819. * Do not allow access to setter, use the addHistoricalApiValues method instead.
  1820. *
  1821. * @param null|array $historicalApiValues
  1822. *
  1823. * @return self
  1824. */
  1825. protected function setHistoricalApiValues(?array $historicalApiValues): self
  1826. {
  1827. $this->historicalApiValues = $historicalApiValues;
  1829. return $this;
  1830. }
  1831. }