API Documentation
Back to top  

Main BBP_Converter Class

package bbPress

 Methods

The main bbPress Converter loader

__construct() 
since 2.1.0 bbPress (r3813)

Admin scripts

admin_head() 
since 2.1.0 bbPress (r3813)

Callback processor

process_callback() 
since 2.1.0 bbPress (r3813)

Setup the default actions

setup_actions() 
since 2.1.0 bbPress (r3813)

Admin globals

setup_globals() 
since 2.6.0 bbPress (r6598)

Create Tables for fast syncing

sync_table($drop = false) 
Static
since 2.1.0 bbPress (r3813)

Parameters

$drop

Bump the start within the current step

bump_start() 
since 2.6.0 bbPress (r6460)

Bump the step and reset the start

bump_step() 
since 2.6.0 bbPress (r6460)

Check that user can access the converter

check_access() 
since 2.6.0 bbPress (r6460)

Wrap the converter output in HTML, so styling can be applied

converter_response(string $output = '') 
since 2.1.0 bbPress (r4052)

Parameters

$output

string

Do the converter step

do_steps() 
since 2.6.0 bbPress (r6460)

Maybe restart the converter

maybe_restart() 
since 2.6.0 bbPress (r6460)

Attempt to increase memory and set other system settings

maybe_set_memory() 
since 2.6.0 bbPress (r6460)

Maybe update options

maybe_update_options() 
since 2.6.0 bbPress (r6637)

Reset the converter

reset() 
since 2.6.0 bbPress (r6460)

Setup converter options

setup_options() 
since 2.6.0 bbPress (r6460)

Maybe close converted topics

step_closed_topics() 
since 2.6.0 bbPress (r6513)

Done!

step_done() 
since 2.6.0 bbPress (r6513)

Maybe walk the forum hierarchy

step_forum_hierarchy() 
since 2.6.0 bbPress (r6513)

Maybe convert forum subscriptions

step_forum_subscriptions() 
since 2.6.0 bbPress (r6513)

Maybe convert forums

step_forums() 
since 2.6.0 bbPress (r6513)

Maybe clean up passwords

step_passwords() 
since 2.6.0 bbPress (r6513)

Maybe convert replies

step_replies() 
since 2.6.0 bbPress (r6513)

Maybe convert reply authors (anonymous)

step_reply_authors() 
since 2.6.0 bbPress (r6513)

Maybe convert the threaded reply hierarchy

step_reply_hierarchy() 
since 2.6.0 bbPress (r6513)

Maybe convert sticky topics (not super stickies)

step_stickies() 
since 2.6.0 bbPress (r6513)

Maybe convert super-sticky topics (not per-forum)

step_super_stickies() 
since 2.6.0 bbPress (r6513)

Maybe clean the sync table

step_sync_table() 
since 2.6.0 bbPress (r6513)

Maybe convert topic favorites

step_topic_favorites() 
since 2.6.0 bbPress (r6513)

Maybe convert topic subscriptions

step_topic_subscriptions() 
since 2.6.0 bbPress (r6513)

Maybe convert topic tags

step_topic_tags() 
since 2.6.0 bbPress (r6513)

Maybe convert topics

step_topics() 
since 2.6.0 bbPress (r6513)

Maybe convert topic authors (anonymous)

step_topics_authors() 
since 2.6.0 bbPress (r6513)

Maybe convert users

step_users() 
since 2.6.0 bbPress (r6513)

 Properties

 

Type of converter to use.

$converter : \BBP_Converter_Base

Default

null
 

Path to included platforms.

$converters_dir : string

Default

''
 

Number of rows.

$max : integer

Default

0
 

Maximum number of converter steps.

$max_steps : integer

Default

17
 

Name of source forum platform.

$platform : integer

Default

''
 

Number of rows.

$rows : integer

Default

0
 

Number of rows in the current step.

$rows_in_step : integer

Default

0
 

Start.

$start : integer

Default

0
 

Step in converter process.

$step : integer

Default

0
 

Percent complete of current step.

$step_percentage : integer

Default

0
 

Percent complete of all step.

$total_percentage : integer

Default

0
 

Map of steps to methods.

$steps : array

Default

array(1 => 'sync_table', 2 => 'users', 3 => 'passwords', 4 => 'forums', 5 => 'forum_hierarchy', 6 => 'forum_subscriptions', 7 => 'topics', 8 => 'topics_authors', 9 => 'stickies', 10 => 'super_stickies', 11 => 'closed_topics', 12 => 'topic_tags', 13 => 'topic_subscriptions', 14 => 'topic_favorites', 15 => 'replies', 16 => 'reply_authors', 17 => 'reply_hierarchy')