phpBB/phpbb/feed/feed_interface.php


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

<?php
/**
 *
 * This file is part of the phpBB Forum Software package.
 *
 * @copyright (c) phpBB Limited <https://www.phpbb.com>
 * @license GNU General Public License, version 2 (GPL-2.0)
 *
 * For full copyright and license information, please see
 * the docs/CREDITS.txt file.
 *
 */

namespace phpbb\feed;

/**
 * Interface implemented by all feeds types
 */
interface feed_interface
{
	/**
	 * Set keys.
	 */
	public function set_keys();

	/**
	 * Open feed
	 */
	public function open();

	/**
	 * Close feed
	 */
	public function close();

	/**
	 * Set key
	 *
	 * @param string $key Key
	 * @param mixed $value Value
	 */
	public function set($key, $value);

	/**
	 * Get key
	 *
	 * @param string $key Key
	 * @return mixed
	 */
	public function get($key);

	/**
	 * Get the next post in the feed
	 *
	 * @return array
	 */
	public function get_item();

	/**
	 * Adjust a feed entry
	 *
	 * @param $item_row
	 * @param $row
	 * @return array
	 */
	public function adjust_item(&$item_row, &$row);
}