Docs For Class forum_driver

Description

copyright: ocProducts Ltd
license: Common Public Attribution License

Located in /sources/forum/wbb2.php (line 23)

forum_driver_base
   |
   --forum_driver_wbb_shared
      |
      --forum_driver_wbb2

Method Summary

array get_skin_list ()

boolean is_banned (MEMBER $member)

?array member_group_query (array $groups, [?integer $max = NULL], [integer $start = 0])

GROUP pname_group (array $r)

GROUP _get_guest_group ()

array _get_members_groups (MEMBER $member)

array _get_moderator_groups ()

array _get_super_admin_groups ()

ID_TEXT _get_theme ([boolean $skip_member_specific = false])

array _get_usergroup_list ()

boolean _is_staff (MEMBER $member)

boolean _is_super_admin (MEMBER $member)

Variables

Inherited Variables

Inherited from forum_driver_base

forum_driver_base::$connection
forum_driver_base::$MEMBER_ROWS_CACHED

Methods

get_skin_list (line 92)

Find a list of all forum skins (aka themes).

return: The list of skins

array get_skin_list ()

is_banned (line 74)

Find out if the given member id is banned.

return: Whether the member is banned

boolean is_banned (MEMBER $member)

MEMBER $member: The member id

member_group_query (line 57)

Get an array of members who are in at least one of the given array of usergroups.

return: The array of members (NULL: no members)

?array member_group_query (array $groups, [?integer $max = NULL], [integer $start = 0])

array $groups: The array of usergroups
?integer $max: Return up to this many entries for primary members and this many entries for secondary members (NULL: no limit, only use no limit if querying very restricted usergroups!)
integer $start: Return primary members after this offset and secondary members after this offset

pname_group (line 44)

From a member profile-row, get the member's primary usergroup.

return: The member's primary usergroup

GROUP pname_group (array $r)

array $r: The profile-row

_get_guest_group (line 31)

Get the ID of the usergroup that is for guests.

return: The guest usergroup

GROUP _get_guest_group ()

_get_members_groups (line 212)

Get the forum usergroup relating to the specified member id.

return: The array of forum usergroups

array _get_members_groups (MEMBER $member)

MEMBER $member: The member id

_get_moderator_groups (line 191)

Get the ids of the moderator usergroups.

It should not be assumed that a member only has one usergroup - this depends upon the forum the driver works for. It also does not take the staff site filter into account.

return: The moderator usergroup ids

array _get_moderator_groups ()

_get_super_admin_groups (line 180)

Get the ids of the admin usergroups.

return: The admin usergroup ids

array _get_super_admin_groups ()

_get_theme (line 108)

Try to find the theme that the logged-in/guest member is using, and map it to an ocPortal theme.

The themes/map.ini file functions to provide this mapping between forum themes, and ocPortal themes, and has a slightly different meaning for different forum drivers. For example, some drivers map the forum themes theme directory to the ocPortal theme name, whilst others made the humanly readeable name.

return: The theme

ID_TEXT _get_theme ([boolean $skip_member_specific = false])

boolean $skip_member_specific: Whether to avoid member-specific lookup

_get_usergroup_list (line 201)

Get the forum usergroup list.

return: The usergroup list

array _get_usergroup_list ()

_is_staff (line 155)

Find if the specified member id is marked as staff or not.

return: Whether the member is staff

boolean _is_staff (MEMBER $member)

MEMBER $member: The member id

_is_super_admin (line 168)

Find if the specified member id is marked as a super admin or not.

return: Whether the member is a super admin

boolean _is_super_admin (MEMBER $member)

MEMBER $member: The member id

Inherited Methods

Inherited From forum_driver_wbb_shared

forum_driver_wbb_shared::check_db()
forum_driver_wbb_shared::find_emoticons()
forum_driver_wbb_shared::forum_authorise_login()
forum_driver_wbb_shared::forum_get_lang()
forum_driver_wbb_shared::forum_id_from_name()
forum_driver_wbb_shared::get_custom_fields()
forum_driver_wbb_shared::get_drivered_table_prefix()
forum_driver_wbb_shared::get_emoticon_chooser()
forum_driver_wbb_shared::get_emo_dir()
forum_driver_wbb_shared::get_forum_topic_posts()
forum_driver_wbb_shared::get_guest_id()
forum_driver_wbb_shared::get_matching_members()
forum_driver_wbb_shared::get_members()
forum_driver_wbb_shared::get_member_avatar_url()
forum_driver_wbb_shared::get_member_email_allowed()
forum_driver_wbb_shared::get_member_from_username()
forum_driver_wbb_shared::get_member_ip()
forum_driver_wbb_shared::get_member_join_timestamp()
forum_driver_wbb_shared::get_member_photo_url()
forum_driver_wbb_shared::get_member_row()
forum_driver_wbb_shared::get_member_row_field()
forum_driver_wbb_shared::get_next_member()
forum_driver_wbb_shared::get_num_forum_posts()
forum_driver_wbb_shared::get_num_users_forums()
forum_driver_wbb_shared::get_post_count()
forum_driver_wbb_shared::get_previous_member()
forum_driver_wbb_shared::get_tid_from_topic()
forum_driver_wbb_shared::get_topics()
forum_driver_wbb_shared::get_topic_count()
forum_driver_wbb_shared::get_top_posters()
forum_driver_wbb_shared::install_create_custom_field()
forum_driver_wbb_shared::install_get_path_search_list()
forum_driver_wbb_shared::install_specifics()
forum_driver_wbb_shared::install_test_load_from()
forum_driver_wbb_shared::is_cookie_login_name()
forum_driver_wbb_shared::is_hashed()
forum_driver_wbb_shared::make_post_forum_topic()
forum_driver_wbb_shared::member_home_link()
forum_driver_wbb_shared::pget_row()
forum_driver_wbb_shared::pin_topic()
forum_driver_wbb_shared::pnamelast_visit()
forum_driver_wbb_shared::pname_email()
forum_driver_wbb_shared::pname_id()
forum_driver_wbb_shared::pname_name()
forum_driver_wbb_shared::post_link()
forum_driver_wbb_shared::probe_ip()
forum_driver_wbb_shared::set_custom_field()
forum_driver_wbb_shared::show_forum_topics()
forum_driver_wbb_shared::topic_link()
forum_driver_wbb_shared::_forum_link()
forum_driver_wbb_shared::_get_member_email_address()
forum_driver_wbb_shared::_get_num_new_forum_posts()
forum_driver_wbb_shared::_get_username()
forum_driver_wbb_shared::_join_link()
forum_driver_wbb_shared::_member_pm_link()
forum_driver_wbb_shared::_member_profile_link()
forum_driver_wbb_shared::_online_link()

Inherited From forum_driver_base

forum_driver_base::disable_staff_filter()
forum_driver_base::forum_link()
forum_driver_base::get_guest_group()
forum_driver_base::get_members_groups()
forum_driver_base::get_member_email_address()
forum_driver_base::get_moderator_groups()
forum_driver_base::get_num_new_forum_posts()
forum_driver_base::get_super_admin_groups()
forum_driver_base::get_theme()
forum_driver_base::get_usergroup_list()
forum_driver_base::get_username()
forum_driver_base::is_staff()
forum_driver_base::is_super_admin()
forum_driver_base::join_link()
forum_driver_base::member_pm_link()
forum_driver_base::member_profile_hyperlink()
forum_driver_base::member_profile_link()
forum_driver_base::online_link()

Class forum_driver_wbb2

Inherited Variables

Inherited Methods