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
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 | ||
| 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 |
Methods
Constructor
Set keys.
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.
Adjust a feed entry
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
at line 29
set_keys()
Set keys.
in
base at line 139
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
in
base at line 173
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 42
string
get_sql()
Returns the SQL query used to retrieve the posts of the feed.
at line 67
array
adjust_item($item_row, $row)
Adjust a feed entry