[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3  *
   4  * This file is part of the phpBB Forum Software package.
   5  *
   6  * @copyright (c) phpBB Limited <https://www.phpbb.com>
   7  * @license GNU General Public License, version 2 (GPL-2.0)
   8  *
   9  * For full copyright and license information, please see
  10  * the docs/CREDITS.txt file.
  11  *
  12  */
  13  
  14  namespace phpbb\cron\task;
  15  
  16  /**
  17  * Parametrized cron task interface.
  18  *
  19  * Parametrized cron tasks are somewhat of a cross between regular cron tasks and
  20  * delayed jobs. Whereas regular cron tasks perform some action globally,
  21  * parametrized cron tasks perform actions on a particular object (or objects).
  22  * Parametrized cron tasks do not make sense and are not usable without
  23  * specifying these objects.
  24  */
  25  interface parametrized extends \phpbb\cron\task\task
  26  {
  27      /**
  28      * Returns parameters of this cron task as an array.
  29      *
  30      * The array must map string keys to string values.
  31      *
  32      * @return array
  33      */
  34  	public function get_parameters();
  35  
  36      /**
  37      * Parses parameters found in $request, which is an instance of
  38      * \phpbb\request\request_interface.
  39      *
  40      * $request contains user input and must not be trusted.
  41      * Cron task must validate all data before using it.
  42      *
  43      * @param \phpbb\request\request_interface $request Request object.
  44      *
  45      * @return null
  46      */
  47  	public function parse_parameters(\phpbb\request\request_interface $request);
  48  }