Class Hook_phpbb3

Description
Method Summary
ID_TEXT convert_topic_emoticon (integer $iconid)
string fix_links (string $post, string $uid, object The $db, string $table_prefix, [?AUTO_LINK $post_id = NULL], [boolean $is_pm = false])
void import_attachments (object The $db, string $table_prefix, PATH $file_base)
void import_bookmarks (object The $db, string $table_prefix, PATH $file_base)
void import_config (object The $db, string $table_prefix, PATH $file_base)
void import_custom_comcode (object The $db, string $table_prefix, PATH $file_base)
void import_friends (object The $db, string $table_prefix, PATH $file_base)
void import_ip_bans (object The $db, string $table_prefix, PATH $file_base)
void import_ocf_custom_profile_fields (object The $db, string $table_prefix, PATH $file_base)
void import_ocf_forums (object The $db, string $table_prefix, PATH $old_base_dir)
void import_ocf_groups (object The $db, string $table_prefix, PATH $file_base)
void import_ocf_members (object The $db, string $table_prefix, PATH $file_base)
void import_ocf_member_files (object The $db, string $table_prefix, PATH $file_base)
void import_ocf_personal_topics (object The $db, string $table_prefix, PATH $old_base_dir)
void import_ocf_polls_and_votes (object The $db, string $table_prefix, PATH $file_base)
void import_ocf_posts (object The $db, string $table_prefix, PATH $file_base)
void import_ocf_topics (object The $db, string $table_prefix, PATH $file_base)
void import_ocf_tracking (object The $db, string $table_prefix, PATH $file_base)
void import_ocf_warnings (object The $db, string $table_prefix, PATH $file_base)
void import_reported_posts_forum (object The $db, string $table_prefix, PATH $file_base)
void import_wordfilter (object The $db, string $table_prefix, PATH $file_base)
?array info ()
array probe_db_access (string $file_base)
array _find_parent_forum_and_category (array $rows, integer $parent_forum)
string _fix_links_callback_forum (array $m)
string _fix_links_callback_member (array $m)
string _fix_links_callback_topic (array $m)
void _import_perm (object The $db, string $table_prefix, integer $option_id, GROUP $group_id, AUTO_LINK $forum_id, BINARY $auth_setting)
void _import_permg (object The $db, string $table_prefix, integer $option_id, GROUP $group_id, BINARY $auth_setting)
?string _translate_permission (string $perm)
IP _un_phpbb_ip (string $ip)
Methods
convert_topic_emoticon (line 1151)

Convert a phpBB topic icon code into a standard ocPortal theme image code (assumes the default ones).

  • return: ocPortal code
ID_TEXT convert_topic_emoticon (integer $iconid)
  • integer $iconid: phpBB code
fix_links (line 929)

Convert phpBB URLs pasted in text fields into ocPortal ones.

  • return: The new text field text
string fix_links (string $post, string $uid, object The $db, string $table_prefix, [?AUTO_LINK $post_id = NULL], [boolean $is_pm = false])
  • string $post: The text field text (e.g. a post)
  • string $uid: Bbcode uid
  • object The $db: DB connection to import from
  • string $table_prefix: The table prefix the target prefix is using
  • ?AUTO_LINK $post_id: The ID of the post/message being imported (NULL: attachments not supported)
  • boolean $is_pm: Whether it is a personal message
import_attachments (line 206)

Standard import function.

void import_attachments (object The $db, string $table_prefix, PATH $file_base)
  • object The $db: DB connection to import from
  • string $table_prefix: The table prefix the target prefix is using
  • PATH $file_base: The base directory we are importing from
import_bookmarks (line 1279)

Standard import function.

void import_bookmarks (object The $db, string $table_prefix, PATH $file_base)
  • object The $db: DB connection to import from
  • string $table_prefix: The table prefix the target prefix is using
  • PATH $file_base: The base directory we are importing from
import_config (line 133)

Standard import function.

void import_config (object The $db, string $table_prefix, PATH $file_base)
  • object The $db: DB connection to import from
  • string $table_prefix: The table prefix the target prefix is using
  • PATH $file_base: The base directory we are importing from
import_custom_comcode (line 1238)

Standard import function.

void import_custom_comcode (object The $db, string $table_prefix, PATH $file_base)
  • object The $db: DB connection to import from
  • string $table_prefix: The table prefix the target prefix is using
  • PATH $file_base: The base directory we are importing from
import_friends (line 1412)

Standard import function.

void import_friends (object The $db, string $table_prefix, PATH $file_base)
  • object The $db: DB connection to import from
  • string $table_prefix: The table prefix the target prefix is using
  • PATH $file_base: The base directory we are importing from
import_ip_bans (line 544)

Standard import function.

void import_ip_bans (object The $db, string $table_prefix, PATH $file_base)
  • object The $db: DB connection to import from
  • string $table_prefix: The table prefix the target prefix is using
  • PATH $file_base: The base directory we are importing from
import_ocf_custom_profile_fields (line 1316)

Standard import function.

void import_ocf_custom_profile_fields (object The $db, string $table_prefix, PATH $file_base)
  • object The $db: DB connection to import from
  • string $table_prefix: The table prefix the target prefix is using
  • PATH $file_base: The base directory we are importing from
import_ocf_forums (line 580)

Standard import function.

void import_ocf_forums (object The $db, string $table_prefix, PATH $old_base_dir)
  • object The $db: DB connection to import from
  • string $table_prefix: The table prefix the target prefix is using
  • PATH $old_base_dir: The base directory we are importing from
import_ocf_groups (line 249)

Standard import function.

void import_ocf_groups (object The $db, string $table_prefix, PATH $file_base)
  • object The $db: DB connection to import from
  • string $table_prefix: The table prefix the target prefix is using
  • PATH $file_base: The base directory we are importing from
import_ocf_members (line 337)

Standard import function.

void import_ocf_members (object The $db, string $table_prefix, PATH $file_base)
  • object The $db: DB connection to import from
  • string $table_prefix: The table prefix the target prefix is using
  • PATH $file_base: The base directory we are importing from
import_ocf_member_files (line 465)

Standard import function.

void import_ocf_member_files (object The $db, string $table_prefix, PATH $file_base)
  • object The $db: DB connection to import from
  • string $table_prefix: The table prefix the target prefix is using
  • PATH $file_base: The base directory we are importing from
import_ocf_personal_topics (line 1046)

Standard import function.

void import_ocf_personal_topics (object The $db, string $table_prefix, PATH $old_base_dir)
  • object The $db: DB connection to import from
  • string $table_prefix: The table prefix the target prefix is using
  • PATH $old_base_dir: The base directory we are importing from
import_ocf_polls_and_votes (line 990)

Standard import function.

void import_ocf_polls_and_votes (object The $db, string $table_prefix, PATH $file_base)
  • object The $db: DB connection to import from
  • string $table_prefix: The table prefix the target prefix is using
  • PATH $file_base: The base directory we are importing from
import_ocf_posts (line 809)

Standard import function.

void import_ocf_posts (object The $db, string $table_prefix, PATH $file_base)
  • object The $db: DB connection to import from
  • string $table_prefix: The table prefix the target prefix is using
  • PATH $file_base: The base directory we are importing from
import_ocf_topics (line 778)

Standard import function.

void import_ocf_topics (object The $db, string $table_prefix, PATH $file_base)
  • object The $db: DB connection to import from
  • string $table_prefix: The table prefix the target prefix is using
  • PATH $file_base: The base directory we are importing from
import_ocf_tracking (line 1180)

Standard import function.

void import_ocf_tracking (object The $db, string $table_prefix, PATH $file_base)
  • object The $db: DB connection to import from
  • string $table_prefix: The table prefix the target prefix is using
  • PATH $file_base: The base directory we are importing from
import_ocf_warnings (line 1379)

Standard import function.

void import_ocf_warnings (object The $db, string $table_prefix, PATH $file_base)
  • object The $db: DB connection to import from
  • string $table_prefix: The table prefix the target prefix is using
  • PATH $file_base: The base directory we are importing from
import_reported_posts_forum (line 1441)

Standard import function.

void import_reported_posts_forum (object The $db, string $table_prefix, PATH $file_base)
  • object The $db: DB connection to import from
  • string $table_prefix: The table prefix the target prefix is using
  • PATH $file_base: The base directory we are importing from
import_wordfilter (line 1300)

Standard import function.

void import_wordfilter (object The $db, string $table_prefix, PATH $file_base)
  • object The $db: DB connection to import from
  • string $table_prefix: The table prefix the target prefix is using
  • PATH $file_base: The base directory we are importing from
info (line 52)

Standard modular info function.

  • return: Map of module info (NULL: module is disabled).
?array info ()
probe_db_access (line 108)

Probe a file path for DB access details.

  • return: A quartet of the details (db_name, db_user, db_pass, table_prefix)
array probe_db_access (string $file_base)
  • string $file_base: The probe path
_find_parent_forum_and_category (line 664)

Helper function to locate parent forum and category of a forum. Has to be clever to locate both, by tree traversal.

  • return: A pair: the category ID, the forum ID
array _find_parent_forum_and_category (array $rows, integer $parent_forum)
  • array $rows: Rows of forums/categories
  • integer $parent_forum: Key for the 'parent' (which may be for cat or may be for real parent)
_fix_links_callback_forum (line 902)

Substitution callback for 'fix_links'.

  • return: The substitution string
string _fix_links_callback_forum (array $m)
  • array $m: The match
_fix_links_callback_member (line 913)

Substitution callback for 'fix_links'.

  • return: The substitution string
string _fix_links_callback_member (array $m)
  • array $m: The match
_fix_links_callback_topic (line 891)

Substitution callback for 'fix_links'.

  • return: The substitution string
string _fix_links_callback_topic (array $m)
  • array $m: The match
_import_perm (line 706)

Helper function to import a permission to a usergroup, from a specific phpBB option row.

void _import_perm (object The $db, string $table_prefix, integer $option_id, GROUP $group_id, AUTO_LINK $forum_id, BINARY $auth_setting)
  • object The $db: DB connection to import from
  • string $table_prefix: The table prefix the target prefix is using
  • integer $option_id: Option row ID
  • GROUP $group_id: Group it applies to
  • AUTO_LINK $forum_id: Forum it applies to
  • BINARY $auth_setting: Setting
_import_permg (line 310)

Helper function to import a global permission to a usergroup, from a specific phpBB option row.

void _import_permg (object The $db, string $table_prefix, integer $option_id, GROUP $group_id, BINARY $auth_setting)
  • object The $db: DB connection to import from
  • string $table_prefix: The table prefix the target prefix is using
  • integer $option_id: Option row ID
  • GROUP $group_id: Group it applies to
  • BINARY $auth_setting: Setting
_translate_permission (line 733)

Helper function to translate phpBB permissions to ocPortal permissions.

  • return: New perm (NULL: could not convert)
?string _translate_permission (string $perm)
  • string $perm: Old perm
_un_phpbb_ip (line 565)

Convert an IP address from phpBB hexadecimal string format.

  • return: The normal IP address
IP _un_phpbb_ip (string $ip)
  • string $ip: The phpBB IP address

Documentation generated on Sun, 02 Jan 2011 23:21:07 +0000 by phpDocumentor 1.4.3