Added a wee bit of phpDoc.

Changed the name of the method get_task_log to get_log
Changed the default name of the file when the log is downloaded to
gallery3_task_log.txt

1 files changed, 13 insertions, 1 deletions

diff --git a/modules/gallery/models/task.php b/modules/gallery/models/task.php
index 55bb8e21..b7e255a2 100644
--- a/modules/gallery/models/task.php
+++ b/modules/gallery/models/task.php
@@ -49,6 +49,10 @@ class Task_Model extends ORM {
     return user::lookup($this->owner_id);
   }
 
+  /**
+   * Log a message to the task log.
+   * @params $msg mixed a string or array of strings
+   */
   public function log($msg) {
     $key = $this->_cache_key();
     $log = Cache::instance()->get($key);
@@ -63,11 +67,19 @@ class Task_Model extends ORM {
                            array("task", "log", "import"), 2592000);
   }
 
-  public function get_task_log() {
+  /**
+   * Retrieve the cached log information for this task.
+   * @returns the log data or null if there is no log data
+   */
+  public function get_log() {
     $log_data = Cache::instance()->get($this->_cache_key());
     return  $log_data !== null ? $log_data : false;
   }
 
+  /**
+   * Build the task cache key
+   * @returns the key to use in access the cache
+   */
   private function _cache_key() {
     return md5("$this->id; $this->name; $this->callback");
   }