PHPXRef 0.7.1 : phpBB-3.1.12-deutsch : Detail view of prune

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:	159 lines (4 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

prune_forum:: (7 methods):
  __construct()
  set_forum_data()
  run()
  is_runnable()
  should_run()
  get_parameters()
  parse_parameters()

Class: prune_forum - X-Ref

Prune one forum 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) 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

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

PHP Cross Reference of phpBB-3.1.12-deutsch

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

Defines 1 class