Check the connected DB is valid for this forum driver.

• return: Whether it is valid

Find if the given member id and password is valid. If username is NULL, then the member id is used instead.

All authorisation, cookies, and form-logins, are passed through this function. Some forums do cookie logins differently, so a Boolean is passed in to indicate whether it is a cookie login.

• return: A map of 'id' and 'error'. If 'id' is NULL, an error occured and 'error' is set

• ?SHORT_TEXT $username: The member username (NULL: don't use this in the authentication - but look it up using the ID if needed)
• MEMBER $userid: The member id
• MD5 $password_hashed: The md5-hashed password
• string $password_raw: The raw password
• boolean $cookie_login: Whether this is a cookie login

Attempt to to find the member's language from their forum profile. It converts between language-identifiers using a map (lang/map.ini).

• return: The member's language (NULL: unknown)

• MEMBER $member: The member who's language needs to be fetched

Get custom profile fields values for all 'ocp_' prefixed keys.

• return: A map of the custom profile fields, key_suffix=>value (NULL: no fields)

• MEMBER $member: The member id

Get an emoticon chooser template.

• return: The emoticon chooser template

• string $field_name: The ID of the form field the emoticon chooser adds to

Get an array of maps for the topic in the given forum.

• return: The array of maps (Each map is: title, message, member, date) (-1 for no such forum, -2 for no such topic)

• SHORT_TEXT $forum_name: The forum name
• SHORT_TEXT $topic_name: The topic name
• SHORT_TEXT $topic_description: The topic description. If this is non-blank, this is used for the search rather than the title
• integer &$count: The comment count will be returned here by reference
• integer $max: Maximum comments to returned
• integer $start: Comment to start at

Find all members with a name matching the given SQL LIKE string.

• return: The array of matched members (NULL: none found)

• string $pattern: The pattern
• ?integer $limit: Maximum number to return (limits to the most recent active) (NULL: no limit)

Get the number of members registered on the forum.

• return: The number of members

Find if this member may have e-mails sent to them

• return: Whether the member may have e-mails sent to them

• MEMBER $member: The member id

Get a first known IP address of the given member.

• return: The IP address

• MEMBER $member: The member id

Get the photo URL for the specified member id.

• return: The URL (blank: none)

• MEMBER $member: The member id

Gets a named field of a member row from the database.

• return: The field

• MEMBER $member: The member id
• string $field: The field identifier

Get the total posts ever made on the forum.

• return: The number of posts

Get the given member's post count.

• return: The post count

• MEMBER $member: The member id

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

• return: The list of skins

Get the total topics ever made on the forum.

• return: The number of topics

Get the rows for the top given number of posters on the forum.

• return: The rows for the given number of top posters in the forum

• integer $limit: The limit to the number of top posters to fetch

Get an array of paths to search for config at.

• return: The paths in which to search for the forum config

Searches for forum auto-config at this path.

• return: Whether the forum auto-config could be found

• PATH $path: The path in which to search

Find if the login cookie contains the login name instead of the member id.

• return: Whether the login cookie contains a login name or a member id

Makes a post in the specified forum, in the specified topic according to the given specifications. If the topic doesn't exist, it is created along with a spacer-post.

Spacer posts exist in order to allow staff to delete the first true post in a topic. Without spacers, this would not be possible with most forum systems. They also serve to provide meta information on the topic that cannot be encoded in the title (such as a link to the content being commented upon). Note that $post should be in HTML, and some forums do not store posts as HTML. This is unfortunate, but there are some limits to just how far you can reasonably integrate with all these different forum systems without making a programatic mess.

• SHORT_TEXT $forum_name: The forum name
• SHORT_TEXT $topic_name: The topic name
• MEMBER $member: The member id
• LONG_TEXT $_post: The post content in Comcode format
• LONG_TEXT $title: The post title
• tempcode $_topic_for: The content title the topic is related to
• ?TIME $time: The post time (NULL: use current time)
• ?IP $ip: The post IP address (NULL: use current members IP address)

Get a URL to the specified member's home (control panel).

• return: The URL to the members home

• MEMBER $id: The member id

Pin a topic.

• AUTO_LINK $id: The topic id

From a member profile-row, get the member's e-mail address.

• return: The member e-mail address

• array $r: The profile-row

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

• return: The member id

• array $r: The profile-row

Get a URL to the specified post id.

• return: The URL to the post

• integer $id: The post id
• string $forum: The forum id

Salts a password based on a supplied salt.

• return: The password hash.

• string $password: The md5()'ed password.
• string $salt: The salt.

Get an array of topics in the given forum. Each topic is an array with the following attributes:

• id, the topic id
• title, the topic title
• lastusername, the username of the last poster
• lasttime, the timestamp of the last reply
• closed, a Boolean for whether the topic is currently closed or not
• firsttitle, the title of the first post
• firstpost, the first post (only set if $show_first_posts was true)

• return: The array of topics (NULL: error)

• mixed $name: The forum name or an array of forum IDs
• integer $limit: The limit
• integer $start: The start position
• integer &$max_rows: The total rows (not a parameter: returns by reference)
• SHORT_TEXT $filter_topic_name: The topic name filter
• boolean $show_first_posts: Whether to show the first posts
• string $date_key: The date key to sort by
• boolean $hot: Whether to limit to hot topics
• SHORT_TEXT $filter_topic_description: The topic description filter

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 to disable the staff filter

Get the forum usergroup relating to the specified member id.

• return: The array of forum usergroups

• MEMBER $member: The member id

Get the ids of the moderator groups.

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

• return: The moderator group ids

Get the ids of the admin groups.

• return: The admin group ids

Get the forum usergroup list.

• return: The usergroup list

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

• return: Whether the member is staff

• MEMBER $member: The member id

Get a URL to the registration page (for people to create member accounts).

• return: The URL to the registration page

Get a URL to the specified member's profile.

• return: The URL to the member profile

• MEMBER $id: The member id

Convert an IP address into phpBB hexadecimal string format.

• return: The phpBB IP address

• IP $ip: The normal IP address