DataObjects/Events.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         if (!empty($q['query']['from'])) {
34             $dt = date('Y-m-d' , strtotime($q['query']['from']));
35             $this->whereAdd(" Events.event_when >=  '$dt' ");
36         }
37         if (!empty($q['query']['to'])) {
38             $dt = date('Y-m-d' , strtotime($q['query']['to']));
39             $this->whereAdd(" Events.event_when <=  '$dt' ");
40         }
41         /*
42         if (!empty($q['query']['grouped']) && $q['query']['grouped'] == 'gr') {
43             // grouped..
44             DB_DataObject::Debuglevel(1);
45             $this->groupBy('on_id');
46             $this->selectAdd('
47                 (SELECT count(id) FROM core_event_audit WHERE event_id = Events.id) as changed
48                 ');
49         }
50         */
51         
52         if (!$au->hasPerm("Admin.Admin_Tab", 'S')) {
53             //DB_DataObject::DebugLevel(1);
54             // they can only view their changes..
55             $this->person_id = $au->id;
56             
57         }
58         
59             
60     }
61     /**
62      * check who is trying to access this. false == access denied..
63      * @return {boolean} true if access is allowed.
64      */
65     function checkPerm($lvl, $au) 
66     {
67         if ($lvl == 'S') {
68             return true;
69         }
70         // listing is controleed by applyfilters..
71         return $au->hasPerm("Admin.Admin_Tab", 'S');
72     }
73     /**
74      * object :
75      * return the object that this relates to.
76      * 
77      * @return {DB_DataObject} related object
78      */
79     function object()
80     {
81         $o = DB_DataObject::factory($this->on_table);
82         $o->get($this->on_id);
83         return $o;
84         
85     }
86     
87     
88     /**
89      * init:
90      * Initialize an event - ready to insert..
91      * 
92      * @param {String} action  - group/name of event
93      * @param {DataObject|false} obj - dataobject action occured on.
94      * @param {String} any remarks 
95      */
96     
97     function init($act, $obj, $remarks)
98     {
99         $ff = HTML_FlexyFramework::get();
100         $pg = $ff->page;
101         $au = $pg->getAuthUser();
102         
103         if ($ff->cli && empty($au) && isset($obj->person_id)) {
104             $au = DB_DataObject::Factory('Person'); // not always a person..
105             $au->get($obj->person_id);
106         } 
107          
108          
109          
110         $this->person_name = $au && !empty($au->name) ? $au->name : '';
111         $this->person_id = $au ? $au->id : '';
112         $this->ipaddr = isset($_SERVER["REMOTE_ADDR"]) ? $_SERVER["REMOTE_ADDR"] : 'cli';
113         $this->action = $act;
114         $this->on_table = $obj ? $obj->tableName() : '';
115         $pk = $obj ? $obj->keys()  : false;
116         $this->on_id  = $obj && $pk ? $obj->{$pk[0]}: 0;
117         $rem  = array();
118         // should this really go in remarks? - 
119         if ($obj && method_exists($obj,'toEventString')) {
120             $rem[] = $obj->toEventString() ;
121         }
122         $rem[] = $remarks;
123         $this->remarks = implode(' : ', $rem);
124     }
125     
126     /**
127      * Generate an audit for this field.
128      *
129      * @param {DB_DataObject} new data
130      * @param {DB_DataObject} old data
131      * 
132      * @return {int} number of entries logged.
133      */
134     
135     function audit($new, $old = false)
136     {
137         if ($old == $new) {
138             return 0; // they are the same...
139         }
140          
141         $ret = 0;
142         foreach(array_keys($new->table()) as $k) {
143             // should we JSON serialize this?
144             $n = empty($new->$k) ? '' : $new->$k;
145             $o = empty($old->$k) || empty($old->$k) ? '' : $old->$k;
146             if ($n == $o) {
147                 continue;
148             }
149             $this->auditField($k, $o, $n, $old);
150             $ret++;
151         }
152         return $ret;
153     }
154     /**
155      * Record an audited change, in theory so we can audit data that is not just
156      * database Fields...
157      *
158      * @param {string} $name    table field anme
159      * @param {mixed} $ov  old value
160      * @param {mixed} $onv  new value
161      * @param {mixed} $old  old object (false if we are creating..)
162      */
163     function auditField($name, $ov, $nv, $old=false )
164     {
165         $x = DB_DataObject::factory('core_event_audit');
166         $x->setFrom(array(
167             'event_id' => $this->id,
168             'name' => $name,
169             'old_audit_id' => $old ? $x->findLast($this, $name) : 0,
170             'newvalue' => $nv
171
172         ));
173         $x->insert();
174     
175     }
176 }