aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/includes/cron/task/core
diff options
context:
space:
mode:
authorAndreas Fischer <bantu@phpbb.com>2010-12-17 01:24:27 +0100
committerOleg Pudeyev <oleg@bsdpower.com>2011-02-12 22:05:53 -0500
commit47702b8ca72aeaa2b33dd13f2aa762ae7271c10a (patch)
tree301bc2522dd6195cafd92a9d29fc4031ed9cf10c /phpBB/includes/cron/task/core
parent3c0561b68fc3bcff387d46d255ca1accc80df88a (diff)
downloadforums-47702b8ca72aeaa2b33dd13f2aa762ae7271c10a.tar
forums-47702b8ca72aeaa2b33dd13f2aa762ae7271c10a.tar.gz
forums-47702b8ca72aeaa2b33dd13f2aa762ae7271c10a.tar.bz2
forums-47702b8ca72aeaa2b33dd13f2aa762ae7271c10a.tar.xz
forums-47702b8ca72aeaa2b33dd13f2aa762ae7271c10a.zip
[feature/system-cron] Add phpDoc documentation for everything else.
PHPBB3-9596
Diffstat (limited to 'phpBB/includes/cron/task/core')
-rw-r--r--phpBB/includes/cron/task/core/prune_all_forums.php4
-rw-r--r--phpBB/includes/cron/task/core/prune_forum.php13
-rw-r--r--phpBB/includes/cron/task/core/queue.php8
-rw-r--r--phpBB/includes/cron/task/core/tidy_cache.php6
-rw-r--r--phpBB/includes/cron/task/core/tidy_database.php4
-rw-r--r--phpBB/includes/cron/task/core/tidy_search.php6
-rw-r--r--phpBB/includes/cron/task/core/tidy_sessions.php4
-rw-r--r--phpBB/includes/cron/task/core/tidy_warnings.php6
8 files changed, 50 insertions, 1 deletions
diff --git a/phpBB/includes/cron/task/core/prune_all_forums.php b/phpBB/includes/cron/task/core/prune_all_forums.php
index 2e6f2444d3..69ae7f63cd 100644
--- a/phpBB/includes/cron/task/core/prune_all_forums.php
+++ b/phpBB/includes/cron/task/core/prune_all_forums.php
@@ -28,6 +28,8 @@ class phpbb_cron_task_core_prune_all_forums extends phpbb_cron_task_base
{
/**
* Runs this cron task.
+ *
+ * @return void
*/
public function run()
{
@@ -60,6 +62,8 @@ class phpbb_cron_task_core_prune_all_forums extends phpbb_cron_task_base
/**
* Returns whether this cron task can run, given current board configuration.
+ *
+ * @return bool
*/
public function is_runnable()
{
diff --git a/phpBB/includes/cron/task/core/prune_forum.php b/phpBB/includes/cron/task/core/prune_forum.php
index 6393281d32..18db44cf2d 100644
--- a/phpBB/includes/cron/task/core/prune_forum.php
+++ b/phpBB/includes/cron/task/core/prune_forum.php
@@ -37,6 +37,8 @@ class phpbb_cron_task_core_prune_forum extends phpbb_cron_task_base implements p
* If $forum_data is not given, forum id will be retrieved via request_var
* and a database query will be performed to load the necessary information
* about the forum.
+ *
+ * @return void
*/
public function __construct($forum_data = null)
{
@@ -53,6 +55,8 @@ class phpbb_cron_task_core_prune_forum extends phpbb_cron_task_base implements p
/**
* Runs this cron task.
+ *
+ * @return void
*/
public function run()
{
@@ -75,6 +79,8 @@ class phpbb_cron_task_core_prune_forum extends phpbb_cron_task_base implements p
/**
* Returns whether this cron task can run, given current board configuration.
+ *
+ * @return bool
*/
public function is_runnable()
{
@@ -85,6 +91,8 @@ class phpbb_cron_task_core_prune_forum extends phpbb_cron_task_base implements p
/**
* Returns whether this cron task should run now, because enough time
* has passed since it was last run.
+ *
+ * @return bool
*/
public function should_run()
{
@@ -93,8 +101,9 @@ class phpbb_cron_task_core_prune_forum extends phpbb_cron_task_base implements p
/**
* Returns parameters of this cron task as an array.
- *
* The array has one key, f, whose value is id of the forum to be pruned.
+ *
+ * @return array
*/
public function get_parameters()
{
@@ -106,6 +115,8 @@ class phpbb_cron_task_core_prune_forum extends phpbb_cron_task_base implements p
* phpbb_request_interface.
*
* It is expected to have a key f whose value is id of the forum to be pruned.
+ *
+ * @return void
*/
public function parse_parameters(phpbb_request_interface $request)
{
diff --git a/phpBB/includes/cron/task/core/queue.php b/phpBB/includes/cron/task/core/queue.php
index 852a8d97f4..ccea4b85bd 100644
--- a/phpBB/includes/cron/task/core/queue.php
+++ b/phpBB/includes/cron/task/core/queue.php
@@ -24,6 +24,8 @@ class phpbb_cron_task_core_queue extends phpbb_cron_task_base
{
/**
* Runs this cron task.
+ *
+ * @return void
*/
public function run()
{
@@ -38,6 +40,8 @@ class phpbb_cron_task_core_queue extends phpbb_cron_task_base
/**
* Returns whether this cron task can run, given current board configuration.
+ *
+ * @return bool
*/
public function is_runnable()
{
@@ -48,6 +52,8 @@ class phpbb_cron_task_core_queue extends phpbb_cron_task_base
/**
* Returns whether this cron task should run now, because enough time
* has passed since it was last run.
+ *
+ * @return bool
*/
public function should_run()
{
@@ -57,6 +63,8 @@ class phpbb_cron_task_core_queue extends phpbb_cron_task_base
/**
* Returns whether this cron task can be run in shutdown function.
+ *
+ * @return bool
*/
public function is_shutdown_function_safe()
{
diff --git a/phpBB/includes/cron/task/core/tidy_cache.php b/phpBB/includes/cron/task/core/tidy_cache.php
index 8a91f68a48..83a60d8760 100644
--- a/phpBB/includes/cron/task/core/tidy_cache.php
+++ b/phpBB/includes/cron/task/core/tidy_cache.php
@@ -24,6 +24,8 @@ class phpbb_cron_task_core_tidy_cache extends phpbb_cron_task_base
{
/**
* Runs this cron task.
+ *
+ * @return void
*/
public function run()
{
@@ -33,6 +35,8 @@ class phpbb_cron_task_core_tidy_cache extends phpbb_cron_task_base
/**
* Returns whether this cron task can run, given current board configuration.
+ *
+ * @return bool
*/
public function is_runnable()
{
@@ -43,6 +47,8 @@ class phpbb_cron_task_core_tidy_cache extends phpbb_cron_task_base
/**
* Returns whether this cron task should run now, because enough time
* has passed since it was last run.
+ *
+ * @return bool
*/
public function should_run()
{
diff --git a/phpBB/includes/cron/task/core/tidy_database.php b/phpBB/includes/cron/task/core/tidy_database.php
index 847b882c7d..82a0a4583e 100644
--- a/phpBB/includes/cron/task/core/tidy_database.php
+++ b/phpBB/includes/cron/task/core/tidy_database.php
@@ -24,6 +24,8 @@ class phpbb_cron_task_core_tidy_database extends phpbb_cron_task_base
{
/**
* Runs this cron task.
+ *
+ * @return void
*/
public function run()
{
@@ -38,6 +40,8 @@ class phpbb_cron_task_core_tidy_database extends phpbb_cron_task_base
/**
* Returns whether this cron task should run now, because enough time
* has passed since it was last run.
+ *
+ * @return bool
*/
public function should_run()
{
diff --git a/phpBB/includes/cron/task/core/tidy_search.php b/phpBB/includes/cron/task/core/tidy_search.php
index 735dc14b68..a781005960 100644
--- a/phpBB/includes/cron/task/core/tidy_search.php
+++ b/phpBB/includes/cron/task/core/tidy_search.php
@@ -26,6 +26,8 @@ class phpbb_cron_task_core_tidy_search extends phpbb_cron_task_base
{
/**
* Runs this cron task.
+ *
+ * @return void
*/
public function run()
{
@@ -51,6 +53,8 @@ class phpbb_cron_task_core_tidy_search extends phpbb_cron_task_base
/**
* Returns whether this cron task can run, given current board configuration.
+ *
+ * @return bool
*/
public function is_runnable()
{
@@ -65,6 +69,8 @@ class phpbb_cron_task_core_tidy_search extends phpbb_cron_task_base
/**
* Returns whether this cron task should run now, because enough time
* has passed since it was last run.
+ *
+ * @return bool
*/
public function should_run()
{
diff --git a/phpBB/includes/cron/task/core/tidy_sessions.php b/phpBB/includes/cron/task/core/tidy_sessions.php
index dc398fa5e4..5826584691 100644
--- a/phpBB/includes/cron/task/core/tidy_sessions.php
+++ b/phpBB/includes/cron/task/core/tidy_sessions.php
@@ -24,6 +24,8 @@ class phpbb_cron_task_core_tidy_sessions extends phpbb_cron_task_base
{
/**
* Runs this cron task.
+ *
+ * @return void
*/
public function run()
{
@@ -34,6 +36,8 @@ class phpbb_cron_task_core_tidy_sessions extends phpbb_cron_task_base
/**
* Returns whether this cron task should run now, because enough time
* has passed since it was last run.
+ *
+ * @return bool
*/
public function should_run()
{
diff --git a/phpBB/includes/cron/task/core/tidy_warnings.php b/phpBB/includes/cron/task/core/tidy_warnings.php
index c3826dc687..3b0cf57f0c 100644
--- a/phpBB/includes/cron/task/core/tidy_warnings.php
+++ b/phpBB/includes/cron/task/core/tidy_warnings.php
@@ -26,6 +26,8 @@ class phpbb_cron_task_core_tidy_warnings extends phpbb_cron_task_base
{
/**
* Runs this cron task.
+ *
+ * @return void
*/
public function run()
{
@@ -39,6 +41,8 @@ class phpbb_cron_task_core_tidy_warnings extends phpbb_cron_task_base
/**
* Returns whether this cron task can run, given current board configuration.
+ *
+ * @return bool
*/
public function is_runnable()
{
@@ -49,6 +53,8 @@ class phpbb_cron_task_core_tidy_warnings extends phpbb_cron_task_base
/**
* Returns whether this cron task should run now, because enough time
* has passed since it was last run.
+ *
+ * @return bool
*/
public function should_run()
{
generated by cgit v1.2.1 (git 2.21.0) at 2025-10-09 22:30:06 +0000