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 \DateTime
  341. *
  342. * @ORM\Column(name="updated", type="datetime")
  343. *
  344. * @Gedmo\Timestampable(on="update")
  345. */
  346. protected $updated;
  348. /**
  349. * @var HumanResource
  350. *
  351. * @ORM\ManyToOne(targetEntity="MedBrief\MSR\Entity\HumanResource")
  352. *
  353. * @ORM\JoinColumns({
  354. *
  355. * @ORM\JoinColumn(name="sortedBy_id", referencedColumnName="id")
  356. * })
  357. */
  358. protected $sortedBy;
  360. /**
  361. * @var HumanResource
  362. *
  363. * @ORM\ManyToOne(targetEntity="MedBrief\MSR\Entity\HumanResource")
  364. *
  365. * @ORM\JoinColumns({
  366. *
  367. * @ORM\JoinColumn(name="dateSortedBy_id", referencedColumnName="id")
  368. * })
  369. */
  370. protected $dateSortedBy;
  372. /**
  373. * @var HumanResource
  374. *
  375. * @ORM\ManyToOne(targetEntity="MedBrief\MSR\Entity\HumanResource")
  376. *
  377. * @ORM\JoinColumns({
  378. *
  379. * @ORM\JoinColumn(name="admissionSortedBy_id", referencedColumnName="id")
  380. * })
  381. */
  382. protected $admissionSortedBy;
  384. /**
  385. * @var HumanResource
  386. *
  387. * @ORM\ManyToOne(targetEntity="MedBrief\MSR\Entity\HumanResource")
  388. *
  389. * @ORM\JoinColumns({
  390. *
  391. * @ORM\JoinColumn(name="scanCompletedBy_id", referencedColumnName="id")
  392. * })
  393. */
  394. protected $scanCompletedBy;
  396. /**
  397. * @var HumanResource
  398. *
  399. * @ORM\ManyToOne(targetEntity="MedBrief\MSR\Entity\HumanResource")
  400. *
  401. * @ORM\JoinColumns({
  402. *
  403. * @ORM\JoinColumn(name="qaBy_id", referencedColumnName="id")
  404. * })
  405. */
  406. protected $qaBy;
  408. /**
  409. * @var HumanResource
  410. *
  411. * @ORM\ManyToOne(targetEntity="MedBrief\MSR\Entity\HumanResource")
  412. *
  413. * @ORM\JoinColumns({
  414. *
  415. * @ORM\JoinColumn(name="uploadedBy_id", referencedColumnName="id")
  416. * })
  417. */
  418. protected $uploadedBy;
  420. /**
  421. * @var Collection
  422. *
  423. * @ORM\OneToMany(targetEntity="MedBrief\MSR\Entity\BatchRequestDetail", mappedBy="batchRequest", cascade={"persist","remove"}, orphanRemoval=true)
  424. */
  425. protected $details;
  427. /**
  428. * @var ChronologyRequest
  429. *
  430. * @ORM\ManyToOne(targetEntity="MedBrief\MSR\Entity\ChronologyRequest", inversedBy="batches")
  431. *
  432. * @ORM\JoinColumns({
  433. *
  434. * @ORM\JoinColumn(name="chronologyRequest_id", referencedColumnName="id")
  435. * })
  436. */
  437. protected $chronologyRequest;
  439. /**
  440. * @var RecordsReceived
  441. *
  442. * @ORM\Embedded(class="MedBrief\MSR\Entity\Embeddable\RecordsReceived", columnPrefix="recordsReceived_")
  443. */
  444. protected $recordsReceived;
  446. /**
  447. * @var int|null
  448. *
  449. * @ORM\Column(name="radiologyDiscCount", type="integer", nullable=true)
  450. */
  451. protected $radiologyDiscCount;
  453. /**
  454. * @var string|null
  455. *
  456. * @ORM\Column(name="hoursQuoted", type="decimal", precision=7, scale=2, nullable=true)
  457. */
  458. protected $hoursQuoted;
  460. /**
  461. * @var int|null
  462. *
  463. * @ORM\Column(name="quoteStatus", type="integer", nullable=true)
  464. */
  465. protected $quoteStatus;
  467. /**
  468. * @var Collection
  469. *
  470. * @ORM\OneToMany(targetEntity="MedBrief\MSR\Entity\Disc", mappedBy="batchRequest", cascade={"persist"})
  471. */
  472. protected $discs;
  474. /**
  475. * @var SortingSession
  476. *
  477. * @ORM\ManyToOne(targetEntity="MedBrief\MSR\Entity\SortingSession", inversedBy="batchRequests")
  478. *
  479. * @ORM\JoinColumns({
  480. *
  481. * @ORM\JoinColumn(name="sortingSession_id", referencedColumnName="id")
  482. * })
  483. */
  484. protected $sortingSession;
  486. /**
  487. * @var Collection
  488. *
  489. * @ORM\OneToMany(targetEntity="MedBrief\MSR\Entity\BatchDocument", mappedBy="batchRequest", cascade={"persist"})
  490. *
  491. * @ORM\OrderBy({
  492. * "sortOrder"="ASC"
  493. * })
  494. */
  495. protected $batchDocuments;
  497. /**
  498. * @var Collection
  499. *
  500. * @ORM\OneToMany(targetEntity="MedBrief\MSR\Entity\Page", mappedBy="batchRequest", cascade={"persist"})
  501. */
  502. protected $pages;
  504. /**
  505. * @var bool
  506. *
  507. * @ORM\Column(name="locked", type="boolean", nullable=true, options={"default"=false})
  508. */
  509. protected $locked;
  511. /**
  512. * @var string
  513. *
  514. * @ORM\Column(name="paginationPrefix", type="string", nullable=true)
  515. */
  516. protected $paginationPrefix;
  518. /**
  519. * @var string
  520. *
  521. * @ORM\Column(name="paginationIndentLevel", type="integer", nullable=true)
  522. */
  523. protected $paginationIndentLevel;
  525. /**
  526. * @var int
  527. *
  528. * @ORM\Column(name="paginationType", type="integer", nullable=true, options={"default"="1"})
  529. */
  530. protected $paginationType;
  532. /**
  533. * @var int|null
  534. *
  535. * @ORM\Column(name="clonedPageCount", type="integer", nullable=true)
  536. */
  537. protected $clonedPageCount;
  539. /**
  540. * @var string|null
  541. *
  542. * @ORM\Column(name="centreNameHistory", type="string", nullable=true)
  543. */
  544. protected $centreNameHistory;
  546. /**
  547. * @var Collection
  548. *
  549. * @ORM\OneToMany(targetEntity="MedBrief\MSR\Entity\Preprocessing\PreprocessDocument", mappedBy="batchRequest")
  550. */
  551. private $preprocessDocuments;
  553. /**
  554. * @var int|null
  555. *
  556. * @ORM\Column(name="centreType", type="integer", nullable=true)
  557. */
  558. private $centreType;
  560. /**
  561. * @var int|null
  562. *
  563. * @ORM\Column(name="scannedPageCount", type="integer", nullable=true)
  564. *
  565. */
  566. private ?int $scannedPageCount;
  568. /**
  569. * Constructor
  570. */
  571. public function __construct()
  572. {
  573. $this->isCopy = true;
  574. $this->chronologyRequired = false;
  575. $this->details = new ArrayCollection();
  576. $this->discs = new ArrayCollection();
  577. $this->recordsReceived = new RecordsReceived();
  578. $this->pages = new ArrayCollection();
  579. $this->batchDocuments = new ArrayCollection();
  580. $this->preprocessDocuments = new ArrayCollection();
  581. }
  583. /**
  584. * __toString
  585. *
  586. * @return string
  587. */
  588. public function __toString()
  589. {
  590. return (string) $this->getId();
  591. }
  593. /**
  594. * Get id
  595. *
  596. * @return int
  597. */
  598. public function getId()
  599. {
  600. return $this->id;
  601. }
  603. /**
  604. * Set isCopy
  605. *
  606. * @param bool $isCopy
  607. *
  608. * @return BatchRequest
  609. */
  610. public function setIsCopy($isCopy)
  611. {
  612. $this->isCopy = $isCopy;
  614. return $this;
  615. }
  617. /**
  618. * Get isCopy
  619. *
  620. * @return bool
  621. */
  622. public function getIsCopy()
  623. {
  624. return $this->isCopy;
  625. }
  627. /**
  628. * Get isCopyLabel
  629. *
  630. * @return bool
  631. */
  632. public function getIsCopyLabel()
  633. {
  634. return $this->isCopy ? 'Copy' : 'Original Records';
  635. }
  637. /**
  638. * Get isCopyOptions
  639. *
  640. * @return array
  641. */
  642. public static function getIsCopyOptions()
  643. {
  644. return [
  645. 'Copy' => true,
  646. 'Original Records' => false,
  647. ];
  648. }
  650. /**
  651. * Set dateReceived
  652. *
  653. * @param \DateTime $dateReceived
  654. *
  655. * @return BatchRequest
  656. */
  657. public function setDateReceived($dateReceived)
  658. {
  659. $this->dateReceived = $dateReceived;
  661. return $this;
  662. }
  664. /**
  665. * Get dateReceived
  666. *
  667. * @return \DateTime
  668. */
  669. public function getDateReceived()
  670. {
  671. return $this->dateReceived;
  672. }
  674. /**
  675. * Set estimatedDeadlineDate
  676. *
  677. * @param \DateTime $estimatedDeadlineDate
  678. *
  679. * @return BatchRequest
  680. */
  681. public function setEstimatedDeadlineDate($estimatedDeadlineDate)
  682. {
  683. $this->estimatedDeadlineDate = $estimatedDeadlineDate;
  685. return $this;
  686. }
  688. /**
  689. * Get estimatedDeadlineDate
  690. *
  691. * @return \DateTime
  692. */
  693. public function getEstimatedDeadlineDate()
  694. {
  695. return $this->estimatedDeadlineDate;
  696. }
  698. /**
  699. * Get generateEstimatedDeadlineDate
  700. *
  701. * @return BatchRequest
  702. */
  703. public function generateEstimatedDeadlineDate()
  704. {
  705. if (!$this->estimatedDeadlineDate && $this->getDateReceived()) {
  706. $estimatedDeadlineDate = clone $this->getDateReceived();
  707. $estimatedDeadlineDate->modify(self::AUTO_DATE_ESTIMATED_DEADLINE);
  708. $this->setEstimatedDeadlineDate($estimatedDeadlineDate);
  709. }
  710. return $this;
  711. }
  713. /**
  714. * Set dateCompleted
  715. *
  716. * @param \DateTime $dateCompleted
  717. *
  718. * @return BatchRequest
  719. */
  720. public function setDateCompleted($dateCompleted)
  721. {
  722. $this->dateCompleted = $dateCompleted;
  724. return $this;
  725. }
  727. /**
  728. * Get dateCompleted
  729. *
  730. * @return \DateTime
  731. */
  732. public function getDateCompleted()
  733. {
  734. return $this->dateCompleted;
  735. }
  737. /**
  738. * Set destructionDate
  739. *
  740. * @param \DateTime $destructionDate
  741. *
  742. * @return BatchRequest
  743. */
  744. public function setDestructionDate($destructionDate)
  745. {
  746. $this->destructionDate = $destructionDate;
  748. return $this;
  749. }
  751. /**
  752. * Get destructionDate
  753. *
  754. * @return \DateTime
  755. */
  756. public function getDestructionDate()
  757. {
  758. return $this->destructionDate;
  759. }
  761. /**
  762. * Updates the destruction date based on if the destroyOrReturned field
  763. * is set to RECORDS_DESTROY, and a dateCompleted is set.
  764. *
  765. * Used as a lifecycleCallback.
  766. *
  767. * @ORM\PrePersist
  768. *
  769. * @ORM\PreUpdate
  770. */
  771. public function updateDestructionDate()
  772. {
  773. // If the records are set to be destroyed, calculate and set the destruction date.
  774. if ($this->getDestroyOrReturn() === self::RECORDS_DESTROY && $this->getDateCompleted()) {
  775. $destructionDate = clone $this->getDateCompleted();
  776. $destructionDate->modify(self::AUTO_DATE_DESTRUCTION);
  777. $this->setDestructionDate($destructionDate);
  778. } else {
  779. $this->setDestructionDate(null);
  780. }
  782. return $this;
  783. }
  785. /**
  786. * Returns true if the batch has been destroyed.
  787. *
  788. * Functions by checking if the destroyOrReturn value was set to destroy,
  789. * and if a dateDestroyedOrReturned is set.
  790. *
  791. * @return bool
  792. */
  793. public function isDestroyed()
  794. {
  795. return $this->getDestroyOrReturn() === self::RECORDS_DESTROY && $this->getDateDestroyedOrReturned();
  796. }
  798. /**
  799. * Set dateDestroyedOrReturned
  800. *
  801. * @param \DateTime $dateDestroyedOrReturned
  802. *
  803. * @return BatchRequest
  804. */
  805. public function setDateDestroyedOrReturned($dateDestroyedOrReturned)
  806. {
  807. $this->dateDestroyedOrReturned = $dateDestroyedOrReturned;
  809. return $this;
  810. }
  812. /**
  813. * Get dateDestroyedOrReturned
  814. *
  815. * @return \DateTime
  816. */
  817. public function getDateDestroyedOrReturned()
  818. {
  819. return $this->dateDestroyedOrReturned;
  820. }
  822. /**
  823. * Set archiveBoxNumber
  824. *
  825. * @param string $archiveBoxNumber
  826. *
  827. * @return BatchRequest
  828. */
  829. public function setArchiveBoxNumber($archiveBoxNumber)
  830. {
  831. $this->archiveBoxNumber = $archiveBoxNumber;
  833. return $this;
  834. }
  836. /**
  837. * Get archiveBoxNumber
  838. *
  839. * @return string
  840. */
  841. public function getArchiveBoxNumber()
  842. {
  843. return $this->archiveBoxNumber;
  844. }
  846. /**
  847. * Get archiveBoxNumber
  848. *
  849. * @return string
  850. */
  851. public function getArchiveBoxNumberInclPrefix()
  852. {
  853. $prefix = '';
  854. if ($this->getProject() && $this->getProject()->getAccount()) {
  855. $prefix = $this->getProject()->getAccount()->getPrefix();
  856. }
  858. return ($prefix ? $prefix . '-' : '') . $this->archiveBoxNumber;
  859. }
  861. /**
  862. * Set qaDate
  863. *
  864. * @param \DateTime $qaDate
  865. *
  866. * @return BatchRequest
  867. */
  868. public function setQaDate($qaDate)
  869. {
  870. $this->qaDate = $qaDate;
  872. return $this;
  873. }
  875. /**
  876. * Get qaDate
  877. *
  878. * @return \DateTime
  879. */
  880. public function getQaDate()
  881. {
  882. return $this->qaDate;
  883. }
  885. /**
  886. * Set qaDuration
  887. *
  888. * @param int $qaDuration
  889. *
  890. * @return BatchRequest
  891. */
  892. public function setQaDuration($qaDuration)
  893. {
  894. $this->qaDuration = $qaDuration;
  896. return $this;
  897. }
  899. /**
  900. * Get qaDuration
  901. *
  902. * @return int
  903. */
  904. public function getQaDuration()
  905. {
  906. return $this->qaDuration;
  907. }
  909. /**
  910. * Set uploadedDate
  911. *
  912. * @param \DateTime $uploadedDate
  913. *
  914. * @return BatchRequest
  915. */
  916. public function setUploadedDate($uploadedDate)
  917. {
  918. $this->uploadedDate = $uploadedDate;
  920. return $this;
  921. }
  923. /**
  924. * Get uploadedDate
  925. *
  926. * @return \DateTime
  927. */
  928. public function getUploadedDate()
  929. {
  930. return $this->uploadedDate;
  931. }
  933. /**
  934. * Set deletedAt
  935. *
  936. * @param \DateTime $deletedAt
  937. *
  938. * @return BatchRequest
  939. */
  940. public function setDeletedAt($deletedAt)
  941. {
  942. $this->deletedAt = $deletedAt;
  944. return $this;
  945. }
  947. /**
  948. * Get deletedAt
  949. *
  950. * @return \DateTime
  951. */
  952. public function getDeletedAt()
  953. {
  954. return $this->deletedAt;
  955. }
  957. /**
  958. * Set dataCategory
  959. *
  960. * @param int $dataCategory
  961. *
  962. * @return BatchRequest
  963. */
  964. public function setDataCategory($dataCategory)
  965. {
  966. $this->dataCategory = $dataCategory;
  968. return $this;
  969. }
  971. /**
  972. * Get dataCategory
  973. *
  974. * @return int
  975. */
  976. public function getDataCategory()
  977. {
  978. return $this->dataCategory;
  979. }
  981. /**
  982. * Convenience function for checking if this BatchRequest is
  983. * dataCategory DATA_CATEGORY_RADIOLOGY.
  984. *
  985. * @return bool
  986. */
  987. public function isRadiologyDataCategory()
  988. {
  989. return $this->getDataCategory() === self::DATA_CATEGORY_RADIOLOGY;
  990. }
  992. /**
  993. * Convenience function for checking if this BatchRequest is
  994. * of type media - which includes certain dataCategories.
  995. *
  996. * @return bool
  997. */
  998. public function isDataCategoryTypeMedia()
  999. {
  1000. $mediaTypeDataCategories = [
  1001. self::DATA_CATEGORY_RADIOLOGY,
  1002. self::DATA_CATEGORY_AUDIO,
  1003. self::DATA_CATEGORY_VIDEO,
  1004. ];
  1005. return in_array($this->getDataCategory(), $mediaTypeDataCategories);
  1006. }
  1008. /**
  1009. * Get dataCategoryOptions
  1010. *
  1011. * @return array
  1012. */
  1013. public static function getDataCategoryOptions()
  1014. {
  1015. return [
  1016. self::DATA_CATEGORY_RADIOLOGY => 'Radiology',
  1017. self::DATA_CATEGORY_VIDEO => 'Video',
  1018. self::DATA_CATEGORY_AUDIO => 'Audio',
  1019. self::DATA_CATEGORY_HARD_COPY_INDEXED => 'Hard copy indexed',
  1020. self::DATA_CATEGORY_MEDICAL_RECORDS => 'Medical records',
  1021. self::DATA_CATEGORY_ELECTRONIC_INDEXED => 'Electronic indexed',
  1022. ];
  1023. }
  1025. /**
  1026. * Get dataCategoryLabel
  1027. *
  1028. * @return int
  1029. */
  1030. public function getDataCategoryLabel()
  1031. {
  1032. $options = self::getDataCategoryOptions();
  1033. return $options[$this->getDataCategory()] ?? '';
  1034. }
  1036. /**
  1037. * Set sortedDate
  1038. *
  1039. * @param \DateTime $sortedDate
  1040. *
  1041. * @return BatchRequest
  1042. */
  1043. public function setSortedDate($sortedDate)
  1044. {
  1045. $this->sortedDate = $sortedDate;
  1047. return $this;
  1048. }
  1050. /**
  1051. * Get sortedDate
  1052. *
  1053. * @return \DateTime
  1054. */
  1055. public function getSortedDate()
  1056. {
  1057. return $this->sortedDate;
  1058. }
  1060. /**
  1061. * Set scannedDate
  1062. *
  1063. * @param \DateTime $scannedDate
  1064. *
  1065. * @return BatchRequest
  1066. */
  1067. public function setScannedDate($scannedDate)
  1068. {
  1069. $this->scannedDate = $scannedDate;
  1071. return $this;
  1072. }
  1074. /**
  1075. * Get scannedDate
  1076. *
  1077. * @return \DateTime
  1078. */
  1079. public function getScannedDate()
  1080. {
  1081. return $this->scannedDate;
  1082. }
  1084. /**
  1085. * Set pageCount
  1086. *
  1087. * @param int $pageCount
  1088. *
  1089. * @return BatchRequest
  1090. */
  1091. public function setPageCount($pageCount)
  1092. {
  1093. $this->pageCount = $pageCount;
  1095. return $this;
  1096. }
  1098. /**
  1099. * Get pageCount
  1100. *
  1101. * @return int
  1102. */
  1103. public function getPageCount()
  1104. {
  1105. return $this->pageCount;
  1106. }
  1108. /**
  1109. * Set blankAndDupesCount
  1110. *
  1111. * @param int $blankAndDupesCount
  1112. *
  1113. * @return BatchRequest
  1114. */
  1115. public function setBlankAndDupesCount($blankAndDupesCount)
  1116. {
  1117. $this->blankAndDupesCount = $blankAndDupesCount;
  1119. return $this;
  1120. }
  1122. /**
  1123. * Get blankAndDupesCount
  1124. *
  1125. * @return int
  1126. */
  1127. public function getBlankAndDupesCount()
  1128. {
  1129. return $this->blankAndDupesCount;
  1130. }
  1132. /**
  1133. * Set scanDuration
  1134. *
  1135. * @param int $scanDuration
  1136. *
  1137. * @return BatchRequest
  1138. */
  1139. public function setScanDuration($scanDuration)
  1140. {
  1141. $this->scanDuration = $scanDuration;
  1143. return $this;
  1144. }
  1146. /**
  1147. * Get scanDuration
  1148. *
  1149. * @return int
  1150. */
  1151. public function getScanDuration()
  1152. {
  1153. return $this->scanDuration;
  1154. }
  1156. /**
  1157. * Set sectionSortDuration
  1158. *
  1159. * @param int $sectionSortDuration
  1160. *
  1161. * @return BatchRequest
  1162. */
  1163. public function setSectionSortDuration($sectionSortDuration)
  1164. {
  1165. $this->sectionSortDuration = $sectionSortDuration;
  1167. return $this;
  1168. }
  1170. /**
  1171. * Get sectionSortDuration
  1172. *
  1173. * @return int
  1174. */
  1175. public function getSectionSortDuration()
  1176. {
  1177. return $this->sectionSortDuration;
  1178. }
  1180. /**
  1181. * Set dateSortDuration
  1182. *
  1183. * @param int $dateSortDuration
  1184. *
  1185. * @return BatchRequest
  1186. */
  1187. public function setDateSortDuration($dateSortDuration)
  1188. {
  1189. $this->dateSortDuration = $dateSortDuration;
  1191. return $this;
  1192. }
  1194. /**
  1195. * Get dateSortDuration
  1196. *
  1197. * @return int
  1198. */
  1199. public function getDateSortDuration()
  1200. {
  1201. return $this->dateSortDuration;
  1202. }
  1204. /**
  1205. * Set project
  1206. *
  1207. * @param Project $project
  1208. *
  1209. * @return BatchRequest
  1210. */
  1211. public function setProject(?Project $project = null)
  1212. {
  1213. $this->project = $project;
  1215. return $this;
  1216. }
  1218. /**
  1219. * Get project
  1220. *
  1221. * @return Project
  1222. */
  1223. public function getProject()
  1224. {
  1225. return $this->project;
  1226. }
  1228. /**
  1229. * Set sortDeadlineDate
  1230. *
  1231. * @param \DateTime $sortDeadlineDate
  1232. *
  1233. * @return BatchRequest
  1234. */
  1235. public function setSortDeadlineDate($sortDeadlineDate)
  1236. {
  1237. $this->sortDeadlineDate = $sortDeadlineDate;
  1239. return $this;
  1240. }
  1242. /**
  1243. * Get sortDeadlineDate
  1244. *
  1245. * @return \DateTime
  1246. */
  1247. public function getSortDeadlineDate()
  1248. {
  1249. if (!$this->sortDeadlineDate && $this->getDateReceived()) {
  1250. $sortDeadlineDate = clone $this->getDateReceived();
  1251. $sortDeadlineDate->modify(self::AUTO_DATE_SORT_DEADLINE);
  1252. return $sortDeadlineDate;
  1253. }
  1255. return $this->sortDeadlineDate;
  1256. }
  1258. /**
  1259. * Set created
  1260. *
  1261. * @param \DateTime $created
  1262. *
  1263. * @return BatchRequest
  1264. */
  1265. public function setCreated($created)
  1266. {
  1267. $this->created = $created;
  1269. return $this;
  1270. }
  1272. /**
  1273. * Get created
  1274. *
  1275. * @return \DateTime
  1276. */
  1277. public function getCreated()
  1278. {
  1279. return $this->created;
  1280. }
  1282. /**
  1283. * Set updated
  1284. *
  1285. * @param \DateTime $updated
  1286. *
  1287. * @return BatchRequest
  1288. */
  1289. public function setUpdated($updated)
  1290. {
  1291. $this->updated = $updated;
  1293. return $this;
  1294. }
  1296. /**
  1297. * Get updated
  1298. *
  1299. * @return \DateTime
  1300. */
  1301. public function getUpdated()
  1302. {
  1303. return $this->updated;
  1304. }
  1306. /**
  1307. * Set sortedBy
  1308. *
  1309. * @param HumanResource $sortedBy
  1310. *
  1311. * @return BatchRequest
  1312. */
  1313. public function setSortedBy(?HumanResource $sortedBy = null)
  1314. {
  1315. $this->sortedBy = $sortedBy;
  1317. return $this;
  1318. }
  1320. /**
  1321. * Get sortedBy
  1322. *
  1323. * @return HumanResource
  1324. */
  1325. public function getSortedBy()
  1326. {
  1327. return $this->sortedBy;
  1328. }
  1330. /**
  1331. * Set scanCompletedBy
  1332. *
  1333. * @param HumanResource $scanCompletedBy
  1334. *
  1335. * @return BatchRequest
  1336. */
  1337. public function setScanCompletedBy(?HumanResource $scanCompletedBy = null)
  1338. {
  1339. $this->scanCompletedBy = $scanCompletedBy;
  1341. return $this;
  1342. }
  1344. /**
  1345. * Get scanCompletedBy
  1346. *
  1347. * @return HumanResource
  1348. */
  1349. public function getScanCompletedBy()
  1350. {
  1351. return $this->scanCompletedBy;
  1352. }
  1354. /**
  1355. * Set qaBy
  1356. *
  1357. * @param HumanResource $qaBy
  1358. *
  1359. * @return BatchRequest
  1360. */
  1361. public function setQaBy(?HumanResource $qaBy = null)
  1362. {
  1363. $this->qaBy = $qaBy;
  1365. return $this;
  1366. }
  1368. /**
  1369. * Get qaBy
  1370. *
  1371. * @return HumanResource
  1372. */
  1373. public function getQaBy()
  1374. {
  1375. return $this->qaBy;
  1376. }
  1378. /**
  1379. * Set uploadedBy
  1380. *
  1381. * @param HumanResource $uploadedBy
  1382. *
  1383. * @return BatchRequest
  1384. */
  1385. public function setUploadedBy(?HumanResource $uploadedBy = null)
  1386. {
  1387. $this->uploadedBy = $uploadedBy;
  1389. return $this;
  1390. }
  1392. /**
  1393. * Get uploadedBy
  1394. *
  1395. * @return HumanResource
  1396. */
  1397. public function getUploadedBy()
  1398. {
  1399. return $this->uploadedBy;
  1400. }
  1402. /**
  1403. * Set destroyOrReturn
  1404. *
  1405. * @param int $destroyOrReturn
  1406. *
  1407. * @return BatchRequest
  1408. */
  1409. public function setDestroyOrReturn($destroyOrReturn)
  1410. {
  1411. $this->destroyOrReturn = $destroyOrReturn;
  1413. return $this;
  1414. }
  1416. /**
  1417. * Get destroyOrReturn
  1418. *
  1419. * @return int
  1420. */
  1421. public function getDestroyOrReturn()
  1422. {
  1423. return $this->destroyOrReturn;
  1424. }
  1426. /**
  1427. * Get reasonForCancellationOptions
  1428. *
  1429. * @return array
  1430. */
  1431. public static function getDestroyOrReturnOptions()
  1432. {
  1433. return [
  1434. self::RECORDS_RETURN => 'Return',
  1435. self::RECORDS_DESTROY => 'Destroy',
  1436. ];
  1437. }
  1439. /**
  1440. * Get reasonForCancellationLabel
  1441. *
  1442. * @return string
  1443. */
  1444. public function getDestroyOrReturnLabel()
  1445. {
  1446. $options = self::getDestroyOrReturnOptions();
  1447. return $options[$this->getDestroyOrReturn()] ?? '';
  1448. }
  1450. /**
  1451. * Set chronologyRequired
  1452. *
  1453. * @param bool $chronologyRequired
  1454. *
  1455. * @return BatchRequest
  1456. */
  1457. public function setChronologyRequired($chronologyRequired)
  1458. {
  1459. $this->chronologyRequired = $chronologyRequired;
  1461. // Remove the linked ChronologyRequest if we indicate the BatchRequest does not require Chronology
  1462. if (!$chronologyRequired) {
  1463. $this->setChronologyRequest(null);
  1464. }
  1466. return $this;
  1467. }
  1469. /**
  1470. * Get chronologyRequired
  1471. *
  1472. * @return bool
  1473. */
  1474. public function getChronologyRequired()
  1475. {
  1476. return $this->chronologyRequired;
  1477. }
  1479. /**
  1480. * Get chronologyRequired
  1481. *
  1482. * @return bool
  1483. */
  1484. public function getChronologyRequiredLabel()
  1485. {
  1486. return $this->chronologyRequired ? 'Yes' : 'No';
  1487. }
  1489. /**
  1490. * Add detail
  1491. *
  1492. * @param BatchRequestDetail $detail
  1493. *
  1494. * @return BatchRequest
  1495. */
  1496. public function addDetail(BatchRequestDetail $detail)
  1497. {
  1498. $this->details[] = $detail;
  1500. return $this;
  1501. }
  1503. /**
  1504. * Remove detail
  1505. *
  1506. * @param BatchRequestDetail $detail
  1507. */
  1508. public function removeDetail(BatchRequestDetail $detail)
  1509. {
  1510. $this->details->removeElement($detail);
  1511. }
  1513. /**
  1514. * Get details
  1515. *
  1516. * @return Collection
  1517. */
  1518. public function getDetails()
  1519. {
  1520. return $this->details;
  1521. }
  1523. /**
  1524. * Set chronologyRequest
  1525. *
  1526. * @param ChronologyRequest $chronologyRequest
  1527. *
  1528. * @return BatchRequest
  1529. */
  1530. public function setChronologyRequest(?ChronologyRequest $chronologyRequest = null)
  1531. {
  1532. $this->chronologyRequest = $chronologyRequest;
  1534. return $this;
  1535. }
  1537. /**
  1538. * Get chronologyRequest
  1539. *
  1540. * @return ChronologyRequest
  1541. */
  1542. public function getChronologyRequest()
  1543. {
  1544. return $this->chronologyRequest;
  1545. }
  1547. /**
  1548. * Set receivedFrom
  1549. *
  1550. * @param string $receivedFrom
  1551. *
  1552. * @return BatchRequest
  1553. */
  1554. public function setReceivedFrom($receivedFrom)
  1555. {
  1556. $this->receivedFrom = $receivedFrom;
  1558. return $this;
  1559. }
  1561. /**
  1562. * Get receivedFrom
  1563. *
  1564. * @return string
  1565. */
  1566. public function getReceivedFrom()
  1567. {
  1568. return $this->receivedFrom;
  1569. }
  1571. /**
  1572. * Set recordsReceived
  1573. *
  1574. * @param RecordsReceived $recordsReceived
  1575. *
  1576. * @return BatchRequest
  1577. */
  1578. public function setRecordsReceived(RecordsReceived $recordsReceived)
  1579. {
  1580. $this->recordsReceived = $recordsReceived;
  1582. return $this;
  1583. }
  1585. /**
  1586. * Get recordsReceived
  1587. *
  1588. * @return RecordsReceived
  1589. */
  1590. public function getRecordsReceived()
  1591. {
  1592. return $this->recordsReceived;
  1593. }
  1595. /**
  1596. * Set passwords
  1597. *
  1598. * @param string $passwords
  1599. *
  1600. * @return BatchRequest
  1601. */
  1602. public function setPasswords($passwords)
  1603. {
  1604. $this->passwords = $passwords;
  1606. return $this;
  1607. }
  1609. /**
  1610. * Get passwords
  1611. *
  1612. * @return string
  1613. */
  1614. public function getPasswords()
  1615. {
  1616. return $this->passwords;
  1617. }
  1619. /**
  1620. * Add disc
  1621. *
  1622. * @param Disc $disc
  1623. *
  1624. * @return BatchRequest
  1625. */
  1626. public function addDisc(Disc $disc)
  1627. {
  1628. $this->discs[] = $disc;
  1630. return $this;
  1631. }
  1633. /**
  1634. * Remove disc
  1635. *
  1636. * @param Disc $disc
  1637. */
  1638. public function removeDisc(Disc $disc)
  1639. {
  1640. $this->discs->removeElement($disc);
  1641. }
  1643. /**
  1644. * Get discs
  1645. *
  1646. * @return Collection
  1647. */
  1648. public function getDiscs()
  1649. {
  1650. return $this->discs;
  1651. }
  1653. /**
  1654. * Unsets the association between this BatchRequest and Discs.
  1655. * Used as a preRemove lifecycle event, to avoid broken relationships when
  1656. * soft deleting a BatchRequest. Takes the place of a onDelete=NULL database
  1657. * call.
  1658. *
  1659. * @ORM\PreRemove
  1660. *
  1661. * @return void
  1662. */
  1663. public function clearDiscs()
  1664. {
  1665. foreach ($this->getDiscs() as $disc) {
  1666. // Only set the owning side relation to null.
  1667. $disc->setBatchRequest(null);
  1668. }
  1669. }
  1671. /**
  1672. * Set radiologyDiscCount
  1673. *
  1674. * @param int $radiologyDiscCount
  1675. *
  1676. * @return BatchRequest
  1677. */
  1678. public function setRadiologyDiscCount($radiologyDiscCount)
  1679. {
  1680. $this->radiologyDiscCount = $radiologyDiscCount;
  1682. return $this;
  1683. }
  1685. /**
  1686. * Get radiologyDiscCount
  1687. *
  1688. * @return int
  1689. */
  1690. public function getRadiologyDiscCount()
  1691. {
  1692. return $this->radiologyDiscCount;
  1693. }
  1695. /**
  1696. * Returns the number of Discs that still need to be created for this BatchRequest.
  1697. *
  1698. * @return int
  1699. */
  1700. public function getOutstandingRadiologyDiscCount()
  1701. {
  1702. return (int) $this->getRadiologyDiscCount() - $this->getDiscs()->count();
  1703. }
  1705. /**
  1706. * Gets all BatchRequests related to this BatchRequest, i.e.
  1707. * those that belong to the same ServiceRequestGroup
  1708. *
  1709. * @param $inclCurrent - Optionally include the current BatchRequest
  1710. *
  1711. * @return array
  1712. */
  1713. public function getRelatedBatchRequests($inclCurrent = false)
  1714. {
  1715. // If the BatchRequest does not belong to a ServiceRequest group,
  1716. // it has no related batches.
  1717. if (!$this->getServiceRequestGroup()) {
  1718. return [];
  1719. }
  1721. // Assign the calling class to a more readable variable
  1722. $currentBatchRequest = $this;
  1724. // Filter through the ServiceRequests on the ServiceRequestGroup and return the BatchRequests only.
  1725. $relatedBatchRequests = $this->getServiceRequestGroup()->getServiceRequests()->filter(function ($serviceRequest) use ($inclCurrent, $currentBatchRequest) {
  1726. // If the serviceRequest belongs to the currentBatchRequest...
  1727. if ($serviceRequest->getId() === $currentBatchRequest->getServiceRequest()->getId()) {
  1728. // include it if we want to include the current batchRequest
  1729. return $inclCurrent;
  1730. }
  1732. // If the serviceRequest is attached to a batchRequest, include it.
  1733. if ($serviceRequest->isBatchRequest()) {
  1734. return true;
  1735. }
  1737. // Don't include any others
  1738. return false;
  1739. });
  1741. // Extract the Serviceable from the ServiceRequest, which should be a BatchRequest.
  1742. return array_map(function ($serviceRequest) {
  1743. return $serviceRequest->getServiceable();
  1744. }, $relatedBatchRequests->toArray());
  1745. }
  1747. /**
  1748. * Set hoursQuoted
  1749. *
  1750. * @param int $hoursQuoted
  1751. *
  1752. * @return BatchRequest
  1753. */
  1754. public function setHoursQuoted($hoursQuoted)
  1755. {
  1756. $this->hoursQuoted = $hoursQuoted;
  1758. return $this;
  1759. }
  1761. /**
  1762. * Get hoursQuoted
  1763. *
  1764. * @return int
  1765. */
  1766. public function getHoursQuoted()
  1767. {
  1768. return $this->hoursQuoted;
  1769. }
  1771. /**
  1772. * Set quoteStatus
  1773. *
  1774. * @param int $quoteStatus
  1775. *
  1776. * @return BatchRequest
  1777. */
  1778. public function setQuoteStatus($quoteStatus)
  1779. {
  1780. $this->quoteStatus = $quoteStatus;
  1782. return $this;
  1783. }
  1785. /**
  1786. * Get quoteStatus
  1787. *
  1788. * @return int
  1789. */
  1790. public function getQuoteStatus()
  1791. {
  1792. return $this->quoteStatus;
  1793. }
  1795. /**
  1796. * Get quoteStatusLabel
  1797. *
  1798. * @return bool
  1799. */
  1800. public function getQuoteStatusLabel()
  1801. {
  1802. $options = self::getQuoteStatusOptions();
  1803. return $options[$this->getQuoteStatus()] ?? '';
  1804. }
  1806. /**
  1807. * Get quoteStatusOptions
  1808. *
  1809. * @return array
  1810. */
  1811. public static function getQuoteStatusOptions()
  1812. {
  1813. return [
  1814. self::QUOTE_STATUS_PENDING => 'Pending',
  1815. self::QUOTE_STATUS_ACCEPTED => 'Accepted',
  1816. self::QUOTE_STATUS_DECLINED => 'Declined',
  1817. ];
  1818. }
  1820. /**
  1821. * Set shelfLocation
  1822. *
  1823. * @param string $shelfLocation
  1824. *
  1825. * @return BatchRequest
  1826. */
  1827. public function setShelfLocation($shelfLocation)
  1828. {
  1829. $this->shelfLocation = $shelfLocation;
  1831. return $this;
  1832. }
  1834. /**
  1835. * Get shelfLocation
  1836. *
  1837. * @return string
  1838. */
  1839. public function getShelfLocation()
  1840. {
  1841. return $this->shelfLocation;
  1842. }
  1844. /**
  1845. * Set sortingSession
  1846. *
  1847. * @param SortingSession $sortingSession
  1848. *
  1849. * @return BatchRequest
  1850. */
  1851. public function setSortingSession(?SortingSession $sortingSession = null)
  1852. {
  1853. $this->sortingSession = $sortingSession;
  1855. return $this;
  1856. }
  1858. /**
  1859. * Get sortingSession
  1860. *
  1861. * @return SortingSession
  1862. */
  1863. public function getSortingSession()
  1864. {
  1865. return $this->sortingSession;
  1866. }
  1868. /**
  1869. * Add page
  1870. *
  1871. * @param Page $page
  1872. *
  1873. * @return BatchRequest
  1874. */
  1875. public function addPage(Page $page)
  1876. {
  1877. $this->pages[] = $page;
  1879. return $this;
  1880. }
  1882. /**
  1883. * Remove page
  1884. *
  1885. * @param Page $page
  1886. */
  1887. public function removePage(Page $page)
  1888. {
  1889. $this->pages->removeElement($page);
  1890. }
  1892. /**
  1893. * Get pages
  1894. *
  1895. * @return Collection
  1896. */
  1897. public function getPages()
  1898. {
  1899. return $this->pages;
  1900. }
  1902. /**
  1903. * Add batchDocument
  1904. *
  1905. * @param BatchDocument $batchDocument
  1906. *
  1907. * @return BatchRequest
  1908. */
  1909. public function addBatchDocument(BatchDocument $batchDocument)
  1910. {
  1911. $this->batchDocuments[] = $batchDocument;
  1913. return $this;
  1914. }
  1916. /**
  1917. * Remove batchDocument
  1918. *
  1919. * @param BatchDocument $batchDocument
  1920. */
  1921. public function removeBatchDocument(BatchDocument $batchDocument)
  1922. {
  1923. $this->batchDocuments->removeElement($batchDocument);
  1924. }
  1926. /**
  1927. * Get batchDocuments
  1928. *
  1929. * @return Collection|BatchDocument[]
  1930. */
  1931. public function getBatchDocuments()
  1932. {
  1933. return $this->batchDocuments;
  1934. }
  1936. /**
  1937. * Get batchDocuments that are PDF only.
  1938. *
  1939. * @return Collection|BatchDocument[]
  1940. */
  1941. public function getBatchDocumentsPdfOnly()
  1942. {
  1943. return $this->batchDocuments->filter(function (BatchDocument $item) {
  1944. return $item->getDocument()->getFileFamilyType() === Document::FILE_TYPE_PDF;
  1945. });
  1946. }
  1948. /**
  1949. * Set locked
  1950. *
  1951. * @param bool $locked
  1952. *
  1953. * @return BatchRequest
  1954. */
  1955. public function setLocked($locked)
  1956. {
  1957. $this->locked = $locked;
  1959. return $this;
  1960. }
  1962. /**
  1963. * Get locked
  1964. *
  1965. * @return bool
  1966. */
  1967. public function isLocked()
  1968. {
  1969. return $this->locked;
  1970. }
  1972. /**
  1973. * Checks to see if this BatchRequest has pending BatchDocuments
  1974. *
  1975. * @return bool
  1976. */
  1977. public function hasPendingBatchDocuments()
  1978. {
  1979. /** @var BatchDocument $batchDocument */
  1980. foreach ($this->getBatchDocuments() as $batchDocument) {
  1981. if ($batchDocument->getStatus() === BatchDocument::STATUS_PENDING) {
  1982. return true;
  1983. }
  1984. }
  1986. return false;
  1987. }
  1989. /**
  1990. * Checks to see if this BatchRequest has in progress BatchDocuments
  1991. *
  1992. * @return bool
  1993. */
  1994. public function hasInProgressBatchDocuments()
  1995. {
  1996. /** @var BatchDocument $batchDocument */
  1997. foreach ($this->getBatchDocuments() as $batchDocument) {
  1998. if ($batchDocument->getStatus() === BatchDocument::STATUS_IN_PROGRESS) {
  1999. return true;
  2000. }
  2001. }
  2003. return false;
  2004. }
  2006. /**
  2007. * Set centreName
  2008. *
  2009. * @param string $centreName
  2010. *
  2011. * @return BatchRequest
  2012. */
  2013. public function setCentreName($centreName)
  2014. {
  2015. $centreName = trim($centreName);
  2016. if ($this->getReceivedFrom() === null) {
  2017. $this->setReceivedFrom($centreName);
  2018. }
  2019. $this->centreName = $centreName;
  2021. return $this;
  2022. }
  2024. /**
  2025. * Set paginationType
  2026. *
  2027. * @param int $paginationType
  2028. *
  2029. * @return BatchRequest
  2030. */
  2031. public function setPaginationType($paginationType)
  2032. {
  2033. $this->paginationType = $paginationType;
  2035. return $this;
  2036. }
  2038. /**
  2039. * Get centreName
  2040. *
  2041. * @return string
  2042. */
  2043. public function getCentreName()
  2044. {
  2045. return $this->centreName;
  2046. }
  2048. /**
  2049. * Get paginationType
  2050. *
  2051. * @return int
  2052. */
  2053. public function getPaginationType()
  2054. {
  2055. return $this->paginationType;
  2056. }
  2058. /**
  2059. * Get paginationTypeOptions
  2060. *
  2061. * @return array
  2062. */
  2063. public static function getPaginationTypeOptions()
  2064. {
  2065. return [
  2066. self::PAGINATION_TYPE_NORMAL => 'Normal',
  2067. self::PAGINATION_TYPE_INSERTION => 'Insertion',
  2068. self::PAGINATION_TYPE_UPDATE => 'Update',
  2069. ];
  2070. }
  2072. /**
  2073. * Get paginationTypeLabel
  2074. *
  2075. * @return int
  2076. */
  2077. public function getPaginationTypeLabel()
  2078. {
  2079. $options = self::getPaginationTypeOptions();
  2080. return $options[$this->getPaginationType()] ?? '';
  2081. }
  2083. /**
  2084. * Returns true if the pagination type insertion.
  2085. *
  2086. * @return bool
  2087. */
  2088. public function isInsertionPaginationType()
  2089. {
  2090. return $this->getPaginationType() === self::PAGINATION_TYPE_INSERTION;
  2091. }
  2093. /**
  2094. * Returns true if the pagination type is update.
  2095. *
  2096. * @return bool
  2097. */
  2098. public function isUpdatePaginationType()
  2099. {
  2100. return $this->getPaginationType() === self::PAGINATION_TYPE_UPDATE;
  2101. }
  2103. /**
  2104. * Gets the label to use in the choice drop downs.
  2105. *
  2106. * @return string
  2107. */
  2108. public function getChoiceLabel()
  2109. {
  2110. return sprintf('%1$s (%2$s Pag.)', $this->getServiceRequestGroupId(), $this->getPaginationTypeLabel());
  2111. }
  2113. /**
  2114. * Set admissionSortDuration.
  2115. *
  2116. * @param string|null $admissionSortDuration
  2117. *
  2118. * @return BatchRequest
  2119. */
  2120. public function setAdmissionSortDuration($admissionSortDuration = null)
  2121. {
  2122. $this->admissionSortDuration = $admissionSortDuration;
  2124. return $this;
  2125. }
  2127. /**
  2128. * Get admissionSortDuration.
  2129. *
  2130. * @return string|null
  2131. */
  2132. public function getAdmissionSortDuration()
  2133. {
  2134. return $this->admissionSortDuration;
  2135. }
  2137. /**
  2138. * Get locked.
  2139. *
  2140. * @return bool|null
  2141. */
  2142. public function getLocked()
  2143. {
  2144. return $this->locked;
  2145. }
  2147. /**
  2148. * Set dateSortedBy.
  2149. *
  2150. * @param HumanResource|null $dateSortedBy
  2151. *
  2152. * @return BatchRequest
  2153. */
  2154. public function setDateSortedBy(?HumanResource $dateSortedBy = null)
  2155. {
  2156. $this->dateSortedBy = $dateSortedBy;
  2158. return $this;
  2159. }
  2161. /**
  2162. * Get dateSortedBy.
  2163. *
  2164. * @return HumanResource|null
  2165. */
  2166. public function getDateSortedBy()
  2167. {
  2168. return $this->dateSortedBy;
  2169. }
  2171. /**
  2172. * Set admissionSortedBy.
  2173. *
  2174. * @param HumanResource|null $admissionSortedBy
  2175. *
  2176. * @return BatchRequest
  2177. */
  2178. public function setAdmissionSortedBy(?HumanResource $admissionSortedBy = null)
  2179. {
  2180. $this->admissionSortedBy = $admissionSortedBy;
  2182. return $this;
  2183. }
  2185. /**
  2186. * Get admissionSortedBy.
  2187. *
  2188. * @return HumanResource|null
  2189. */
  2190. public function getAdmissionSortedBy()
  2191. {
  2192. return $this->admissionSortedBy;
  2193. }
  2195. /**
  2196. * Set paginationPrefix.
  2197. *
  2198. * @param string|null $paginationPrefix
  2199. *
  2200. * @return BatchRequest
  2201. */
  2202. public function setPaginationPrefix($paginationPrefix = null)
  2203. {
  2204. $this->paginationPrefix = $paginationPrefix;
  2206. return $this;
  2207. }
  2209. /**
  2210. * Get paginationPrefix.
  2211. *
  2212. * @return string|null
  2213. */
  2214. public function getPaginationPrefix()
  2215. {
  2216. return $this->paginationPrefix;
  2217. }
  2219. /**
  2220. * Set paginationIndentLevel.
  2221. *
  2222. * @param int|null $paginationIndentLevel
  2223. *
  2224. * @return BatchRequest
  2225. */
  2226. public function setPaginationIndentLevel($paginationIndentLevel = null)
  2227. {
  2228. $this->paginationIndentLevel = $paginationIndentLevel;
  2230. return $this;
  2231. }
  2233. /**
  2234. * Get paginationIndentLevel.
  2235. *
  2236. * @return int|null
  2237. */
  2238. public function getPaginationIndentLevel()
  2239. {
  2240. return $this->paginationIndentLevel ?: self::PAGINATION_INDENT_LEVEL_1;
  2241. }
  2243. /**
  2244. * Set clonedPageCount.
  2245. *
  2246. * @param int|null $clonedPageCount
  2247. *
  2248. * @return BatchRequest
  2249. */
  2250. public function setClonedPageCount($clonedPageCount = null)
  2251. {
  2252. $this->clonedPageCount = $clonedPageCount;
  2254. return $this;
  2255. }
  2257. /**
  2258. * Get clonedPageCount.
  2259. *
  2260. * @return int|null
  2261. */
  2262. public function getClonedPageCount(): ?int
  2263. {
  2264. return $this->clonedPageCount;
  2265. }
  2267. /**
  2268. * Get the value of centreNameHistory
  2269. *
  2270. * @return string|null
  2271. */
  2272. public function getCentreNameHistory()
  2273. {
  2274. return $this->centreNameHistory;
  2275. }
  2277. /**
  2278. * Set the value of centreNameHistory
  2279. *
  2280. * @param string|null $centreNameHistory
  2281. *
  2282. * @return BatchRequest
  2283. */
  2284. public function setCentreNameHistory($centreNameHistory = null)
  2285. {
  2286. $this->centreNameHistory = $centreNameHistory;
  2288. return $this;
  2289. }
  2291. /**
  2292. * @return Collection|PreprocessDocument[]
  2293. */
  2294. public function getPreprocessDocuments(): Collection
  2295. {
  2296. return $this->preprocessDocuments;
  2297. }
  2299. /**
  2300. * @return PreprocessDocument[]
  2301. */
  2302. public function getPreprocessDocumentsArray(): array
  2303. {
  2304. return $this->preprocessDocuments->toArray();
  2305. }
  2307. /**
  2308. * @param PreprocessDocument $preprocessDocument
  2309. *
  2310. * @return self
  2311. */
  2312. public function addPreprocessDocument(PreprocessDocument $preprocessDocument): self
  2313. {
  2314. if (!$this->preprocessDocuments->contains($preprocessDocument)) {
  2315. $this->preprocessDocuments[] = $preprocessDocument;
  2316. $preprocessDocument->setBatchRequest($this);
  2317. }
  2319. return $this;
  2320. }
  2322. /**
  2323. * @param PreprocessDocument $preprocessDocument
  2324. *
  2325. * @return self
  2326. */
  2327. public function removePreprocessDocument(PreprocessDocument $preprocessDocument): self
  2328. {
  2329. if ($this->preprocessDocuments->removeElement($preprocessDocument)) {
  2330. // set the owning side to null (unless already changed)
  2331. if ($preprocessDocument->getBatchRequest() === $this) {
  2332. $preprocessDocument->setBatchRequest(null);
  2333. }
  2334. }
  2336. return $this;
  2337. }
  2339. /**
  2340. * @return int|null
  2341. */
  2342. public function getCentreType(): ?int
  2343. {
  2344. return $this->centreType;
  2345. }
  2347. /**
  2348. * @param int|null $centreType
  2349. *
  2350. * @return self
  2351. */
  2352. public function setCentreType(?int $centreType): self
  2353. {
  2354. $this->centreType = $centreType;
  2356. return $this;
  2357. }
  2359. /**
  2360. * @return array
  2361. */
  2362. public static function getCentreTypeOptions(): array
  2363. {
  2364. $options = self::getConstantsWithLabelsAsChoices('CENTRE_TYPE');
  2366. $includeOptions = [
  2367. self::CENTRE_TYPE_TRUST,
  2368. self::CENTRE_TYPE_GP,
  2369. self::CENTRE_TYPE_AMBULANCE_SERVICE,
  2370. self::CENTRE_TYPE_CARE_HOME,
  2371. self::CENTRE_TYPE_MARIE_STOPES,
  2372. self::CENTRE_TYPE_PHARMACY,
  2373. self::CENTRE_TYPE_CONSULTANT,
  2374. self::CENTRE_TYPE_HOSPITAL,
  2375. self::CENTRE_TYPE_PSYCHOLOGY,
  2376. self::CENTRE_TYPE_PHYSIO,
  2377. self::CENTRE_TYPE_PODIATRIST,
  2378. self::CENTRE_TYPE_URGENT_CARE_CENTRE,
  2379. self::CENTRE_TYPE_WALKIN_CENTRE,
  2380. self::CENTRE_TYPE_OTHER_PRE_PROCESSING,
  2381. ];
  2383. // Only return certain options for batch requests
  2384. $options = array_intersect($options, $includeOptions);
  2386. ksort($options);
  2388. $reLabeledOptions = [];
  2390. // Append the incl or excl label. Currently, we show the include label as so few centre types are included for pre-processing.
  2391. $preprocessingCentreTypes = static::getAllowedPreprocessingCentreTypes();
  2392. foreach ($options as $label => $value) {
  2393. if (in_array($value, $preprocessingCentreTypes) === true) {
  2394. $reLabeledOptions[sprintf('%1$s %2$s', $label, self::INCLUDE_FOR_PREPROCESSIN_LABEL)] = $value;
  2395. } else {
  2396. $reLabeledOptions[$label] = $value;
  2397. }
  2398. }
  2400. // Add other at the back
  2401. $reLabeledOptions[self::CENTRE_TYPE_OTHER__LABEL] = self::CENTRE_TYPE_OTHER;
  2403. return $reLabeledOptions;
  2404. }
  2406. /**
  2407. * Returns an array of allowed centre types for preprocessing.
  2408. *
  2409. * @return array
  2410. */
  2411. public static function getAllowedPreprocessingCentreTypes(): array
  2412. {
  2413. return [
  2414. // self::CENTRE_TYPE_TRUST,
  2415. self::CENTRE_TYPE_GP,
  2416. // self::CENTRE_TYPE_AMBULANCE_SERVICE,
  2417. // self::CENTRE_TYPE_CARE_HOME,
  2418. // self::CENTRE_TYPE_MARIE_STOPES,
  2419. // self::CENTRE_TYPE_PHARMACY,
  2420. // self::CENTRE_TYPE_CONSULTANT,
  2421. // self::CENTRE_TYPE_HOSPITAL,
  2422. // self::CENTRE_TYPE_PSYCHOLOGY,
  2423. // self::CENTRE_TYPE_PHYSIO,
  2424. // self::CENTRE_TYPE_PODIATRIST,
  2425. // self::CENTRE_TYPE_URGENT_CARE_CENTRE,
  2426. // self::CENTRE_TYPE_WALKIN_CENTRE,
  2427. // self::CENTRE_TYPE_OTHER_PRE_PROCESSING,
  2428. ];
  2429. }
  2431. /**
  2432. * Returns true if the batch request is for GP Records.
  2433. *
  2434. * @return bool
  2435. */
  2436. public function isGpRecords(): bool
  2437. {
  2438. return $this->getCentreType() === self::CENTRE_TYPE_GP;
  2439. }
  2441. /**
  2442. * Returns true of the batch request should be included for pre-processing.
  2443. *
  2444. * @return bool
  2445. */
  2446. public function allowPreprocessing(): bool
  2447. {
  2448. $isServiceRequestComplete = $this->getServiceRequest()->isComplete();
  2449. $isAllowedCentreType = in_array($this->getCentreType(), static::getAllowedPreprocessingCentreTypes());
  2451. // If the type of records is not a GP records set, we only want to allow certain centre names
  2452. // to go for pre-processing.
  2453. $isCentreNameMatch = true;
  2454. // If not a GP records set...
  2455. if ($this->isGpRecords() === false) {
  2456. // Check if the centre wildcards appear in the name
  2457. $pattern = '/' . implode('|', array_map('preg_quote', self::TRUST_NAME_WILDCARDS)) . '/i';
  2458. // Use preg_match to check if any of the wildcards are found
  2459. if (preg_match($pattern, $this->getCentreName()) === 0) {
  2460. $isCentreNameMatch = false;
  2461. }
  2462. }
  2464. return $isServiceRequestComplete === false && $isAllowedCentreType === true && $isCentreNameMatch === true;
  2465. }
  2467. /**
  2468. * @return string
  2469. */
  2470. public function getCentreTypeLabel(): string
  2471. {
  2472. $options = array_flip(self::getCentreTypeOptions());
  2474. return $options[$this->getCentreType()] ?? '';
  2475. }
  2477. /**
  2478. * Returns true if the batch is to be included for preprocessing.
  2479. *
  2480. * @return bool
  2481. */
  2482. public function includedForPreProcessing(): bool
  2483. {
  2484. if (!$this->getSortingSession() || $this->getSortingSession()->getRequiresPreProcessing() === false) {
  2485. return false;
  2486. }
  2488. return !empty(array_filter($this->getSortingSession()->getPreprocessItems(), function (BatchRequest $batchRequest) {
  2489. return $batchRequest->getId() === $this->getId();
  2490. }));
  2491. }
  2493. /**
  2494. * @return bool
  2495. */
  2496. public function isSubmittedForPreprocessing(): bool
  2497. {
  2498. $preprocessDocument = $this->getPreprocessDocuments()->last();
  2500. return $preprocessDocument instanceof PreprocessDocument && !$preprocessDocument->isIgnore();
  2501. }
  2503. /**
  2504. * @return int|null
  2505. */
  2506. public function getComputerizedRecordsCount(): ?int
  2507. {
  2508. return $this->computerizedRecordsCount;
  2509. }
  2511. /**
  2512. * @param int|null $computerizedRecordsCount
  2513. *
  2514. * @return self
  2515. */
  2516. public function setComputerizedRecordsCount(?int $computerizedRecordsCount = null): self
  2517. {
  2518. $this->computerizedRecordsCount = $computerizedRecordsCount;
  2520. return $this;
  2521. }
  2523. /**
  2524. * Returns the pages that should be billed at the standard rate, based on this logic:
  2525. * Total @ Standard Rate (new) = SUM of the following page counts:
  2526. * - Sorted Page Count
  2527. * - Blanks and Dupes Count
  2528. * - Computerised Records, but only if count is < 1000. @see COMPUTERIZED_RECORDS_BILLING_THRESHOLD
  2529. *
  2530. * @return int
  2531. */
  2532. public function getPageCountBilledAtStandardRate(): int
  2533. {
  2534. return $this->getPageCount() + $this->getBlankAndDupesCount() + ($this->getComputerizedRecordsCount() < self::COMPUTERIZED_RECORDS_BILLING_THRESHOLD ? $this->getComputerizedRecordsCount() : 0);
  2535. }
  2537. /**
  2538. * @return bool
  2539. */
  2540. public function hasImportantNotes(): bool
  2541. {
  2542. return $this->getDetails()->filter(function (BatchRequestDetail $batchRequestDetail) {
  2543. return $batchRequestDetail->getIsImportant();
  2544. })->count();
  2545. }
  2547. /**
  2548. * @return bool
  2549. */
  2550. public function canAutoCancel(): bool
  2551. {
  2552. if ($this->getServiceRequest() && ($this->getServiceRequest()->getStatus() === ServiceRequest::STATUS_AWAITING_RECORDS_ARRIVAL || $this->getServiceRequest()->getStatus() === ServiceRequest::STATUS_AWAITING_QUOTE_APPROVAL)) {
  2553. return true;
  2554. }
  2555. return false;
  2556. }
  2558. /**
  2559. * Gets the number of pages scanned
  2560. *
  2561. * @return int|null
  2562. */
  2563. public function getScannedPageCount(): ?int
  2564. {
  2565. return $this->scannedPageCount;
  2566. }
  2568. /**
  2569. * Sets the number of pages scanned
  2570. *
  2571. * @param int|null $scannedPageCount
  2572. *
  2573. * @return self
  2574. */
  2575. public function setScannedPageCount(?int $scannedPageCount): self
  2576. {
  2577. $this->scannedPageCount = $scannedPageCount;
  2579. return $this;
  2580. }
  2581. }