Class forum_driver_ipb_shared

Description
Description | Descendents | Vars | Methods (details)

Located in /sources/forum/shared/ipb.php (line 21) 

forum_driver_base
   |
   --forum_driver_ipb_shared
Direct descendents
Description | Descendents | Vars | Methods (details)
Class Description
forum_driver_ipb1
forum_driver_ipb2
forum_driver_ipb3
Method Summary
Description | Descendents | Vars | Methods (details)
boolean check_db ()
?LANGUAGE_NAME forum_get_lang (MEMBER $member)
integer forum_id_from_name (SHORT_TEXT $forum_name)
string get_drivered_table_prefix ()
tempcode get_emoticon_chooser ([string $field_name = 'post'])
MEMBER get_guest_id ()
boolean get_member_email_allowed (MEMBER $member)
IP get_member_ip (MEMBER $member)
TIME get_member_join_timestamp (MEMBER $member)
URLPATH get_member_photo_url (MEMBER $member)
mixed get_member_row_field (MEMBER $member, string $field)
?MEMBER get_next_member (MEMBER $member)
integer get_num_users_forums ()
integer get_post_count (MEMBER $member)
?MEMBER get_previous_member (MEMBER $member)
integer get_tid_from_topic (SHORT_TEXT $topic, string $forum, [SHORT_TEXT $description = ''])
integer get_topic_count (MEMBER $member)
array get_top_posters (integer $limit)
array install_specifics ()
string ipb_escape (string $val)
void ipb_unescape ( $val)
boolean is_banned (MEMBER $member)
boolean is_cookie_login_name ()
boolean is_hashed ()
?array member_group_query (array $groups, [?integer $max = NULL], [integer $start = 0])
URLPATH member_home_link (MEMBER $id)
void pin_topic (AUTO_LINK $id)
TIME pnamelast_visit (array $r)
SHORT_TEXT pname_email (array $r)
GROUP pname_group (array $r)
MEMBER pname_id (array $r)
URLPATH post_link (integer $id, string $forum)
array probe_ip (IP $ip)
URLPATH topic_link (integer $id, string $forum)
void unentity_1 ( $matches)
void unentity_2 ( $matches)
URLPATH _forum_link (integer $id)
SHORT_TEXT _get_member_email_address (MEMBER $member)
array _get_moderator_groups ()
integer _get_num_new_forum_posts ()
array _get_super_admin_groups ()
array _get_usergroup_list ()
boolean _is_staff (MEMBER $member)
boolean _is_super_admin (MEMBER $member)
URLPATH _join_link ()
URLPATH _member_pm_link (MEMBER $id)
URLPATH _member_profile_link (MEMBER $id)
URLPATH _online_link ()
Variables
Description | Descendents | Vars (details) | Methods (details)

Inherited Variables

Inherited from forum_driver_base

forum_driver_base::$connection
 forum_driver_base::$MEMBER_ROWS_CACHED
Methods
Description | Descendents | Vars Methods (details)
check_db (line 29)

Check the connected DB is valid for this forum driver.

  • return: Whether it is valid
boolean check_db ()
forum_get_lang (line 52)

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)
?LANGUAGE_NAME forum_get_lang (MEMBER $member)
  • MEMBER $member: The member who's language needs to be fetched
forum_id_from_name (line 322)

Get the forum id from a forum name.

  • return: The forum id
integer forum_id_from_name (SHORT_TEXT $forum_name)
  • SHORT_TEXT $forum_name: The forum name
get_drivered_table_prefix (line 150)

Get the forums' table prefix for the database.

  • return: The forum database table prefix
string get_drivered_table_prefix ()
get_emoticon_chooser (line 183)

Get an emoticon chooser template.

  • return: The emoticon chooser template
tempcode get_emoticon_chooser ([string $field_name = 'post'])
  • string $field_name: The ID of the form field the emoticon chooser adds to
get_guest_id (line 140)

Find the member id of the forum guest member.

  • return: The member id of the forum guest member
MEMBER get_guest_id ()
get_member_email_allowed (line 469)

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

  • return: Whether the member may have e-mails sent to them
boolean get_member_email_allowed (MEMBER $member)
  • MEMBER $member: The member id
get_member_ip (line 620)

Get a first known IP address of the given member.

  • return: The IP address
IP get_member_ip (MEMBER $member)
  • MEMBER $member: The member id
get_member_join_timestamp (line 482)

Get the timestamp of a member's join date.

  • return: The timestamp
TIME get_member_join_timestamp (MEMBER $member)
  • MEMBER $member: The member id
get_member_photo_url (line 454)

Get the photo URL for the specified member id.

  • return: The URL (blank: none)
URLPATH get_member_photo_url (MEMBER $member)
  • MEMBER $member: The member id
Redefined in descendants as:
get_member_row_field (line 632)

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

  • return: The field
mixed get_member_row_field (MEMBER $member, string $field)
  • MEMBER $member: The member id
  • string $field: The field identifier
get_next_member (line 418)

Get the member id of the next member after the given one, or NULL.

It cannot be assumed there are no gaps in member ids, as members may be deleted.

  • return: The next member id (NULL: no next member)
?MEMBER get_next_member (MEMBER $member)
  • MEMBER $member: The member id to increment
Redefined in descendants as:
get_num_users_forums (line 562)

Get the number of members currently online on the forums.

  • return: The number of members
integer get_num_users_forums ()
get_post_count (line 493)

Get the given member's post count.

  • return: The post count
integer get_post_count (MEMBER $member)
  • MEMBER $member: The member id
get_previous_member (line 405)

This is the opposite of the get_next_member function.

  • return: The previous member id (NULL: no previous member)
?MEMBER get_previous_member (MEMBER $member)
  • MEMBER $member: The member id to decrement
Redefined in descendants as:
get_tid_from_topic (line 335)

Get the topic id from a topic name in the specified forum. It is used by comment topics, which means that the unique-topic-name assumption holds valid.

  • return: The topic id
integer get_tid_from_topic (SHORT_TEXT $topic, string $forum, [SHORT_TEXT $description = ''])
  • SHORT_TEXT $topic: The topic name
  • string $forum: The forum id
  • SHORT_TEXT $description: The topic description
get_topic_count (line 506)

Get the given member's topic count.

  • return: The topic count
integer get_topic_count (MEMBER $member)
  • MEMBER $member: The member id
get_top_posters (line 41)

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
array get_top_posters (integer $limit)
  • integer $limit: The limit to the number of top posters to fetch
Redefined in descendants as:
install_specifics (line 166)

Get an array of attributes to take in from the installer. Almost all forums require a table prefix, which the requirement there-of is defined through this function.

The attributes have 4 values in an array

  • name, the name of the attribute for info.php
  • default, the default value (perhaps obtained through autodetection from forum config)
  • description, a textual description of the attributes
  • title, a textual title of the attribute

  • return: The attributes for the forum
array install_specifics ()
ipb_escape (line 65)

Escape a value for HTML embedding, IPB style.

  • return: The escaped value
string ipb_escape (string $val)
  • string $val: The value to escape
ipb_unescape (line 98)
void ipb_unescape ( $val)
  • $val
is_banned (line 517)

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
Redefined in descendants as:
is_cookie_login_name (line 120)

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
boolean is_cookie_login_name ()
is_hashed (line 130)

Find if login cookie is md5-hashed.

  • return: Whether the login cookie is md5-hashed
boolean is_hashed ()
member_group_query (line 388)

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
Redefined in descendants as:
member_home_link (line 257)

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

  • return: The URL to the members home
URLPATH member_home_link (MEMBER $id)
  • MEMBER $id: The member id
Redefined in descendants as:
pin_topic (line 202)

Pin a topic.

void pin_topic (AUTO_LINK $id)
  • AUTO_LINK $id: The topic id
pnamelast_visit (line 235)

From a member profile-row, get the member's last visit date.

  • return: The last visit date
TIME pnamelast_visit (array $r)
  • array $r: The profile-row
pname_email (line 246)

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

  • return: The member e-mail address
SHORT_TEXT pname_email (array $r)
  • array $r: The profile-row
pname_group (line 213)

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
Redefined in descendants as:
pname_id (line 224)

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

  • return: The member id
MEMBER pname_id (array $r)
  • array $r: The profile-row
Redefined in descendants as:
post_link (line 371)

Get a URL to the specified post id.

  • return: The URL to the post
URLPATH post_link (integer $id, string $forum)
  • integer $id: The post id
  • string $forum: The forum id
probe_ip (line 430)

Try to find a member with the given IP address

  • return: The distinct rows found
array probe_ip (IP $ip)
  • IP $ip: The IP address
Redefined in descendants as:
topic_link (line 358)

Get a URL to the specified topic id. Most forums don't require the second parameter, but some do, so it is required in the interface.

  • return: The URL to the topic
URLPATH topic_link (integer $id, string $forum)
  • integer $id: The topic id
  • string $forum: The forum id
unentity_1 (line 86)
void unentity_1 ( $matches)
  • $matches
unentity_2 (line 92)
void unentity_2 ( $matches)
  • $matches
_forum_link (line 311)

Get a URL to the specified forum.

  • return: The URL to the specified forum
URLPATH _forum_link (integer $id)
  • integer $id: The forum id
_get_member_email_address (line 443)

Get the e-mail address for the specified member id.

  • return: The e-mail address
SHORT_TEXT _get_member_email_address (MEMBER $member)
  • MEMBER $member: The member id
_get_moderator_groups (line 593)

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_num_new_forum_posts (line 572)

Get the number of new forum posts.

  • return: The number of posts
integer _get_num_new_forum_posts ()
_get_super_admin_groups (line 582)

Get the ids of the admin usergroups.

  • return: The admin usergroup ids
array _get_super_admin_groups ()
_get_usergroup_list (line 603)

Get the forum usergroup list.

  • return: The usergroup list
array _get_usergroup_list ()
_is_staff (line 537)

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
Redefined in descendants as:
_is_super_admin (line 550)

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
Redefined in descendants as:
_join_link (line 279)

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

  • return: The URL to the registration page
URLPATH _join_link ()
Redefined in descendants as:
_member_pm_link (line 300)

Get a URL to send a private/personal message to the given member.

  • return: The URL to the private/personal message page
URLPATH _member_pm_link (MEMBER $id)
  • MEMBER $id: The member id
Redefined in descendants as:
_member_profile_link (line 269)

Get a URL to the specified member's profile.

  • return: The URL to the member profile
URLPATH _member_profile_link (MEMBER $id)
  • MEMBER $id: The member id
_online_link (line 289)

Get a URL to the members-online page.

  • return: The URL to the members-online page
URLPATH _online_link ()
Redefined in descendants as:

Inherited Methods

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()

Documentation generated on Sun, 02 Jan 2011 23:16:19 +0000 by phpDocumentor 1.4.3