DataObjects/Core_notify.php
[Pman.Core] / DataObjects / Core_notify.php
1 <?php
2 /**
3  *
4  * Table is designed to be used with a mailer to notify or issue
5  * emails (or maybe others later??)
6  *
7  *
8 CREATE TABLE  core_notify  (
9   `id` int(11)  NOT NULL AUTO_INCREMENT,
10   `recur_id` INT(11) NOT NULL;
11   `act_when` DATETIME NOT NULL,
12   `onid` int(11)  NOT NULL DEFAULT 0,
13   `ontable` varchar(128)  NOT NULL DEFAULT '',
14   `person_id` int(11)  NOT NULL DEFAULT 0,
15   `msgid` varchar(128)  NOT NULL  DEFAULT '',
16   `sent` DATETIME  NOT NULL,
17   `event_id` int(11)  NOT NULL DEFAULT 0,
18   PRIMARY KEY (`id`),
19   INDEX `lookup`(`act_when`, `msgid`)
20 );
21 **/
22
23 require_once 'DB/DataObject.php';
24
25 class Pman_Core_DataObjects_Core_notify extends DB_DataObject 
26 {
27     ###START_AUTOCODE
28     /* the code below is auto generated do not remove the above tag */
29
30     public $__table = 'core_notify';                     // table name
31     public $id;                              // int(11)  not_null primary_key auto_increment
32     public $recur_id;                        // int(11) not_null
33     public $act_when;                        // datetime(19)  not_null multiple_key binary
34     public $onid;                            // int(11)  not_null
35     public $ontable;                         // string(128)  not_null
36     public $person_id;                       // int(11)  not_null
37     public $msgid;                           // string(128)  not_null
38     public $sent;                            // datetime(19)  not_null binary
39     public $event_id;                        // int(11)  
40     public $watch_id;                        // int(11)  
41     public $trigger_person_id;                 // int(11)
42     public $trigger_event_id;              // int(11)  
43     public $evtype;                         // event type (or method to call)fall
44     public $act_start;
45     
46     /* the code above is auto generated do not remove the tag below */
47     ###END_AUTOCODE
48     
49     function person($set = false)
50     {
51         if ($set !== false) {
52             $this->person_id = is_object($set) ? $set->id : $set;
53             return;
54         }
55         $c = DB_DataObject::Factory('Person');
56         $c->get($this->person_id);
57         return $c;
58         
59     }
60     function object($set = false)
61     {
62         if ($set !== false) {
63             $this->ontable = $set->tableName();
64             $this->onid = $set->id;
65             return $set;
66         }
67         $c = DB_DataObject::factory($this->ontable);
68         
69         if ($this->onid == 0) {
70             return $c; // empty dataobject.
71         }
72         
73         $c->autoJoin();
74         
75         if ($c->get($this->onid)) {
76             return $c;
77         }
78         return false;
79         
80     }
81     function beforeDelete($dependants_array, $roo) {
82         if ($this->delivered()) {
83             $roo->jerr("you can not delete a record of a successfull delivery");
84         }
85     }
86     function  beforeInsert($request,$roo)
87     {
88         if (empty($request['act_when']) && !empty($request['act_start'])) {
89             $this->act_start($request['act_start']);
90         }
91         
92     }
93     function beforeUpdate($old, $request,$roo)
94     {
95         if (empty($request['act_when']) && !empty($request['act_start'])) {
96             $this->act_start($request['act_start']);
97         }
98     }
99     
100     
101     function act_start($set = false)
102     {
103         if ($set === false) {
104             return $this->act_start;
105         }
106         $this->act_when = $set;
107         $this->act_start = $set;
108         return $set;
109     }
110     
111     function event()
112     {
113
114         $c = DB_DataObject::factory('Events');
115         
116         if ($c->get($this->event_id)) {
117             return $c;
118         }
119         return false;
120         
121     }
122     
123     function triggerEvent()
124     {
125
126         $c = DB_DataObject::factory('Events');
127         
128         if ($c->get($this->trigger_event_id)) {
129             return $c;
130         }
131         return false;
132         
133     }
134     
135     function delivered()
136     {
137         return !empty($this->msgid);
138     }
139     
140     function whereAddDeliveryStatus($delivered = false)
141     {
142         $tn = $this->tableName();
143         if ($delivered) {
144             $this->whereAdd("$tn.msgid IS NOT NULL AND $tn.msgid != ''");
145         } else {
146             $this->whereAdd("$tn.msgid IS NULL OR $tn.msgid = ''");    
147         }
148     }
149     
150     function status() // used by commandline reporting at present..
151     {
152         switch($this->event_id) {
153             case -1:
154                 return 'DELIVERED';   //not valid..
155             case 0:
156                 return 'PENDING';
157             default:
158                 $p ='';
159                 if (strtotime($this->act_when) > time()) {
160                     $p = "RETRY: {$this->act_when} ";
161                 }
162                 return  $p. $this->event()->remarks;
163         }
164         
165     }
166     
167     function applyFilters($q, $au, $roo)
168     {
169         if (isset($q['ontable']) && !in_array($q['ontable'], array('Person', 'Events',  'core_watch'))) {
170             // this will only work on tables not joined to ours.
171             
172             //DB_DAtaObject::DebugLevel(1);
173             // then we can build a join..
174             $d = DB_DataObject::Factory($q['ontable']);
175             $ji = $d->autoJoin();
176             //echo '<PRE>';print_R($ji);
177             // get cols
178             foreach($ji['join_names'] as $cname=>$fname) {
179                  $this->selectAdd($fname . ' as ontable_id_' . $cname );
180             }
181             
182             //$this->selectAdd($d->_query['data_select']); -- this will cause the same dataIndex...
183             $this->_join .= "
184                 LEFT JOIN {$d->tableName()} ON {$this->tableName()}.onid = {$d->tableName()}.id
185                 {$d->_join}
186             "; 
187             $this->selectAs($d, 'core_notify_%s');
188         } 
189         if (!empty($q['query']['person_id_name']) ) {
190             $this->whereAdd( "join_person_id_id.name LIKE '{$this->escape($q['query']['person_id_name'])}%'");
191              
192         }
193          if (!empty($q['query']['status'])) {
194             switch ($q['query']['status']) {
195                 
196                 case 'SUCCESS';
197                     $this->whereAdd("msgid  != ''");
198                     break;
199                 case 'FAILED';
200                     
201                     $this->whereAdd("msgid  = '' AND event_id > 0 AND act_when < NOW()");
202                     
203                     break;
204                 case 'PENDING';
205                     $this->whereAdd('event_id = 0 OR (event_id  > 0 AND act_when > NOW() )');
206                     break;
207                 
208                 case 'OPENED';
209                     $this->whereAdd('is_open > 0');
210                     break;
211                 
212                 case 'ALL':
213                 default:
214                     break;
215             }
216         }
217         
218         $this->selectAdd("
219             (SELECT
220                     display_name
221             FROM
222                     core_enum
223             WHERE
224                     etype = 'Core.NotifyType'
225                 AND
226                     name = core_notify.evtype
227                 AND
228                     active = 1
229             ) AS evtype_align
230         ");
231         
232         
233         
234         
235     }
236     
237 }