DataObjects/ProjectDirectory.php
[Pman.Core] / DataObjects / Events.php
1 <?php
2 /**
3  * Table Definition for Events
4  */
5 require_once 'DB/DataObject.php';
6
7 class Pman_Core_DataObjects_Events extends DB_DataObject 
8 {
9     ###START_AUTOCODE
10     /* the code below is auto generated do not remove the above tag */
11
12     public $__table = 'Events';                          // table name
13     public $id;                              // int(11)  not_null primary_key auto_increment
14     public $person_name;                     // string(128)  
15     public $event_when;                      // datetime(19)  binary
16     public $action;                          // string(32)  
17     public $ipaddr;                          // string(16)  
18     public $on_id;                           // int(11)  
19     public $on_table;                        // string(64)  
20     public $person_id;                       // int(11)  
21     public $remarks;                         // blob(65535)  blob
22
23     
24     /* the code above is auto generated do not remove the tag below */
25     ###END_AUTOCODE
26     
27     
28     
29     
30     //  ------------ROO HOOKS------------------------------------
31     function applyFilters($q, $au)
32     {
33         $tn = $this->tableName();
34         if (!empty($q['query']['from'])) {
35             $dt = date('Y-m-d' , strtotime($q['query']['from']));
36             $this->whereAdd(" {$tn}.event_when >=  '$dt' ");
37         }
38         if (!empty($q['query']['to'])) {
39             $dt = date('Y-m-d' , strtotime($q['query']['to']));
40             $this->whereAdd(" {$tn}.event_when <=  '$dt' ");
41         }
42         /*
43         if (!empty($q['query']['grouped']) && $q['query']['grouped'] == 'gr') {
44             // grouped..
45             DB_DataObject::Debuglevel(1);
46             $this->groupBy('on_id');
47             $this->selectAdd('
48                 (SELECT count(id) FROM core_event_audit WHERE event_id = Events.id) as changed
49                 ');
50         }
51         */
52         
53         if (!$au->hasPerm("Admin.Admin_Tab", 'S')) {
54             //DB_DataObject::DebugLevel(1);
55             // they can only view their changes..
56             $this->person_id = $au->id;
57             
58         }
59         // _join = tablename,tablename...
60         
61         /// on_table=cohead
62         //   &_join=cohead
63         //   &_join_cols=cohead_number
64         //    &_columns=on_id_cohead_number,event_when << this is ignored at present.
65         // max(event_when) is not supported... by any query yet..
66         
67         
68         if (isset($q['_join'])) {
69             //DB_DataObject::DebugLevel(1);
70             $joins = explode(',',$q['_join']);
71             
72             $this->selectAdd(); // ???
73             $distinct = false;
74             
75             foreach($joins as $t) {
76                 $t = preg_replace('/[^a-z_]+/', '', $t); // protection.
77                 $x = DB_DataObject::Factory($t);
78                 if (!is_a($x,'DB_DataObject')) {
79                     continue;
80                 }
81                 $jtn = $x->tableName();
82                 $jk = array_shift($x->keys());
83                 $this->_join .= "
84                 
85                     LEFT JOIN {$jtn} as join_on_id_{$jtn} ON {$tn}.on_id = join_on_id_{$jtn}.{$jk}
86                         AND on_table = '{$jtn}'
87                 ";
88                 $keys = array_keys($x->table());
89                 if (isset($q['_join_cols'])) {
90                     $jcs = explode(',',$q['_join_cols'] );
91                     //DB_DataObject::DebugLevel(1);
92                     
93                     foreach($jcs as $jc) { 
94                         if (! in_array($jc, $keys)) {
95                             continue;
96                         }
97                         if ($distinct) { 
98                         
99                        
100                             $this->selectAdd( " join_on_id_{$jtn}.{$jc}   as on_id_{$jc} ");
101                         } else {
102                             $this->selectAdd( " distinct(join_on_id_{$jtn}.{$jc}  ) as on_id_{$jc} ");
103                             $distinct = true;
104                         }
105                         $this->groupBy("on_id_{$jc} ");
106                         $this->whereAdd("join_on_id_{$jtn}.{$jc} IS NOT NULL");
107                     }
108                     $this->selectAdd( "MAX(events.event_when) as event_when");
109                     $this->orderBy('event_when DESC');
110                    // $this->selectAs(array($q['_join_cols']) , 'on_id_%s', "join_on_id_{$jtn}");
111                 } else { 
112                     $this->selectAs($x, 'on_id_%s', "join_on_id_{$jtn}");
113                 }
114             }
115                 
116                 
117             
118             
119         }
120         
121         
122         
123             
124     }
125     /**
126      * check who is trying to access this. false == access denied..
127      * @return {boolean} true if access is allowed.
128      */
129     function checkPerm($lvl, $au) 
130     {
131         if ($lvl == 'S') {
132             return true;
133         }
134         // listing is controleed by applyfilters..
135         return $au->hasPerm("Admin.Admin_Tab", 'S');
136     }
137     /**
138      * object :
139      * return the object that this relates to.
140      * 
141      * @return {DB_DataObject} related object
142      */
143     function object()
144     {
145         $o = DB_DataObject::factory($this->on_table);
146         $o->get($this->on_id);
147         return $o;
148         
149     }
150     
151     
152     /**
153      * init:
154      * Initialize an event - ready to insert..
155      * 
156      * @param {String} action  - group/name of event
157      * @param {DataObject|false} obj - dataobject action occured on.
158      * @param {String} any remarks 
159      */
160     
161     function init($act, $obj, $remarks)
162     {
163         $ff = HTML_FlexyFramework::get();
164         $pg = $ff->page;
165         $au = $pg->getAuthUser();
166         
167         if ($ff->cli && empty($au) && isset($obj->person_id)) {
168             $au = DB_DataObject::Factory('Person'); // not always a person..
169             $au->get($obj->person_id);
170         } 
171          
172          
173          
174         $this->person_name = $au && !empty($au->name) ? $au->name : '';
175         $this->person_id = $au ? $au->id : '';
176         $this->ipaddr = isset($_SERVER["REMOTE_ADDR"]) ? $_SERVER["REMOTE_ADDR"] : 'cli';
177         $this->action = $act;
178         $this->on_table = $obj ? $obj->tableName() : '';
179         $pk = $obj ? $obj->keys()  : false;
180         $this->on_id  = $obj && $pk ? $obj->{$pk[0]}: 0;
181         $rem  = array();
182         // should this really go in remarks? - 
183         if ($obj && method_exists($obj,'toEventString')) {
184             $rem[] = $obj->toEventString() ;
185         }
186         $rem[] = $remarks;
187         $this->remarks = implode(' : ', $rem);
188     }
189     
190     /**
191      * Generate an audit for this field.
192      *
193      * @param {DB_DataObject} new data
194      * @param {DB_DataObject} old data
195      * 
196      * @return {int} number of entries logged.
197      */
198     
199     function audit($new, $old = false)
200     {
201         if ($old == $new) {
202             return 0; // they are the same...
203         }
204          
205         $ret = 0;
206         foreach(array_keys($new->table()) as $k) {
207             // should we JSON serialize this?
208             $n = empty($new->$k) ? '' : $new->$k;
209             $o = empty($old->$k) || empty($old->$k) ? '' : $old->$k;
210             if ($n == $o) {
211                 continue;
212             }
213             $this->auditField($k, $o, $n, $old);
214             $ret++;
215         }
216         return $ret;
217     }
218     /**
219      * Record an audited change, in theory so we can audit data that is not just
220      * database Fields...
221      *
222      * @param {string} $name    table field anme
223      * @param {mixed} $ov  old value
224      * @param {mixed} $onv  new value
225      * @param {mixed} $old  old object (false if we are creating..)
226      */
227     function auditField($name, $ov, $nv, $old=false )
228     {
229         $x = DB_DataObject::factory('core_event_audit');
230         $x->setFrom(array(
231             'event_id' => $this->id,
232             'name' => $name,
233             'old_audit_id' => $old ? $x->findLast($this, $name) : 0,
234             'newvalue' => $nv
235
236         ));
237         $x->insert();
238     
239     }
240 }