[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\feed;
  15  
  16  /**
  17   * Interface implemented by all feeds types
  18   */
  19  interface feed_interface
  20  {
  21      /**
  22       * Set keys.
  23       */
  24  	public function set_keys();
  25  
  26      /**
  27       * Open feed
  28       */
  29  	public function open();
  30  
  31      /**
  32       * Close feed
  33       */
  34  	public function close();
  35  
  36      /**
  37       * Set key
  38       *
  39       * @param string $key Key
  40       * @param mixed $value Value
  41       */
  42  	public function set($key, $value);
  43  
  44      /**
  45       * Get key
  46       *
  47       * @param string $key Key
  48       * @return mixed
  49       */
  50  	public function get($key);
  51  
  52      /**
  53       * Get the next post in the feed
  54       *
  55       * @return array
  56       */
  57  	public function get_item();
  58  
  59      /**
  60       * Adjust a feed entry
  61       *
  62       * @param $item_row
  63       * @param $row
  64       * @return array
  65       */
  66  	public function adjust_item(&$item_row, &$row);
  67  }