library/classes/Note.class.php

   1 <?php
   2
   3
   4 /**
   5  * class Note
   6  * This class offers functionality to store sequential comments/notes about an external object or anything with a unique id.
   7  * It is not intended that once a note is save it can be editied or changed.
   8  */
   9
  10 class Note extends ORDataObject
  11 {
  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     /**
 103      * Convenience function to generate string debug data about the object
 104      */
 105     function toString($html = false)
 106     {
 107         $string .= "\n"
 108         . "ID: " . $this->id."\n"
 109         . "FID: " . $this->foreign_id."\n"
 110         . "note: " . $this->note . "\n"
 111         . "date: " . $this->date . "\n"
 112         . "owner: " . $this->owner . "\n"
 113         . "revision: " . $this->revision. "\n";
 114
 115         if ($html) {
 116             return nl2br($string);
 117         } else {
 118             return $string;
 119         }
 120     }
 121
 122     /**#@+
 123     *   Getter/Setter methods used by reflection to affect object in persist/poulate operations
 124     *   @param mixed new value for given attribute
 125     */
 126     function set_id($id)
 127     {
 128         $this->id = $id;
 129     }
 130     function get_id()
 131     {
 132         return $this->id;
 133     }
 134     function set_foreign_id($fid)
 135     {
 136         $this->foreign_id = $fid;
 137     }
 138     function get_foreign_id()
 139     {
 140         return $this->foreign_id;
 141     }
 142     function set_note($note)
 143     {
 144         $this->note = $note;
 145     }
 146     function get_note()
 147     {
 148         return $this->note;
 149     }
 150     function set_date($date)
 151     {
 152         $this->date = $date;
 153     }
 154     function get_date()
 155     {
 156         return $this->date;
 157     }
 158     function set_owner($owner)
 159     {
 160         $this->owner = $owner;
 161     }
 162     function get_owner()
 163     {
 164         return $this->owner;
 165     }
 166     /*
 167     *   No getter for revision because it is updated automatically by the DB.
 168     */
 169     function set_revision($revision)
 170     {
 171         $this->revision = $revision;
 172     }
 173
 174     /*
 175     *   Overridden function to store current object state in the db.
 176     *   This overide is to allow for a "just in time" foreign id, often this is needed
 177     *   when the object is never directly exposed and is handled as part of a larger
 178     *   object hierarchy.
 179     *   @param int $fid foreign id that should be used so that this note can be related (joined) on it later
 180     */
 181
 182     function persist($fid = "")
 183     {
 184         if (!empty($fid)) {
 185             $this->foreign_id = $fid;
 186         }
 187
 188         parent::persist();
 189     }
 190 } // end of Note