phpBB API Documentation
Class

phpbb\feed\helper

class helper

Class with some helpful functions used in feeds

Methods

__construct(config $config, ContainerInterface $container, path_helper $path_helper, renderer $renderer, user $user)

Constructor

get_board_url()

Returns the board url (and caches it in the function)

append_sid($url, $params)

Run links through appendsid(), prepend generateboard_url() and remove session id

format_date($time)

Generate ISO 8601 date string (RFC 3339)

string generate_content(string $content, string $uid, string $bitfield, int $options, int $forum_id, array $post_attachments)

Generate text content

Details

at line 51
public __construct(config $config, ContainerInterface $container, path_helper $path_helper, renderer $renderer, user $user)

Constructor

Parameters

config $config
ContainerInterface $container
path_helper $path_helper
renderer $renderer
user $user

at line 63
public get_board_url()

Returns the board url (and caches it in the function)

at line 78
public append_sid($url, $params)

Run links through appendsid(), prepend generateboard_url() and remove session id

Parameters

$url
$params

at line 86
public format_date($time)

Generate ISO 8601 date string (RFC 3339)

Parameters

$time

at line 111
public string generate_content(string $content, string $uid, string $bitfield, int $options, int $forum_id, array $post_attachments)

Generate text content

Parameters

string $content is feed text content
string $uid is bbcode_uid
string $bitfield is bbcode bitfield
int $options bbcode flag options
int $forum_id is the forum id
array $post_attachments is an array containing the attachments and their respective info

Return Value

string the html content to be printed for the feed