3 * Table Definition for core_watch
5 * works with 'core_notify'
8 * $watch->notify($ontable, $onid)
10 * in which case it should create a core_notify event.
13 * Should 'event' trigger this..
14 * -> eg. somebody makes a 'EDIT' on 'person'
15 * -> a watch exists for
17 * onid = -1 <<-- every entry..
18 * person_id -> who is goes to.
19 * event = CRUD (eg. shortcut for edit/create/delete)
20 * medium = "REVIEW" << eg. review needed..
23 * if onid == 0 then it will monitor all changes to that table..
29 class_exists('DB_DataObject') ? '' : require_once 'DB/DataObject.php';
31 class Pman_Core_DataObjects_Core_watch extends DB_DataObject
34 /* the code below is auto generated do not remove the above tag */
36 public $__table = 'core_watch'; // table name
37 public $id; // int(11) not_null primary_key auto_increment
38 public $ontable; // string(128) not_null
39 public $onid; // int(11) not_null
40 public $person_id; // int(11) not_null
41 public $event; // string(128) not_null
42 public $medium; // string(128) not_null
43 public $active; // int(11) not_null
46 /* the code above is auto generated do not remove the tag below */
48 /** make sure there is a watch for this user.. */
51 function applyFilters($q,$au, $roo)
53 if (!empty($q['_list_actions'])) {
54 $this->listActions($roo,$q);
56 //die("apply filters");
57 if (!empty($q['_split_event_name'])) {
60 substr( event, 1, LOCATE( '.',event) -1) as event_left,
61 substr( event, LOCATE( '.',event) +1) as event_right,
63 display_name FROM core_enum where etype = '{$this->escape($q['_split_event_name'])}'
64 AND name = substr( event, LOCATE( '.',event) +1)
65 ) as event_right_display_name
75 function toRooSingleArray($au,$q)
77 $ret = $this->toArray();
78 if (empty($q['_split_event_name'])) {
81 $bits = explode('.', $this->event);
82 $ret['event_left'] = $bits[0];
83 $ret['event_right'] = $bits[1];
85 if (!empty($ret['event_right'])) {
86 $ce = DB_DataObject::factory('core_enum')->lookupObject($q['_split_event_name'], $ret['event_right']);
87 $ret['event_right_display_name'] = $ce->display_name;
95 function listActions($roo, $q) {
98 $d = DB_DataObject::Factory($q['on_table']);
101 foreach(get_class_methods($d) as $m) {
103 if (!preg_match('/^notify/', $m)) {
107 'display_name' => preg_replace('/^notify/', '' , $m),
108 'name' => $q['on_table'] .':'. $m
123 function ensureNotify( $ontable, $onid, $person_id, $whereAdd)
125 //DB_DAtaObject::debugLevel(1);
126 $w = DB_DataObject::factory('core_watch');
127 $w->person_id = $person_id;
128 if (empty($w->person_id)) {
133 $w->whereAdd($whereAdd);
139 $nw->ontable = $ontable;
142 $nw->medium = 'email';
148 * Generate a notify event based on watches (matching whereAdd)
150 * Usage: $core_watch->notify('mtrack_repos', 1, false, date()
152 * This can match any 'event' type - eg. it can be blank etc...
153 * Generally used by non-event driven notifications, like our
154 * Daily commit message.
156 * @param string $ontable - the database table that has been updated/changed etc.
157 * @param int $onid - the id of the row changed
158 * @param string $whereAdd (optiona) - a DB whereAdd() condition to filter the search for watches
159 * @param datetime $when (default now) - date/time to create the notification for (Eg. end of day..)
160 * @param string $to_ontable - notify event create on this table, rather than watch table.
161 * @param string $to_id - notify event create on this id, rather than watch id.
165 function notify($ontable , $onid, $whereAdd = false, $when=false, $to_ontable=false, $to_onid=false)
167 $w = DB_DataObject::factory('core_watch');
168 if ($whereAdd !== false) {
169 $w->whereAdd($whereAdd );
173 $w->whereAdd('onid = 0 OR onid='. ((int) $onid));
176 $w->ontable = $ontable;
178 //$w->selectAdd('distinct(person_id) as person_id');
180 foreach($w->fetchAll() as $w) {
181 if (!$w->person_id) { // no people??? bugs in watch table
185 $nn = DB_DataObject::Factory('core_notify');
186 $nn->ontable = $to_ontable === false ? $ontable : $to_ontable;
187 $nn->onid = $to_onid === false ? $onid : $to_onid;
188 $nn->evtype = $w->medium;
189 $nn->person_id = $w->person_id;
192 $nf->whereAdd("sent < '2000-01-01'");
194 // we have a item in the queue for that waiting to be sent..
197 $nn->act_start( date("Y-m-d H:i:s", $when !== false ? strtotime($when) : time()) );
205 * This get's called by roo->addEvent()
207 * And searches for matching '$watch->event' == $event->action
208 * along with id/table etc..
210 * it's basic usage is to fill in core_notify after an event has happend.
212 * We can also use it to notify other modules if something has happend.
213 * = eg. mtrack_ticket * watch will notify mtrack_jira::
215 * @param Pman_Core_DataObject_Events $event - the Pman event dataobject that was created
219 function notifyEvent($event)
222 //DB_DataObject::DebugLevel(1);
223 // see if there are any watches on events..
224 // notify everyone flagged except the person doing it...
225 // this is very basic logic... -
226 // if more intelligence is needed...
227 // then it 'rules' will have to be added by the watched object....
228 // anyway leave that for another day..
229 if (empty($event->action)) {
232 $w = DB_DataObject::factory('core_watch');
233 $w->ontable = $event->on_table;
234 $w->whereAdd('onid = 0 OR onid='. ((int) $event->on_id));
236 $w->event = $event->action;
239 // not sure why this is here... - it breaks on the reader article ->
240 if ($event->person_id) {
241 $w->whereAdd('person_id != '. (int) $event->person_id);
244 $watches = $w->fetchAll();
248 $nn = DB_DataObject::Factory('core_notify');
249 $nn->ontable = $event->on_table;
250 $nn->onid = $event->on_id;
252 foreach($watches as $watch) {
254 if (!$watch->person_id) { // no people??? bugs in watch table
255 $dom = explode(':',$watch->medium);
256 if (count($dom) != 2) {
259 // in some scenarios (like watching for new articles)
260 // we need to create a core, notify on the medium..
261 // in which case we set the set $nn->evtype = medium..
262 // in that case - just let the called method generate the notify..
265 $do = DB_DataObject::factory($dom[0]);
266 if (!method_exists($do,$dom[1])) {
269 //echo "calling {$watch->medium}\n";
270 // the triggered method, can either do something
271 // or modify the notify event..
272 if ($do->{$dom[1]}($event, $n) !== false) {
273 //echo "method did not return false?";
281 $n->trigger_person_id = $event->person_id;
282 $n->trigger_event_id = $event->id;
283 $n->person_id = $watch->person_id;
284 $n->watch_id = $watch->id;
286 // does this watch already have a flag...
288 $nf->whereAdd("sent < '2000-01-01'");
289 //$nf->whereAdd('sent < act_when');
291 // we have a item in the queue for that waiting to be sent..
294 //echo "inserting notify?";
295 $n->act_start( empty($n->act_start) ? date("Y-m-d H:i:s") : $n->act_start );
302 function initDatabase($roo, $data) {
303 foreach($data as $d) {
305 if (isset($dd['active'])) {
306 unset($dd['active']);
308 $t = DB_DataObject::Factory($this->tableName());
310 if ($t->find(true)) {
313 $t = DB_DataObject::Factory($this->tableName());