prune_shadow_topics
class prune_shadow_topics extends base implements parametrized
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.
Properties
protected | $phpbb_root_path | ||
protected | $php_ext | ||
protected | $config | ||
protected | $db | ||
protected | $log | ||
protected | $user | ||
protected | $forum_data | If $forum_data is given, it is assumed to contain necessary information about a single forum that is to be pruned. |
Methods
Returns whether this cron task can run, given current board configuration.
Returns whether this cron task should run now, because enough time has passed since it was last run.
Constructor.
Manually set forum data.
Runs this cron task.
Returns parameters of this cron task as an array.
Parses parameters found in $request, which is an instance of \phpbb\request\request_interface.
Automatically prune shadow topics Based on fuunction auto_prune()
Details
in
base at line 34
string
get_name()
Returns the name of the task.
in
base at line 44
set_name(string $name)
Sets the name of the task.
at line 101
bool
is_runnable()
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.
at line 114
bool
should_run()
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.
at line 52
__construct(string $phpbb_root_path, string $php_ext, config $config, driver_interface $db, log $log, user $user)
Constructor.
at line 67
set_forum_data(array $forum_data)
Manually set forum data.
at line 77
null
run()
Runs this cron task.
at line 125
array
get_parameters()
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.
at line 140
null
parse_parameters(request_interface $request)
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.
at line 171
protected null
auto_prune_shadow_topics(int $forum_id, string $prune_mode, int $prune_flags, int $prune_days, int $prune_freq)
Automatically prune shadow topics Based on fuunction auto_prune()