src/Events/PatientDocuments/PatientDocumentTreeViewFilterEvent.php

   1 <?php
   2
   3 /**
   4  * PatientDocumentTreeViewFilterEvent is fired when patient documents are rendered in the html tree view widget.  It
   5  * enables event listeners to modify the html element that is displayed for each patient document.
   6  * @see Carecoordination\Listener\CCDAEventsSubscriber::onPatientDocumentTreeViewFilter for an example.
   7  *
   8  * @package openemr
   9  * @link      http://www.open-emr.org
  10  * @author    Stephen Nielson <snielson@discoverandchange.com>
  11  * @copyright Copyright (c) 2022 Discover and Change <snielson@discoverandchange.com>
  12  * @license   https://github.com/openemr/openemr/blob/master/LICENSE GNU General Public License 3
  13  */
  14
  15 namespace OpenEMR\Events\PatientDocuments;
  16
  17 use HTML_TreeNode;
  18 use CategoryTree;
  19
  20 class PatientDocumentTreeViewFilterEvent
  21 {
  22     const EVENT_NAME = "patient.document.tree.view.filter";
  23
  24     /**
  25      * @var CategoryTree
  26      */
  27     private $categoryTreeNode;
  28
  29     /**
  30      * @var \HTML_TreeNode
  31      */
  32     private $htmlTreeNode;
  33
  34     /**
  35      * @var ?string
  36      */
  37     private $documentId;
  38
  39     /**
  40      * @var ?string
  41      */
  42     private $documentName;
  43
  44     /**
  45      * @var ?string
  46      */
  47     private $categoryId;
  48
  49     /**
  50      * @var array
  51      */
  52     private $categoryInfo;
  53
  54     /**
  55      * @var ?int
  56      */
  57     private $pid;
  58
  59     public function __construct()
  60     {
  61     }
  62
  63     /**
  64      * @return CategoryTree
  65      */
  66     public function getCategoryTreeNode(): CategoryTree
  67     {
  68         return $this->categoryTreeNode;
  69     }
  70
  71     /**
  72      * @param CategoryTree $categoryTreeNode
  73      * @return PatientDocumentTreeViewFilterEvent
  74      */
  75     public function setCategoryTreeNode(CategoryTree $categoryTreeNode): PatientDocumentTreeViewFilterEvent
  76     {
  77         $this->categoryTreeNode = $categoryTreeNode;
  78         return $this;
  79     }
  80
  81     /**
  82      * @return HTML_TreeNode
  83      */
  84     public function getHtmlTreeNode(): HTML_TreeNode
  85     {
  86         return $this->htmlTreeNode;
  87     }
  88
  89     /**
  90      * @param HTML_TreeNode $htmlTreeNode
  91      * @return PatientDocumentTreeViewFilterEvent
  92      */
  93     public function setHtmlTreeNode(HTML_TreeNode $htmlTreeNode): PatientDocumentTreeViewFilterEvent
  94     {
  95         $this->htmlTreeNode = $htmlTreeNode;
  96         return $this;
  97     }
  98
  99     /**
 100      * @return mixed
 101      */
 102     public function getPid()
 103     {
 104         return $this->pid;
 105     }
 106
 107     /**
 108      * @param mixed $pid
 109      * @return PatientDocumentTreeViewFilterEvent
 110      */
 111     public function setPid($pid)
 112     {
 113         $this->pid = $pid;
 114         return $this;
 115     }
 116
 117     /**
 118      * @return mixed
 119      */
 120     public function getDocumentId()
 121     {
 122         return $this->documentId;
 123     }
 124
 125     /**
 126      * @param mixed $documentId
 127      * @return PatientDocumentTreeViewFilterEvent
 128      */
 129     public function setDocumentId($documentId)
 130     {
 131         $this->documentId = $documentId;
 132         return $this;
 133     }
 134
 135     /**
 136      * @return mixed
 137      */
 138     public function getDocumentName()
 139     {
 140         return $this->documentName;
 141     }
 142
 143     /**
 144      * @param mixed $documentName
 145      * @return PatientDocumentTreeViewFilterEvent
 146      */
 147     public function setDocumentName($documentName)
 148     {
 149         $this->documentName = $documentName;
 150         return $this;
 151     }
 152
 153     /**
 154      * @return mixed
 155      */
 156     public function getCategoryId()
 157     {
 158         return $this->categoryId;
 159     }
 160
 161     /**
 162      * @param mixed $categoryId
 163      * @return PatientDocumentTreeViewFilterEvent
 164      */
 165     public function setCategoryId($categoryId)
 166     {
 167         $this->categoryId = $categoryId;
 168         return $this;
 169     }
 170
 171     /**
 172      * @return array
 173      */
 174     public function getCategoryInfo(): array
 175     {
 176         return $this->categoryInfo;
 177     }
 178
 179     /**
 180      * @param array $categoryInfo
 181      * @return PatientDocumentTreeViewFilterEvent
 182      */
 183     public function setCategoryInfo(array $categoryInfo): PatientDocumentTreeViewFilterEvent
 184     {
 185         $this->categoryInfo = $categoryInfo;
 186         return $this;
 187     }
 188 }