phpBB API Documentation
Class

phpbb\feed\forums

class forums extends base

'All Forums' feed

This will give you a list of all postable forums where feeds are enabled including forum description, topic stats and post stats

Methods

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

Constructor

 from base
set_keys()

Set keys.
open()

Open feed

 from base
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

 from base
get_sql()

{@inheritdoc}
array adjust_item($item_row $item_row, $row $row)

Adjust a feed entry

Details

in base at line 85
public __construct(helper $helper, config $config, driver_interface $db, driver_interface $cache, user $user, auth $auth, content_visibility $content_visibility, 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
string $phpEx php file extension

at line 29
public set_keys()

Set keys.

in base at line 121
public open()

Open feed

in base at line 128
public close()

Close feed

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

Set key

Parameters

string $key Key
mixed $value Value

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

Get key

Parameters

string $key Key

Return Value

mixed

in base at line 155
public array get_item()

Get the next post in the feed

Return Value

array

at line 42
public get_sql()

{@inheritdoc}

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

Adjust a feed entry

Parameters

$item_row $item_row
$row $row

Return Value

array