Docs For Class forum_driver

Description

Located in /sources/forum_stub.php (line 31)

Direct descendents

Class	Description
forum_driver_aef
forum_driver_mybb
forum_driver_none
forum_driver_ocf
forum_driver_phpbb2
forum_driver_phpbb3
forum_driver_ipb_shared
forum_driver_vb_shared
forum_driver_wbb_shared
forum_driver_smf
forum_driver_smf2
forum_driver_wowbb

Variable Summary

mixed $connection

mixed $MEMBER_ROWS_CACHED

Method Summary

boolean disable_staff_filter ()

mixed forum_link (integer $id, [boolean $tempcode_okay = false])

GROUP get_guest_group ()

array get_members_groups (MEMBER $id, [boolean $skip_secret = false], [boolean $handle_probation = false])

SHORT_TEXT get_member_email_address (MEMBER $id)

array get_moderator_groups ()

integer get_num_new_forum_posts ()

array get_super_admin_groups ()

ID_TEXT get_theme ([?ID_TEXT $zone_for = NULL])

array get_usergroup_list ([boolean $hide_hidden = false], [boolean $only_permissive = false])

?SHORT_TEXT get_username (MEMBER $id)

boolean is_staff (MEMBER $id)

boolean is_super_admin (MEMBER $id)

mixed join_link ()

mixed member_pm_link (MEMBER $id)

tempcode member_profile_hyperlink (MEMBER $id, [boolean $definitely_profile = false], [string $_username = ''])

mixed member_profile_link (MEMBER $id, [boolean $definitely_profile = false], [boolean $tempcode_okay = false])

mixed online_link ()

Variables

mixed $connection (line 34)

mixed $MEMBER_ROWS_CACHED (line 36)

Methods

disable_staff_filter (line 223)

If we can't get a list of admins via a usergroup query, we have to disable the staff filter - else the staff filtering can cause disaster at the point of being turned on (because it can't automatically sync).

return: Whether the staff filter is disabled

boolean disable_staff_filter ()

forum_link (line 141)

Get a URL to a forum.

return: The URL

mixed forum_link (integer $id, [boolean $tempcode_okay = false])

integer $id: The ID of the forum
boolean $tempcode_okay: Whether it is okay to return the result using Tempcode (more efficient)

get_guest_group (line 43)

Find the usergroup id of the forum guest member.

return: The usergroup id of the forum guest member

GROUP get_guest_group ()

get_members_groups (line 304)

Get a list of usergroups a member is in.

return: The list of usergroups

array get_members_groups (MEMBER $id, [boolean $skip_secret = false], [boolean $handle_probation = false])

MEMBER $id: The member
boolean $skip_secret: Whether to skip looking at secret usergroups.
boolean $handle_probation: Whether to take probation into account

get_member_email_address (line 181)

Get a member's e-mail address.

return: The e-mail address (blank: not known)

SHORT_TEXT get_member_email_address (MEMBER $id)

MEMBER $id: The member

get_moderator_groups (line 268)

Get a list of the moderator usergroups.

return: The list of usergroups

array get_moderator_groups ()

get_num_new_forum_posts (line 398)

Get the number of new forum posts on the system in the last 24 hours.

return: Number of forum posts

integer get_num_new_forum_posts ()

get_super_admin_groups (line 253)

Get a list of the super admin usergroups.

return: The list of usergroups

array get_super_admin_groups ()

get_theme (line 322)

Get the current member's theme identifier.

return: The theme identifier

ID_TEXT get_theme ([?ID_TEXT $zone_for = NULL])

?ID_TEXT $zone_for: The zone we are getting the theme for (NULL: current zone)

get_usergroup_list (line 285)

Get a map of forum usergroups (id=>name).

return: The map

array get_usergroup_list ([boolean $hide_hidden = false], [boolean $only_permissive = false])

boolean $hide_hidden: Whether to obscure the name of hidden usergroups
boolean $only_permissive: Whether to only grab permissive usergroups

get_username (line 155)

Get a member's username.

return: The username (NULL: deleted member)

?SHORT_TEXT get_username (MEMBER $id)

MEMBER $id: The member

is_staff (line 197)

Find whether a member is staff.

return: The answer

boolean is_staff (MEMBER $id)

MEMBER $id: The member

is_super_admin (line 236)

Find whether a member is a super administrator.

return: The answer

boolean is_super_admin (MEMBER $id)

MEMBER $id: The member

join_link (line 102)

Get a URL to a forum join page.

return: The URL

mixed join_link ()

member_pm_link (line 127)

Get a URL to send a forum member a PM.

return: The URL

mixed member_pm_link (MEMBER $id)

MEMBER $id: The forum member

member_profile_hyperlink (line 86)

Get a hyperlink (i.e. HTML link, not just a URL) to a forum member's member profile.

return: The hyperlink

tempcode member_profile_hyperlink (MEMBER $id, [boolean $definitely_profile = false], [string $_username = ''])

MEMBER $id: The forum member
boolean $definitely_profile: Whether to be insistent that we go to the profile, rather than possibly starting an IM which can link to the profile
string $_username: The username (blank: look it up)

member_profile_link (line 56)

Get a URL to a forum member's member profile.

return: The URL

mixed member_profile_link (MEMBER $id, [boolean $definitely_profile = false], [boolean $tempcode_okay = false])

MEMBER $id: The forum member
boolean $definitely_profile: Whether to be insistent that we go to the profile, rather than possibly starting an IM which can link to the profile
boolean $tempcode_okay: Whether it is okay to return the result using Tempcode (more efficient)

online_link (line 114)

Get a URL to a forum 'user online' list.

return: The URL

mixed online_link ()

Class forum_driver_base