phpBB API Documentation
Class

phpbb\feed\forum

class forum extends post_base

Forum feed

This will give you the last {$this->num_items} posts made within a specific forum.

Methods

__construct(helper $helper, config $config, driver_interface $db, driver_interface $cache, user $user, auth $auth, content_visibility $content_visibility, dispatcher_interface $phpbb_dispatcher, string $phpEx)

Constructor

from base
set_keys()

Set keys.

from post_base
open()

Open feed

close()

Close feed

from base
set(string $key, mixed $value)

Set key

from base
mixed get(string $key)

Get key

from base
array get_item()

Get the next post in the feed

mixed get_attachments($post_id $post_id)

Get attachments related to a given post

from attachments_base
array adjust_item($item_row $item_row, $row $row)

Adjust a feed entry

set_forum_id(int $forum_id)

Set the Forum ID

Details

in base at line 92
public __construct(helper $helper, config $config, driver_interface $db, driver_interface $cache, user $user, auth $auth, content_visibility $content_visibility, dispatcher_interface $phpbb_dispatcher, string $phpEx)

Constructor

Parameters

helper $helper Feed helper
config $config Config object
driver_interface $db Database connection
driver_interface $cache Cache object
user $user User object
auth $auth Auth object
content_visibility $content_visibility Auth object
dispatcher_interface $phpbb_dispatcher Event dispatcher object
string $phpEx php file extension

in post_base at line 26
public set_keys()

Set keys.

at line 47
public open()

Open feed

in base at line 146
public close()

Close feed

in base at line 157
public set(string $key, mixed $value)

Set key

Parameters

string $key Key
mixed $value Value

in base at line 165
public mixed get(string $key)

Get key

Parameters

string $key Key

Return Value

mixed

at line 174
public array get_item()

Get the next post in the feed

Return Value

array

in attachments_base at line 93
public mixed get_attachments($post_id $post_id)

Get attachments related to a given post

Parameters

$post_id $post_id int Post id

Return Value

mixed Attachments related to $post_id

at line 163
public array adjust_item($item_row $item_row, $row $row)

Adjust a feed entry

Parameters

$item_row $item_row
$row $row

Return Value

array

at line 37
public set_forum_id(int $forum_id)

Set the Forum ID

Parameters

int $forum_id Forum ID