Merge pull request #1195 from chillu/pulls/deprecate-scheduled-tasks

API Deprecated ScheduledTask and subclasses

docs/en/changelogs/3.1.0.md

@@ -218,4 +218,7 @@ through the CMS controllers, providing a simple level of security.
    - `DataList#find`
    - `DataList#byIDs`
    - `DataList#reverse`
- * `DataList#dataQuery` has been changed to return a clone of the query, and so can't be used to modify the list's query directly. Use `DataList#alterDataQuery` instead to modify dataQuery in a safe manner.
+ * `DataList#dataQuery` has been changed to return a clone of the query, and so can't be used to modify the list's query directly. Use `DataList#alterDataQuery` instead to modify dataQuery in a safe manner.
+ * `ScheduledTask`, `QuarterHourlyTask`, `HourlyTask`, `DailyTask`, `MonthlyTask`, `WeeklyTask` and
+	 `YearlyTask` are deprecated, please extend from `BuildTask` or `CliController`,
+	 and invoke them in self-defined frequencies through Unix cronjobs etc.

tasks/DailyTask.php

@@ -5,6 +5,8 @@
  * 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.
+ *
+ * @deprecated 3.1
  * 
  * @todo Improve documentation
  * @package framework

tasks/HourlyTask.php

@@ -5,6 +5,8 @@
  * 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.
+ *
+ * @deprecated 3.1
  * 
  * @package framework
  * @subpackage cron

tasks/MonthlyTask.php

@@ -5,6 +5,8 @@
  * 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.
+ *
+ * @deprecated 3.1
  * 
  * @package framework
  * @subpackage cron

tasks/QuarterHourlyTask.php

@@ -5,6 +5,8 @@
  * 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.
+ *
+ * @deprecated 3.1
  * 
  * @package framework
  * @subpackage cron

tasks/ScheduledTask.php

@@ -50,6 +50,8 @@
  * # WeelkyTask (every Monday at 6:25am)
  * 25 6 1 * *  www-data /webroot/framework/cli-script.php /WeeklyTask > /var/log/weeklytask.log
  * </code>
+ *
+ * @deprecated 3.1
  * 
  * @todo Improve documentation
  * @package framework
@@ -57,4 +59,15 @@
  */
 abstract class ScheduledTask extends CliController {
 	// this class exists as a logical extension
+
+	public function init() {
+		Deprecation::notice(
+			'3.1', 
+			'ScheduledTask, QuarterHourlyTask, HourlyTask, DailyTask, MonthlyTask, WeeklyTask and ' .
+			'YearlyTask are deprecated, please extend from BuildTask or CliController, ' .
+			'and invoke them in self-defined frequencies through Unix cronjobs etc.'
+		);
+
+		parent::init();
+	}
 }

tasks/WeeklyTask.php

@@ -5,6 +5,8 @@
  * 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.
+ *
+ * @deprecated 3.1
  * 
  * @package framework
  * @subpackage cron

tasks/YearlyTask.php

@@ -5,6 +5,8 @@
  * 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.
+ *
+ * @deprecated 3.1
  * 
  * @package framework
  * @subpackage cron