phpbb/phpBB/includes/cron/task/core/queue.php
Oleg Pudeyev 53dd847dd5 [feature/system-cron] Added @param/@return documentation
Also adjusted some function descriptions for greater informativity.

PHPBB3-9596
2011-02-12 22:05:53 -05:00

84 lines
1.8 KiB
PHP

<?php
/**
*
* @package phpBB3
* @copyright (c) 2010 phpBB Group
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
*
*/
/**
* @ignore
*/
if (!defined('IN_PHPBB'))
{
exit;
}
/**
* Queue cron task. Sends email and jabber messages queued by other scripts.
*
* @package phpBB3
*/
class phpbb_cron_task_core_queue extends phpbb_cron_task_base
{
/**
* Runs this cron task.
*
* @return void
*/
public function run()
{
global $phpbb_root_path, $phpEx;
if (!class_exists('queue'))
{
include($phpbb_root_path . 'includes/functions_messenger.' . $phpEx);
}
$queue = new queue();
$queue->process();
}
/**
* Returns whether this cron task can run, given current board configuration.
*
* Queue task is only run if the email queue (file) exists.
*
* @return bool
*/
public function is_runnable()
{
global $phpbb_root_path, $phpEx;
return file_exists($phpbb_root_path . 'cache/queue.' . $phpEx);
}
/**
* Returns whether this cron task should run now, because enough time
* has passed since it was last run.
*
* The interval between queue runs is specified in board configuration.
*
* @return bool
*/
public function should_run()
{
global $config;
return $config['last_queue_run'] < time() - $config['queue_interval_config'];
}
/**
* Returns whether this cron task can be run in shutdown function.
*
* A user reported that using the mail() function during shutdown
* function execution does not work. Therefore if email is delivered
* via the mail() function (as opposed to SMTP) queue cron task marks
* itself shutdown function-unsafe.
*
* @return bool
*/
public function is_shutdown_function_safe()
{
global $config;
// A user reported using the mail() function while using shutdown does not work. We do not want to risk that.
return !$config['smtp_delivery'];
}
}