From 24ba880d11ba2462760306298fce74e2e4210357 Mon Sep 17 00:00:00 2001
From: Ingo Schommer <ingo@silverstripe.com>
Date: Mon, 1 Dec 2008 01:15:27 +0000
Subject: [PATCH] BUGFIX Calling init() on CliController subclasses before
 triggering process(), to give the controller a chance to perform permission
 control etc. MINOR Documentation for Task* classes

git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/trunk@67018 467b73ca-7a2a-4603-9d3b-597d59a354a9
---
 cli/CliController.php   | 17 +++++++++++++----
 tasks/DailyTask.php     |  7 ++++++-
 tasks/HourlyTask.php    | 11 +++++------
 tasks/MonthlyTask.php   |  5 +++++
 tasks/ScheduledTask.php | 18 +++++++++++++++++-
 tasks/WeeklyTask.php    |  5 +++++
 tasks/YearlyTask.php    |  5 +++++
 7 files changed, 56 insertions(+), 12 deletions(-)

diff --git a/cli/CliController.php b/cli/CliController.php
index b1db8270c..12bc2f1cf 100755
--- a/cli/CliController.php
+++ b/cli/CliController.php
@@ -1,6 +1,11 @@
 <?php
 /**
- * Base class invoked from CLI rather than the webserver (Cron jobs, handling email bounces)
+ * Base class invoked from CLI rather than the webserver (Cron jobs, handling email bounces).
+ * You can call subclasses of CliController directly, which will trigger a
+ * call to {@link process()} on every sub-subclass. For instance, calling
+ * "sake DailyTask" from the commandline will call {@link process()} on every subclass
+ * of DailyTask.
+ * 
  * @package sapphire
  * @subpackage cron
  */
@@ -12,13 +17,17 @@ abstract class CliController extends Controller {
   
     function index() {
         foreach( ClassInfo::subclassesFor( $this->class ) as $subclass ) {
-        	echo $subclass;
+        	echo $subclass . "\n";
         
             $task = new $subclass();
+			$task->init();
             $task->process();
         }
     }
     
-    function process() {}       
+	/**
+	 * Overload this method to contain the task logic.
+	 */
+    function process() {}
 }  
-?>
+?>
\ No newline at end of file
diff --git a/tasks/DailyTask.php b/tasks/DailyTask.php
index 648cf4c8a..05803fc8b 100755
--- a/tasks/DailyTask.php
+++ b/tasks/DailyTask.php
@@ -1,6 +1,11 @@
 <?php
 /**
- * Classes that must be run daily extend this class
+ * Classes that must be run daily extend this class.
+ * 
+ * Please note: Subclasses of this task aren't extecuted automatically,
+ * they need to be triggered by an external automation tool like unix cron.
+ * See {@link ScheduledTask} for details.
+ * 
  * @todo Improve documentation
  * @package sapphire
  * @subpackage cron
diff --git a/tasks/HourlyTask.php b/tasks/HourlyTask.php
index 5d9d2a831..774124248 100644
--- a/tasks/HourlyTask.php
+++ b/tasks/HourlyTask.php
@@ -1,12 +1,11 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage cron
- */
-
 /**
  * Classes that must be run hourly extend this class
+ * 
+ * Please note: Subclasses of this task aren't extecuted automatically,
+ * they need to be triggered by an external automation tool like unix cron.
+ * See {@link ScheduledTask} for details.
+ * 
  * @package sapphire
  * @subpackage cron
  */
diff --git a/tasks/MonthlyTask.php b/tasks/MonthlyTask.php
index 6f87f63e8..57e9913e8 100755
--- a/tasks/MonthlyTask.php
+++ b/tasks/MonthlyTask.php
@@ -1,6 +1,11 @@
 <?php
 /**
  * Classes that must be run monthly extend this class
+ * 
+ * Please note: Subclasses of this task aren't extecuted automatically,
+ * they need to be triggered by an external automation tool like unix cron.
+ * See {@link ScheduledTask} for details.
+ * 
  * @package sapphire
  * @subpackage cron
  */
diff --git a/tasks/ScheduledTask.php b/tasks/ScheduledTask.php
index f76a7b184..4b0b36187 100755
--- a/tasks/ScheduledTask.php
+++ b/tasks/ScheduledTask.php
@@ -1,6 +1,22 @@
 <?php
 /**
- * Abstract task representing scheudled tasks
+ * Abstract task representing scheudled tasks.
+ * You can use the different subclasses {@link HourlyTask}, {@link DailyTask},
+ * {@link WeeklyTask} to determine when a task should be run,
+ * and use automation tools such as unix cron to trigger them.
+ * 
+ * Example Cron:
+ * <code>
+ * # HourlyTask (every hour at 25 minutes past)
+ * 25 * * * *  www-data /my/webroot/sapphire/cli-script.php /DailyTask > /var/log/silverstripe_dailytask.log
+ * 
+ * # DailyTask (every day at 6:25am)
+ * 25 6 * * *  www-data /my/webroot/sapphire/cli-script.php /DailyTask > /var/log/silverstripe_dailytask.log
+ * 
+ * # WeelkyTask (every Monday at 6:25am)
+ * 25 6 1 * *  www-data /my/webroot/sapphire/cli-script.php /WeeklyTask > /var/log/silverstripe_weeklytask.log
+ * </code>
+ * 
  * @todo Improve documentation
  * @package sapphire
  * @subpackage cron
diff --git a/tasks/WeeklyTask.php b/tasks/WeeklyTask.php
index e0338b37c..bcfe56b73 100755
--- a/tasks/WeeklyTask.php
+++ b/tasks/WeeklyTask.php
@@ -1,6 +1,11 @@
 <?php
 /**
  * Classes that must be run weekly extend this class
+ * 
+ * Please note: Subclasses of this task aren't extecuted automatically,
+ * they need to be triggered by an external automation tool like unix cron.
+ * See {@link ScheduledTask} for details.
+ * 
  * @package sapphire
  * @subpackage cron
  */
diff --git a/tasks/YearlyTask.php b/tasks/YearlyTask.php
index d24c74e83..585904482 100644
--- a/tasks/YearlyTask.php
+++ b/tasks/YearlyTask.php
@@ -1,6 +1,11 @@
 <?php
 /**
  * Classes that must be run yearly extend this class
+ * 
+ * Please note: Subclasses of this task aren't extecuted automatically,
+ * they need to be triggered by an external automation tool like unix cron.
+ * See {@link ScheduledTask} for details.
+ * 
  * @package sapphire
  * @subpackage cron
  */