Forum driver class.
package | core_forum_drivers |
---|---|
inherited_from | \Forum_driver_base |
check_db() : boolean
boolean
Whether it is validdisable_staff_filter() : boolean
boolean
Whether the staff filter is disabledfind_topic_id_for_topic_identifier(string $forum, \SHORT_TEXT $topic_identifier) : \?integer
string
The forum name / ID
\SHORT_TEXT
The topic identifier
\?integer
The topic ID (null: not found)forum_get_lang(\MEMBER $member) : \?LANGUAGE_NAME
\MEMBER
The member who's language needs to be fetched
\?LANGUAGE_NAME
The member's language (null: unknown)forum_id_from_name(\SHORT_TEXT $forum_name) : integer
\SHORT_TEXT
The forum name
integer
The forum IDforum_url(integer $id, boolean $tempcode_okay = false
) : mixed
integer
The ID of the forum
boolean
Whether it is okay to return the result using Tempcode (more efficient)
mixed
The URLget_drivered_table_prefix() : string
string
The forum database table prefixget_emoticon_chooser(string $field_name = 'post'
) : \Tempcode
string
The ID of the form field the emoticon chooser adds to
\Tempcode
The emoticon chooser templateget_guest_group() : \GROUP
\GROUP
The usergroup ID of the forum guest memberget_guest_id() : \MEMBER
\MEMBER
The member ID of the forum guest memberget_member_email_address(\MEMBER $id) : \SHORT_TEXT
\MEMBER
The member
\SHORT_TEXT
The e-mail address (blank: not known)get_member_email_allowed(\MEMBER $member) : boolean
\MEMBER
The member ID
boolean
Whether the member may have e-mails sent to themget_member_ip(\MEMBER $member) : \IP
\MEMBER
The member ID
\IP
The IP addressget_member_photo_url(\MEMBER $member) : \URLPATH
\MEMBER
The member ID
\URLPATH
The URL (blank: none)get_member_row_field(\MEMBER $member, string $field) : mixed
\MEMBER
The member ID
string
The field identifier
mixed
The fieldget_members_groups(\MEMBER $id, boolean $skip_secret= false
, boolean $handle_probation= true
) : array
\MEMBER
The member
boolean
Whether to skip looking at secret usergroups.
boolean
Whether to take probation into account
array
The list of usergroupsget_moderator_groups() : array
array
The list of usergroupsget_next_member(\MEMBER $member) : \?MEMBER
It cannot be assumed there are no gaps in member IDs, as members may be deleted.
\MEMBER
The member ID to increment
\?MEMBER
The next member ID (null: no next member)get_num_new_forum_posts() : integer
integer
Number of forum postsget_num_users_forums() : integer
integer
The number of membersget_post_count(\MEMBER $member) : integer
\MEMBER
The member ID
integer
The post countget_post_remaining_details(\AUTO_LINK $topic_id, array $post_ids) : array
\AUTO_LINK
Topic the posts come from
array
List of post IDs
array
Extra detailsget_previous_member(\MEMBER $member) : \?MEMBER
\MEMBER
The member ID to decrement
\?MEMBER
The previous member ID (null: no previous member)get_super_admin_groups() : array
array
The list of usergroupsget_theme(\?ID_TEXT $zone_for = null
) : \ID_TEXT
\?ID_TEXT
The zone we are getting the theme for (null: current zone)
\ID_TEXT
The theme identifierget_top_posters(integer $limit) : array
integer
The limit to the number of top posters to fetch
array
The rows for the given number of top posters in the forumget_topic_count(\MEMBER $member) : integer
\MEMBER
The member ID
integer
The topic countget_usergroup_list(boolean $hide_hidden= false
, boolean $only_permissive= false
, boolean $force_show_all= false
, \?array $force_find= null
, \?MEMBER $for_member= null
, boolean $skip_hidden= false
) : array
boolean
Whether to obscure the name of hidden usergroups
boolean
Whether to only grab permissive usergroups
boolean
Do not limit things even if there are huge numbers of usergroups
\?array
Usergroups that must be included in the results (null: no extras must be)
\?MEMBER
Always return usergroups of this member (null: current member)
boolean
Whether to completely skip hidden usergroups
array
The mapget_username(\MEMBER $id, boolean $use_displayname = false
) : \?SHORT_TEXT
\MEMBER
The member
boolean
Whether to use the displayname rather than the username (if we have them)
\?SHORT_TEXT
The username (null: deleted member)install_delete_custom_field(string $name)
string
The name of the new custom field
install_specifics() : array
The attributes have 4 values in an array
array
The attributes for the forumipb_escape(string $val) : string
string
The value to escape
string
The escaped valueipb_unescape(string $val) : string
string
The value to unescape
string
The unescaped valueis_banned(\MEMBER $member) : boolean
\MEMBER
The member ID
boolean
Whether the member is bannedis_hashed() : boolean
boolean
Whether the login cookie is md5-hashedis_staff(\MEMBER $id, boolean $skip_staff_filter = false
) : boolean
\MEMBER
The member
boolean
Whether to avoid checking the staff filter (i.e. ignore M.S.N.'s)
boolean
The answeris_super_admin(\MEMBER $id) : boolean
\MEMBER
The member
boolean
The answerjoin_url() : mixed
mixed
The URLmember_group_query(array $groups, \?integer $max= null
, integer $start= 0
) : \?array
array
The array of usergroups
\?integer
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
Return primary members after this offset and secondary members after this offset
\?array
The array of members (null: no members)member_home_url(\MEMBER $id) : \URLPATH
\MEMBER
The member ID
\URLPATH
The URL to the members homemember_pm_url(\MEMBER $id, boolean $tempcode_okay = false
) : mixed
\MEMBER
The forum member
boolean
Whether it is okay to return the result using Tempcode (more efficient)
mixed
The URLmember_profile_hyperlink(\MEMBER $id, boolean $definitely_profile= false
, string $_username= ''
, boolean $use_displayname= true
) : \Tempcode
\MEMBER
The forum member
boolean
Whether to be insistent that we go to the profile, rather than possibly starting an IM which can link to the profile
string
The username (blank: look it up)
boolean
Whether to use the displayname rather than the username (if we have them)
\Tempcode
The hyperlinkmember_profile_url(\MEMBER $id, boolean $definitely_profile= false
, boolean $tempcode_okay= false
) : mixed
\MEMBER
The forum member
boolean
Whether to be insistent that we go to the profile, rather than possibly starting an IM which can link to the profile
boolean
Whether it is okay to return the result using Tempcode (more efficient, and allows keep_* parameters to propagate which you almost certainly want!)
mixed
The URLmrow_email(array $r) : \SHORT_TEXT
array
The profile-row
\SHORT_TEXT
The member e-mail addressmrow_group(array $r) : \GROUP
array
The profile-row
\GROUP
The member's primary usergroupmrow_id(array $r) : \MEMBER
array
The profile-row
\MEMBER
The member IDmrow_lastvisit(array $r) : \TIME
array
The profile-row
\TIME
The last visit datepin_topic(\AUTO_LINK $id, boolean $pin = true
)
\AUTO_LINK
The topic ID
boolean
True: pin it, False: unpin it
post_url(integer $id, string $forum) : \URLPATH
integer
The post ID
string
The forum ID
\URLPATH
The URL to the postprobe_ip(\IP $ip) : array
\IP
The IP address
array
The distinct rows foundtopic_is_threaded(integer $topic_id) : boolean
integer
The topic ID
boolean
Whether it istopic_url(integer $id, string $forum) : \URLPATH
integer
The topic ID
string
The forum ID
\URLPATH
The URL to the topicunentity_1(array $matches) : string
array
Matches
string
Replacementunentity_2(array $matches) : string
array
Matches
string
Replacementusers_online_url(boolean $tempcode_okay = false
) : mixed
boolean
Whether it is okay to return the result using Tempcode (more efficient)
mixed
The URL_forum_url(integer $id) : \URLPATH
integer
The forum ID
\URLPATH
The URL to the specified forum_get_member_email_address(\MEMBER $member) : \SHORT_TEXT
\MEMBER
The member ID
\SHORT_TEXT
The e-mail address_get_moderator_groups() : array
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.
array
The moderator usergroup IDs_get_num_new_forum_posts() : integer
integer
The number of posts_get_super_admin_groups() : array
array
The admin usergroup IDs_get_usergroup_list() : array
array
The usergroup list_is_staff(\MEMBER $member) : boolean
\MEMBER
The member ID
boolean
Whether the member is staff_is_super_admin(\MEMBER $member) : boolean
\MEMBER
The member ID
boolean
Whether the member is a super admin_join_url() : \URLPATH
\URLPATH
The URL to the registration page_member_pm_url(\MEMBER $id) : \URLPATH
\MEMBER
The member ID
\URLPATH
The URL to the private/personal message page_member_profile_url(\MEMBER $id) : \URLPATH
\MEMBER
The member ID
\URLPATH
The URL to the member profile_users_online_url() : \URLPATH
\URLPATH
The URL to the members-online page$EMOTICON_CACHE
null
$MEMBER_ROWS_CACHED
array()
$connection