library/classes/Note.class.php

   1 <?php
   2
   3 /**
   4  * class Note
   5  * This class offers functionality to store sequential comments/notes about an external object or anything with a unique id.
   6  * It is not intended that once a note is save it can be editied or changed.
   7  */
   8
   9 use OpenEMR\Common\ORDataObject\ORDataObject;
  10
  11 class Note extends ORDataObject
  12 {
  13     /*
  14     *   Database unique identifier
  15     *   @var id
  16     */
  17     var $id;
  18
  19     /*
  20     *   DB unique identifier reference to some other table, this is not unique in the notes table
  21     *   @var int
  22     */
  23     var $foreign_id;
  24
  25     /*
  26     *   Narrative comments about whatever object is represented by the foreign id this note is associated with
  27     *   @var string upto 255 character string
  28     */
  29     var $note;
  30
  31     /*
  32     *   Foreign key identifier of who initially persisited the note,
  33     *   potentially ownership could be changed but that would be up to an external non-document object process
  34     *   @var int
  35     */
  36     var $owner;
  37
  38     /*
  39     *   Date the note was first persisted
  40     *   @var date
  41     */
  42     var $date;
  43
  44     /*
  45     *   Timestamp of the last time the note was changed and persisted, auto maintained by DB, manually change at your own peril
  46     *   @var int
  47     */
  48     var $revision;
  49
  50     /**
  51      * Constructor sets all Note attributes to their default value
  52      * @param int $id optional existing id of a specific note, if omitted a "blank" note is created
  53      */
  54     function __construct($id = "")
  55     {
  56         //call the parent constructor so we have a _db to work with
  57         parent::__construct();
  58
  59         //shore up the most basic ORDataObject bits
  60         $this->id = $id;
  61         $this->_table = "notes";
  62
  63         $this->note = "";
  64         $this->date = date("Y-m-d H:i:s");
  65
  66         if ($id != "") {
  67             $this->populate();
  68         }
  69     }
  70
  71     /**
  72      * Convenience function to get an array of many document objects
  73      * For really large numbers of documents there is a way more efficient way to do this by overwriting the populate method
  74      * @param int $foreign_id optional id use to limit array on to a specific relation, otherwise every document object is returned
  75      */
  76     public static function notes_factory($foreign_id = "")
  77     {
  78         $notes = array();
  79
  80         $sqlArray = array();
  81
  82         if (empty($foreign_id)) {
  83             $foreign_id_sql = " like '%'";
  84         } else {
  85             $foreign_id_sql = " = ?";
  86             $sqlArray[] = strval($foreign_id);
  87         }
  88
  89         $d = new note();
  90         $sql = "SELECT id FROM " . escape_table_name($d->_table) . " WHERE foreign_id " . $foreign_id_sql . " ORDER BY DATE DESC";
  91         //echo $sql;
  92         $result = $d->_db->Execute($sql, $sqlArray);
  93
  94         while ($result && !$result->EOF) {
  95             $notes[] = new Note($result->fields['id']);
  96             $result->MoveNext();
  97         }
  98
  99         return $notes;
 100     }
 101
 102     public function getOwnerName()
 103     {
 104         if (!empty($this->owner)) {
 105             $user_info = sqlQuery("SELECT `fname`, `lname` FROM `users` where `id`=?", [$this->owner]);
 106             if (!empty($user_info)) {
 107                 return ($user_info['fname'] . " " . $user_info['lname']);
 108             }
 109         }
 110     }
 111
 112     /**
 113      * Convenience function to generate string debug data about the object
 114      */
 115     function toString($html = false)
 116     {
 117         $string .= "\n"
 118         . "ID: " . $this->id . "\n"
 119         . "FID: " . $this->foreign_id . "\n"
 120         . "note: " . $this->note . "\n"
 121         . "date: " . $this->date . "\n"
 122         . "owner: " . $this->owner . "\n"
 123         . "revision: " . $this->revision . "\n";
 124
 125         if ($html) {
 126             return nl2br($string);
 127         } else {
 128             return $string;
 129         }
 130     }
 131
 132     /**#@+
 133     *   Getter/Setter methods used by reflection to affect object in persist/poulate operations
 134     *   @param mixed new value for given attribute
 135     */
 136     function set_id($id)
 137     {
 138         $this->id = $id;
 139     }
 140     function get_id()
 141     {
 142         return $this->id;
 143     }
 144     function set_foreign_id($fid)
 145     {
 146         $this->foreign_id = $fid;
 147     }
 148     function get_foreign_id()
 149     {
 150         return $this->foreign_id;
 151     }
 152     function set_note($note)
 153     {
 154         $this->note = $note;
 155     }
 156     function get_note()
 157     {
 158         return $this->note;
 159     }
 160     function set_date($date)
 161     {
 162         $this->date = $date;
 163     }
 164     function get_date()
 165     {
 166         return $this->date;
 167     }
 168     function set_owner($owner)
 169     {
 170         $this->owner = $owner;
 171     }
 172     function get_owner()
 173     {
 174         return $this->owner;
 175     }
 176     /*
 177     *   No getter for revision because it is updated automatically by the DB.
 178     */
 179     function set_revision($revision)
 180     {
 181         $this->revision = $revision;
 182     }
 183
 184     /*
 185     *   Overridden function to store current object state in the db.
 186     *   This overide is to allow for a "just in time" foreign id, often this is needed
 187     *   when the object is never directly exposed and is handled as part of a larger
 188     *   object hierarchy.
 189     *   @param int $fid foreign id that should be used so that this note can be related (joined) on it later
 190     */
 191
 192     function persist($fid = "")
 193     {
 194         if (!empty($fid)) {
 195             $this->foreign_id = $fid;
 196         }
 197
 198         parent::persist();
 199     }
 200 } // end of Note