[ Index ]

PHP Cross Reference of phpBB-3.1.12-deutsch

title

Body

[close]

/phpbb/cron/task/ -> parametrized.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: 48 lines (1 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

parametrized:: (2 methods):
  get_parameters()
  parse_parameters()


Interface: parametrized  - X-Ref

Parametrized cron task interface.

Parametrized cron tasks are somewhat of a cross between regular cron tasks and
delayed jobs. Whereas regular cron tasks perform some action globally,
parametrized cron tasks perform actions on a particular object (or objects).
Parametrized cron tasks do not make sense and are not usable without
specifying these objects.
get_parameters()   X-Ref
Returns parameters of this cron task as an array.

The array must map string keys to string values.

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.

$request contains user input and must not be trusted.
Cron task must validate all data before using it.

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



Generated: Thu Jan 11 00:25:41 2018 Cross-referenced by PHPXref 0.7.1