src/Entity/SortingSession.php line 29

Open in your IDE?
  1. <?php
  3. namespace MedBrief\MSR\Entity;
  5. use Doctrine\Common\Collections\ArrayCollection;
  6. use Doctrine\Common\Collections\Collection;
  7. use Doctrine\Common\Collections\Criteria;
  8. use Doctrine\ORM\Mapping as ORM;
  9. use Gedmo\Mapping\Annotation as Gedmo;
  10. use MedBrief\MSR\Entity\MatterRequest\Details\Sort;
  11. use MedBrief\MSR\Entity\MatterRequest\MatterRequest;
  12. use MedBrief\MSR\Repository\SortingSessionRepository;
  13. use MedBrief\MSR\Service\Preprocessing\PreprocessableInterface;
  14. use MedBrief\MSR\Service\Preprocessing\PreprocessItemInterface;
  15. use MedBrief\MSR\Service\ProjectClosure\RemoveRecords\RemovableRecordInterface;
  16. use MedBrief\MSR\Service\SortingSession\SortStatusAwareInterface;
  17. use MedBrief\MSR\Traits\FilterableClassConstantsTrait;
  19. /**
  20. * SortingSession
  21. *
  22. * @ORM\Table(name="SortingSession")
  23. *
  24. * @ORM\Entity(repositoryClass=SortingSessionRepository::class)
  25. *
  26. * @Gedmo\SoftDeleteable(fieldName="deletedAt", timeAware=false)
  27. *
  28. */
  29. class SortingSession implements RemovableRecordInterface, PreprocessableInterface, SortStatusAwareInterface
  30. {
  31. use FilterableClassConstantsTrait;
  33. /**
  34. * Constant values for Session Status
  35. */
  36. public const SESSION_STATUS_PENDING = 11; // Allow adding/removing of batches
  37. public const SESSION_STATUS_READY_FOR_SORTER = 12; // Allow adding/removing of batches (Revert to ::STATUS_PENDING on addition ONLY)
  38. public const SESSION_STATUS_IN_PROGRESS = 13; // SS is cast in stone!!
  39. public const SESSION_STATUS_PAUSED = 14; // SS may be deleted, batches to be released
  40. public const SESSION_STATUS_PAGES_MISSING = 15; // Allow adding of batches ONLY (Revert to ::STATUS_PENDING) -> Delete SS to release batches
  41. public const SESSION_STATUS_COMPLETED = 16; // Allow adding of batches ONLY (Revert to ::STATUS_PENDING) -> Delete SS to release batches
  43. // Preparation related statuses
  44. public const SESSION_STATUS_PREPARE_PENDING = 21; // SS is cast in stone!!
  45. public const SESSION_STATUS_PREPARE_IN_PROGRESS = 22; // SS is cast in stone!!
  46. public const SESSION_STATUS_PREPARE_FAILED = 23; // Allow adding/removing of batches (Revert to ::STATUS_PENDING)
  48. // Export related statuses
  49. public const SESSION_STATUS_EXPORT_PENDING = 31;
  50. public const SESSION_STATUS_EXPORT_IN_PROGRESS = 32;
  51. public const SESSION_STATUS_EXPORT_COMPLETED = 33;
  52. public const SESSION_STATUS_EXPORT_FAILED = 34;
  54. // Processing related statuses - these in practice relate to AI processing of the documents prior to sorting
  55. public const SESSION_STATUS_PREPROCESSING_PENDING = 41;
  56. public const SESSION_STATUS_PREPROCESSING_IN_PROGRESS = 42;
  57. public const SESSION_STATUS_PREPROCESSING_FAILED = 43;
  59. // Export Push related statuses
  60. public const EXPORT_PUSH_STATUS_PENDING = 'export_push.pending';
  61. public const EXPORT_PUSH_STATUS_IN_PROGRESS = 'export_push.in_progress';
  62. public const EXPORT_PUSH_STATUS_COMPLETED = 'export_push.completed';
  63. public const EXPORT_PUSH_STATUS_FAILED = 'export_push.failed';
  65. /** Pagination Strategies */
  66. public const PAGINATION_STRATEGY_ABSOLUTE = 1;
  67. public const PAGINATION_STRATEGY_RELATIVE = 2;
  68. public const PAGINATION_STRATEGY_PREFIXED_ABSOLUTE = 3;
  69. public const PAGINATION_STRATEGY_PREFIXED_RELATIVE = 4;
  70. public const PAGINATION_STRATEGY_NONE = 5;
  71. public const PAGINATION_STRATEGY_SECTION = 6;
  72. public const PAGINATION_STRATEGY_PREFIXED_SECTION = 7;
  74. /** Centre Prefixes */
  75. public const CENTRE_PREFIX_ALPHA = 1;
  76. public const CENTRE_PREFIX_NUMERIC = 2;
  78. public const VERSION_OLD = 'old';
  80. // memoStatus constants
  81. public const MEMO_STATUS_READY_TO_SYNC = 'ready_to_sync';
  82. public const MEMO_STATUS_PENDING = 'pending';
  83. public const MEMO_READY_FOR_UPLOAD = 'ready_for_upload';
  84. public const MEMO_STATUS_UPLOADED = 'uploaded';
  86. // Export Unsorted Push related statuses
  87. public const EXPORT_UNSORTED_PUSH_STATUS_PENDING = 'export_unsorted_push.pending';
  88. public const EXPORT_UNSORTED_PUSH_STATUS_IN_PROGRESS = 'export_unsorted_push.in_progress';
  89. public const EXPORT_UNSORTED_PUSH_STATUS_COMPLETED = 'export_unsorted_push.completed';
  90. public const EXPORT_UNSORTED_PUSH_STATUS_FAILED = 'export_unsorted_push.failed';
  92. // Sort Session Type Options
  93. public const SORT_SESSION_TYPE_CLIENT = 'type_client';
  94. public const SORT_SESSION_TYPE_CLIENT__LABEL = 'Client Session';
  96. public const SORT_SESSION_TYPE_MEDBRIEF = 'type_medbrief';
  97. public const SORT_SESSION_TYPE_MEDBRIEF__LABEL = 'Medbrief Session';
  99. /**
  100. * Unmapped field used to indicate if a notification should be sent
  101. *
  102. * @var bool
  103. */
  104. public $sendNotification = false;
  106. /**
  107. * @var int
  108. *
  109. * @ORM\Column(name="id", type="integer")
  110. *
  111. * @ORM\Id
  112. *
  113. * @ORM\GeneratedValue(strategy="IDENTITY")
  114. */
  115. protected $id;
  117. /**
  118. * @var \DateTime|null
  119. *
  120. * @ORM\Column(name="deletedAt", type="datetime", nullable=true)
  121. */
  122. protected $deletedAt;
  124. /**
  125. * @var \DateTime
  126. *
  127. * @ORM\Column(name="created", type="datetime")
  128. *
  129. * @Gedmo\Timestampable(on="create")
  130. */
  131. protected $created;
  133. /**
  134. * @var \DateTime
  135. *
  136. * @ORM\Column(name="updated", type="datetime")
  137. *
  138. * @Gedmo\Timestampable(on="update")
  139. */
  140. protected $updated;
  142. /**
  143. * @var string|null
  144. *
  145. * @ORM\Column(name="storeData", type="text", nullable=true)
  146. */
  147. protected $storeData;
  149. /**
  150. * @var string|null
  151. *
  152. * @ORM\Column(name="exportStoreJson", type="text", nullable=true)
  153. */
  154. protected $exportStoreJson;
  156. /**
  157. * @var int|null
  158. *
  159. * @ORM\Column(name="sessionStatus", type="integer", nullable=true)
  160. */
  161. protected $sessionStatus = self::SESSION_STATUS_PENDING;
  163. /**
  164. * @var int|null
  165. *
  166. * @ORM\Column(name="sortStatus", type="integer", nullable=true)
  167. */
  168. protected $sortStatus = self::SORT_STATUS_CLASSIFY;
  170. /**
  171. * @var string|null
  172. *
  173. * @ORM\Column(name="archiveFilename", type="string", nullable=true)
  174. */
  175. protected $archiveFilename;
  177. /**
  178. * @var int|null
  179. *
  180. * @ORM\Column(name="paginationStrategy", type="integer", nullable=true)
  181. */
  182. protected $paginationStrategy;
  184. /**
  185. * @var string|null
  186. *
  187. * @ORM\Column(name="paginationPrefix", type="string", nullable=true)
  188. */
  189. protected $paginationPrefix;
  191. /**
  192. * @var int|null
  193. *
  194. * @ORM\Column(name="centrePrefix", type="integer", nullable=true)
  195. */
  196. protected $centrePrefix;
  198. /**
  199. * @var int
  200. *
  201. * @ORM\Column(name="centrePrefixPadding", type="integer", options={"default"="3"})
  202. */
  203. protected $centrePrefixPadding = 3;
  205. /**
  206. * @var int
  207. *
  208. * @ORM\Column(name="pageNumberPadding", type="integer", options={"default"="4"})
  209. */
  210. protected $pageNumberPadding = 4;
  212. /**
  213. * @var int
  214. *
  215. * @ORM\Column(name="pageNumberPositionHorizontal", type="integer", options={"default"="3"})
  216. */
  217. protected $pageNumberPositionHorizontal = Sort::PAGE_NUMBER_POSITION_HORIZONTAL_RIGHT;
  219. /**
  220. * @var int
  221. *
  222. * @ORM\Column(name="pageNumberPositionVertical", type="integer", options={"default"="2"})
  223. */
  224. protected $pageNumberPositionVertical = Sort::PAGE_NUMBER_POSITION_VERTICAL_BOTTOM;
  226. /**
  227. * @var int
  228. *
  229. * @ORM\Column(name="pageNumberSize", type="integer", options={"default"="20"})
  230. */
  231. protected $pageNumberSize = Sort::PAGE_NUMBER_SIZE_20;
  233. /**
  234. * @var bool
  235. *
  236. * @ORM\Column(name="pageNumberBackground", type="boolean", options={"default"=false})
  237. */
  238. protected $pageNumberBackground = Sort::PAGE_NUMBER_BACKGROUND_NO;
  240. /**
  241. * @var int
  242. *
  243. * @ORM\Column(name="timeSpentClassify", type="integer", options={"default"="0"})
  244. */
  245. protected $timeSpentClassify = 0;
  247. /**
  248. * @var int
  249. *
  250. * @ORM\Column(name="timeSpentDating", type="integer", options={"default"="0"})
  251. */
  252. protected $timeSpentDating = 0;
  254. /**
  255. * @var int
  256. *
  257. * @ORM\Column(name="timeSpentAdmission", type="integer", options={"default"="0"})
  258. */
  259. protected $timeSpentAdmission = 0;
  261. /**
  262. * @var int
  263. *
  264. * @ORM\Column(name="timeSpentMemo", type="integer", options={"default"="0"})
  265. */
  266. protected $timeSpentMemo = 0;
  268. /**
  269. * @var int
  270. *
  271. * @ORM\Column(name="timeSpentQa", type="integer", options={"default"="0"})
  272. */
  273. protected $timeSpentQa = 0;
  275. /**
  276. * @var \DateTime|null
  277. *
  278. * @ORM\Column(name="dateSentToSorter", type="datetime", nullable=true)
  279. */
  280. protected $dateSentToSorter;
  282. /**
  283. * @var \DateTime|null
  284. *
  285. * @ORM\Column(name="dueDate", type="datetime", nullable=true)
  286. */
  287. protected $dueDate;
  289. /**
  290. * @var \DateTime|null
  291. *
  292. * @ORM\Column(name="estCompletionDate", type="datetime", nullable=true)
  293. */
  294. protected $estCompletionDate;
  296. /**
  297. * @var \DateTime|null
  298. *
  299. * @ORM\Column(name="dateDownloaded", type="datetime", nullable=true)
  300. */
  301. protected $dateDownloaded;
  303. /**
  304. * @var string|null
  305. *
  306. * @ORM\Column(name="mrsFormFilename", type="string", length=255, nullable=true)
  307. */
  308. protected $mrsFormFilename;
  310. /**
  311. * @var int
  312. *
  313. * @ORM\Column(name="startPageNumber", type="integer", options={"default"="1"})
  314. */
  315. protected $startPageNumber = 1;
  317. /**
  318. * @var int|null
  319. *
  320. * @ORM\Column(name="classifyCompletePerc", type="integer", nullable=true)
  321. */
  322. protected $classifyCompletePerc;
  324. /**
  325. * @var int|null
  326. *
  327. * @ORM\Column(name="dateCompletePerc", type="integer", nullable=true)
  328. */
  329. protected $dateCompletePerc;
  331. /**
  332. * @var string|null
  333. *
  334. * @ORM\Column(name="exportError", type="text", nullable=true)
  335. */
  336. protected $exportError;
  338. /**
  339. * @var string|null
  340. *
  341. * @ORM\Column(name="version", type="string", nullable=true)
  342. */
  343. protected $version;
  345. /**
  346. * @var string|null
  347. *
  348. * @ORM\Column(name="exportPushStatus", type="string", nullable=true)
  349. */
  350. protected $exportPushStatus;
  352. /**
  353. * @var string|null
  354. *
  355. * @ORM\Column(name="memoStatus", type="string", nullable=true)
  356. */
  357. protected $memoStatus;
  359. /**
  360. * @var string|null
  361. *
  362. * @ORM\Column(name="qaFailNote", type="text", nullable=true)
  363. */
  364. protected $qaFailNote;
  366. /**
  367. * @var string|null
  368. *
  369. * @ORM\Column(name="exportPushUnsortedStatus", type="string", nullable=true)
  370. */
  371. protected $exportPushUnsortedStatus;
  373. /**
  374. * @var string|null
  375. *
  376. * @ORM\Column(name="sortSessionType", type="string", nullable=true)
  377. */
  378. protected $sortSessionType;
  380. /**
  381. * @var bool
  382. *
  383. * @ORM\Column(name="isUrgent", type="boolean", options={"default"=false})
  384. */
  385. protected $isUrgent = false;
  387. /**
  388. * Indicates if the SortingSession should be sent for pre-processing (AI processing).
  389. *
  390. * @var bool
  391. *
  392. * @ORM\Column(type="boolean", options={"default"=false})
  393. */
  394. protected $requiresPreProcessing = false;
  396. /**
  397. * @var Collection
  398. *
  399. * @ORM\OneToMany(targetEntity="MedBrief\MSR\Entity\BatchRequest", mappedBy="sortingSession", cascade={"persist"})
  400. */
  401. protected $batchRequests;
  403. /**
  404. * @var Collection
  405. *
  406. * @ORM\OneToMany(targetEntity="MedBrief\MSR\Entity\SortingSessionDetail", mappedBy="sortingSession", cascade={"persist","remove"}, orphanRemoval=true)
  407. */
  408. protected $details;
  410. /**
  411. * @var Collection
  412. *
  413. * @ORM\OneToMany(targetEntity="MedBrief\MSR\Entity\SortingSessionMemo", mappedBy="sortingSession", cascade={"persist","remove"}, orphanRemoval=true)
  414. */
  415. protected $sortingSessionMemos;
  417. /**
  418. * @var Project
  419. *
  420. * @ORM\ManyToOne(targetEntity="MedBrief\MSR\Entity\Project", inversedBy="sortingSessions")
  421. *
  422. * @ORM\JoinColumns({
  423. *
  424. * @ORM\JoinColumn(name="project_id", referencedColumnName="id")
  425. * })
  426. */
  427. protected $project;
  429. /**
  430. * @ORM\ManyToOne(targetEntity="MedBrief\MSR\Entity\User")
  431. *
  432. * @var User
  433. */
  434. protected $validatedBy;
  436. /**
  437. * @var User
  438. *
  439. * @ORM\ManyToOne(targetEntity="MedBrief\MSR\Entity\User")
  440. *
  441. * @ORM\JoinColumns({
  442. *
  443. * @ORM\JoinColumn(name="sortedBy_id", referencedColumnName="id")
  444. * })
  445. */
  446. protected $sortedBy;
  448. /**
  449. * @var User
  450. *
  451. * @ORM\ManyToOne(targetEntity="MedBrief\MSR\Entity\User")
  452. *
  453. * @ORM\JoinColumns({
  454. *
  455. * @ORM\JoinColumn(name="datedBy_id", referencedColumnName="id")
  456. * })
  457. */
  458. protected $datedBy;
  460. /**
  461. * @var User
  462. *
  463. * @ORM\ManyToOne(targetEntity="MedBrief\MSR\Entity\User")
  464. *
  465. * @ORM\JoinColumns({
  466. *
  467. * @ORM\JoinColumn(name="admissionBy_id", referencedColumnName="id")
  468. * })
  469. */
  470. protected $admissionBy;
  472. /**
  473. * @var User
  474. *
  475. * @ORM\ManyToOne(targetEntity="MedBrief\MSR\Entity\User")
  476. *
  477. * @ORM\JoinColumns({
  478. *
  479. * @ORM\JoinColumn(name="memoBy_id", referencedColumnName="id")
  480. * })
  481. */
  482. protected $memoBy;
  484. /**
  485. * @var User
  486. *
  487. * @ORM\ManyToOne(targetEntity="MedBrief\MSR\Entity\User")
  488. *
  489. * @ORM\JoinColumns({
  490. *
  491. * @ORM\JoinColumn(name="qaBy_id", referencedColumnName="id")
  492. * })
  493. */
  494. protected $qaBy;
  496. /**
  497. * @var User
  498. *
  499. * @ORM\ManyToOne(targetEntity="MedBrief\MSR\Entity\User")
  500. *
  501. * @ORM\JoinColumns({
  502. *
  503. * @ORM\JoinColumn(name="downloadedBy_id", referencedColumnName="id")
  504. * })
  505. */
  506. protected $downloadedBy;
  508. /**
  509. * @var User
  510. *
  511. * @ORM\ManyToOne(targetEntity="MedBrief\MSR\Entity\User")
  512. *
  513. * @ORM\JoinColumns({
  514. *
  515. * @ORM\JoinColumn(name="exportPushBy_id", referencedColumnName="id")
  516. * })
  517. */
  518. protected $exportPushBy;
  520. /**
  521. * @var User
  522. *
  523. * @ORM\ManyToOne(targetEntity="MedBrief\MSR\Entity\User")
  524. *
  525. * @ORM\JoinColumns({
  526. *
  527. * @ORM\JoinColumn(name="exportPushUnsortedBy_id", referencedColumnName="id")
  528. * })
  529. */
  530. protected $exportPushUnsortedBy;
  532. /**
  533. * @var User
  534. *
  535. * @ORM\ManyToOne(targetEntity="MedBrief\MSR\Entity\User")
  536. *
  537. * @ORM\JoinColumns({
  538. *
  539. * @ORM\JoinColumn(name="activeSortingUser_id", referencedColumnName="id")
  540. * })
  541. */
  542. protected $activeSortingUser;
  544. /**
  545. * @var string
  546. */
  547. protected $mrsFormFile;
  549. /**
  550. * @var string
  551. */
  552. protected $chronologyRequired;
  554. /**
  555. * Constructor
  556. *
  557. * @param null|MatterRequest $matterRequest
  558. */
  559. public function __construct(?MatterRequest $matterRequest = null)
  560. {
  561. $this->batchRequests = new ArrayCollection();
  562. $this->details = new ArrayCollection();
  563. $this->sortingSessionMemos = new ArrayCollection();
  565. // If there was a sort requested on the matter request
  566. if ($matterRequest && $matterRequest->getServiceSelectionDetails() && $matterRequest->getServiceSelectionDetails()->isSortChoiceYes() && $matterRequest->getSortDetails()) {
  567. $this->mapPaginationOptions($matterRequest->getSortDetails());
  568. }
  569. }
  571. /**
  572. * __toString
  573. *
  574. * @return string
  575. */
  576. public function __toString()
  577. {
  578. return (string) $this->getId();
  579. }
  581. /**
  582. * Get id
  583. *
  584. * @return int
  585. */
  586. public function getId(): ?int
  587. {
  588. return $this->id;
  589. }
  591. /**
  592. * Set created
  593. *
  594. * @param \DateTime $created
  595. *
  596. * @return SortingSession
  597. */
  598. public function setCreated($created)
  599. {
  600. $this->created = $created;
  602. return $this;
  603. }
  605. /**
  606. * Get created
  607. *
  608. * @return \DateTime
  609. */
  610. public function getCreated()
  611. {
  612. return $this->created;
  613. }
  615. /**
  616. * Set updated
  617. *
  618. * @param \DateTime $updated
  619. *
  620. * @return SortingSession
  621. */
  622. public function setUpdated($updated)
  623. {
  624. $this->updated = $updated;
  626. return $this;
  627. }
  629. /**
  630. * Get updated
  631. *
  632. * @return \DateTime
  633. */
  634. public function getUpdated()
  635. {
  636. return $this->updated;
  637. }
  639. /**
  640. * Set storeData
  641. *
  642. * @param string $storeData
  643. *
  644. * @return SortingSession
  645. */
  646. public function setStoreData($storeData)
  647. {
  648. $this->storeData = $storeData;
  650. return $this;
  651. }
  653. /**
  654. * Get storeData
  655. *
  656. * @return string
  657. */
  658. public function getStoreData()
  659. {
  660. return $this->storeData;
  661. }
  663. /**
  664. * Get storeDataArray
  665. *
  666. * @return array
  667. */
  668. public function getStoreDataArray()
  669. {
  670. if (!$this->getStoreData()) {
  671. return [];
  672. }
  673. return json_decode($this->getStoreData(), true);
  674. }
  676. /**
  677. * Set sessionStatus
  678. *
  679. * @param int $sessionStatus
  680. *
  681. * @return SortingSession
  682. */
  683. public function setSessionStatus($sessionStatus)
  684. {
  685. // Clear the export error when we do a new export. Clear the push status when we do a new export.
  686. if ($sessionStatus === self::SESSION_STATUS_EXPORT_PENDING) {
  687. $this->setExportError('');
  688. $this->setExportPushStatus(null);
  689. }
  691. $this->sessionStatus = $sessionStatus;
  693. return $this;
  694. }
  696. /**
  697. * Get sessionStatus
  698. *
  699. * @return int
  700. */
  701. public function getSessionStatus()
  702. {
  703. return $this->sessionStatus;
  704. }
  706. /**
  707. * Return true if SortingSession is paused
  708. *
  709. * @return bool
  710. */
  711. public function isPaused()
  712. {
  713. return $this->sessionStatus === self::SESSION_STATUS_PAUSED;
  714. }
  716. /**
  717. * Return true if SortingSession is in progress
  718. *
  719. * @return bool
  720. */
  721. public function isInProgress()
  722. {
  723. return $this->sessionStatus === self::SESSION_STATUS_IN_PROGRESS || $this->getActiveSortingUser() !== null;
  724. }
  726. /**
  727. * Return true if SortingSession is busy preparing for the sorter
  728. *
  729. * @return bool
  730. */
  731. public function isPreparing()
  732. {
  733. return $this->sessionStatus === self::SESSION_STATUS_PREPARE_PENDING || $this->sessionStatus === self::SESSION_STATUS_PREPARE_IN_PROGRESS;
  734. }
  736. /**
  737. * Return true if SortingSession is pending
  738. *
  739. * @return bool
  740. */
  741. public function isPending()
  742. {
  743. return $this->sessionStatus === self::SESSION_STATUS_PENDING;
  744. }
  746. /**
  747. * Return true if SortingSession is prepare failed
  748. *
  749. * @return bool
  750. */
  751. public function isPrepareFailed()
  752. {
  753. return $this->sessionStatus === self::SESSION_STATUS_PREPARE_FAILED;
  754. }
  756. /**
  757. * Return true if SortingSession is ready for sorter
  758. *
  759. * @return bool
  760. */
  761. public function isReadyForSorter()
  762. {
  763. return $this->sessionStatus === self::SESSION_STATUS_READY_FOR_SORTER;
  764. }
  766. /**
  767. * Return true if SortingSession is missing pages
  768. *
  769. * @return bool
  770. */
  771. public function isMissingPages()
  772. {
  773. return $this->sessionStatus === self::SESSION_STATUS_PAGES_MISSING;
  774. }
  776. /**
  777. * Return true if SortingSession export is pending
  778. *
  779. * @return bool
  780. */
  781. public function isExportPending()
  782. {
  783. return $this->sessionStatus === self::SESSION_STATUS_EXPORT_PENDING;
  784. }
  786. /**
  787. * Return true if SortingSession export is in progress
  788. *
  789. * @return bool
  790. */
  791. public function isExportInProgress()
  792. {
  793. return $this->sessionStatus === self::SESSION_STATUS_EXPORT_IN_PROGRESS;
  794. }
  796. /**
  797. * Return true if SortingSession export completed
  798. *
  799. * @return bool
  800. */
  801. public function isExportCompleted()
  802. {
  803. return $this->sessionStatus === self::SESSION_STATUS_EXPORT_COMPLETED;
  804. }
  806. /**
  807. * Return true if SortingSession export failed
  808. *
  809. * @return bool
  810. */
  811. public function isExportFailed()
  812. {
  813. return $this->sessionStatus === self::SESSION_STATUS_EXPORT_FAILED;
  814. }
  816. /**
  817. * @return bool
  818. */
  819. public function isPreprocessingPending()
  820. {
  821. return $this->sessionStatus === self::SESSION_STATUS_PREPROCESSING_PENDING;
  822. }
  824. /**
  825. * @return bool
  826. */
  827. public function isPreprocessingFailed()
  828. {
  829. return $this->sessionStatus === self::SESSION_STATUS_PREPROCESSING_FAILED;
  830. }
  832. /**
  833. * @return bool
  834. */
  835. public function isPreprocessingInProgress()
  836. {
  837. return $this->sessionStatus === self::SESSION_STATUS_PREPROCESSING_IN_PROGRESS;
  838. }
  840. /**
  841. * @return bool
  842. */
  843. public function isPreprocessing(): bool
  844. {
  845. return in_array($this->getSessionStatus(), [
  846. self::SESSION_STATUS_PREPROCESSING_PENDING,
  847. self::SESSION_STATUS_PREPROCESSING_FAILED,
  848. self::SESSION_STATUS_PREPROCESSING_IN_PROGRESS,
  849. ]);
  850. }
  852. /**
  853. * Get sessionStatusOptions
  854. *
  855. * @param array $inclOnly
  856. *
  857. * @return array
  858. */
  859. public static function getSessionStatusOptions(array $inclOnly = [])
  860. {
  861. $options = [
  862. self::SESSION_STATUS_PENDING => 'Pending',
  863. self::SESSION_STATUS_READY_FOR_SORTER => 'Ready for Sorter',
  864. self::SESSION_STATUS_IN_PROGRESS => 'In Progress',
  865. self::SESSION_STATUS_PAUSED => 'Paused',
  866. self::SESSION_STATUS_PAGES_MISSING => 'Pages Missing',
  867. self::SESSION_STATUS_COMPLETED => 'Completed',
  868. self::SESSION_STATUS_PREPARE_PENDING => 'Send to Sorter',
  869. self::SESSION_STATUS_PREPARE_IN_PROGRESS => 'Preparing for Sorter',
  870. self::SESSION_STATUS_PREPARE_FAILED => 'Failed Preparing for Sorter',
  871. self::SESSION_STATUS_EXPORT_PENDING => 'Pending Export',
  872. self::SESSION_STATUS_EXPORT_IN_PROGRESS => 'Export In Progress',
  873. self::SESSION_STATUS_EXPORT_COMPLETED => 'Available To Download',
  874. self::SESSION_STATUS_EXPORT_FAILED => 'Failed Creating Archive',
  875. self::SESSION_STATUS_PREPROCESSING_PENDING => 'Pre-Processing - Pending',
  876. self::SESSION_STATUS_PREPROCESSING_IN_PROGRESS => 'Pre-Processing - In Progress',
  877. self::SESSION_STATUS_PREPROCESSING_FAILED => 'Pre-Processing - Failed',
  878. ];
  880. if ($inclOnly) {
  881. $options = array_filter($options, function ($key) use ($inclOnly) {
  882. return in_array($key, $inclOnly);
  883. }, \ARRAY_FILTER_USE_KEY);
  884. }
  886. return $options;
  887. }
  889. /**
  890. * Get sessionStatusLabel
  891. *
  892. * @return string
  893. */
  894. public function getSessionStatusLabel()
  895. {
  896. $options = self::getSessionStatusOptions();
  897. return $options[$this->getSessionStatus()] ?? '';
  898. }
  900. /**
  901. * Add batchRequest
  902. *
  903. * @param BatchRequest $batchRequest
  904. *
  905. * @return SortingSession
  906. */
  907. public function addBatchRequest(BatchRequest $batchRequest)
  908. {
  909. $batchRequest->setSortingSession($this);
  910. $this->batchRequests[] = $batchRequest;
  912. return $this;
  913. }
  915. /**
  916. * Remove batchRequest
  917. *
  918. * @param BatchRequest $batchRequest
  919. */
  920. public function removeBatchRequest(BatchRequest $batchRequest)
  921. {
  922. $batchRequest->setSortingSession(null);
  923. $this->batchRequests->removeElement($batchRequest);
  924. }
  926. /**
  927. * Get batchRequests
  928. *
  929. * @return BatchRequest[] | ArrayCollection
  930. */
  931. public function getBatchRequests()
  932. {
  933. return $this->batchRequests;
  934. }
  936. /**
  937. * Gets the total page count for the SortingSession.
  938. *
  939. * @return int
  940. */
  941. public function getPageCount()
  942. {
  943. return array_reduce($this->getBatchRequests()->toArray(), function ($pageCount, BatchRequest $batchRequest) {
  944. return $batchRequest->getPages()->count() + $pageCount;
  945. }, 0);
  946. }
  948. /**
  949. * Get batchRequests as a list of request IDs
  950. *
  951. * @return string
  952. */
  953. public function getBatchRequestsCsv()
  954. {
  955. return implode(', ', array_map(function (BatchRequest $batchRequest) {
  956. return $batchRequest->getServiceRequestGroupId();
  957. }, $this->getBatchRequests()->toArray()));
  958. }
  960. /**
  961. * @return string
  962. */
  963. public function getPreprocessDocumentsCsv()
  964. {
  965. $preprocessDocumentsCsv = '';
  967. foreach ($this->getPreprocessItems() as $preprocessItem) {
  968. foreach ($preprocessItem->getPreprocessDocumentsArray() as $preprocessDocument) {
  969. if ($preprocessDocument->isIgnore() === false) {
  970. $preprocessDocumentsCsv .= sprintf('%1$s(%2$s), ', $preprocessDocument->getId(), $preprocessDocument->getStatusLabel());
  971. }
  972. }
  973. }
  975. return trim($preprocessDocumentsCsv, ', ');
  976. }
  978. /**
  979. * Set project
  980. *
  981. * @param Project $project
  982. *
  983. * @return SortingSession
  984. */
  985. public function setProject(?Project $project = null)
  986. {
  987. $this->project = $project;
  989. return $this;
  990. }
  992. /**
  993. * Get project
  994. *
  995. * @return Project
  996. */
  997. public function getProject()
  998. {
  999. return $this->project;
  1000. }
  1002. /**
  1003. * @param User $validatedBy
  1004. *
  1005. * @return self
  1006. */
  1007. public function setValidatedBy(?User $validatedBy = null): self
  1008. {
  1009. $this->validatedBy = $validatedBy;
  1011. return $this;
  1012. }
  1014. /**
  1015. * Get validatedBy
  1016. *
  1017. * @return User|null
  1018. */
  1019. public function getValidatedBy(): ?User
  1020. {
  1021. return $this->validatedBy;
  1022. }
  1024. /**
  1025. * Set sortedBy
  1026. *
  1027. * @param User $sortedBy
  1028. *
  1029. * @return SortingSession
  1030. */
  1031. public function setSortedBy(?User $sortedBy = null)
  1032. {
  1033. $this->sortedBy = $sortedBy;
  1035. return $this;
  1036. }
  1038. /**
  1039. * Get sortedBy
  1040. *
  1041. * @return User
  1042. */
  1043. public function getSortedBy()
  1044. {
  1045. return $this->sortedBy;
  1046. }
  1048. /**
  1049. * Set datedBy
  1050. *
  1051. * @param User $datedBy
  1052. *
  1053. * @return SortingSession
  1054. */
  1055. public function setDatedBy(?User $datedBy = null)
  1056. {
  1057. $this->datedBy = $datedBy;
  1059. return $this;
  1060. }
  1062. /**
  1063. * Get datedBy
  1064. *
  1065. * @return User
  1066. */
  1067. public function getDatedBy()
  1068. {
  1069. return $this->datedBy;
  1070. }
  1072. /**
  1073. * Set qaBy
  1074. *
  1075. * @param User $qaBy
  1076. *
  1077. * @return SortingSession
  1078. */
  1079. public function setQaBy(?User $qaBy = null)
  1080. {
  1081. $this->qaBy = $qaBy;
  1083. return $this;
  1084. }
  1086. /**
  1087. * Get qaBy
  1088. *
  1089. * @return User
  1090. */
  1091. public function getQaBy()
  1092. {
  1093. return $this->qaBy;
  1094. }
  1096. /**
  1097. * Get all the statuses that a SortingSession may be in in order for it to be deleted
  1098. *
  1099. * @return array
  1100. */
  1101. public static function getDeletableStatuses()
  1102. {
  1103. return [
  1104. self::SESSION_STATUS_PENDING,
  1105. self::SESSION_STATUS_COMPLETED,
  1106. self::SESSION_STATUS_PAUSED,
  1107. self::SESSION_STATUS_PAGES_MISSING,
  1108. self::SESSION_STATUS_PREPARE_FAILED,
  1109. ];
  1110. }
  1112. /**
  1113. * Get all the statuses that a SortingSession may be in in order to accept additional BatchRequests
  1114. *
  1115. * @return array
  1116. */
  1117. public static function getBatchAddableStatuses()
  1118. {
  1119. return [
  1120. self::SESSION_STATUS_PENDING,
  1121. self::SESSION_STATUS_READY_FOR_SORTER,
  1122. self::SESSION_STATUS_PAUSED,
  1123. self::SESSION_STATUS_PAGES_MISSING,
  1124. self::SESSION_STATUS_COMPLETED,
  1125. self::SESSION_STATUS_PREPARE_FAILED,
  1126. self::SESSION_STATUS_EXPORT_COMPLETED,
  1127. ];
  1128. }
  1130. /**
  1131. * Get all the statuses that a SortingSession may be in in order to delete associated BatchRequests
  1132. *
  1133. * @return array
  1134. */
  1135. public static function getBatchDeletableStatuses()
  1136. {
  1137. return [
  1138. self::SESSION_STATUS_PENDING,
  1139. self::SESSION_STATUS_READY_FOR_SORTER,
  1140. self::SESSION_STATUS_PREPARE_FAILED,
  1141. self::SESSION_STATUS_PAUSED,
  1142. ];
  1143. }
  1145. /**
  1146. * Get all the statuses that a SortingSession would show in the doc sorter for.
  1147. *
  1148. * @return array
  1149. */
  1150. public static function getActiveStatuses()
  1151. {
  1152. return [
  1153. self::SESSION_STATUS_IN_PROGRESS,
  1154. self::SESSION_STATUS_READY_FOR_SORTER,
  1155. self::SESSION_STATUS_PAUSED,
  1156. ];
  1157. }
  1159. /**
  1160. * Returns true if the SortingSession is in a status that would render it visible in the
  1161. * document sorter.
  1162. *
  1163. * @return bool
  1164. */
  1165. public function hasActiveStatus()
  1166. {
  1167. return in_array($this->getSessionStatus(), self::getActiveStatuses());
  1168. }
  1170. /**
  1171. * Set archiveFilename
  1172. *
  1173. * @param string $archiveFilename
  1174. *
  1175. * @return SortingSession
  1176. */
  1177. public function setArchiveFilename($archiveFilename)
  1178. {
  1179. $this->archiveFilename = $archiveFilename;
  1181. return $this;
  1182. }
  1184. /**
  1185. * Get archiveFilename
  1186. *
  1187. * @return string
  1188. */
  1189. public function getArchiveFilename()
  1190. {
  1191. return $this->archiveFilename;
  1192. }
  1194. /**
  1195. * Set paginationStrategy
  1196. *
  1197. * @param int $paginationStrategy
  1198. *
  1199. * @return SortingSession
  1200. */
  1201. public function setPaginationStrategy($paginationStrategy)
  1202. {
  1203. $this->paginationStrategy = $paginationStrategy;
  1205. return $this;
  1206. }
  1208. /**
  1209. * Get paginationStrategy
  1210. *
  1211. * @return int
  1212. */
  1213. public function getPaginationStrategy()
  1214. {
  1215. return $this->paginationStrategy;
  1216. }
  1218. /**
  1219. * Set paginationPrefix
  1220. *
  1221. * @param string $paginationPrefix
  1222. *
  1223. * @return SortingSession
  1224. */
  1225. public function setPaginationPrefix($paginationPrefix)
  1226. {
  1227. $this->paginationPrefix = $paginationPrefix;
  1229. return $this;
  1230. }
  1232. /**
  1233. * Get paginationPrefix
  1234. *
  1235. * @return string
  1236. */
  1237. public function getPaginationPrefix()
  1238. {
  1239. return $this->paginationPrefix;
  1240. }
  1242. /**
  1243. * Returns an array of pagination strategies that are relative
  1244. *
  1245. * @return array
  1246. */
  1247. public static function getRelativePaginationStrategies()
  1248. {
  1249. return [
  1250. self::PAGINATION_STRATEGY_RELATIVE,
  1251. self::PAGINATION_STRATEGY_PREFIXED_RELATIVE,
  1252. ];
  1253. }
  1255. /**
  1256. * Returns an array of pagination strategies that are relative
  1257. *
  1258. * @return array
  1259. */
  1260. public static function getAbsolutePaginationStrategies()
  1261. {
  1262. return [
  1263. self::PAGINATION_STRATEGY_ABSOLUTE,
  1264. self::PAGINATION_STRATEGY_PREFIXED_ABSOLUTE,
  1265. ];
  1266. }
  1268. /**
  1269. * Returns an array of pagination strategies that are section based
  1270. *
  1271. * @return array
  1272. */
  1273. public static function getSectionPaginationStrategies()
  1274. {
  1275. return [
  1276. self::PAGINATION_STRATEGY_SECTION,
  1277. self::PAGINATION_STRATEGY_PREFIXED_SECTION,
  1278. ];
  1279. }
  1281. /**
  1282. * Returns an array of pagination strategies that are prefixed
  1283. *
  1284. * @return array
  1285. */
  1286. public static function getPrefixedPaginationStrategies()
  1287. {
  1288. return [
  1289. self::PAGINATION_STRATEGY_PREFIXED_ABSOLUTE,
  1290. self::PAGINATION_STRATEGY_PREFIXED_RELATIVE,
  1291. self::PAGINATION_STRATEGY_PREFIXED_SECTION,
  1292. ];
  1293. }
  1295. /**
  1296. * Get Pagination options
  1297. *
  1298. * @param array $inclOnly
  1299. *
  1300. * @return array
  1301. */
  1302. public static function getPaginationOptions(array $inclOnly = [])
  1303. {
  1304. $options = [
  1305. self::PAGINATION_STRATEGY_ABSOLUTE => 'Absolute Numbering',
  1306. self::PAGINATION_STRATEGY_RELATIVE => 'Relative Numbering',
  1307. self::PAGINATION_STRATEGY_SECTION => 'Section Numbering',
  1308. self::PAGINATION_STRATEGY_PREFIXED_ABSOLUTE => 'Absolute Numbering With Prefix',
  1309. self::PAGINATION_STRATEGY_PREFIXED_RELATIVE => 'Relative Numbering With Prefix',
  1310. self::PAGINATION_STRATEGY_PREFIXED_SECTION => 'Section Numbering With Prefix',
  1311. ];
  1313. if ($inclOnly) {
  1314. $options = array_filter($options, function ($key) use ($inclOnly) {
  1315. return in_array($key, $inclOnly);
  1316. }, \ARRAY_FILTER_USE_KEY);
  1317. }
  1319. return $options;
  1320. }
  1322. /**
  1323. * Checks to see if this Sorting Session has been completed
  1324. *
  1325. * @return bool
  1326. */
  1327. public function hasBeenCompleted()
  1328. {
  1329. return in_array($this->getSessionStatus(), [
  1330. self::SESSION_STATUS_COMPLETED,
  1331. self::SESSION_STATUS_EXPORT_PENDING,
  1332. self::SESSION_STATUS_EXPORT_IN_PROGRESS,
  1333. self::SESSION_STATUS_EXPORT_COMPLETED,
  1334. self::SESSION_STATUS_EXPORT_FAILED,
  1335. ]);
  1336. }
  1338. /**
  1339. * Checks to see if this Sorting Session has completed exporting.
  1340. *
  1341. * @return bool
  1342. */
  1343. public function hasBeenExported()
  1344. {
  1345. return in_array($this->getSessionStatus(), [
  1346. self::SESSION_STATUS_EXPORT_COMPLETED,
  1347. ]);
  1348. }
  1350. /**
  1351. * @return mixed
  1352. */
  1353. public function getCentrePrefix()
  1354. {
  1355. return $this->centrePrefix;
  1356. }
  1358. /**
  1359. * getActualCentrePrefix
  1360. *
  1361. * @return mixed
  1362. */
  1363. public function getActualCentrePrefix()
  1364. {
  1365. switch ($this->centrePrefix) {
  1366. case self::CENTRE_PREFIX_ALPHA:
  1367. return 'A';
  1368. break;
  1369. case self::CENTRE_PREFIX_NUMERIC:
  1370. return 1;
  1371. break;
  1372. default:
  1373. return 'A';
  1374. }
  1375. }
  1377. /**
  1378. * @param int $centrePrefix
  1379. *
  1380. * @return SortingSession
  1381. */
  1382. public function setCentrePrefix(?int $centrePrefix = null)
  1383. {
  1384. $this->centrePrefix = $centrePrefix;
  1385. return $this;
  1386. }
  1388. /**
  1389. * Get Centre Prefix options
  1390. *
  1391. * @param array $inclOnly
  1392. *
  1393. * @return array
  1394. */
  1395. public static function getCentrePrefixOptions(array $inclOnly = [])
  1396. {
  1397. $options = [
  1398. self::CENTRE_PREFIX_ALPHA => 'Alphabetical',
  1399. self::CENTRE_PREFIX_NUMERIC => 'Numerical',
  1400. ];
  1402. if ($inclOnly) {
  1403. $options = array_filter($options, function ($key) use ($inclOnly) {
  1404. return in_array($key, $inclOnly);
  1405. }, \ARRAY_FILTER_USE_KEY);
  1406. }
  1408. return $options;
  1409. }
  1411. /**
  1412. * Set sortStatus
  1413. *
  1414. * @param int $sortStatus
  1415. *
  1416. * @return SortingSession
  1417. */
  1418. public function setSortStatus($sortStatus)
  1419. {
  1420. $this->sortStatus = $sortStatus;
  1422. return $this;
  1423. }
  1425. /**
  1426. * Get sortStatus
  1427. *
  1428. * @return int
  1429. */
  1430. public function getSortStatus()
  1431. {
  1432. return $this->sortStatus;
  1433. }
  1435. /**
  1436. * Get sortStatusOptions
  1437. *
  1438. * @param mixed $showAdmission
  1439. * @param mixed $showMemo
  1440. *
  1441. * @return array
  1442. */
  1443. public static function getSortStatusOptions($showAdmission = true, $showMemo = true)
  1444. {
  1445. $options = [];
  1446. $options[self::SORT_STATUS_CLASSIFY] = 'Classify';
  1447. $options[self::SORT_STATUS_DATE] = 'Date';
  1448. if ($showAdmission) {
  1449. $options[self::SORT_STATUS_ADMISSION] = 'Admission';
  1450. }
  1451. if ($showMemo) {
  1452. $options[self::SORT_STATUS_MEMO] = 'File Note';
  1453. }
  1454. $options[self::SORT_STATUS_QA] = 'QA';
  1455. $options[self::SORT_STATUS_COMPLETE] = 'Complete';
  1456. $options[self::SORT_STATUS_DOWNLOADED] = 'Downloaded';
  1458. return $options;
  1459. }
  1461. /**
  1462. * Get sortStatusLabel
  1463. *
  1464. * @return string
  1465. */
  1466. public function getSortStatusLabel()
  1467. {
  1468. $options = self::getSortStatusOptions();
  1469. return $options[$this->getSortStatus()] ?? '';
  1470. }
  1472. /**
  1473. * Returns true if the SortingSession's sort status is self::SORT_STATUS_CLASSIFY
  1474. *
  1475. * @return bool
  1476. */
  1477. public function isSortStatusClassify()
  1478. {
  1479. return $this->getSortStatus() === self::SORT_STATUS_CLASSIFY;
  1480. }
  1482. /**
  1483. * Returns true if the SortingSession's sort status is self::SORT_STATUS_DATE
  1484. *
  1485. * @return bool
  1486. */
  1487. public function isSortStatusDate()
  1488. {
  1489. return $this->getSortStatus() === self::SORT_STATUS_DATE;
  1490. }
  1492. /**
  1493. * Returns true if the SortingSession's sort status is self::SORT_STATUS_ADMISSION
  1494. *
  1495. * @return bool
  1496. */
  1497. public function isSortStatusAdmission()
  1498. {
  1499. return $this->getSortStatus() === self::SORT_STATUS_ADMISSION;
  1500. }
  1502. /**
  1503. * Returns true if the SortingSession's sort status is self::SORT_STATUS_MEMO
  1504. *
  1505. * @return bool
  1506. */
  1507. public function isSortStatusMemo()
  1508. {
  1509. return $this->getSortStatus() === self::SORT_STATUS_MEMO;
  1510. }
  1512. /**
  1513. * Returns true if the SortingSession's sort status is self::SORT_STATUS_QA
  1514. *
  1515. * @return bool
  1516. */
  1517. public function isSortStatusQa()
  1518. {
  1519. return $this->getSortStatus() === self::SORT_STATUS_QA;
  1520. }
  1522. /**
  1523. * Returns true if the SortingSession's sort status is self::SORT_STATUS_COMPLETE
  1524. *
  1525. * @return bool
  1526. */
  1527. public function isSortStatusComplete()
  1528. {
  1529. return $this->getSortStatus() === self::SORT_STATUS_COMPLETE;
  1530. }
  1532. /**
  1533. * Returns true if the SortingSession's sort status is self::SORT_STATUS_COMPLETE
  1534. *
  1535. * @return bool
  1536. */
  1537. public function isSortStatusDownloaded()
  1538. {
  1539. return $this->getSortStatus() === self::SORT_STATUS_DOWNLOADED;
  1540. }
  1542. /**
  1543. * Returns true if the SortingSession has the relevant user assigned to it,
  1544. * based on it's current sortStatus.
  1545. *
  1546. * @return bool
  1547. */
  1548. public function hasRelevantUserAssigned()
  1549. {
  1550. return $this->getRelevantUserAssigned() !== null ? true : false;
  1551. }
  1553. /**
  1554. * Gets the relevant user responsible for this sorting session based on the
  1555. * SortStatus the SortingSession is in.
  1556. *
  1557. * @return User
  1558. */
  1559. public function getRelevantUserAssigned()
  1560. {
  1561. switch ($this->getSortStatus()) {
  1562. case self::SORT_STATUS_CLASSIFY:
  1563. return $this->getSortedBy();
  1564. break;
  1565. case self::SORT_STATUS_DATE:
  1566. return $this->getDatedBy();
  1567. break;
  1568. case self::SORT_STATUS_ADMISSION:
  1569. return $this->getAdmissionBy();
  1570. break;
  1571. case self::SORT_STATUS_MEMO:
  1572. return $this->getMemoBy();
  1573. break;
  1574. case self::SORT_STATUS_QA:
  1575. return $this->getQaBy();
  1576. break;
  1577. }
  1579. return null;
  1580. }
  1582. /**
  1583. * Gets an array of all the assigned Users to this SortingSession
  1584. *
  1585. * @return array
  1586. */
  1587. public function getAllAssignedUsers(): array
  1588. {
  1589. return [
  1590. 'Sort' => $this->getSortedBy(),
  1591. 'Date' => $this->getDatedBy(),
  1592. 'Admission' => $this->getAdmissionBy(),
  1593. 'File Note' => $this->getMemoBy(),
  1594. 'QA' => $this->getQaBy(),
  1595. ];
  1596. }
  1598. /**
  1599. * Set timeSpentClassify
  1600. *
  1601. * @param int $timeSpentClassify
  1602. *
  1603. * @return SortingSession
  1604. */
  1605. public function setTimeSpentClassify($timeSpentClassify)
  1606. {
  1607. $this->timeSpentClassify = $timeSpentClassify;
  1609. return $this;
  1610. }
  1612. /**
  1613. * Get timeSpentClassify
  1614. *
  1615. * @return int
  1616. */
  1617. public function getTimeSpentClassify()
  1618. {
  1619. return $this->timeSpentClassify;
  1620. }
  1622. /**
  1623. * Get timeSpentClassify
  1624. *
  1625. * @return int
  1626. */
  1627. public function getTimeSpentClassifyMinutes()
  1628. {
  1629. return round($this->getTimeSpentClassify() / 60, 2);
  1630. }
  1632. /**
  1633. * Set timeSpentDating
  1634. *
  1635. * @param int $timeSpentDating
  1636. *
  1637. * @return SortingSession
  1638. */
  1639. public function setTimeSpentDating($timeSpentDating)
  1640. {
  1641. $this->timeSpentDating = $timeSpentDating;
  1643. return $this;
  1644. }
  1646. /**
  1647. * Get timeSpentDating
  1648. *
  1649. * @return int
  1650. */
  1651. public function getTimeSpentDating()
  1652. {
  1653. return $this->timeSpentDating;
  1654. }
  1656. /**
  1657. * Get timeSpentDatingMinutes
  1658. *
  1659. * @return int
  1660. */
  1661. public function getTimeSpentDatingMinutes()
  1662. {
  1663. return round($this->getTimeSpentDating() / 60, 2);
  1664. }
  1666. /**
  1667. * Set timeSpentQa
  1668. *
  1669. * @param int $timeSpentQa
  1670. *
  1671. * @return SortingSession
  1672. */
  1673. public function setTimeSpentQa($timeSpentQa)
  1674. {
  1675. $this->timeSpentQa = $timeSpentQa;
  1677. return $this;
  1678. }
  1680. /**
  1681. * Get timeSpentQa
  1682. *
  1683. * @return int
  1684. */
  1685. public function getTimeSpentQa()
  1686. {
  1687. return $this->timeSpentQa;
  1688. }
  1690. /**
  1691. * Get timeSpentQaMinutes
  1692. *
  1693. * @return int
  1694. */
  1695. public function getTimeSpentQaMinutes()
  1696. {
  1697. return round($this->getTimeSpentQa() / 60, 2);
  1698. }
  1700. /**
  1701. * Add timeSpentClassify
  1702. *
  1703. * @param int $timeSpentClassify
  1704. *
  1705. * @return SortingSession
  1706. */
  1707. public function addTimeSpentClassify($timeSpentClassify)
  1708. {
  1709. $this->timeSpentClassify += $timeSpentClassify;
  1711. return $this;
  1712. }
  1714. /**
  1715. * Add timeSpentDating
  1716. *
  1717. * @param int $timeSpentDating
  1718. *
  1719. * @return SortingSession
  1720. */
  1721. public function addTimeSpentDating($timeSpentDating)
  1722. {
  1723. $this->timeSpentDating += $timeSpentDating;
  1725. return $this;
  1726. }
  1728. /**
  1729. * Add timeSpentAdmission
  1730. *
  1731. * @param int $timeSpentAdmission
  1732. *
  1733. * @return SortingSession
  1734. */
  1735. public function addTimeSpentAdmission($timeSpentAdmission)
  1736. {
  1737. $this->timeSpentAdmission += $timeSpentAdmission;
  1739. return $this;
  1740. }
  1742. /**
  1743. * Add timeSpentMemo
  1744. *
  1745. * @param int $timeSpentMemo
  1746. *
  1747. * @return SortingSession
  1748. */
  1749. public function addTimeSpentMemo($timeSpentMemo)
  1750. {
  1751. $this->timeSpentMemo += $timeSpentMemo;
  1753. return $this;
  1754. }
  1756. /**
  1757. * Add timeSpentQa
  1758. *
  1759. * @param int $timeSpentQa
  1760. *
  1761. * @return SortingSession
  1762. */
  1763. public function addTimeSpentQa($timeSpentQa)
  1764. {
  1765. $this->timeSpentQa += $timeSpentQa;
  1767. return $this;
  1768. }
  1770. /**
  1771. * Set deletedAt
  1772. *
  1773. * @param \DateTime $deletedAt
  1774. *
  1775. * @return SortingSession
  1776. */
  1777. public function setDeletedAt($deletedAt)
  1778. {
  1779. $this->deletedAt = $deletedAt;
  1781. return $this;
  1782. }
  1784. /**
  1785. * Get deletedAt
  1786. *
  1787. * @return \DateTime
  1788. */
  1789. public function getDeletedAt()
  1790. {
  1791. return $this->deletedAt;
  1792. }
  1794. /**
  1795. * Set dateSentToSorter
  1796. *
  1797. * @param \DateTime $dateSentToSorter
  1798. *
  1799. * @return SortingSession
  1800. */
  1801. public function setDateSentToSorter($dateSentToSorter = null)
  1802. {
  1803. $this->dateSentToSorter = $dateSentToSorter;
  1805. return $this;
  1806. }
  1808. /**
  1809. * Get dateSentToSorter
  1810. *
  1811. * @return \DateTime
  1812. */
  1813. public function getDateSentToSorter()
  1814. {
  1815. return $this->dateSentToSorter;
  1816. }
  1818. /**
  1819. * Set dateDownloaded
  1820. *
  1821. * @param \DateTime $dateDownloaded
  1822. *
  1823. * @return SortingSession
  1824. */
  1825. public function setDateDownloaded($dateDownloaded)
  1826. {
  1827. $this->dateDownloaded = $dateDownloaded;
  1829. return $this;
  1830. }
  1832. /**
  1833. * Get dateDownloaded
  1834. *
  1835. * @return \DateTime
  1836. */
  1837. public function getDateDownloaded()
  1838. {
  1839. return $this->dateDownloaded;
  1840. }
  1842. /**
  1843. * Set downloadedBy
  1844. *
  1845. * @param User $downloadedBy
  1846. *
  1847. * @return SortingSession
  1848. */
  1849. public function setDownloadedBy(?User $downloadedBy = null)
  1850. {
  1851. $this->downloadedBy = $downloadedBy;
  1853. return $this;
  1854. }
  1856. /**
  1857. * Get downloadedBy
  1858. *
  1859. * @return User
  1860. */
  1861. public function getDownloadedBy()
  1862. {
  1863. return $this->downloadedBy;
  1864. }
  1866. /**
  1867. * Get dueDate based on BatchRequest
  1868. *
  1869. * @return void
  1870. */
  1871. public function getBatchesMaxDueDate()
  1872. {
  1873. $criteria = Criteria::create()
  1874. ->orderBy(['estimatedDeadlineDate' => Criteria::DESC])
  1875. ;
  1876. return $this->getBatchRequests()->count() > 0 && $this->getBatchRequests()->matching($criteria)->first() ? $this->getBatchRequests()->matching($criteria)->first()->getEstimatedDeadlineDate() : null;
  1877. }
  1879. /**
  1880. * Get mrsFormFilename
  1881. *
  1882. * @return string
  1883. */
  1884. public function getMrsFormFilename()
  1885. {
  1886. return $this->mrsFormFilename;
  1887. }
  1889. /**
  1890. * Set mrsFormFile
  1891. *
  1892. * @param string $mrsFormFile
  1893. *
  1894. * @return SortingSession
  1895. */
  1896. public function setMrsFormFile($mrsFormFile)
  1897. {
  1898. $this->mrsFormFile = $mrsFormFile;
  1900. if (null !== $mrsFormFile) {
  1901. // It is required that at least one field changes if you are using doctrine
  1902. // otherwise the event listeners won't be called and the file is lost
  1903. $this->updated = new \DateTimeImmutable();
  1904. }
  1906. return $this;
  1907. }
  1909. /**
  1910. * Set mrsFormFilename
  1911. *
  1912. * @param string $mrsFormFilename
  1913. *
  1914. * @return SortingSession
  1915. */
  1916. public function setMrsFormFilename($mrsFormFilename)
  1917. {
  1918. $this->mrsFormFilename = $mrsFormFilename;
  1920. return $this;
  1921. }
  1923. /**
  1924. * Get mrsFormFile
  1925. *
  1926. * @return string
  1927. */
  1928. public function getMrsFormFile()
  1929. {
  1930. return $this->mrsFormFile;
  1931. }
  1933. /**
  1934. * Set dueDate
  1935. *
  1936. * @param \DateTime $dueDate
  1937. *
  1938. * @return SortingSession
  1939. */
  1940. public function setDueDate($dueDate)
  1941. {
  1942. $this->dueDate = $dueDate;
  1944. return $this;
  1945. }
  1947. /**
  1948. * Get dueDate
  1949. *
  1950. * @return \DateTime
  1951. */
  1952. public function getDueDate()
  1953. {
  1954. return $this->dueDate;
  1955. }
  1957. /**
  1958. * Set estCompletionDate
  1959. *
  1960. * @param \DateTime $estCompletionDate
  1961. *
  1962. * @return SortingSession
  1963. */
  1964. public function setEstCompletionDate($estCompletionDate)
  1965. {
  1966. $this->estCompletionDate = $estCompletionDate;
  1968. return $this;
  1969. }
  1971. /**
  1972. * Get estCompletionDate
  1973. *
  1974. * @return \DateTime
  1975. */
  1976. public function getEstCompletionDate()
  1977. {
  1978. return $this->estCompletionDate;
  1979. }
  1981. /**
  1982. * Set startPageNumber
  1983. *
  1984. * @param int $startPageNumber
  1985. *
  1986. * @return SortingSession
  1987. */
  1988. public function setStartPageNumber($startPageNumber)
  1989. {
  1990. $this->startPageNumber = $startPageNumber;
  1992. return $this;
  1993. }
  1995. /**
  1996. * Get startPageNumber
  1997. *
  1998. * @return int
  1999. */
  2000. public function getStartPageNumber()
  2001. {
  2002. return $this->startPageNumber;
  2003. }
  2005. /**
  2006. * Add detail
  2007. *
  2008. * @param SortingSessionDetail $detail
  2009. *
  2010. * @return SortingSession
  2011. */
  2012. public function addDetail(SortingSessionDetail $detail)
  2013. {
  2014. $this->details[] = $detail;
  2016. return $this;
  2017. }
  2019. /**
  2020. * Set classifyCompletePerc
  2021. *
  2022. * @param int $classifyCompletePerc
  2023. *
  2024. * @return SortingSession
  2025. */
  2026. public function setClassifyCompletePerc($classifyCompletePerc)
  2027. {
  2028. $this->classifyCompletePerc = $classifyCompletePerc;
  2030. return $this;
  2031. }
  2033. /**
  2034. * Remove detail
  2035. *
  2036. * @param SortingSessionDetail $detail
  2037. */
  2038. public function removeDetail(SortingSessionDetail $detail)
  2039. {
  2040. $this->details->removeElement($detail);
  2041. }
  2043. /**
  2044. * Get details
  2045. *
  2046. * @return Collection
  2047. */
  2048. public function getDetails()
  2049. {
  2050. return $this->details;
  2051. }
  2053. /**
  2054. * Get classifyCompletePerc
  2055. *
  2056. * @return int
  2057. */
  2058. public function getClassifyCompletePerc()
  2059. {
  2060. return $this->classifyCompletePerc;
  2061. }
  2063. /**
  2064. * Set dateCompletePerc
  2065. *
  2066. * @param int $dateCompletePerc
  2067. *
  2068. * @return SortingSession
  2069. */
  2070. public function setDateCompletePerc($dateCompletePerc)
  2071. {
  2072. $this->dateCompletePerc = $dateCompletePerc;
  2074. return $this;
  2075. }
  2077. /**
  2078. * Get dateCompletePerc
  2079. *
  2080. * @return int
  2081. */
  2082. public function getDateCompletePerc()
  2083. {
  2084. return $this->dateCompletePerc;
  2085. }
  2087. /**
  2088. * Set centrePrefixPadding
  2089. *
  2090. * @param int $centrePrefixPadding
  2091. *
  2092. * @return SortingSession
  2093. */
  2094. public function setCentrePrefixPadding($centrePrefixPadding)
  2095. {
  2096. $this->centrePrefixPadding = $centrePrefixPadding;
  2098. return $this;
  2099. }
  2101. /**
  2102. * Get centrePrefixPadding
  2103. *
  2104. * @return int
  2105. */
  2106. public function getCentrePrefixPadding()
  2107. {
  2108. return $this->centrePrefixPadding;
  2109. }
  2111. /**
  2112. * Set pageNumberPadding
  2113. *
  2114. * @param int $pageNumberPadding
  2115. *
  2116. * @return SortingSession
  2117. */
  2118. public function setPageNumberPadding($pageNumberPadding)
  2119. {
  2120. $this->pageNumberPadding = $pageNumberPadding;
  2122. return $this;
  2123. }
  2125. /**
  2126. * Get pageNumberPadding
  2127. *
  2128. * @return int
  2129. */
  2130. public function getPageNumberPadding()
  2131. {
  2132. return $this->pageNumberPadding;
  2133. }
  2135. /**
  2136. * Set exportError
  2137. *
  2138. * @param string $exportError
  2139. *
  2140. * @return SortingSession
  2141. */
  2142. public function setExportError($exportError)
  2143. {
  2144. $this->exportError = $exportError;
  2146. return $this;
  2147. }
  2149. /**
  2150. * Get exportError
  2151. *
  2152. * @return string
  2153. */
  2154. public function getExportError()
  2155. {
  2156. return $this->exportError;
  2157. }
  2159. /**
  2160. * Set admissionBy.
  2161. *
  2162. * @param User|null $admissionBy
  2163. *
  2164. * @return SortingSession
  2165. */
  2166. public function setAdmissionBy(?User $admissionBy = null)
  2167. {
  2168. $this->admissionBy = $admissionBy;
  2170. return $this;
  2171. }
  2173. /**
  2174. * Get admissionBy.
  2175. *
  2176. * @return User|null
  2177. */
  2178. public function getAdmissionBy()
  2179. {
  2180. return $this->admissionBy;
  2181. }
  2183. /**
  2184. * Set timeSpentAdmission.
  2185. *
  2186. * @param int $timeSpentAdmission
  2187. *
  2188. * @return SortingSession
  2189. */
  2190. public function setTimeSpentAdmission($timeSpentAdmission)
  2191. {
  2192. $this->timeSpentAdmission = $timeSpentAdmission;
  2194. return $this;
  2195. }
  2197. /**
  2198. * Get timeSpentAdmission.
  2199. *
  2200. * @return int
  2201. */
  2202. public function getTimeSpentAdmission()
  2203. {
  2204. return $this->timeSpentAdmission;
  2205. }
  2207. /**
  2208. * Get timeSpentAdmissionMinutes
  2209. *
  2210. * @return int
  2211. */
  2212. public function getTimeSpentAdmissionMinutes()
  2213. {
  2214. return round($this->getTimeSpentAdmission() / 60, 2);
  2215. }
  2217. /**
  2218. * Set exportStoreJson.
  2219. *
  2220. * @param string|null $exportStoreJson
  2221. *
  2222. * @return SortingSession
  2223. */
  2224. public function setExportStoreJson($exportStoreJson = null)
  2225. {
  2226. $this->exportStoreJson = $exportStoreJson;
  2228. return $this;
  2229. }
  2231. /**
  2232. * Get exportStoreJson.
  2233. *
  2234. * @return string|null
  2235. */
  2236. public function getExportStoreJson()
  2237. {
  2238. return $this->exportStoreJson;
  2239. }
  2241. /**
  2242. * Get getExportStoreArray
  2243. *
  2244. * @return array
  2245. */
  2246. public function getExportStoreArray()
  2247. {
  2248. if (!$this->getExportStoreJson()) {
  2249. return [];
  2250. }
  2251. return json_decode($this->getExportStoreJson(), true);
  2252. }
  2254. /**
  2255. * Set version.
  2256. *
  2257. * @param string|null $version
  2258. *
  2259. * @return SortingSession
  2260. */
  2261. public function setVersion($version = null)
  2262. {
  2263. $this->version = $version;
  2265. return $this;
  2266. }
  2268. /**
  2269. * Get version.
  2270. *
  2271. * @return string|null
  2272. */
  2273. public function getVersion()
  2274. {
  2275. return $this->version;
  2276. }
  2278. /**
  2279. * Returns true if the SortingSession was done in the old DocSorter version.
  2280. *
  2281. * @return bool
  2282. */
  2283. public function isOldVersion()
  2284. {
  2285. return $this->getVersion() === self::VERSION_OLD;
  2286. }
  2288. /**
  2289. * Set exportPushStatus.
  2290. *
  2291. * @param string|null $exportPushStatus
  2292. *
  2293. * @return SortingSession
  2294. */
  2295. public function setExportPushStatus($exportPushStatus = null)
  2296. {
  2297. // Clear the push error when we do a new push.
  2298. if ($exportPushStatus === self::EXPORT_PUSH_STATUS_PENDING) {
  2299. $this->setExportError('');
  2300. }
  2301. $this->exportPushStatus = $exportPushStatus;
  2303. return $this;
  2304. }
  2306. /**
  2307. * Get exportPushStatus.
  2308. *
  2309. * @return string|null
  2310. */
  2311. public function getExportPushStatus()
  2312. {
  2313. return $this->exportPushStatus;
  2314. }
  2316. /**
  2317. * Returns true if the SortingSession is pending export push to medical records.
  2318. *
  2319. * @return bool
  2320. */
  2321. public function isExportPushPending()
  2322. {
  2323. return $this->getExportPushStatus() === self::EXPORT_PUSH_STATUS_PENDING;
  2324. }
  2326. /**
  2327. * Returns true if the SortingSession is in progress export push to medical records.
  2328. *
  2329. * @return bool
  2330. */
  2331. public function isExportPushInProgress()
  2332. {
  2333. return $this->getExportPushStatus() === self::EXPORT_PUSH_STATUS_IN_PROGRESS;
  2334. }
  2336. /**
  2337. * Returns true if the SortingSession is completed export push to medical records.
  2338. *
  2339. * @return bool
  2340. */
  2341. public function isExportPushCompleted()
  2342. {
  2343. return $this->getExportPushStatus() === self::EXPORT_PUSH_STATUS_COMPLETED;
  2344. }
  2346. /**
  2347. * Returns true if the SortingSession is failed export push to medical records.
  2348. *
  2349. * @return bool
  2350. */
  2351. public function isExportPushFailed()
  2352. {
  2353. return $this->getExportPushStatus() === self::EXPORT_PUSH_STATUS_FAILED;
  2354. }
  2356. /**
  2357. * Set exportPushBy.
  2358. *
  2359. * @param User|null $exportPushBy
  2360. *
  2361. * @return SortingSession
  2362. */
  2363. public function setExportPushBy(?User $exportPushBy = null)
  2364. {
  2365. $this->exportPushBy = $exportPushBy;
  2367. return $this;
  2368. }
  2370. /**
  2371. * Get exportPushBy.
  2372. *
  2373. * @return User|null
  2374. */
  2375. public function getExportPushBy()
  2376. {
  2377. return $this->exportPushBy;
  2378. }
  2380. /**
  2381. * Set memoStatus.
  2382. *
  2383. * @param string|null $memoStatus
  2384. *
  2385. * @return SortingSession
  2386. */
  2387. public function setMemoStatus($memoStatus = null)
  2388. {
  2389. $this->memoStatus = $memoStatus;
  2391. return $this;
  2392. }
  2394. /**
  2395. * Get memoStatus.
  2396. *
  2397. * @return string|null
  2398. */
  2399. public function getMemoStatus()
  2400. {
  2401. return $this->memoStatus;
  2402. }
  2404. /**
  2405. * Get MemoStatusOptions
  2406. *
  2407. * @param bool $selectableOnly - only return options that can be selected by a user.
  2408. *
  2409. * @return array
  2410. */
  2411. public static function getMemoStatusOptions(bool $selectableOnly = false)
  2412. {
  2413. // Leave this in place, as previously Ready to Sync was part not selectable - but we had to change this,
  2414. $options = [
  2415. ];
  2417. $selectableOptions = [
  2418. self::MEMO_STATUS_READY_TO_SYNC => 'Ready to Sync',
  2419. self::MEMO_STATUS_PENDING => 'Pending',
  2420. self::MEMO_READY_FOR_UPLOAD => 'Ready for Upload',
  2421. self::MEMO_STATUS_UPLOADED => 'Uploaded',
  2422. ];
  2424. return array_merge($selectableOnly ? [] : $options, $selectableOptions);
  2425. }
  2427. /**
  2428. * Get MemoStatusLabel
  2429. *
  2430. * @return string
  2431. */
  2432. public function getMemoStatusLabel()
  2433. {
  2434. $options = self::getMemoStatusOptions();
  2435. return $options[$this->getMemoStatus()] ?? '';
  2436. }
  2438. /**
  2439. * Returns true if the memo status is ready to sync.
  2440. *
  2441. * @return string
  2442. */
  2443. public function isMemoReadyToSync()
  2444. {
  2445. return $this->getMemoStatus() === self::MEMO_STATUS_READY_TO_SYNC;
  2446. }
  2448. /**
  2449. * Set timeSpentMemo.
  2450. *
  2451. * @param int $timeSpentMemo
  2452. *
  2453. * @return SortingSession
  2454. */
  2455. public function setTimeSpentMemo($timeSpentMemo)
  2456. {
  2457. $this->timeSpentMemo = $timeSpentMemo;
  2459. return $this;
  2460. }
  2462. /**
  2463. * Get timeSpentMemo.
  2464. *
  2465. * @return int
  2466. */
  2467. public function getTimeSpentMemo()
  2468. {
  2469. return $this->timeSpentMemo;
  2470. }
  2472. /**
  2473. * Get timeSpentMemoMinutes
  2474. *
  2475. * @return int
  2476. */
  2477. public function getTimeSpentMemoMinutes()
  2478. {
  2479. return round($this->getTimeSpentMemo() / 60, 2);
  2480. }
  2482. /**
  2483. * Set qaFailNote.
  2484. *
  2485. * @param string|null $qaFailNote
  2486. *
  2487. * @return SortingSession
  2488. */
  2489. public function setQaFailNote($qaFailNote = null)
  2490. {
  2491. $this->qaFailNote = $qaFailNote;
  2493. return $this;
  2494. }
  2496. /**
  2497. * Get qaFailNote.
  2498. *
  2499. * @return string|null
  2500. */
  2501. public function getQaFailNote()
  2502. {
  2503. return $this->qaFailNote;
  2504. }
  2506. /**
  2507. * Set memoBy.
  2508. *
  2509. * @param User|null $memoBy
  2510. *
  2511. * @return SortingSession
  2512. */
  2513. public function setMemoBy(?User $memoBy = null)
  2514. {
  2515. $this->memoBy = $memoBy;
  2517. return $this;
  2518. }
  2520. /**
  2521. * Get memoBy.
  2522. *
  2523. * @return User|null
  2524. */
  2525. public function getMemoBy()
  2526. {
  2527. return $this->memoBy;
  2528. }
  2530. public static function getChronologyRequiredOptions()
  2531. {
  2532. $options = [];
  2533. $options[0] = 'No';
  2534. $options[1] = 'Yes';
  2536. return $options;
  2537. }
  2539. /**
  2540. * Determines whether a chronology is requested.
  2541. *
  2542. * @return string 'Yes'/'No'
  2543. */
  2544. public function getChronologyRequired()
  2545. {
  2546. $chronologies = $this->getProject()->getChronologyRequests();
  2547. /** @var ChronologyRequest $latestChronology */
  2548. $latestChronology = $chronologies->last();
  2550. if ($latestChronology
  2551. && !$latestChronology->getServiceRequest()->isComplete()
  2552. && !$latestChronology->getServiceRequest()->isCancelled()
  2553. && ($latestChronology->getServiceOption()->appliesToSubCategoryChronAndSor() || $latestChronology->getServiceOption()->appliesToSubCategoryChronOnly())) {
  2554. return 'Yes';
  2555. }
  2556. return 'No';
  2557. }
  2559. /**
  2560. * Returns all batch documents associated with the sorting session that are in status failed.
  2561. *
  2562. * @return array
  2563. */
  2564. public function getFailedBatchDocuments()
  2565. {
  2566. $failedBatchDocuments = [];
  2567. /** @var BatchRequest $batchRequest */
  2568. foreach ($this->getBatchRequests() as $batchRequest) {
  2569. /** @var BatchDocument $batchDocument */
  2570. foreach ($batchRequest->getBatchDocuments() as $batchDocument) {
  2571. if ($batchDocument->isFailed()) {
  2572. $failedBatchDocuments[] = $batchDocument;
  2573. }
  2574. }
  2575. }
  2577. return $failedBatchDocuments;
  2578. }
  2580. /**
  2581. * Returns all batch request IDs as a string associated with the sorting session,
  2582. * that have a batch document in status failed.
  2583. *
  2584. * @return string
  2585. */
  2586. public function getFailedBatchDocumentsBatchRequestIdsStr()
  2587. {
  2588. return
  2589. implode(
  2590. array_unique(
  2591. array_map(
  2592. function (BatchDocument $batchDocument) {
  2593. return $batchDocument->getBatchRequest()->getServiceRequestGroupId();
  2594. },
  2595. $this->getFailedBatchDocuments()
  2596. )
  2597. )
  2598. );
  2599. }
  2601. /**
  2602. * Set exportPushUnsortedStatus.
  2603. *
  2604. * @param string|null $exportPushUnsortedStatus
  2605. *
  2606. * @return SortingSession
  2607. */
  2608. public function setExportPushUnsortedStatus($exportPushUnsortedStatus = null)
  2609. {
  2610. $this->exportPushUnsortedStatus = $exportPushUnsortedStatus;
  2612. return $this;
  2613. }
  2615. /**
  2616. * Get exportPushUnsortedStatus.
  2617. *
  2618. * @return string|null
  2619. */
  2620. public function getExportPushUnsortedStatus()
  2621. {
  2622. return $this->exportPushUnsortedStatus;
  2623. }
  2625. /**
  2626. * Returns true if exportPushUnsortedStatus is pending.
  2627. *
  2628. * @return bool
  2629. */
  2630. public function isExportPushUnsortedStatusPending(): bool
  2631. {
  2632. return $this->exportPushUnsortedStatus === self::EXPORT_UNSORTED_PUSH_STATUS_PENDING;
  2633. }
  2635. /**
  2636. * Returns true if exportPushUnsortedStatus is in progress.
  2637. *
  2638. * @return bool
  2639. */
  2640. public function isExportPushUnsortedStatusInProgress(): bool
  2641. {
  2642. return $this->exportPushUnsortedStatus === self::EXPORT_UNSORTED_PUSH_STATUS_IN_PROGRESS;
  2643. }
  2645. /**
  2646. * Returns true if exportPushUnsortedStatus is completed.
  2647. *
  2648. * @return bool
  2649. */
  2650. public function isExportPushUnsortedStatusCompleted(): bool
  2651. {
  2652. return $this->exportPushUnsortedStatus === self::EXPORT_UNSORTED_PUSH_STATUS_COMPLETED;
  2653. }
  2655. /**
  2656. * Returns true if exportPushUnsortedStatus is failed.
  2657. *
  2658. * @return bool
  2659. */
  2660. public function isExportPushUnsortedStatusFailed(): bool
  2661. {
  2662. return $this->exportPushUnsortedStatus === self::EXPORT_UNSORTED_PUSH_STATUS_FAILED;
  2663. }
  2665. /**
  2666. * Set exportPushUnsortedBy.
  2667. *
  2668. * @param User|null $exportPushUnsortedBy
  2669. *
  2670. * @return SortingSession
  2671. */
  2672. public function setExportPushUnsortedBy(?User $exportPushUnsortedBy = null)
  2673. {
  2674. $this->exportPushUnsortedBy = $exportPushUnsortedBy;
  2676. return $this;
  2677. }
  2679. /**
  2680. * Get exportPushUnsortedBy.
  2681. *
  2682. * @return User|null
  2683. */
  2684. public function getExportPushUnsortedBy()
  2685. {
  2686. return $this->exportPushUnsortedBy;
  2687. }
  2689. /**
  2690. * Set activeSortingUser.
  2691. *
  2692. * @param User|null $activeSortingUser
  2693. *
  2694. * @return SortingSession
  2695. */
  2696. public function setActiveSortingUser(?User $activeSortingUser = null)
  2697. {
  2698. $this->activeSortingUser = $activeSortingUser;
  2700. return $this;
  2701. }
  2703. /**
  2704. * Get activeSortingUser.
  2705. *
  2706. * @return User|null
  2707. */
  2708. public function getActiveSortingUser(): ?User
  2709. {
  2710. return $this->activeSortingUser;
  2711. }
  2713. /**
  2714. * Returns a description of who the current active sorting user is.
  2715. *
  2716. * @return string
  2717. */
  2718. public function getActiveSortingUserDescription(): string
  2719. {
  2720. if ($this->getActiveSortingUser()) {
  2721. return sprintf('%1$s (%2$s)', $this->getActiveSortingUser()->getFullName(), $this->getActiveSortingUser()->getEmail());
  2722. }
  2723. return '';
  2724. }
  2726. /**
  2727. * Returns true if external editing is allowed for the sorting session for the specified user.
  2728. *
  2729. * @param User $user
  2730. *
  2731. * @return bool
  2732. */
  2733. public function allowExternalEditing(User $user): bool
  2734. {
  2735. // Allow external editing for these sort statuses
  2736. $allowSortStatus = $this->isSortStatusComplete() || $this->isSortStatusDownloaded();
  2738. // Allow external editing if no active sorter on sorting session
  2739. $allowUnassignedSortingSession = $this->getActiveSortingUser() === null || $user === $this->getActiveSortingUser();
  2741. return $allowSortStatus && $allowUnassignedSortingSession;
  2742. }
  2744. /**
  2745. * Set sortSessionType
  2746. *
  2747. * @param string $sortSessionType
  2748. *
  2749. * @return SortingSession
  2750. */
  2751. public function setSortSessionType($sortSessionType)
  2752. {
  2753. $this->sortSessionType = $sortSessionType;
  2755. return $this;
  2756. }
  2758. /**
  2759. * Get sortSessionType
  2760. *
  2761. * @return string
  2762. */
  2763. public function getSortSessionType()
  2764. {
  2765. return $this->sortSessionType;
  2766. }
  2768. /**
  2769. * Return array of ClientSortSessionTypeOptions
  2770. *
  2771. * @return array
  2772. */
  2773. public static function getClientSortSessionTypeOptions()
  2774. {
  2775. $options = [
  2776. self::SORT_SESSION_TYPE_CLIENT => 'Client Session',
  2777. ];
  2779. return $options;
  2780. }
  2782. /**
  2783. * Returns an array of permitted values for the Labels field.
  2784. *
  2785. * @return array
  2786. */
  2787. public static function getSortSessionTypeOptions()
  2788. {
  2789. $typeOptions = self::getConstantsWithLabelsAsChoices('SORT_SESSION_TYPE');
  2791. return $typeOptions;
  2792. }
  2794. /**
  2795. * Returns an array of Labels to be readable by humans.
  2796. *
  2797. * @return array
  2798. */
  2799. public function getSortSessionTypeLabels()
  2800. {
  2801. $labelOptions = array_flip(self::getClientSortSessionTypeOptions());
  2802. return array_map(function ($label) use ($labelOptions) {
  2803. return $labelOptions[$label] ?: 'Unknown';
  2804. }, $this->labels);
  2805. }
  2807. /**
  2808. * Returns a human readable version of the type isSentEmailLabel
  2809. *
  2810. * @return string
  2811. */
  2812. public function getSortSessionTypeLabel()
  2813. {
  2814. $options = array_flip(self::getSortSessionTypeOptions());
  2816. return $options[$this->getSortSessionType()] ?? '';
  2817. }
  2819. /**
  2820. * Returns true if all the sorting session stages are the same
  2821. *
  2822. * @return bool
  2823. */
  2824. public function hasSameSorters()
  2825. {
  2826. $isSame = true;
  2827. $sortedBy = $this->getSortedBy();
  2828. $arr = [
  2829. $this->getDatedBy(),
  2830. $this->getAdmissionBy(),
  2831. $this->getMemoBy(),
  2832. $this->getQaBy(),
  2833. ];
  2835. foreach ($arr as $value) {
  2836. if ($value !== $sortedBy) {
  2837. $isSame = false;
  2838. break;
  2839. }
  2840. }
  2841. return $isSame;
  2842. }
  2844. /**
  2845. * Method to check if session is a Client session. Returns true if it's a client session
  2846. *
  2847. * @return bool
  2848. */
  2849. public function isClientSortingSession(): bool
  2850. {
  2851. return $this->getSortSessionType() === self::SORT_SESSION_TYPE_CLIENT;
  2852. }
  2854. /**
  2855. * Method to check if session is a Medbrief session. Returns true if it's a Medbrief session
  2856. *
  2857. * @return bool
  2858. */
  2859. public function isMedbriefSortingSession(): bool
  2860. {
  2861. return $this->getSortSessionType() === self::SORT_SESSION_TYPE_MEDBRIEF;
  2862. }
  2864. /**
  2865. * Get the value of pageNumberPositionHorizontal
  2866. *
  2867. * @return int
  2868. */
  2869. public function getPageNumberPositionHorizontal()
  2870. {
  2871. return $this->pageNumberPositionHorizontal;
  2872. }
  2874. /**
  2875. * Set the value of pageNumberPositionHorizontal
  2876. *
  2877. * @param int|null $pageNumberPositionHorizontal|null
  2878. *
  2879. * @return self
  2880. */
  2881. public function setPageNumberPositionHorizontal(?int $pageNumberPositionHorizontal = null)
  2882. {
  2883. if ($pageNumberPositionHorizontal !== null) {
  2884. $this->pageNumberPositionHorizontal = $pageNumberPositionHorizontal;
  2885. }
  2887. return $this;
  2888. }
  2890. /**
  2891. * Get the value of pageNumberPositionVertical
  2892. *
  2893. * @return int
  2894. */
  2895. public function getPageNumberPositionVertical()
  2896. {
  2897. return $this->pageNumberPositionVertical;
  2898. }
  2900. /**
  2901. * Set the value of pageNumberPositionVertical
  2902. *
  2903. * @param int|null $pageNumberPositionVertical
  2904. *
  2905. * @return self
  2906. */
  2907. public function setPageNumberPositionVertical(?int $pageNumberPositionVertical = null)
  2908. {
  2909. if ($pageNumberPositionVertical !== null) {
  2910. $this->pageNumberPositionVertical = $pageNumberPositionVertical;
  2911. }
  2913. return $this;
  2914. }
  2916. /**
  2917. * Get the value of pageNumberSize
  2918. *
  2919. * @return int
  2920. */
  2921. public function getPageNumberSize()
  2922. {
  2923. return $this->pageNumberSize;
  2924. }
  2926. /**
  2927. * Set the value of pageNumberSize
  2928. *
  2929. * @param int|null $pageNumberSize
  2930. *
  2931. * @return self
  2932. */
  2933. public function setPageNumberSize(?int $pageNumberSize = null)
  2934. {
  2935. if ($pageNumberSize !== null) {
  2936. $this->pageNumberSize = $pageNumberSize;
  2937. }
  2939. return $this;
  2940. }
  2942. /**
  2943. * Get the value of pageNumberBackground
  2944. *
  2945. * @return bool
  2946. */
  2947. public function getPageNumberBackground()
  2948. {
  2949. return $this->pageNumberBackground;
  2950. }
  2952. /**
  2953. * Set the value of pageNumberBackground
  2954. *
  2955. * @param bool|null $pageNumberBackground
  2956. *
  2957. * @return self
  2958. */
  2959. public function setPageNumberBackground(?bool $pageNumberBackground = null)
  2960. {
  2961. if ($pageNumberBackground !== null) {
  2962. $this->pageNumberBackground = $pageNumberBackground;
  2963. }
  2965. return $this;
  2966. }
  2968. /**
  2969. * Get the value of isUrgent
  2970. *
  2971. * @return bool
  2972. */
  2973. public function getIsUrgent()
  2974. {
  2975. return $this->isUrgent;
  2976. }
  2978. /**
  2979. * @return string
  2980. */
  2981. public function getIsUrgentLabel(): string
  2982. {
  2983. return $this->isUrgent ? 'Yes' : 'No';
  2984. }
  2986. /**
  2987. * Set the value of isUrgent
  2988. *
  2989. * @param bool $isUrgent
  2990. *
  2991. * @return self
  2992. */
  2993. public function setIsUrgent(bool $isUrgent)
  2994. {
  2995. $this->isUrgent = $isUrgent;
  2997. return $this;
  2998. }
  3000. /**
  3001. * @return Collection|SortingSessionMemo[]
  3002. */
  3003. public function getSortingSessionMemos(): Collection
  3004. {
  3005. return $this->sortingSessionMemos;
  3006. }
  3008. /**
  3009. * @param SortingSessionMemo $sortingSessionMemo
  3010. *
  3011. * @return self
  3012. */
  3013. public function addSortingSessionMemo(SortingSessionMemo $sortingSessionMemo): self
  3014. {
  3015. if (!$this->sortingSessionMemos->contains($sortingSessionMemo)) {
  3016. $this->sortingSessionMemos[] = $sortingSessionMemo;
  3017. $sortingSessionMemo->setSortingSession($this);
  3018. }
  3020. return $this;
  3021. }
  3023. /**
  3024. * @param SortingSessionMemo $sortingSessionMemo
  3025. *
  3026. * @return self
  3027. */
  3028. public function removeSortingSessionMemo(SortingSessionMemo $sortingSessionMemo): self
  3029. {
  3030. if ($this->sortingSessionMemos->removeElement($sortingSessionMemo)) {
  3031. // set the owning side to null (unless already changed)
  3032. if ($sortingSessionMemo->getSortingSession() === $this) {
  3033. $sortingSessionMemo->setSortingSession(null);
  3034. }
  3035. }
  3037. return $this;
  3038. }
  3040. /**
  3041. * @return bool
  3042. */
  3043. public function getRequiresPreProcessing(): bool
  3044. {
  3045. return $this->requiresPreProcessing;
  3046. }
  3048. /**
  3049. * @param bool $requiresPreProcessing
  3050. *
  3051. * @return self
  3052. */
  3053. public function setRequiresPreProcessing(bool $requiresPreProcessing): self
  3054. {
  3055. $this->requiresPreProcessing = $requiresPreProcessing;
  3057. return $this;
  3058. }
  3060. /**
  3061. * @inheritDoc
  3062. */
  3063. public function setPreprocessStatusComplete(): PreprocessableInterface
  3064. {
  3065. $this->setSessionStatus(self::SESSION_STATUS_READY_FOR_SORTER);
  3067. return $this;
  3068. }
  3070. /**
  3071. * @inheritDoc
  3072. */
  3073. public function setPreprocessStatusFailed(): PreprocessableInterface
  3074. {
  3075. $this->setSessionStatus(self::SESSION_STATUS_PREPROCESSING_FAILED);
  3077. return $this;
  3078. }
  3080. /**
  3081. * @inheritDoc
  3082. */
  3083. public function setPreprocessStatusInProgress(): PreprocessableInterface
  3084. {
  3085. $this->setSessionStatus(self::SESSION_STATUS_PREPROCESSING_IN_PROGRESS);
  3086. return $this;
  3087. }
  3089. /**
  3090. * @return PreprocessItemInterface[]
  3091. */
  3092. public function getPreprocessItems(): array
  3093. {
  3094. return $this->getBatchRequests()->filter(function (BatchRequest $batchRequest) {
  3095. // Exclude complete and 'Other' centre type batch requests from pre-processing
  3096. return $batchRequest->allowPreprocessing();
  3097. })->toArray();
  3098. }
  3100. /**
  3101. * Gets a CSV of all pre-processing items for this sorting session.
  3102. * A '*' indicates the item has not been submitted for pre-processing yet,
  3103. * and will submitted on the next 'Send to Sorter' run.
  3104. *
  3105. * @return string
  3106. */
  3107. public function getPreprocessItemsCsv(): string
  3108. {
  3109. return implode(', ', array_map(function (BatchRequest $batchRequest) {
  3110. return $batchRequest->getServiceRequestGroupId() . ($batchRequest->isSubmittedForPreprocessing() === false ? '*' : '');
  3111. }, $this->getPreprocessItems()));
  3112. }
  3114. /**
  3115. * @inheritDoc
  3116. */
  3117. public function hasIncompletePreprocessItems(): bool
  3118. {
  3119. foreach ($this->getPreprocessItems() as $preprocessItem) {
  3120. $preprocessDocuments = $preprocessItem->getPreprocessDocumentsArray();
  3121. foreach ($preprocessDocuments as $preprocessDocument) {
  3122. if ($preprocessDocument->isIncomplete()) {
  3123. return true;
  3124. }
  3125. }
  3126. }
  3128. return false;
  3129. }
  3131. /**
  3132. * Convenience method to check session status of a SortingSession is pending.
  3133. *
  3134. * @return bool
  3135. */
  3136. public function isSessionStatusPending(): bool
  3137. {
  3138. return $this->getSessionStatus() === self::SESSION_STATUS_PENDING
  3139. || $this->getSessionStatus() === self::SESSION_STATUS_EXPORT_PENDING
  3140. || $this->getSessionStatus() === self::SESSION_STATUS_PREPROCESSING_PENDING;
  3141. }
  3143. /**
  3144. * Convenience method to check session status of a SortingSession is in the export phase.
  3145. *
  3146. * @return bool
  3147. */
  3148. public function isSessionStatusExport(): bool
  3149. {
  3150. return $this->getSessionStatus() === self::SESSION_STATUS_EXPORT_IN_PROGRESS
  3151. || $this->getSessionStatus() === self::SESSION_STATUS_EXPORT_PENDING;
  3152. }
  3154. /**
  3155. * Convenience method to check session status of a SortingSession when it is ready for sorter.
  3156. *
  3157. * @return bool
  3158. */
  3159. public function isSessionStatusReadyForSorter(): bool
  3160. {
  3161. return $this->getSessionStatus() === self::SESSION_STATUS_READY_FOR_SORTER;
  3162. }
  3164. /**
  3165. * Convenience method to check session status of a SortingSession is in progress.
  3166. *
  3167. * @return bool
  3168. */
  3169. public function isSessionStatusInProgress(): bool
  3170. {
  3171. return $this->getSessionStatus() === self::SESSION_STATUS_IN_PROGRESS
  3172. || $this->getSessionStatus() === self::SESSION_STATUS_PREPROCESSING_IN_PROGRESS;
  3173. }
  3175. /**
  3176. * Convenience method to check session status of a SortingSession that is paused.
  3177. *
  3178. * @return bool
  3179. */
  3180. public function isSessionStatusPaused(): bool
  3181. {
  3182. return $this->getSessionStatus() === self::SESSION_STATUS_PAUSED;
  3183. }
  3185. /**
  3186. * Convenience method to check session status of a SortingSession that has missing pages.
  3187. *
  3188. * @return bool
  3189. */
  3190. public function isSessionStatusPagesMissing(): bool
  3191. {
  3192. return $this->getSessionStatus() === self::SESSION_STATUS_PAGES_MISSING;
  3193. }
  3195. /**
  3196. * Convenience method to check session status of a SortingSession is completed.
  3197. *
  3198. * @return bool
  3199. */
  3200. public function isSessionStatusCompleted(): bool
  3201. {
  3202. return $this->getSessionStatus() === self::SESSION_STATUS_COMPLETED
  3203. || $this->getSessionStatus() === self::SESSION_STATUS_EXPORT_COMPLETED;
  3204. }
  3206. /**
  3207. * Convenience method to check session status of a SortingSession has failed in 3 preparing,exporting and preprocessing.
  3208. *
  3209. * @return bool
  3210. */
  3211. public function hasSessionStatusFailed(): bool
  3212. {
  3213. return $this->getSessionStatus() === self::SESSION_STATUS_PREPARE_FAILED
  3214. || $this->getSessionStatus() === self::SESSION_STATUS_EXPORT_FAILED
  3215. || $this->getSessionStatus() === self::SESSION_STATUS_PREPROCESSING_FAILED;
  3216. }
  3218. /**
  3219. * Maps the sort options from the Sort entity on the associated MatterRequest,
  3220. * with the pagination options on the SortingSession.
  3221. *
  3222. * @param Sort $sort
  3223. *
  3224. * @return void
  3225. */
  3226. protected function mapPaginationOptions(Sort $sort)
  3227. {
  3228. // centrePrefix
  3229. if ($sort->isCentrePrefixAlpha()) {
  3230. $this->setCentrePrefix(self::CENTRE_PREFIX_ALPHA);
  3231. } elseif ($sort->isCentrePrefixNumeric()) {
  3232. $this->setCentrePrefix(self::CENTRE_PREFIX_NUMERIC);
  3233. }
  3235. // Pagination Strategy
  3236. if ($sort->isPagePrefixNone()) {
  3237. if ($sort->isPaginationRunCentre()) {
  3238. $this->setPaginationStrategy(self::PAGINATION_STRATEGY_RELATIVE);
  3239. } elseif ($sort->isPaginationRunContinuous()) {
  3240. $this->setPaginationStrategy(self::PAGINATION_STRATEGY_ABSOLUTE);
  3241. }
  3242. } else {
  3243. if ($sort->isPaginationRunCentre()) {
  3244. $this->setPaginationStrategy(self::PAGINATION_STRATEGY_PREFIXED_RELATIVE);
  3245. } elseif ($sort->isPaginationRunContinuous()) {
  3246. $this->setPaginationStrategy(self::PAGINATION_STRATEGY_PREFIXED_ABSOLUTE);
  3247. }
  3248. if ($sort->isPagePrefixLetter()) {
  3249. $this->setPaginationPrefix('A');
  3250. } elseif ($sort->isPagePrefixNumeric()) {
  3251. $this->setPaginationPrefix('1.');
  3252. }
  3253. }
  3255. $this->setPageNumberPadding($sort->getPageNumberPaddingInteger());
  3256. $this->setPageNumberPositionHorizontal($sort->getPageNumberPositionHorizontal());
  3257. $this->setPageNumberPositionVertical($sort->getPageNumberPositionVertical());
  3258. $this->setPageNumberSize($sort->getPageNumberSize());
  3259. $this->setPageNumberBackground($sort->getPageNumberBackground());
  3260. }
  3261. }