src/Entity/BatchRequest.php line 35

Open in your IDE?
  1. <?php
  3. namespace MedBrief\MSR\Entity;
  5. use DH\Auditor\Provider\Doctrine\Auditing\Annotation as Audit;
  6. use Doctrine\Common\Collections\ArrayCollection;
  7. use Doctrine\Common\Collections\Collection;
  8. use Doctrine\ORM\Mapping as ORM;
  9. use Gedmo\Mapping\Annotation as Gedmo;
  10. use MedBrief\MSR\Entity\Embeddable\RecordsReceived;
  11. use MedBrief\MSR\Entity\Preprocessing\PreprocessDocument;
  12. use MedBrief\MSR\Entity\RequestType\RequestTypeAwareInterface;
  13. use MedBrief\MSR\Entity\RequestType\RequestTypeAwareTrait;
  14. use MedBrief\MSR\Entity\Serviceable\ServiceableInterface;
  15. use MedBrief\MSR\Entity\Serviceable\ServiceableTrait;
  16. use MedBrief\MSR\Repository\BatchRequestRepository;
  17. use MedBrief\MSR\Service\Preprocessing\PreprocessItemInterface;
  18. use MedBrief\MSR\Service\RecordsRequestCentreTypeAwareInterface;
  19. use MedBrief\MSR\Service\SortingSession\Preprocessing\PreprocessingCriteriaAwareInterface;
  20. use MedBrief\MSR\Traits\FilterableClassConstantsTrait;
  22. /**
  23. * @ORM\Table(name="BatchRequest")
  24. *
  25. * @ORM\Entity(repositoryClass=BatchRequestRepository::class)
  26. *
  27. * @ORM\HasLifecycleCallbacks
  28. *
  29. * @Gedmo\SoftDeleteable(fieldName="deletedAt", timeAware=false)
  30. *
  31. * @Audit\Auditable
  32. *
  33. * @Audit\Security(view={"ROLE_ALLOWED_TO_AUDIT"})
  34. */
  35. class BatchRequest implements ServiceableInterface, RequestTypeAwareInterface, PreprocessItemInterface, RecordsRequestCentreTypeAwareInterface, PreprocessingCriteriaAwareInterface
  36. {
  37. use ServiceableTrait;
  39. use RequestTypeAwareTrait;
  41. use FilterableClassConstantsTrait;
  43. public const BATCH_STANDARD_SHELF_LOCATIONS = [
  44. 'Records With Issues' => 'RWI',
  45. 'Returns Shelf' => 'Returns Shelf',
  46. ];
  48. public const PAGINATION_INDENT_LEVEL_1 = 1;
  49. public const PAGINATION_INDENT_LEVEL_1__LABEL = 1;
  51. public const PAGINATION_INDENT_LEVEL_2 = 2;
  52. public const PAGINATION_INDENT_LEVEL_2__LABEL = 2;
  54. public const PAGINATION_INDENT_LEVEL_3 = 3;
  55. public const PAGINATION_INDENT_LEVEL_3__LABEL = 3;
  57. public const PAGINATION_INDENT_LEVEL_4 = 4;
  58. public const PAGINATION_INDENT_LEVEL_4__LABEL = 4;
  60. public const PAGINATION_INDENT_LEVEL_5 = 5;
  61. public const PAGINATION_INDENT_LEVEL_5__LABEL = 5;
  63. /**
  64. * paginationType constants
  65. */
  66. public const PAGINATION_TYPE_NORMAL = 1;
  67. public const PAGINATION_TYPE_INSERTION = 2;
  68. public const PAGINATION_TYPE_UPDATE = 3;
  70. // dataCategory constant values
  71. public const DATA_CATEGORY_RADIOLOGY = 1;
  72. public const DATA_CATEGORY_VIDEO = 2;
  73. public const DATA_CATEGORY_AUDIO = 3;
  74. public const DATA_CATEGORY_HARD_COPY_INDEXED = 4;
  75. public const DATA_CATEGORY_MEDICAL_RECORDS = 5;
  76. public const DATA_CATEGORY_ELECTRONIC_INDEXED = 6;
  78. // destroyOrReturn constant values
  79. // This is not a simple boolean value, to allow for more future values (such as both)
  80. // and to force a value selection.
  81. public const RECORDS_DESTROY = 1;
  82. public const RECORDS_RETURN = 2;
  84. // Constants used for auto date calculation
  85. public const AUTO_DATE_SORT_DEADLINE = '+6weekday';
  86. public const AUTO_DATE_ESTIMATED_DEADLINE = '+10weekday';
  87. public const AUTO_DATE_DESTRUCTION = '+30day';
  89. // Constants for quoteStatus
  90. public const QUOTE_STATUS_PENDING = 1;
  91. public const QUOTE_STATUS_ACCEPTED = 2;
  92. public const QUOTE_STATUS_DECLINED = 3;
  94. public const COMPUTERIZED_RECORDS_BILLING_THRESHOLD = 1000;
  96. public const EXCLUDE_FROM_PREPROCESSIN_LABEL = '(Excl. from pre-processing)';
  97. public const INCLUDE_FOR_PREPROCESSIN_LABEL = '(Incl. for pre-processing)';
  99. public const CENTRE_TYPE_OTHER_PRE_PROCESSING = 1000;
  100. public const CENTRE_TYPE_OTHER_PRE_PROCESSING__LABEL = 'Other - Pre-processing';
  102. /**
  103. * @var ServiceRequest
  104. *
  105. * @ORM\OneToOne(targetEntity="MedBrief\MSR\Entity\ServiceRequest", mappedBy="batchRequest", cascade={"persist"})
  106. */
  107. protected $serviceRequest;
  109. /**
  110. * @var int
  111. *
  112. * @ORM\Column(name="id", type="integer")
  113. *
  114. * @ORM\Id
  115. *
  116. * @ORM\GeneratedValue(strategy="IDENTITY")
  117. */
  118. protected $id;
  120. /**
  121. * @var string|null
  122. *
  123. * @ORM\Column(name="receivedFrom", type="text", nullable=true)
  124. */
  125. protected $receivedFrom;
  127. /**
  128. * @var string|null
  129. *
  130. * @ORM\Column(name="centreName", type="text", nullable=true)
  131. */
  132. protected $centreName;
  134. /**
  135. * @var int|null
  136. *
  137. * @ORM\Column(name="dataCategory", type="integer", nullable=true)
  138. */
  139. protected $dataCategory;
  141. /**
  142. * @var bool|null
  143. *
  144. * @ORM\Column(name="isCopy", type="boolean", options={"default"=true} , nullable=true)
  145. */
  146. protected $isCopy;
  148. /**
  149. * @var \DateTime|null
  150. *
  151. * @ORM\Column(name="dateReceived", type="date", nullable=true)
  152. */
  153. protected $dateReceived;
  155. /**
  156. * @var \DateTime|null
  157. *
  158. * @ORM\Column(name="sortDeadlineDate", type="date", nullable=true)
  159. */
  160. protected $sortDeadlineDate;
  162. /**
  163. * @var \DateTime|null
  164. *
  165. * @ORM\Column(name="estimatedDeadlineDate", type="date", nullable=true)
  166. */
  167. protected $estimatedDeadlineDate;
  169. /**
  170. * @var \DateTime|null
  171. *
  172. * @ORM\Column(name="dateCompleted", type="date", nullable=true)
  173. */
  174. protected $dateCompleted;
  176. /**
  177. * @var string|null
  178. *
  179. * @ORM\Column(name="passwords", type="string", nullable=true)
  180. */
  181. protected $passwords;
  183. /**
  184. * @var bool
  185. *
  186. * @ORM\Column(name="chronologyRequired", type="boolean", options={"default"=false})
  187. */
  188. protected $chronologyRequired;
  190. /**
  191. * @var int|null
  192. *
  193. * @ORM\Column(name="destroyOrReturn", type="integer", nullable=true)
  194. */
  195. protected $destroyOrReturn;
  197. /**
  198. * @var \DateTime|null
  199. *
  200. * @ORM\Column(name="destructionDate", type="date", nullable=true)
  201. */
  202. protected $destructionDate;
  204. /**
  205. * @var \DateTime|null
  206. *
  207. * @ORM\Column(name="dateDestroyedOrReturned", type="date", nullable=true)
  208. */
  209. protected $dateDestroyedOrReturned;
  211. /**
  212. * @var int|null
  213. *
  214. * @ORM\Column(name="archiveBoxNumber", type="integer", nullable=true)
  215. */
  216. protected $archiveBoxNumber;
  218. /**
  219. * The physical location where Records are to be/have been stored
  220. *
  221. * @var string
  222. *
  223. * @ORM\Column(name="shelfLocation", type="string", length=255, nullable=true)
  224. */
  225. protected $shelfLocation;
  227. /**
  228. * @var \DateTime|null
  229. *
  230. * @ORM\Column(name="qaDate", type="date", nullable=true)
  231. */
  232. protected $qaDate;
  234. /**
  235. * @var string|null
  236. *
  237. * @ORM\Column(name="qaDuration", type="decimal", precision=7, scale=2, nullable=true)
  238. */
  239. protected $qaDuration;
  241. /**
  242. * @var \DateTime|null
  243. *
  244. * @ORM\Column(name="uploadedDate", type="date", nullable=true)
  245. */
  246. protected $uploadedDate;
  248. /**
  249. * @var \DateTime|null
  250. *
  251. * @ORM\Column(name="sortedDate", type="date", nullable=true)
  252. */
  253. protected $sortedDate;
  255. /**
  256. * @var \DateTime|null
  257. *
  258. * @ORM\Column(name="scannedDate", type="date", nullable=true)
  259. */
  260. protected $scannedDate;
  262. /**
  263. * @var int|null
  264. *
  265. * @ORM\Column(name="pageCount", type="integer", nullable=true)
  266. */
  267. protected $pageCount;
  269. /**
  270. * @var int|null
  271. *
  272. * @ORM\Column(name="blankAndDupesCount", type="integer", nullable=true)
  273. */
  274. protected $blankAndDupesCount;
  276. /**
  277. * @var int|null
  278. *
  279. * @ORM\Column(name="computerizedRecordsCount", type="integer", nullable=true)
  280. */
  281. protected $computerizedRecordsCount;
  283. /**
  284. * @var string|null
  285. *
  286. * @ORM\Column(name="scanDuration", type="decimal", precision=7, scale=2, nullable=true)
  287. */
  288. protected $scanDuration;
  290. /**
  291. * @var string|null
  292. *
  293. * @ORM\Column(name="sectionSortDuration", type="decimal", precision=7, scale=2, nullable=true)
  294. */
  295. protected $sectionSortDuration;
  297. /**
  298. * @var string|null
  299. *
  300. * @ORM\Column(name="dateSortDuration", type="decimal", precision=7, scale=2, nullable=true)
  301. */
  302. protected $dateSortDuration;
  304. /**
  305. * @var string|null
  306. *
  307. * @ORM\Column(name="admissionSortDuration", type="decimal", precision=7, scale=2, nullable=true)
  308. */
  309. protected $admissionSortDuration;
  311. /**
  312. * @var Project
  313. *
  314. * @ORM\ManyToOne(targetEntity="MedBrief\MSR\Entity\Project", inversedBy="batchRequests")
  315. *
  316. * @ORM\JoinColumns({
  317. *
  318. * @ORM\JoinColumn(name="project_id", referencedColumnName="id")
  319. * })
  320. */
  321. protected $project;
  323. /**
  324. * @var \DateTime|null
  325. *
  326. * @ORM\Column(name="deletedAt", type="datetime", nullable=true)
  327. */
  328. protected $deletedAt;
  330. /**
  331. * @var \DateTime
  332. *
  333. * @ORM\Column(name="created", type="datetime")
  334. *
  335. * @Gedmo\Timestampable(on="create")
  336. */
  337. protected $created;
  339. /**
  340. * @var User|null
  341. *
  342. * @ORM\ManyToOne(targetEntity="MedBrief\MSR\Entity\User")
  343. *
  344. * @ORM\JoinColumns({
  345. *
  346. * @ORM\JoinColumn(name="createdBy_id", referencedColumnName="id", nullable=true)
  347. * })
  348. */
  349. protected $createdBy;
  351. /**
  352. * @var \DateTime
  353. *
  354. * @ORM\Column(name="updated", type="datetime")
  355. *
  356. * @Gedmo\Timestampable(on="update")
  357. */
  358. protected $updated;
  360. /**
  361. * @var HumanResource
  362. *
  363. * @ORM\ManyToOne(targetEntity="MedBrief\MSR\Entity\HumanResource")
  364. *
  365. * @ORM\JoinColumns({
  366. *
  367. * @ORM\JoinColumn(name="sortedBy_id", referencedColumnName="id")
  368. * })
  369. */
  370. protected $sortedBy;
  372. /**
  373. * @var HumanResource
  374. *
  375. * @ORM\ManyToOne(targetEntity="MedBrief\MSR\Entity\HumanResource")
  376. *
  377. * @ORM\JoinColumns({
  378. *
  379. * @ORM\JoinColumn(name="dateSortedBy_id", referencedColumnName="id")
  380. * })
  381. */
  382. protected $dateSortedBy;
  384. /**
  385. * @var HumanResource
  386. *
  387. * @ORM\ManyToOne(targetEntity="MedBrief\MSR\Entity\HumanResource")
  388. *
  389. * @ORM\JoinColumns({
  390. *
  391. * @ORM\JoinColumn(name="admissionSortedBy_id", referencedColumnName="id")
  392. * })
  393. */
  394. protected $admissionSortedBy;
  396. /**
  397. * @var HumanResource
  398. *
  399. * @ORM\ManyToOne(targetEntity="MedBrief\MSR\Entity\HumanResource")
  400. *
  401. * @ORM\JoinColumns({
  402. *
  403. * @ORM\JoinColumn(name="scanCompletedBy_id", referencedColumnName="id")
  404. * })
  405. */
  406. protected $scanCompletedBy;
  408. /**
  409. * @var HumanResource
  410. *
  411. * @ORM\ManyToOne(targetEntity="MedBrief\MSR\Entity\HumanResource")
  412. *
  413. * @ORM\JoinColumns({
  414. *
  415. * @ORM\JoinColumn(name="qaBy_id", referencedColumnName="id")
  416. * })
  417. */
  418. protected $qaBy;
  420. /**
  421. * @var HumanResource
  422. *
  423. * @ORM\ManyToOne(targetEntity="MedBrief\MSR\Entity\HumanResource")
  424. *
  425. * @ORM\JoinColumns({
  426. *
  427. * @ORM\JoinColumn(name="uploadedBy_id", referencedColumnName="id")
  428. * })
  429. */
  430. protected $uploadedBy;
  432. /**
  433. * @var Collection
  434. *
  435. * @ORM\OneToMany(targetEntity="MedBrief\MSR\Entity\BatchRequestDetail", mappedBy="batchRequest", cascade={"persist","remove"}, orphanRemoval=true)
  436. */
  437. protected $details;
  439. /**
  440. * @var ChronologyRequest
  441. *
  442. * @ORM\ManyToOne(targetEntity="MedBrief\MSR\Entity\ChronologyRequest", inversedBy="batches")
  443. *
  444. * @ORM\JoinColumns({
  445. *
  446. * @ORM\JoinColumn(name="chronologyRequest_id", referencedColumnName="id")
  447. * })
  448. */
  449. protected $chronologyRequest;
  451. /**
  452. * @var RecordsReceived
  453. *
  454. * @ORM\Embedded(class="MedBrief\MSR\Entity\Embeddable\RecordsReceived", columnPrefix="recordsReceived_")
  455. */
  456. protected $recordsReceived;
  458. /**
  459. * @var int|null
  460. *
  461. * @ORM\Column(name="radiologyDiscCount", type="integer", nullable=true)
  462. */
  463. protected $radiologyDiscCount;
  465. /**
  466. * @var string|null
  467. *
  468. * @ORM\Column(name="hoursQuoted", type="decimal", precision=7, scale=2, nullable=true)
  469. */
  470. protected $hoursQuoted;
  472. /**
  473. * @var int|null
  474. *
  475. * @ORM\Column(name="quoteStatus", type="integer", nullable=true)
  476. */
  477. protected $quoteStatus;
  479. /**
  480. * @var Collection
  481. *
  482. * @ORM\OneToMany(targetEntity="MedBrief\MSR\Entity\Disc", mappedBy="batchRequest", cascade={"persist"})
  483. */
  484. protected $discs;
  486. /**
  487. * @var SortingSession
  488. *
  489. * @ORM\ManyToOne(targetEntity="MedBrief\MSR\Entity\SortingSession", inversedBy="batchRequests")
  490. *
  491. * @ORM\JoinColumns({
  492. *
  493. * @ORM\JoinColumn(name="sortingSession_id", referencedColumnName="id")
  494. * })
  495. */
  496. protected $sortingSession;
  498. /**
  499. * @var Collection
  500. *
  501. * @ORM\OneToMany(targetEntity="MedBrief\MSR\Entity\BatchDocument", mappedBy="batchRequest", cascade={"persist"})
  502. *
  503. * @ORM\OrderBy({
  504. * "sortOrder"="ASC"
  505. * })
  506. */
  507. protected $batchDocuments;
  509. /**
  510. * @var Collection
  511. *
  512. * @ORM\OneToMany(targetEntity="MedBrief\MSR\Entity\Page", mappedBy="batchRequest", cascade={"persist"})
  513. */
  514. protected $pages;
  516. /**
  517. * @var bool
  518. *
  519. * @ORM\Column(name="locked", type="boolean", nullable=true, options={"default"=false})
  520. */
  521. protected $locked;
  523. /**
  524. * @var string
  525. *
  526. * @ORM\Column(name="paginationPrefix", type="string", nullable=true)
  527. */
  528. protected $paginationPrefix;
  530. /**
  531. * @var string
  532. *
  533. * @ORM\Column(name="paginationIndentLevel", type="integer", nullable=true)
  534. */
  535. protected $paginationIndentLevel;
  537. /**
  538. * @var int
  539. *
  540. * @ORM\Column(name="paginationType", type="integer", nullable=true, options={"default"="1"})
  541. */
  542. protected $paginationType;
  544. /**
  545. * @var int|null
  546. *
  547. * @ORM\Column(name="clonedPageCount", type="integer", nullable=true)
  548. */
  549. protected $clonedPageCount;
  551. /**
  552. * @var string|null
  553. *
  554. * @ORM\Column(name="centreNameHistory", type="string", nullable=true)
  555. */
  556. protected $centreNameHistory;
  558. /**
  559. * @var Collection
  560. *
  561. * @ORM\OneToMany(targetEntity="MedBrief\MSR\Entity\Preprocessing\PreprocessDocument", mappedBy="batchRequest")
  562. */
  563. private $preprocessDocuments;
  565. /**
  566. * @var int|null
  567. *
  568. * @ORM\Column(name="centreType", type="integer", nullable=true)
  569. */
  570. private $centreType;
  572. /**
  573. * @var int|null
  574. *
  575. * @ORM\Column(name="scannedPageCount", type="integer", nullable=true)
  576. *
  577. */
  578. private ?int $scannedPageCount;
  580. /**
  581. * Constructor
  582. */
  583. public function __construct()
  584. {
  585. $this->isCopy = true;
  586. $this->chronologyRequired = false;
  587. $this->details = new ArrayCollection();
  588. $this->discs = new ArrayCollection();
  589. $this->recordsReceived = new RecordsReceived();
  590. $this->pages = new ArrayCollection();
  591. $this->batchDocuments = new ArrayCollection();
  592. $this->preprocessDocuments = new ArrayCollection();
  593. }
  595. /**
  596. * __toString
  597. *
  598. * @return string
  599. */
  600. public function __toString()
  601. {
  602. return (string) $this->getId();
  603. }
  605. /**
  606. * Get id
  607. *
  608. * @return int
  609. */
  610. public function getId()
  611. {
  612. return $this->id;
  613. }
  615. /**
  616. * Set isCopy
  617. *
  618. * @param bool $isCopy
  619. *
  620. * @return BatchRequest
  621. */
  622. public function setIsCopy($isCopy)
  623. {
  624. $this->isCopy = $isCopy;
  626. return $this;
  627. }
  629. /**
  630. * Get isCopy
  631. *
  632. * @return bool
  633. */
  634. public function getIsCopy()
  635. {
  636. return $this->isCopy;
  637. }
  639. /**
  640. * Get isCopyLabel
  641. *
  642. * @return bool
  643. */
  644. public function getIsCopyLabel()
  645. {
  646. return $this->isCopy ? 'Copy' : 'Original Records';
  647. }
  649. /**
  650. * Get isCopyOptions
  651. *
  652. * @return array
  653. */
  654. public static function getIsCopyOptions()
  655. {
  656. return [
  657. 'Copy' => true,
  658. 'Original Records' => false,
  659. ];
  660. }
  662. /**
  663. * Set dateReceived
  664. *
  665. * @param \DateTime $dateReceived
  666. *
  667. * @return BatchRequest
  668. */
  669. public function setDateReceived($dateReceived)
  670. {
  671. $this->dateReceived = $dateReceived;
  673. return $this;
  674. }
  676. /**
  677. * Get dateReceived
  678. *
  679. * @return \DateTime
  680. */
  681. public function getDateReceived()
  682. {
  683. return $this->dateReceived;
  684. }
  686. /**
  687. * Set estimatedDeadlineDate
  688. *
  689. * @param \DateTime $estimatedDeadlineDate
  690. *
  691. * @return BatchRequest
  692. */
  693. public function setEstimatedDeadlineDate($estimatedDeadlineDate)
  694. {
  695. $this->estimatedDeadlineDate = $estimatedDeadlineDate;
  697. return $this;
  698. }
  700. /**
  701. * Get estimatedDeadlineDate
  702. *
  703. * @return \DateTime
  704. */
  705. public function getEstimatedDeadlineDate()
  706. {
  707. return $this->estimatedDeadlineDate;
  708. }
  710. /**
  711. * Get generateEstimatedDeadlineDate
  712. *
  713. * @return BatchRequest
  714. */
  715. public function generateEstimatedDeadlineDate()
  716. {
  717. if (!$this->estimatedDeadlineDate && $this->getDateReceived()) {
  718. $estimatedDeadlineDate = clone $this->getDateReceived();
  719. $estimatedDeadlineDate->modify(self::AUTO_DATE_ESTIMATED_DEADLINE);
  720. $this->setEstimatedDeadlineDate($estimatedDeadlineDate);
  721. }
  722. return $this;
  723. }
  725. /**
  726. * Set dateCompleted
  727. *
  728. * @param \DateTime $dateCompleted
  729. *
  730. * @return BatchRequest
  731. */
  732. public function setDateCompleted($dateCompleted)
  733. {
  734. $this->dateCompleted = $dateCompleted;
  736. return $this;
  737. }
  739. /**
  740. * Get dateCompleted
  741. *
  742. * @return \DateTime
  743. */
  744. public function getDateCompleted()
  745. {
  746. return $this->dateCompleted;
  747. }
  749. /**
  750. * Set destructionDate
  751. *
  752. * @param \DateTime $destructionDate
  753. *
  754. * @return BatchRequest
  755. */
  756. public function setDestructionDate($destructionDate)
  757. {
  758. $this->destructionDate = $destructionDate;
  760. return $this;
  761. }
  763. /**
  764. * Get destructionDate
  765. *
  766. * @return \DateTime
  767. */
  768. public function getDestructionDate()
  769. {
  770. return $this->destructionDate;
  771. }
  773. /**
  774. * Updates the destruction date based on if the destroyOrReturned field
  775. * is set to RECORDS_DESTROY, and a dateCompleted is set.
  776. *
  777. * Used as a lifecycleCallback.
  778. *
  779. * @ORM\PrePersist
  780. *
  781. * @ORM\PreUpdate
  782. */
  783. public function updateDestructionDate()
  784. {
  785. // If the records are set to be destroyed, calculate and set the destruction date.
  786. if ($this->getDestroyOrReturn() === self::RECORDS_DESTROY && $this->getDateCompleted()) {
  787. $destructionDate = clone $this->getDateCompleted();
  788. $destructionDate->modify(self::AUTO_DATE_DESTRUCTION);
  789. $this->setDestructionDate($destructionDate);
  790. } else {
  791. $this->setDestructionDate(null);
  792. }
  794. return $this;
  795. }
  797. /**
  798. * Returns true if the batch has been destroyed.
  799. *
  800. * Functions by checking if the destroyOrReturn value was set to destroy,
  801. * and if a dateDestroyedOrReturned is set.
  802. *
  803. * @return bool
  804. */
  805. public function isDestroyed()
  806. {
  807. return $this->getDestroyOrReturn() === self::RECORDS_DESTROY && $this->getDateDestroyedOrReturned();
  808. }
  810. /**
  811. * Set dateDestroyedOrReturned
  812. *
  813. * @param \DateTime $dateDestroyedOrReturned
  814. *
  815. * @return BatchRequest
  816. */
  817. public function setDateDestroyedOrReturned($dateDestroyedOrReturned)
  818. {
  819. $this->dateDestroyedOrReturned = $dateDestroyedOrReturned;
  821. return $this;
  822. }
  824. /**
  825. * Get dateDestroyedOrReturned
  826. *
  827. * @return \DateTime
  828. */
  829. public function getDateDestroyedOrReturned()
  830. {
  831. return $this->dateDestroyedOrReturned;
  832. }
  834. /**
  835. * Set archiveBoxNumber
  836. *
  837. * @param string $archiveBoxNumber
  838. *
  839. * @return BatchRequest
  840. */
  841. public function setArchiveBoxNumber($archiveBoxNumber)
  842. {
  843. $this->archiveBoxNumber = $archiveBoxNumber;
  845. return $this;
  846. }
  848. /**
  849. * Get archiveBoxNumber
  850. *
  851. * @return string
  852. */
  853. public function getArchiveBoxNumber()
  854. {
  855. return $this->archiveBoxNumber;
  856. }
  858. /**
  859. * Get archiveBoxNumber
  860. *
  861. * @return string
  862. */
  863. public function getArchiveBoxNumberInclPrefix()
  864. {
  865. $prefix = '';
  866. if ($this->getProject() && $this->getProject()->getAccount()) {
  867. $prefix = $this->getProject()->getAccount()->getPrefix();
  868. }
  870. return ($prefix ? $prefix . '-' : '') . $this->archiveBoxNumber;
  871. }
  873. /**
  874. * Set qaDate
  875. *
  876. * @param \DateTime $qaDate
  877. *
  878. * @return BatchRequest
  879. */
  880. public function setQaDate($qaDate)
  881. {
  882. $this->qaDate = $qaDate;
  884. return $this;
  885. }
  887. /**
  888. * Get qaDate
  889. *
  890. * @return \DateTime
  891. */
  892. public function getQaDate()
  893. {
  894. return $this->qaDate;
  895. }
  897. /**
  898. * Set qaDuration
  899. *
  900. * @param int $qaDuration
  901. *
  902. * @return BatchRequest
  903. */
  904. public function setQaDuration($qaDuration)
  905. {
  906. $this->qaDuration = $qaDuration;
  908. return $this;
  909. }
  911. /**
  912. * Get qaDuration
  913. *
  914. * @return int
  915. */
  916. public function getQaDuration()
  917. {
  918. return $this->qaDuration;
  919. }
  921. /**
  922. * Set uploadedDate
  923. *
  924. * @param \DateTime $uploadedDate
  925. *
  926. * @return BatchRequest
  927. */
  928. public function setUploadedDate($uploadedDate)
  929. {
  930. $this->uploadedDate = $uploadedDate;
  932. return $this;
  933. }
  935. /**
  936. * Get uploadedDate
  937. *
  938. * @return \DateTime
  939. */
  940. public function getUploadedDate()
  941. {
  942. return $this->uploadedDate;
  943. }
  945. /**
  946. * Set deletedAt
  947. *
  948. * @param \DateTime $deletedAt
  949. *
  950. * @return BatchRequest
  951. */
  952. public function setDeletedAt($deletedAt)
  953. {
  954. $this->deletedAt = $deletedAt;
  956. return $this;
  957. }
  959. /**
  960. * Get deletedAt
  961. *
  962. * @return \DateTime
  963. */
  964. public function getDeletedAt()
  965. {
  966. return $this->deletedAt;
  967. }
  969. /**
  970. * Set dataCategory
  971. *
  972. * @param int $dataCategory
  973. *
  974. * @return BatchRequest
  975. */
  976. public function setDataCategory($dataCategory)
  977. {
  978. $this->dataCategory = $dataCategory;
  980. return $this;
  981. }
  983. /**
  984. * Get dataCategory
  985. *
  986. * @return int
  987. */
  988. public function getDataCategory()
  989. {
  990. return $this->dataCategory;
  991. }
  993. /**
  994. * Convenience function for checking if this BatchRequest is
  995. * dataCategory DATA_CATEGORY_RADIOLOGY.
  996. *
  997. * @return bool
  998. */
  999. public function isRadiologyDataCategory()
  1000. {
  1001. return $this->getDataCategory() === self::DATA_CATEGORY_RADIOLOGY;
  1002. }
  1004. /**
  1005. * Convenience function for checking if this BatchRequest is
  1006. * of type media - which includes certain dataCategories.
  1007. *
  1008. * @return bool
  1009. */
  1010. public function isDataCategoryTypeMedia()
  1011. {
  1012. $mediaTypeDataCategories = [
  1013. self::DATA_CATEGORY_RADIOLOGY,
  1014. self::DATA_CATEGORY_AUDIO,
  1015. self::DATA_CATEGORY_VIDEO,
  1016. ];
  1017. return in_array($this->getDataCategory(), $mediaTypeDataCategories);
  1018. }
  1020. /**
  1021. * Get dataCategoryOptions
  1022. *
  1023. * @return array
  1024. */
  1025. public static function getDataCategoryOptions()
  1026. {
  1027. return [
  1028. self::DATA_CATEGORY_RADIOLOGY => 'Radiology',
  1029. self::DATA_CATEGORY_VIDEO => 'Video',
  1030. self::DATA_CATEGORY_AUDIO => 'Audio',
  1031. self::DATA_CATEGORY_HARD_COPY_INDEXED => 'Hard copy indexed',
  1032. self::DATA_CATEGORY_MEDICAL_RECORDS => 'Medical records',
  1033. self::DATA_CATEGORY_ELECTRONIC_INDEXED => 'Electronic indexed',
  1034. ];
  1035. }
  1037. /**
  1038. * Get dataCategoryLabel
  1039. *
  1040. * @return int
  1041. */
  1042. public function getDataCategoryLabel()
  1043. {
  1044. $options = self::getDataCategoryOptions();
  1045. return $options[$this->getDataCategory()] ?? '';
  1046. }
  1048. /**
  1049. * Set sortedDate
  1050. *
  1051. * @param \DateTime $sortedDate
  1052. *
  1053. * @return BatchRequest
  1054. */
  1055. public function setSortedDate($sortedDate)
  1056. {
  1057. $this->sortedDate = $sortedDate;
  1059. return $this;
  1060. }
  1062. /**
  1063. * Get sortedDate
  1064. *
  1065. * @return \DateTime
  1066. */
  1067. public function getSortedDate()
  1068. {
  1069. return $this->sortedDate;
  1070. }
  1072. /**
  1073. * Set scannedDate
  1074. *
  1075. * @param \DateTime $scannedDate
  1076. *
  1077. * @return BatchRequest
  1078. */
  1079. public function setScannedDate($scannedDate)
  1080. {
  1081. $this->scannedDate = $scannedDate;
  1083. return $this;
  1084. }
  1086. /**
  1087. * Get scannedDate
  1088. *
  1089. * @return \DateTime
  1090. */
  1091. public function getScannedDate()
  1092. {
  1093. return $this->scannedDate;
  1094. }
  1096. /**
  1097. * Set pageCount
  1098. *
  1099. * @param int $pageCount
  1100. *
  1101. * @return BatchRequest
  1102. */
  1103. public function setPageCount($pageCount)
  1104. {
  1105. $this->pageCount = $pageCount;
  1107. return $this;
  1108. }
  1110. /**
  1111. * Get pageCount
  1112. *
  1113. * @return int
  1114. */
  1115. public function getPageCount()
  1116. {
  1117. return $this->pageCount;
  1118. }
  1120. /**
  1121. * Set blankAndDupesCount
  1122. *
  1123. * @param int $blankAndDupesCount
  1124. *
  1125. * @return BatchRequest
  1126. */
  1127. public function setBlankAndDupesCount($blankAndDupesCount)
  1128. {
  1129. $this->blankAndDupesCount = $blankAndDupesCount;
  1131. return $this;
  1132. }
  1134. /**
  1135. * Get blankAndDupesCount
  1136. *
  1137. * @return int
  1138. */
  1139. public function getBlankAndDupesCount()
  1140. {
  1141. return $this->blankAndDupesCount;
  1142. }
  1144. /**
  1145. * Set scanDuration
  1146. *
  1147. * @param int $scanDuration
  1148. *
  1149. * @return BatchRequest
  1150. */
  1151. public function setScanDuration($scanDuration)
  1152. {
  1153. $this->scanDuration = $scanDuration;
  1155. return $this;
  1156. }
  1158. /**
  1159. * Get scanDuration
  1160. *
  1161. * @return int
  1162. */
  1163. public function getScanDuration()
  1164. {
  1165. return $this->scanDuration;
  1166. }
  1168. /**
  1169. * Set sectionSortDuration
  1170. *
  1171. * @param int $sectionSortDuration
  1172. *
  1173. * @return BatchRequest
  1174. */
  1175. public function setSectionSortDuration($sectionSortDuration)
  1176. {
  1177. $this->sectionSortDuration = $sectionSortDuration;
  1179. return $this;
  1180. }
  1182. /**
  1183. * Get sectionSortDuration
  1184. *
  1185. * @return int
  1186. */
  1187. public function getSectionSortDuration()
  1188. {
  1189. return $this->sectionSortDuration;
  1190. }
  1192. /**
  1193. * Set dateSortDuration
  1194. *
  1195. * @param int $dateSortDuration
  1196. *
  1197. * @return BatchRequest
  1198. */
  1199. public function setDateSortDuration($dateSortDuration)
  1200. {
  1201. $this->dateSortDuration = $dateSortDuration;
  1203. return $this;
  1204. }
  1206. /**
  1207. * Get dateSortDuration
  1208. *
  1209. * @return int
  1210. */
  1211. public function getDateSortDuration()
  1212. {
  1213. return $this->dateSortDuration;
  1214. }
  1216. /**
  1217. * Set project
  1218. *
  1219. * @param Project $project
  1220. *
  1221. * @return BatchRequest
  1222. */
  1223. public function setProject(?Project $project = null)
  1224. {
  1225. $this->project = $project;
  1227. return $this;
  1228. }
  1230. /**
  1231. * Get project
  1232. *
  1233. * @return Project
  1234. */
  1235. public function getProject()
  1236. {
  1237. return $this->project;
  1238. }
  1240. /**
  1241. * Set sortDeadlineDate
  1242. *
  1243. * @param \DateTime $sortDeadlineDate
  1244. *
  1245. * @return BatchRequest
  1246. */
  1247. public function setSortDeadlineDate($sortDeadlineDate)
  1248. {
  1249. $this->sortDeadlineDate = $sortDeadlineDate;
  1251. return $this;
  1252. }
  1254. /**
  1255. * Get sortDeadlineDate
  1256. *
  1257. * @return \DateTime
  1258. */
  1259. public function getSortDeadlineDate()
  1260. {
  1261. if (!$this->sortDeadlineDate && $this->getDateReceived()) {
  1262. $sortDeadlineDate = clone $this->getDateReceived();
  1263. $sortDeadlineDate->modify(self::AUTO_DATE_SORT_DEADLINE);
  1264. return $sortDeadlineDate;
  1265. }
  1267. return $this->sortDeadlineDate;
  1268. }
  1270. /**
  1271. * Set created
  1272. *
  1273. * @param \DateTime $created
  1274. *
  1275. * @return BatchRequest
  1276. */
  1277. public function setCreated($created)
  1278. {
  1279. $this->created = $created;
  1281. return $this;
  1282. }
  1284. /**
  1285. * Get created
  1286. *
  1287. * @return \DateTime
  1288. */
  1289. public function getCreated()
  1290. {
  1291. return $this->created;
  1292. }
  1294. /**
  1295. * Set createdBy
  1296. *
  1297. * @param User|null $createdBy
  1298. *
  1299. * @return BatchRequest
  1300. */
  1301. public function setCreatedBy(?User $createdBy = null)
  1302. {
  1303. $this->createdBy = $createdBy;
  1305. return $this;
  1306. }
  1308. /**
  1309. * Get createdBy
  1310. *
  1311. * @return User|null
  1312. */
  1313. public function getCreatedBy(): ?User
  1314. {
  1315. return $this->createdBy;
  1316. }
  1318. /**
  1319. * Set updated
  1320. *
  1321. * @param \DateTime $updated
  1322. *
  1323. * @return BatchRequest
  1324. */
  1325. public function setUpdated($updated)
  1326. {
  1327. $this->updated = $updated;
  1329. return $this;
  1330. }
  1332. /**
  1333. * Get updated
  1334. *
  1335. * @return \DateTime
  1336. */
  1337. public function getUpdated()
  1338. {
  1339. return $this->updated;
  1340. }
  1342. /**
  1343. * Set sortedBy
  1344. *
  1345. * @param HumanResource $sortedBy
  1346. *
  1347. * @return BatchRequest
  1348. */
  1349. public function setSortedBy(?HumanResource $sortedBy = null)
  1350. {
  1351. $this->sortedBy = $sortedBy;
  1353. return $this;
  1354. }
  1356. /**
  1357. * Get sortedBy
  1358. *
  1359. * @return HumanResource
  1360. */
  1361. public function getSortedBy()
  1362. {
  1363. return $this->sortedBy;
  1364. }
  1366. /**
  1367. * Set scanCompletedBy
  1368. *
  1369. * @param HumanResource $scanCompletedBy
  1370. *
  1371. * @return BatchRequest
  1372. */
  1373. public function setScanCompletedBy(?HumanResource $scanCompletedBy = null)
  1374. {
  1375. $this->scanCompletedBy = $scanCompletedBy;
  1377. return $this;
  1378. }
  1380. /**
  1381. * Get scanCompletedBy
  1382. *
  1383. * @return HumanResource
  1384. */
  1385. public function getScanCompletedBy()
  1386. {
  1387. return $this->scanCompletedBy;
  1388. }
  1390. /**
  1391. * Set qaBy
  1392. *
  1393. * @param HumanResource $qaBy
  1394. *
  1395. * @return BatchRequest
  1396. */
  1397. public function setQaBy(?HumanResource $qaBy = null)
  1398. {
  1399. $this->qaBy = $qaBy;
  1401. return $this;
  1402. }
  1404. /**
  1405. * Get qaBy
  1406. *
  1407. * @return HumanResource
  1408. */
  1409. public function getQaBy()
  1410. {
  1411. return $this->qaBy;
  1412. }
  1414. /**
  1415. * Set uploadedBy
  1416. *
  1417. * @param HumanResource $uploadedBy
  1418. *
  1419. * @return BatchRequest
  1420. */
  1421. public function setUploadedBy(?HumanResource $uploadedBy = null)
  1422. {
  1423. $this->uploadedBy = $uploadedBy;
  1425. return $this;
  1426. }
  1428. /**
  1429. * Get uploadedBy
  1430. *
  1431. * @return HumanResource
  1432. */
  1433. public function getUploadedBy()
  1434. {
  1435. return $this->uploadedBy;
  1436. }
  1438. /**
  1439. * Set destroyOrReturn
  1440. *
  1441. * @param int $destroyOrReturn
  1442. *
  1443. * @return BatchRequest
  1444. */
  1445. public function setDestroyOrReturn($destroyOrReturn)
  1446. {
  1447. $this->destroyOrReturn = $destroyOrReturn;
  1449. return $this;
  1450. }
  1452. /**
  1453. * Get destroyOrReturn
  1454. *
  1455. * @return int
  1456. */
  1457. public function getDestroyOrReturn()
  1458. {
  1459. return $this->destroyOrReturn;
  1460. }
  1462. /**
  1463. * Get reasonForCancellationOptions
  1464. *
  1465. * @return array
  1466. */
  1467. public static function getDestroyOrReturnOptions()
  1468. {
  1469. return [
  1470. self::RECORDS_RETURN => 'Return',
  1471. self::RECORDS_DESTROY => 'Destroy',
  1472. ];
  1473. }
  1475. /**
  1476. * Get reasonForCancellationLabel
  1477. *
  1478. * @return string
  1479. */
  1480. public function getDestroyOrReturnLabel()
  1481. {
  1482. $options = self::getDestroyOrReturnOptions();
  1483. return $options[$this->getDestroyOrReturn()] ?? '';
  1484. }
  1486. /**
  1487. * Set chronologyRequired
  1488. *
  1489. * @param bool $chronologyRequired
  1490. *
  1491. * @return BatchRequest
  1492. */
  1493. public function setChronologyRequired($chronologyRequired)
  1494. {
  1495. $this->chronologyRequired = $chronologyRequired;
  1497. // Remove the linked ChronologyRequest if we indicate the BatchRequest does not require Chronology
  1498. if (!$chronologyRequired) {
  1499. $this->setChronologyRequest(null);
  1500. }
  1502. return $this;
  1503. }
  1505. /**
  1506. * Get chronologyRequired
  1507. *
  1508. * @return bool
  1509. */
  1510. public function getChronologyRequired()
  1511. {
  1512. return $this->chronologyRequired;
  1513. }
  1515. /**
  1516. * Get chronologyRequired
  1517. *
  1518. * @return bool
  1519. */
  1520. public function getChronologyRequiredLabel()
  1521. {
  1522. return $this->chronologyRequired ? 'Yes' : 'No';
  1523. }
  1525. /**
  1526. * Add detail
  1527. *
  1528. * @param BatchRequestDetail $detail
  1529. *
  1530. * @return BatchRequest
  1531. */
  1532. public function addDetail(BatchRequestDetail $detail)
  1533. {
  1534. $this->details[] = $detail;
  1536. return $this;
  1537. }
  1539. /**
  1540. * Remove detail
  1541. *
  1542. * @param BatchRequestDetail $detail
  1543. */
  1544. public function removeDetail(BatchRequestDetail $detail)
  1545. {
  1546. $this->details->removeElement($detail);
  1547. }
  1549. /**
  1550. * Get details
  1551. *
  1552. * @return Collection
  1553. */
  1554. public function getDetails()
  1555. {
  1556. return $this->details;
  1557. }
  1559. /**
  1560. * Set chronologyRequest
  1561. *
  1562. * @param ChronologyRequest $chronologyRequest
  1563. *
  1564. * @return BatchRequest
  1565. */
  1566. public function setChronologyRequest(?ChronologyRequest $chronologyRequest = null)
  1567. {
  1568. $this->chronologyRequest = $chronologyRequest;
  1570. return $this;
  1571. }
  1573. /**
  1574. * Get chronologyRequest
  1575. *
  1576. * @return ChronologyRequest
  1577. */
  1578. public function getChronologyRequest()
  1579. {
  1580. return $this->chronologyRequest;
  1581. }
  1583. /**
  1584. * Set receivedFrom
  1585. *
  1586. * @param string $receivedFrom
  1587. *
  1588. * @return BatchRequest
  1589. */
  1590. public function setReceivedFrom($receivedFrom)
  1591. {
  1592. $this->receivedFrom = $receivedFrom;
  1594. return $this;
  1595. }
  1597. /**
  1598. * Get receivedFrom
  1599. *
  1600. * @return string
  1601. */
  1602. public function getReceivedFrom()
  1603. {
  1604. return $this->receivedFrom;
  1605. }
  1607. /**
  1608. * Set recordsReceived
  1609. *
  1610. * @param RecordsReceived $recordsReceived
  1611. *
  1612. * @return BatchRequest
  1613. */
  1614. public function setRecordsReceived(RecordsReceived $recordsReceived)
  1615. {
  1616. $this->recordsReceived = $recordsReceived;
  1618. return $this;
  1619. }
  1621. /**
  1622. * Get recordsReceived
  1623. *
  1624. * @return RecordsReceived
  1625. */
  1626. public function getRecordsReceived()
  1627. {
  1628. return $this->recordsReceived;
  1629. }
  1631. /**
  1632. * Set passwords
  1633. *
  1634. * @param string $passwords
  1635. *
  1636. * @return BatchRequest
  1637. */
  1638. public function setPasswords($passwords)
  1639. {
  1640. $this->passwords = $passwords;
  1642. return $this;
  1643. }
  1645. /**
  1646. * Get passwords
  1647. *
  1648. * @return string
  1649. */
  1650. public function getPasswords()
  1651. {
  1652. return $this->passwords;
  1653. }
  1655. /**
  1656. * Add disc
  1657. *
  1658. * @param Disc $disc
  1659. *
  1660. * @return BatchRequest
  1661. */
  1662. public function addDisc(Disc $disc)
  1663. {
  1664. $this->discs[] = $disc;
  1666. return $this;
  1667. }
  1669. /**
  1670. * Remove disc
  1671. *
  1672. * @param Disc $disc
  1673. */
  1674. public function removeDisc(Disc $disc)
  1675. {
  1676. $this->discs->removeElement($disc);
  1677. }
  1679. /**
  1680. * Get discs
  1681. *
  1682. * @return Collection
  1683. */
  1684. public function getDiscs()
  1685. {
  1686. return $this->discs;
  1687. }
  1689. /**
  1690. * Unsets the association between this BatchRequest and Discs.
  1691. * Used as a preRemove lifecycle event, to avoid broken relationships when
  1692. * soft deleting a BatchRequest. Takes the place of a onDelete=NULL database
  1693. * call.
  1694. *
  1695. * @ORM\PreRemove
  1696. *
  1697. * @return void
  1698. */
  1699. public function clearDiscs()
  1700. {
  1701. foreach ($this->getDiscs() as $disc) {
  1702. // Only set the owning side relation to null.
  1703. $disc->setBatchRequest(null);
  1704. }
  1705. }
  1707. /**
  1708. * Set radiologyDiscCount
  1709. *
  1710. * @param int $radiologyDiscCount
  1711. *
  1712. * @return BatchRequest
  1713. */
  1714. public function setRadiologyDiscCount($radiologyDiscCount)
  1715. {
  1716. $this->radiologyDiscCount = $radiologyDiscCount;
  1718. return $this;
  1719. }
  1721. /**
  1722. * Get radiologyDiscCount
  1723. *
  1724. * @return int
  1725. */
  1726. public function getRadiologyDiscCount()
  1727. {
  1728. return $this->radiologyDiscCount;
  1729. }
  1731. /**
  1732. * Returns the number of Discs that still need to be created for this BatchRequest.
  1733. *
  1734. * @return int
  1735. */
  1736. public function getOutstandingRadiologyDiscCount()
  1737. {
  1738. return (int) $this->getRadiologyDiscCount() - $this->getDiscs()->count();
  1739. }
  1741. /**
  1742. * Gets all BatchRequests related to this BatchRequest, i.e.
  1743. * those that belong to the same ServiceRequestGroup
  1744. *
  1745. * @param $inclCurrent - Optionally include the current BatchRequest
  1746. *
  1747. * @return array
  1748. */
  1749. public function getRelatedBatchRequests($inclCurrent = false)
  1750. {
  1751. // If the BatchRequest does not belong to a ServiceRequest group,
  1752. // it has no related batches.
  1753. if (!$this->getServiceRequestGroup()) {
  1754. return [];
  1755. }
  1757. // Assign the calling class to a more readable variable
  1758. $currentBatchRequest = $this;
  1760. // Filter through the ServiceRequests on the ServiceRequestGroup and return the BatchRequests only.
  1761. $relatedBatchRequests = $this->getServiceRequestGroup()->getServiceRequests()->filter(function ($serviceRequest) use ($inclCurrent, $currentBatchRequest) {
  1762. // If the serviceRequest belongs to the currentBatchRequest...
  1763. if ($serviceRequest->getId() === $currentBatchRequest->getServiceRequest()->getId()) {
  1764. // include it if we want to include the current batchRequest
  1765. return $inclCurrent;
  1766. }
  1768. // If the serviceRequest is attached to a batchRequest, include it.
  1769. if ($serviceRequest->isBatchRequest()) {
  1770. return true;
  1771. }
  1773. // Don't include any others
  1774. return false;
  1775. });
  1777. // Extract the Serviceable from the ServiceRequest, which should be a BatchRequest.
  1778. return array_map(function ($serviceRequest) {
  1779. return $serviceRequest->getServiceable();
  1780. }, $relatedBatchRequests->toArray());
  1781. }
  1783. /**
  1784. * Set hoursQuoted
  1785. *
  1786. * @param int $hoursQuoted
  1787. *
  1788. * @return BatchRequest
  1789. */
  1790. public function setHoursQuoted($hoursQuoted)
  1791. {
  1792. $this->hoursQuoted = $hoursQuoted;
  1794. return $this;
  1795. }
  1797. /**
  1798. * Get hoursQuoted
  1799. *
  1800. * @return int
  1801. */
  1802. public function getHoursQuoted()
  1803. {
  1804. return $this->hoursQuoted;
  1805. }
  1807. /**
  1808. * Set quoteStatus
  1809. *
  1810. * @param int $quoteStatus
  1811. *
  1812. * @return BatchRequest
  1813. */
  1814. public function setQuoteStatus($quoteStatus)
  1815. {
  1816. $this->quoteStatus = $quoteStatus;
  1818. return $this;
  1819. }
  1821. /**
  1822. * Get quoteStatus
  1823. *
  1824. * @return int
  1825. */
  1826. public function getQuoteStatus()
  1827. {
  1828. return $this->quoteStatus;
  1829. }
  1831. /**
  1832. * Get quoteStatusLabel
  1833. *
  1834. * @return bool
  1835. */
  1836. public function getQuoteStatusLabel()
  1837. {
  1838. $options = self::getQuoteStatusOptions();
  1839. return $options[$this->getQuoteStatus()] ?? '';
  1840. }
  1842. /**
  1843. * Get quoteStatusOptions
  1844. *
  1845. * @return array
  1846. */
  1847. public static function getQuoteStatusOptions()
  1848. {
  1849. return [
  1850. self::QUOTE_STATUS_PENDING => 'Pending',
  1851. self::QUOTE_STATUS_ACCEPTED => 'Accepted',
  1852. self::QUOTE_STATUS_DECLINED => 'Declined',
  1853. ];
  1854. }
  1856. /**
  1857. * Set shelfLocation
  1858. *
  1859. * @param string $shelfLocation
  1860. *
  1861. * @return BatchRequest
  1862. */
  1863. public function setShelfLocation($shelfLocation)
  1864. {
  1865. $this->shelfLocation = $shelfLocation;
  1867. return $this;
  1868. }
  1870. /**
  1871. * Get shelfLocation
  1872. *
  1873. * @return string
  1874. */
  1875. public function getShelfLocation()
  1876. {
  1877. return $this->shelfLocation;
  1878. }
  1880. /**
  1881. * Set sortingSession
  1882. *
  1883. * @param SortingSession $sortingSession
  1884. *
  1885. * @return BatchRequest
  1886. */
  1887. public function setSortingSession(?SortingSession $sortingSession = null)
  1888. {
  1889. $this->sortingSession = $sortingSession;
  1891. return $this;
  1892. }
  1894. /**
  1895. * Get sortingSession
  1896. *
  1897. * @return SortingSession
  1898. */
  1899. public function getSortingSession()
  1900. {
  1901. return $this->sortingSession;
  1902. }
  1904. /**
  1905. * Add page
  1906. *
  1907. * @param Page $page
  1908. *
  1909. * @return BatchRequest
  1910. */
  1911. public function addPage(Page $page)
  1912. {
  1913. $this->pages[] = $page;
  1915. return $this;
  1916. }
  1918. /**
  1919. * Remove page
  1920. *
  1921. * @param Page $page
  1922. */
  1923. public function removePage(Page $page)
  1924. {
  1925. $this->pages->removeElement($page);
  1926. }
  1928. /**
  1929. * Get pages
  1930. *
  1931. * @return Collection
  1932. */
  1933. public function getPages()
  1934. {
  1935. return $this->pages;
  1936. }
  1938. /**
  1939. * Add batchDocument
  1940. *
  1941. * @param BatchDocument $batchDocument
  1942. *
  1943. * @return BatchRequest
  1944. */
  1945. public function addBatchDocument(BatchDocument $batchDocument)
  1946. {
  1947. $this->batchDocuments[] = $batchDocument;
  1949. return $this;
  1950. }
  1952. /**
  1953. * Remove batchDocument
  1954. *
  1955. * @param BatchDocument $batchDocument
  1956. */
  1957. public function removeBatchDocument(BatchDocument $batchDocument)
  1958. {
  1959. $this->batchDocuments->removeElement($batchDocument);
  1960. }
  1962. /**
  1963. * Get batchDocuments
  1964. *
  1965. * @return Collection|BatchDocument[]
  1966. */
  1967. public function getBatchDocuments()
  1968. {
  1969. return $this->batchDocuments;
  1970. }
  1972. /**
  1973. * Get batchDocuments that are PDF only.
  1974. *
  1975. * @return Collection|BatchDocument[]
  1976. */
  1977. public function getBatchDocumentsPdfOnly()
  1978. {
  1979. return $this->batchDocuments->filter(function (BatchDocument $item) {
  1980. return $item->getDocument()->getFileFamilyType() === Document::FILE_TYPE_PDF;
  1981. });
  1982. }
  1984. /**
  1985. * Get batchDocuments that are PDFs, plus any non-PDF documents left in a failed
  1986. * state (including encrypted PDFs) so they remain visible in the review list.
  1987. *
  1988. * @return Collection|BatchDocument[]
  1989. */
  1990. public function getBatchDocumentsPdfOrFailed()
  1991. {
  1992. return $this->batchDocuments->filter(function (BatchDocument $item) {
  1993. return $item->getDocument()->getFileFamilyType() === Document::FILE_TYPE_PDF
  1994. || $item->isFailed()
  1995. || $item->getStatus() === BatchDocument::STATUS_FAILED_ENCRYPTED;
  1996. });
  1997. }
  1999. /**
  2000. * Set locked
  2001. *
  2002. * @param bool $locked
  2003. *
  2004. * @return BatchRequest
  2005. */
  2006. public function setLocked($locked)
  2007. {
  2008. $this->locked = $locked;
  2010. return $this;
  2011. }
  2013. /**
  2014. * Get locked
  2015. *
  2016. * @return bool
  2017. */
  2018. public function isLocked()
  2019. {
  2020. return $this->locked;
  2021. }
  2023. /**
  2024. * Checks to see if this BatchRequest has pending BatchDocuments
  2025. *
  2026. * @return bool
  2027. */
  2028. public function hasPendingBatchDocuments()
  2029. {
  2030. /** @var BatchDocument $batchDocument */
  2031. foreach ($this->getBatchDocuments() as $batchDocument) {
  2032. if ($batchDocument->getStatus() === BatchDocument::STATUS_PENDING) {
  2033. return true;
  2034. }
  2035. }
  2037. return false;
  2038. }
  2040. /**
  2041. * Checks to see if this BatchRequest has in progress BatchDocuments
  2042. *
  2043. * @return bool
  2044. */
  2045. public function hasInProgressBatchDocuments()
  2046. {
  2047. /** @var BatchDocument $batchDocument */
  2048. foreach ($this->getBatchDocuments() as $batchDocument) {
  2049. if ($batchDocument->getStatus() === BatchDocument::STATUS_IN_PROGRESS) {
  2050. return true;
  2051. }
  2052. }
  2054. return false;
  2055. }
  2057. /**
  2058. * Set centreName
  2059. *
  2060. * @param string $centreName
  2061. *
  2062. * @return BatchRequest
  2063. */
  2064. public function setCentreName($centreName)
  2065. {
  2066. $centreName = trim($centreName);
  2067. if ($this->getReceivedFrom() === null) {
  2068. $this->setReceivedFrom($centreName);
  2069. }
  2070. $this->centreName = $centreName;
  2072. return $this;
  2073. }
  2075. /**
  2076. * Set paginationType
  2077. *
  2078. * @param int $paginationType
  2079. *
  2080. * @return BatchRequest
  2081. */
  2082. public function setPaginationType($paginationType)
  2083. {
  2084. $this->paginationType = $paginationType;
  2086. return $this;
  2087. }
  2089. /**
  2090. * Get centreName
  2091. *
  2092. * @return string
  2093. */
  2094. public function getCentreName()
  2095. {
  2096. return $this->centreName;
  2097. }
  2099. /**
  2100. * Get paginationType
  2101. *
  2102. * @return int
  2103. */
  2104. public function getPaginationType()
  2105. {
  2106. return $this->paginationType;
  2107. }
  2109. /**
  2110. * Get paginationTypeOptions
  2111. *
  2112. * @return array
  2113. */
  2114. public static function getPaginationTypeOptions()
  2115. {
  2116. return [
  2117. self::PAGINATION_TYPE_NORMAL => 'Normal',
  2118. self::PAGINATION_TYPE_INSERTION => 'Insertion',
  2119. self::PAGINATION_TYPE_UPDATE => 'Update',
  2120. ];
  2121. }
  2123. /**
  2124. * Get paginationTypeLabel
  2125. *
  2126. * @return int
  2127. */
  2128. public function getPaginationTypeLabel()
  2129. {
  2130. $options = self::getPaginationTypeOptions();
  2131. return $options[$this->getPaginationType()] ?? '';
  2132. }
  2134. /**
  2135. * Returns true if the pagination type insertion.
  2136. *
  2137. * @return bool
  2138. */
  2139. public function isInsertionPaginationType()
  2140. {
  2141. return $this->getPaginationType() === self::PAGINATION_TYPE_INSERTION;
  2142. }
  2144. /**
  2145. * Returns true if the pagination type is update.
  2146. *
  2147. * @return bool
  2148. */
  2149. public function isUpdatePaginationType()
  2150. {
  2151. return $this->getPaginationType() === self::PAGINATION_TYPE_UPDATE;
  2152. }
  2154. /**
  2155. * Gets the label to use in the choice drop downs.
  2156. *
  2157. * @return string
  2158. */
  2159. public function getChoiceLabel()
  2160. {
  2161. return sprintf('%1$s (%2$s Pag.)', $this->getServiceRequestGroupId(), $this->getPaginationTypeLabel());
  2162. }
  2164. /**
  2165. * Set admissionSortDuration.
  2166. *
  2167. * @param string|null $admissionSortDuration
  2168. *
  2169. * @return BatchRequest
  2170. */
  2171. public function setAdmissionSortDuration($admissionSortDuration = null)
  2172. {
  2173. $this->admissionSortDuration = $admissionSortDuration;
  2175. return $this;
  2176. }
  2178. /**
  2179. * Get admissionSortDuration.
  2180. *
  2181. * @return string|null
  2182. */
  2183. public function getAdmissionSortDuration()
  2184. {
  2185. return $this->admissionSortDuration;
  2186. }
  2188. /**
  2189. * Get locked.
  2190. *
  2191. * @return bool|null
  2192. */
  2193. public function getLocked()
  2194. {
  2195. return $this->locked;
  2196. }
  2198. /**
  2199. * Set dateSortedBy.
  2200. *
  2201. * @param HumanResource|null $dateSortedBy
  2202. *
  2203. * @return BatchRequest
  2204. */
  2205. public function setDateSortedBy(?HumanResource $dateSortedBy = null)
  2206. {
  2207. $this->dateSortedBy = $dateSortedBy;
  2209. return $this;
  2210. }
  2212. /**
  2213. * Get dateSortedBy.
  2214. *
  2215. * @return HumanResource|null
  2216. */
  2217. public function getDateSortedBy()
  2218. {
  2219. return $this->dateSortedBy;
  2220. }
  2222. /**
  2223. * Set admissionSortedBy.
  2224. *
  2225. * @param HumanResource|null $admissionSortedBy
  2226. *
  2227. * @return BatchRequest
  2228. */
  2229. public function setAdmissionSortedBy(?HumanResource $admissionSortedBy = null)
  2230. {
  2231. $this->admissionSortedBy = $admissionSortedBy;
  2233. return $this;
  2234. }
  2236. /**
  2237. * Get admissionSortedBy.
  2238. *
  2239. * @return HumanResource|null
  2240. */
  2241. public function getAdmissionSortedBy()
  2242. {
  2243. return $this->admissionSortedBy;
  2244. }
  2246. /**
  2247. * Set paginationPrefix.
  2248. *
  2249. * @param string|null $paginationPrefix
  2250. *
  2251. * @return BatchRequest
  2252. */
  2253. public function setPaginationPrefix($paginationPrefix = null)
  2254. {
  2255. $this->paginationPrefix = $paginationPrefix;
  2257. return $this;
  2258. }
  2260. /**
  2261. * Get paginationPrefix.
  2262. *
  2263. * @return string|null
  2264. */
  2265. public function getPaginationPrefix()
  2266. {
  2267. return $this->paginationPrefix;
  2268. }
  2270. /**
  2271. * Set paginationIndentLevel.
  2272. *
  2273. * @param int|null $paginationIndentLevel
  2274. *
  2275. * @return BatchRequest
  2276. */
  2277. public function setPaginationIndentLevel($paginationIndentLevel = null)
  2278. {
  2279. $this->paginationIndentLevel = $paginationIndentLevel;
  2281. return $this;
  2282. }
  2284. /**
  2285. * Get paginationIndentLevel.
  2286. *
  2287. * @return int|null
  2288. */
  2289. public function getPaginationIndentLevel()
  2290. {
  2291. return $this->paginationIndentLevel ?: self::PAGINATION_INDENT_LEVEL_1;
  2292. }
  2294. /**
  2295. * Set clonedPageCount.
  2296. *
  2297. * @param int|null $clonedPageCount
  2298. *
  2299. * @return BatchRequest
  2300. */
  2301. public function setClonedPageCount($clonedPageCount = null)
  2302. {
  2303. $this->clonedPageCount = $clonedPageCount;
  2305. return $this;
  2306. }
  2308. /**
  2309. * Get clonedPageCount.
  2310. *
  2311. * @return int|null
  2312. */
  2313. public function getClonedPageCount(): ?int
  2314. {
  2315. return $this->clonedPageCount;
  2316. }
  2318. /**
  2319. * Get the value of centreNameHistory
  2320. *
  2321. * @return string|null
  2322. */
  2323. public function getCentreNameHistory()
  2324. {
  2325. return $this->centreNameHistory;
  2326. }
  2328. /**
  2329. * Set the value of centreNameHistory
  2330. *
  2331. * @param string|null $centreNameHistory
  2332. *
  2333. * @return BatchRequest
  2334. */
  2335. public function setCentreNameHistory($centreNameHistory = null)
  2336. {
  2337. $this->centreNameHistory = $centreNameHistory;
  2339. return $this;
  2340. }
  2342. /**
  2343. * @return Collection|PreprocessDocument[]
  2344. */
  2345. public function getPreprocessDocuments(): Collection
  2346. {
  2347. return $this->preprocessDocuments;
  2348. }
  2350. /**
  2351. * @return PreprocessDocument[]
  2352. */
  2353. public function getPreprocessDocumentsArray(): array
  2354. {
  2355. return $this->preprocessDocuments->toArray();
  2356. }
  2358. /**
  2359. * @param PreprocessDocument $preprocessDocument
  2360. *
  2361. * @return self
  2362. */
  2363. public function addPreprocessDocument(PreprocessDocument $preprocessDocument): self
  2364. {
  2365. if (!$this->preprocessDocuments->contains($preprocessDocument)) {
  2366. $this->preprocessDocuments[] = $preprocessDocument;
  2367. $preprocessDocument->setBatchRequest($this);
  2368. }
  2370. return $this;
  2371. }
  2373. /**
  2374. * @param PreprocessDocument $preprocessDocument
  2375. *
  2376. * @return self
  2377. */
  2378. public function removePreprocessDocument(PreprocessDocument $preprocessDocument): self
  2379. {
  2380. if ($this->preprocessDocuments->removeElement($preprocessDocument)) {
  2381. // set the owning side to null (unless already changed)
  2382. if ($preprocessDocument->getBatchRequest() === $this) {
  2383. $preprocessDocument->setBatchRequest(null);
  2384. }
  2385. }
  2387. return $this;
  2388. }
  2390. /**
  2391. * @return int|null
  2392. */
  2393. public function getCentreType(): ?int
  2394. {
  2395. return $this->centreType;
  2396. }
  2398. /**
  2399. * @param int|null $centreType
  2400. *
  2401. * @return self
  2402. */
  2403. public function setCentreType(?int $centreType): self
  2404. {
  2405. $this->centreType = $centreType;
  2407. return $this;
  2408. }
  2410. /**
  2411. * @return array
  2412. */
  2413. public static function getCentreTypeOptions(): array
  2414. {
  2415. $options = self::getConstantsWithLabelsAsChoices('CENTRE_TYPE');
  2417. $includeOptions = [
  2418. self::CENTRE_TYPE_TRUST,
  2419. self::CENTRE_TYPE_GP,
  2420. self::CENTRE_TYPE_AMBULANCE_SERVICE,
  2421. self::CENTRE_TYPE_CARE_HOME,
  2422. self::CENTRE_TYPE_MARIE_STOPES,
  2423. self::CENTRE_TYPE_PHARMACY,
  2424. self::CENTRE_TYPE_CONSULTANT,
  2425. self::CENTRE_TYPE_HOSPITAL,
  2426. self::CENTRE_TYPE_PSYCHOLOGY,
  2427. self::CENTRE_TYPE_PHYSIO,
  2428. self::CENTRE_TYPE_PODIATRIST,
  2429. self::CENTRE_TYPE_URGENT_CARE_CENTRE,
  2430. self::CENTRE_TYPE_WALKIN_CENTRE,
  2431. self::CENTRE_TYPE_OTHER_PRE_PROCESSING,
  2432. ];
  2434. // Only return certain options for batch requests
  2435. $options = array_intersect($options, $includeOptions);
  2437. ksort($options);
  2439. $reLabeledOptions = [];
  2441. // Append the incl or excl label. Currently, we show the include label as so few centre types are included for pre-processing.
  2442. $preprocessingCentreTypes = static::getAllowedPreprocessingCentreTypes();
  2443. foreach ($options as $label => $value) {
  2444. if (in_array($value, $preprocessingCentreTypes) === true) {
  2445. $reLabeledOptions[sprintf('%1$s %2$s', $label, self::INCLUDE_FOR_PREPROCESSIN_LABEL)] = $value;
  2446. } else {
  2447. $reLabeledOptions[$label] = $value;
  2448. }
  2449. }
  2451. // Add other at the back
  2452. $reLabeledOptions[self::CENTRE_TYPE_OTHER__LABEL] = self::CENTRE_TYPE_OTHER;
  2454. return $reLabeledOptions;
  2455. }
  2457. /**
  2458. * Returns an array of allowed centre types for preprocessing.
  2459. *
  2460. * @return array
  2461. */
  2462. public static function getAllowedPreprocessingCentreTypes(): array
  2463. {
  2464. return [
  2465. // self::CENTRE_TYPE_TRUST,
  2466. self::CENTRE_TYPE_GP,
  2467. // self::CENTRE_TYPE_AMBULANCE_SERVICE,
  2468. // self::CENTRE_TYPE_CARE_HOME,
  2469. // self::CENTRE_TYPE_MARIE_STOPES,
  2470. // self::CENTRE_TYPE_PHARMACY,
  2471. // self::CENTRE_TYPE_CONSULTANT,
  2472. // self::CENTRE_TYPE_HOSPITAL,
  2473. // self::CENTRE_TYPE_PSYCHOLOGY,
  2474. // self::CENTRE_TYPE_PHYSIO,
  2475. // self::CENTRE_TYPE_PODIATRIST,
  2476. // self::CENTRE_TYPE_URGENT_CARE_CENTRE,
  2477. // self::CENTRE_TYPE_WALKIN_CENTRE,
  2478. // self::CENTRE_TYPE_OTHER_PRE_PROCESSING,
  2479. ];
  2480. }
  2482. /**
  2483. * Returns true if the batch request is for GP Records.
  2484. *
  2485. * @return bool
  2486. */
  2487. public function isGpRecords(): bool
  2488. {
  2489. return $this->getCentreType() === self::CENTRE_TYPE_GP;
  2490. }
  2492. /**
  2493. * Returns true of the batch request should be included for pre-processing.
  2494. *
  2495. * @return bool
  2496. */
  2497. public function allowPreprocessing(): bool
  2498. {
  2499. $isServiceRequestComplete = $this->getServiceRequest()->isComplete();
  2500. $isAllowedCentreType = in_array($this->getCentreType(), static::getAllowedPreprocessingCentreTypes());
  2502. // If the type of records is not a GP records set, we only want to allow certain centre names
  2503. // to go for pre-processing.
  2504. $isCentreNameMatch = true;
  2505. // If not a GP records set...
  2506. if ($this->isGpRecords() === false) {
  2507. // Check if the centre wildcards appear in the name
  2508. $pattern = '/' . implode('|', array_map('preg_quote', self::TRUST_NAME_WILDCARDS)) . '/i';
  2509. // Use preg_match to check if any of the wildcards are found
  2510. if (preg_match($pattern, $this->getCentreName()) === 0) {
  2511. $isCentreNameMatch = false;
  2512. }
  2513. }
  2515. return $isServiceRequestComplete === false && $isAllowedCentreType === true && $isCentreNameMatch === true;
  2516. }
  2518. /**
  2519. * @return string
  2520. */
  2521. public function getCentreTypeLabel(): string
  2522. {
  2523. $options = array_flip(self::getCentreTypeOptions());
  2525. return $options[$this->getCentreType()] ?? '';
  2526. }
  2528. /**
  2529. * Returns true if the batch is to be included for preprocessing.
  2530. *
  2531. * @return bool
  2532. */
  2533. public function includedForPreProcessing(): bool
  2534. {
  2535. if (!$this->getSortingSession() || $this->getSortingSession()->getRequiresPreProcessing() === false) {
  2536. return false;
  2537. }
  2539. return !empty(array_filter($this->getSortingSession()->getPreprocessItems(), function (BatchRequest $batchRequest) {
  2540. return $batchRequest->getId() === $this->getId();
  2541. }));
  2542. }
  2544. /**
  2545. * @return bool
  2546. */
  2547. public function isSubmittedForPreprocessing(): bool
  2548. {
  2549. $preprocessDocument = $this->getPreprocessDocuments()->last();
  2551. return $preprocessDocument instanceof PreprocessDocument && !$preprocessDocument->isIgnore();
  2552. }
  2554. /**
  2555. * @return int|null
  2556. */
  2557. public function getComputerizedRecordsCount(): ?int
  2558. {
  2559. return $this->computerizedRecordsCount;
  2560. }
  2562. /**
  2563. * @param int|null $computerizedRecordsCount
  2564. *
  2565. * @return self
  2566. */
  2567. public function setComputerizedRecordsCount(?int $computerizedRecordsCount = null): self
  2568. {
  2569. $this->computerizedRecordsCount = $computerizedRecordsCount;
  2571. return $this;
  2572. }
  2574. /**
  2575. * Returns the pages that should be billed at the standard rate, based on this logic:
  2576. * Total @ Standard Rate (new) = SUM of the following page counts:
  2577. * - Sorted Page Count
  2578. * - Blanks and Dupes Count
  2579. * - Computerised Records, but only if count is < 1000. @see COMPUTERIZED_RECORDS_BILLING_THRESHOLD
  2580. *
  2581. * @return int
  2582. */
  2583. public function getPageCountBilledAtStandardRate(): int
  2584. {
  2585. return $this->getPageCount() + $this->getBlankAndDupesCount() + ($this->getComputerizedRecordsCount() < self::COMPUTERIZED_RECORDS_BILLING_THRESHOLD ? $this->getComputerizedRecordsCount() : 0);
  2586. }
  2588. /**
  2589. * @return bool
  2590. */
  2591. public function hasImportantNotes(): bool
  2592. {
  2593. return $this->getDetails()->filter(function (BatchRequestDetail $batchRequestDetail) {
  2594. return $batchRequestDetail->getIsImportant();
  2595. })->count();
  2596. }
  2598. /**
  2599. * @return bool
  2600. */
  2601. public function canAutoCancel(): bool
  2602. {
  2603. if ($this->getServiceRequest() && ($this->getServiceRequest()->getStatus() === ServiceRequest::STATUS_AWAITING_RECORDS_ARRIVAL || $this->getServiceRequest()->getStatus() === ServiceRequest::STATUS_AWAITING_QUOTE_APPROVAL)) {
  2604. return true;
  2605. }
  2606. return false;
  2607. }
  2609. /**
  2610. * Gets the number of pages scanned
  2611. *
  2612. * @return int|null
  2613. */
  2614. public function getScannedPageCount(): ?int
  2615. {
  2616. return $this->scannedPageCount;
  2617. }
  2619. /**
  2620. * Sets the number of pages scanned
  2621. *
  2622. * @param int|null $scannedPageCount
  2623. *
  2624. * @return self
  2625. */
  2626. public function setScannedPageCount(?int $scannedPageCount): self
  2627. {
  2628. $this->scannedPageCount = $scannedPageCount;
  2630. return $this;
  2631. }
  2632. }