From: Alan Knowles <alan@akbkhome.com>
Date: Tue, 4 Dec 2012 23:43:34 +0000 (+0800)
Subject: DataObjects/Core_watch.php
X-Git-Url: http://git.roojs.org/?p=Pman.Core;a=commitdiff_plain;h=f0e1c0573f5df51534d1028c2a73cff0afab2e72

DataObjects/Core_watch.php
---

diff --git a/DataObjects/Core_watch.php b/DataObjects/Core_watch.php
index ba602c58..6770874a 100644
--- a/DataObjects/Core_watch.php
+++ b/DataObjects/Core_watch.php
@@ -78,10 +78,20 @@ class Pman_Core_DataObjects_Core_watch extends DB_DataObject
      * Generate a notify event based on watches (matching whereAdd)
      *
      * Usage: $core_watch->notify('mtrack_repos', 1, false, date()
+     *
+     * This can match any 'event' type - eg. it can be blank etc...
+     *   Generally used by non-event driven notifications, like our
+     *   Daily commit message.
+     *
+     *  @param string $ontable - the database table that has been updated/changed etc.
+     *  @param int    $onid    - the id of the row changed
+     *  @param string  $whereAdd (optiona) - a DB whereAdd() condition to filter the search for watches
+     *  @param datetime    $when   (default now)  - date/time to create the notification for (Eg. end of day..)
+     * 
      */
     function notify($ontable , $onid, $whereAdd = false, $when=false)
     {
-        $w = DB_DataObject::factory('core_watch');
+        $w = DB_DataObject::factory('core_watch');   
         if ($whereAdd !== false) { 
             $w->whereAdd($whereAdd  );
         }