[ Index ]

PHP Cross Reference of phpBB-3.2.11-deutsch

title

Body

[close]

/phpbb/cron/task/core/ -> prune_shadow_topics.php (summary)

This file is part of the phpBB Forum Software package.

Copyright: (c) phpBB Limited
License: GNU General Public License, version 2 (GPL-2.0)
File Size: 200 lines (6 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

prune_shadow_topics:: (8 methods):
  __construct()
  set_forum_data()
  run()
  is_runnable()
  should_run()
  get_parameters()
  parse_parameters()
  auto_prune_shadow_topics()


Class: prune_shadow_topics  - X-Ref

Prune one forum of its shadow topics cron task.

It is intended to be used when cron is invoked via web.
This task can decide whether it should be run using data obtained by viewforum
code, without making additional database queries.
__construct($phpbb_root_path, $php_ext, \phpbb\config\config $config, \phpbb\db\driver\driver_interface $db, \phpbb\log\log $log, \phpbb\user $user)   X-Ref
Constructor.

param: string $phpbb_root_path The root path
param: string $php_ext PHP file extension
param: \phpbb\config\config $config The config
param: \phpbb\db\driver\driver_interface $db The db connection
param: \phpbb\log\log $log The phpBB log system
param: \phpbb\user $user The phpBB user object

set_forum_data($forum_data)   X-Ref
Manually set forum data.

param: array $forum_data Information about a forum to be pruned.

run()   X-Ref
Runs this cron task.

return: null

is_runnable()   X-Ref
Returns whether this cron task can run, given current board configuration.

This cron task will not run when system cron is utilised, as in
such cases prune_all_forums task would run instead.

Additionally, this task must be given the forum data, either via
the constructor or parse_parameters method.

return: bool

should_run()   X-Ref
Returns whether this cron task should run now, because enough time
has passed since it was last run.

Forum pruning interval is specified in the forum data.

return: bool

get_parameters()   X-Ref
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

parse_parameters(\phpbb\request\request_interface $request)   X-Ref
Parses parameters found in $request, which is an instance of
\phpbb\request\request_interface.

It is expected to have a key f whose value is id of the forum to be pruned.

param: \phpbb\request\request_interface $request Request object.
return: null

auto_prune_shadow_topics($forum_id, $prune_mode, $prune_flags, $prune_days, $prune_freq)   X-Ref
Automatically prune shadow topics
Based on fuunction auto_prune()

param: int $forum_id Forum ID of forum that should be pruned
param: string $prune_mode Prune mode
param: int $prune_flags Prune flags
param: int $prune_days Prune date in days
param: int $prune_freq Prune frequency
return: null



Generated: Wed Nov 11 20:33:01 2020 Cross-referenced by PHPXref 0.7.1