From 1bfbcb8b7e91f4b36b703eeee7e6eeb99fbca3a0 Mon Sep 17 00:00:00 2001
From: Igor Wiedler <igor@wiedler.ch>
Date: Thu, 28 Oct 2010 21:38:50 +0200
Subject: [feature/system-cron] remove cron_ prefix from files

PHPBB3-9596
---
 phpBB/includes/cron/task_base.php | 64 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 64 insertions(+)
 create mode 100644 phpBB/includes/cron/task_base.php

(limited to 'phpBB/includes/cron/task_base.php')

diff --git a/phpBB/includes/cron/task_base.php b/phpBB/includes/cron/task_base.php
new file mode 100644
index 0000000000..1edb4aae51
--- /dev/null
+++ b/phpBB/includes/cron/task_base.php
@@ -0,0 +1,64 @@
+<?php
+/**
+*
+* @package phpBB3
+* @version $Id$
+* @copyright (c) 2010 phpBB Group
+* @license http://opensource.org/licenses/gpl-license.php GNU Public License
+*
+*/
+
+/**
+* @ignore
+*/
+if (!defined('IN_PHPBB'))
+{
+	exit;
+}
+
+if (!interface_exists('cron_task'))
+{
+	include($phpbb_root_path . 'includes/cron/cron_task.' . $phpEx);
+}
+
+/**
+* Cron task base class. Provides sensible defaults for cron tasks
+* and partially implements cron task interface, making writing cron tasks easier.
+*
+* At a minimum, subclasses must override the run() method.
+*
+* Cron tasks need not inherit from this base class. If desired,
+* they may implement cron task interface directly.
+*
+* @package phpBB3
+*/
+abstract class cron_task_base implements cron_task
+{
+	/**
+	* Returns whether this cron task can run, given current board configuration.
+	*
+	* For example, a cron task that prunes forums can only run when
+	* forum pruning is enabled.
+	*/
+	public function is_runnable()
+	{
+		return true;
+	}
+
+	/**
+	* Returns whether this cron task should run now, because enough time
+	* has passed since it was last run.
+	*/
+	public function should_run()
+	{
+		return true;
+	}
+
+	/**
+	* Returns whether this cron task can be run in shutdown function.
+	*/
+	public function is_shutdown_function_safe()
+	{
+		return true;
+	}
+}
-- 
cgit v1.2.1