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

4 files changed, 17 insertions, 5 deletions

diff --git a/modules/gallery/controllers/admin_maintenance.php b/modules/gallery/controllers/admin_maintenance.php
index 37cc5222..543961a1 100644
--- a/modules/gallery/controllers/admin_maintenance.php
+++ b/modules/gallery/controllers/admin_maintenance.php
@@ -119,8 +119,8 @@ class Admin_Maintenance_Controller extends Admin_Controller {
     }
 
     header("Content-Type: application/text");
-    header("Content-Disposition: filename=g2_import.txt");
-    print $task->get_task_log();
+    header("Content-Disposition: filename=gallery3_task_log.txt");
+    print $task->get_log();
   }
 
   /**
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");
   }
diff --git a/modules/gallery/views/admin_maintenance.html.php b/modules/gallery/views/admin_maintenance.html.php
index f50c95dd..eecc045c 100644
--- a/modules/gallery/views/admin_maintenance.html.php
+++ b/modules/gallery/views/admin_maintenance.html.php
@@ -164,7 +164,7 @@
           <a href="<?= url::site("admin/maintenance/remove/$task->id?csrf=$csrf") ?>">
             <?= t("remove") ?>
           </a>
-          <? if ($task->get_task_log()): ?>
+          <? if ($task->get_log()): ?>
           <a class="gDialogLink" href="<?= url::site("admin/maintenance/show_log/$task->id?csrf=$csrf") ?>">
             <?= t("browse log") ?>
           </a>
diff --git a/modules/gallery/views/admin_maintenance_show_log.html.php b/modules/gallery/views/admin_maintenance_show_log.html.php
index afd988bb..9d850986 100644
--- a/modules/gallery/views/admin_maintenance_show_log.html.php
+++ b/modules/gallery/views/admin_maintenance_show_log.html.php
@@ -12,7 +12,7 @@ appendTo('body').submit().remove();
 <div id="gTaskLogDialog">
   <h1> <?= $task->name ?> </h1>
   <div class="gTaskLog">
-    <pre><?= p::purify($task->get_task_log()) ?></pre>
+    <pre><?= p::purify($task->get_log()) ?></pre>
   </div>
   <button id="gCloseButton" class="ui-state-default ui-corner-all" onclick="dismiss()"><?= t("Close") ?></button>
   <button id="gSaveButton" class="ui-state-default ui-corner-all" onclick="download()"><?= t("Save") ?></button>