forum
class forum extends post_base
Forum feed
This will give you the last {$this->num_items} posts made within a specific forum.
Properties
protected helper | $helper | Feed helper object |
from base |
protected config | $config | from base | |
protected driver_interface | $db | from base | |
protected driver_interface | $cache | from base | |
protected user | $user | from base | |
protected auth | $auth | from base | |
protected content_visibility | $content_visibility | from base | |
protected dispatcher_interface | $phpbb_dispatcher | from base | |
protected string | $phpEx | from base | |
protected | $sql | SQL Query to be executed to get feed items |
from base |
protected | $keys | Keys specified for retrieval of title, content, etc. |
from base |
protected | $num_items | from post_base | |
protected | $separator | Separator for title elements to separate items (for example forum / topic) |
from base |
protected | $separator_stats | Separator for the statistics row (Posted by, post date, replies, etc.) |
from base |
protected mixed | $result | from base | |
protected | $attachments | Attachments that may be displayed |
from attachments_base |
protected | $forum_id | ||
protected | $forum_data |
Methods
Constructor
Open feed
Get the next post in the feed
Returns the ids of the forum for which the current user can approve the post in the moderation queue.
Returns true if the current user can approve the post of the given forum
Returns true if the given id is in the excluded forums list.
Returns all password protected forum ids the current user is currently NOT authenticated for.
Returns the SQL query used to retrieve the posts of the feed.
Retrieve the list of attachments that may be displayed
Adjust a feed entry
Set the Forum ID
Details
in
base at line 92
__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
in
post_base at line 26
set_keys()
Set keys.
at line 47
open()
Open feed
in
base at line 146
close()
Close feed
in
base at line 157
set(string $key, mixed $value)
Set key
in
base at line 165
mixed
get(string $key)
Get key
at line 174
array
get_item()
Get the next post in the feed
in
base at line 210
protected int[]
get_readable_forums()
Returns the ids of the forums readable by the current user.
in
base at line 227
protected int[]
get_moderator_approve_forums()
Returns the ids of the forum for which the current user can approve the post in the moderation queue.
in
base at line 245
protected bool
is_moderator_approve_forum(int $forum_id)
Returns true if the current user can approve the post of the given forum
in
base at line 262
protected int[]
get_excluded_forums()
Returns the ids of the forum excluded from the feeds
in
base at line 295
protected bool
is_excluded_forum(int $forum_id)
Returns true if the given id is in the excluded forums list.
in
base at line 307
protected array
get_passworded_forums()
Returns all password protected forum ids the current user is currently NOT authenticated for.
in
base at line 317
protected string
user_viewprofile($row)
Returns the link to the user profile.
at line 115
protected string
get_sql()
Returns the SQL query used to retrieve the posts of the feed.
in
attachments_base at line 32
protected
fetch_attachments(array $post_ids = array(), array $topic_ids = array())
Retrieve the list of attachments that may be displayed
in
attachments_base at line 93
mixed
get_attachments(int $post_id)
Get attachments related to a given post
at line 163
array
adjust_item($item_row, $row)
Adjust a feed entry
at line 37
forum
set_forum_id(int $forum_id)
Set the Forum ID