mirror of
https://github.com/phpbb/phpbb.git
synced 2025-10-29 06:26:22 +01:00
53 lines
950 B
PHP
53 lines
950 B
PHP
<?php
|
|
/**
|
|
*
|
|
* This file is part of the phpBB Forum Software package.
|
|
*
|
|
* @copyright (c) phpBB Limited <https://www.phpbb.com>
|
|
* @license GNU General Public License, version 2 (GPL-2.0)
|
|
*
|
|
* For full copyright and license information, please see
|
|
* the docs/CREDITS.txt file.
|
|
*
|
|
*/
|
|
|
|
namespace phpbb\cron\task;
|
|
|
|
/**
|
|
* Cron task interface
|
|
*/
|
|
interface task
|
|
{
|
|
/**
|
|
* Returns the name of the task.
|
|
*
|
|
* @return string Name of wrapped task.
|
|
*/
|
|
public function get_name();
|
|
|
|
/**
|
|
* Runs this cron task.
|
|
*
|
|
* @return null
|
|
*/
|
|
public function run();
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function is_runnable();
|
|
|
|
/**
|
|
* Returns whether this cron task should run now, because enough time
|
|
* has passed since it was last run.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function should_run();
|
|
}
|