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_wrapper.php | 103 +++++++++++++++++++++++++++++++++++
 1 file changed, 103 insertions(+)
 create mode 100644 phpBB/includes/cron/task_wrapper.php

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

diff --git a/phpBB/includes/cron/task_wrapper.php b/phpBB/includes/cron/task_wrapper.php
new file mode 100644
index 0000000000..17f80278a7
--- /dev/null
+++ b/phpBB/includes/cron/task_wrapper.php
@@ -0,0 +1,103 @@
+<?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;
+}
+
+// We use parametrized_cron_task in is_parametrized
+if (!interface_exists('cron_task'))
+{
+	include($phpbb_root_path . 'includes/cron/cron_task.' . $phpEx);
+}
+
+/**
+* Cron task wrapper class.
+* Enhances cron tasks with convenience methods that work identically for all tasks.
+*
+* @package phpBB3
+*/
+class cron_task_wrapper
+{
+	/**
+	* Wraps a task $task, which must implement cron_task interface.
+	*/
+	public function __construct(cron_task $task)
+	{
+		$this->task = $task;
+	}
+
+	/**
+	* Returns whether this task is parametrized.
+	*
+	* Parametrized tasks accept parameters during initialization and must
+	* normally be scheduled with parameters.
+	*/
+	public function is_parametrized()
+	{
+		return $this->task instanceof parametrized_cron_task;
+	}
+
+	/**
+	* Returns whether the wrapped task is ready to run.
+	*
+	* A task is ready to run when it is runnable according to current configuration
+	* and enough time has passed since it was last run.
+	*/
+	public function is_ready()
+	{
+		return $this->task->is_runnable() && $this->task->should_run();
+	}
+
+	/**
+	* Returns the name of wrapped task. It is the same as the wrapped class's class name.
+	*/
+	public function get_name()
+	{
+		return get_class($this->task);
+	}
+
+	/**
+	* Returns a url through which this task may be invoked via web.
+	*/
+	public function get_url()
+	{
+		global $phpbb_root_path, $phpEx;
+
+		$name = $this->get_name();
+		if ($this->is_parametrized())
+		{
+			$params = $this->task->get_parameters();
+			$extra = '';
+			foreach ($params as $key => $value)
+			{
+				$extra .= '&amp;' . $key . '=' . urlencode($value);
+			}
+		}
+		else
+		{
+			$extra = '';
+		}
+		$url = append_sid($phpbb_root_path . 'cron.' . $phpEx, 'cron_type=' . $name . $extra);
+		return $url;
+	}
+
+	/**
+	* Forwards all other method calls to the wrapped task implementation.
+	*/
+	public function __call($name, $args)
+	{
+		return call_user_func_array(array($this->task, $name), $args);
+	}
+}
-- 
cgit v1.2.1