phpDocumentor
Back to top  

 Methods

__construct() 

__construct() 
Inherited

inherited_from \XenForo_Importer_Abstract::__construct()

configStep() 

configStep(\XenForo_ControllerAdmin_Abstract $controller, \XenForo_ImportSession $session, $step, array $options) 
Inherited

inherited_from \XenForo_Importer_Abstract::configStep()

Parameters

$controller

$session

$step

$options

configStepAvatars() 

configStepAvatars(array $options) 

Parameters

$options

configStepForumPermissions() 

configStepForumPermissions(array $options) 

Parameters

$options

configStepPolls() 

configStepPolls(array $options) 

Parameters

$options

configStepUserGroups() 

configStepUserGroups(array $options) 

Parameters

$options

configStepUsers() 

configStepUsers(array $options) 

Parameters

$options

configure() 

configure(\XenForo_ControllerAdmin_Abstract $controller, array $config) 

Parameters

$controller

$config

getImportCompleteMessages() 

getImportCompleteMessages() 
Inherited

inherited_from \XenForo_Importer_Abstract::getImportCompleteMessages()

getKey() 

getKey() 
Inherited

inherited_from \XenForo_Importer_Abstract::getKey()

getName() 

getName() 

getStep() 

getStep($step) 
Inherited

inherited_from \XenForo_Importer_Abstract::getStep()

Parameters

$step

getSteps() 

getSteps() 

processAttachmentTags() 

processAttachmentTags($oldAttachmentId, $newAttachmentId, $messageText) 

Parameters

$oldAttachmentId

$newAttachmentId

$messageText

runStep() 

runStep(\XenForo_ControllerAdmin_Abstract $controller, \XenForo_ImportSession $session, $step, $start, array $options) 
Inherited

inherited_from \XenForo_Importer_Abstract::runStep()

Parameters

$controller

$session

$step

$start

$options

stepAttachments() 

stepAttachments($start, array $options) 

Parameters

$start

$options

stepAvatars() 

stepAvatars($start, array $options) 

Parameters

$start

$options

stepForumPermissions() 

stepForumPermissions($start, array $options) 

Parameters

$start

$options

stepForums() 

stepForums($start, array $options) 

Parameters

$start

$options

stepModerators() 

stepModerators($start, array $options) 

Parameters

$start

$options

stepPolls() 

stepPolls($start, array $options) 

Parameters

$start

$options

stepPrivateMessages() 

stepPrivateMessages($start, array $options) 

Parameters

$start

$options

stepProfileComments() 

stepProfileComments($start, array $options) 

Parameters

$start

$options

stepReputation() 

stepReputation($start, array $options) 

Parameters

$start

$options

stepStatusUpdates() 

stepStatusUpdates($start, array $options) 

Parameters

$start

$options

stepThreads() 

stepThreads($start, array $options) 

Parameters

$start

$options

stepUserFields() 

stepUserFields($start, array $options) 

Parameters

$start

$options

stepUserGroups() 

stepUserGroups($start, array $options) 

Parameters

$start

$options

stepUsers() 

stepUsers($start, array $options) 

Parameters

$start

$options

stepUsersFailed() 

stepUsersFailed($start, array $options) 

Parameters

$start

$options

stepUsersMerge() 

stepUsersMerge($start, array $options) 

Parameters

$start

$options

validateConfiguration() 

validateConfiguration(array $config) 

Parameters

$config

_bootstrap() 

_bootstrap(array $config) 

Parameters

$config

_bootstrapImporter() 

_bootstrapImporter(array $config) 
Inherited

inherited_from \XenForo_Importer_Abstract::_bootstrapImporter()

Parameters

$config

Caches the app_cache and module_cache from IPB

_cacheAppsAndModules() 

_calculateModeratorPermissions() 

_calculateModeratorPermissions(array $mod) 

Parameters

$mod

_calculateUserGroupPermissions() 

_calculateUserGroupPermissions(array $userGroup) 

Parameters

$userGroup

_convertIPBoardMediaTag() 

_convertIPBoardMediaTag(array $regexMatches) 

Parameters

$regexMatches

Convert the given text to valid UTF-8

_convertToUtf8(string $string, boolean $entities) : string
Inherited

inherited_from \XenForo_Importer_Abstract::_convertToUtf8()

Parameters

$string

string

$entities

boolean

Convert < (and other) entities back to < characters

Returns

string

Convert's IPB's a=A|b=B|c=C user field choice format into XF's array format

_convertUserFieldChoices(array $profileField) : array

Parameters

$profileField

array

Returns

array

Converts IPB's aann-naa style of input matching into a regular expression

_convertUserFieldMatchTypeToRegex(string $inputFormat) : string

Parameters

$inputFormat

string

Returns

string

Gets the application cache

_getAppCache() : array

Returns

array

Fetches an array representing all the source user groups

_getGroupCache() : array

Returns

array[userGroupId => userGroup, userGroupId => userGroup...]

Fetches an array of all user groups to which the user belongs

_getGroupsForUser(array $user) : array

Parameters

$user

array

Returns

array

Gets the module cache

_getModuleCache() : array

Returns

array

_getNextUserStep() 

_getNextUserStep() 

Returns the value of a member custom profile field for the specified member

_getProfileField(array $user, string $title, integer $id) : string

Parameters

$user

array

$title

string

Name of the custom profile field

$id

integer

If specified, fetch the field by its numeric id instead

Returns

stringUTF-8 converted

_getProgressOutput() 

_getProgressOutput($lastId, $maxId) 
Inherited

inherited_from \XenForo_Importer_Abstract::_getProgressOutput()

Parameters

$lastId

$maxId

_getSelectUserSql() 

_getSelectUserSql($where) 

Parameters

$where

_getStatusUpdateUserIdMap() 

_getStatusUpdateUserIdMap(\XenForo_Model_Import $model, array $statusUpdates) 

Parameters

$model

$statusUpdates

_getStatusUpdateUserInfo() 

_getStatusUpdateUserInfo(array $statusUpdate, array $userIdMap) 

Parameters

$statusUpdate

$userIdMap

_getStatusUpdates() 

_getStatusUpdates($start, $limit) 

Parameters

$start

$limit

_getUserGroupAvatarPerms() 

_getUserGroupAvatarPerms(array $userGroup) 

Parameters

$userGroup

Forums must have been imported already for this to function.

_guessForumPermissions() 

Interpret the data stored in IPB's gender field

_handleProfileFieldGender(string $gender) : string

Parameters

$gender

string

Returns

string

Checks that the $permissions array given has the admin permission specified

_hasAdminPermission(array $adminRestrictions, string $appName, string $moduleName, string $permName) : boolean

Parameters

$adminRestrictions

array

$appName

string

$moduleName

string

$permName

string

Returns

boolean

_importForumTree() 

_importForumTree($parentId, array $forumTree, array $forumIdMap) 

Parameters

$parentId

$forumTree

$forumIdMap

_importOrMergeUser() 

_importOrMergeUser(array $user, array $options) 

Parameters

$user

$options

Perform any additional importing behaviour for the specified status update

_importStatusUpdateExtra(array $statusUpdate, integer $profilePostId, array $profilePost) : array

Parameters

$statusUpdate

array

Source data

$profilePostId

integer

Inserted profile post id

$profilePost

array

Imported data

Returns

arrayData with which to update the profile post

Imports thread watch records for the given thread

_importThreadWatch(integer $threadId, array $sourceThread) 

Parameters

$threadId

integer

Imported XenForo thread ID

$sourceThread

array

IPB source thread data

_importUser() 

_importUser(array $user, array $options) 

Parameters

$user

$options

Explodes IPB's ,x,y,z, format into array(x, y, z)

_ipbExplode(string $commaList) : array

Parameters

$commaList

string

Returns

array

Check if the specified user is an administrator, by looking at all of their user group memberships and checking if any of them have cp access privs.

_isAdmin(array $user, array $adminRestrictions) : boolean

Parameters

$user

array

$adminRestrictions

array

Returns

boolean

Check if the specified user is a super moderator but checking all their user group memberships for g_is_supmod

_isSuperModerator(array $user) : boolean

Parameters

$user

array

Returns

boolean

_mapLookUp() 

_mapLookUp(array $map, $key, $default, $lowerKey) 
Inherited

inherited_from \XenForo_Importer_Abstract::_mapLookUp()

Parameters

$map

$key

$default

$lowerKey

_mapLookUpList() 

_mapLookUpList(array $map, array $keys, $lowerKey) 
Inherited

inherited_from \XenForo_Importer_Abstract::_mapLookUpList()

Parameters

$map

$keys

$lowerKey

_mergeUser() 

_mergeUser(array $user, $targetUserId) 

Parameters

$user

$targetUserId

Parse out HTML smilies and other stuff we can't use from IP.Board BB code

_parseIPBoardBbCode(string $message, boolean $autoLink) : string

Parameters

$message

string

$autoLink

boolean

Auto-link URLs in IP.Board messages

Returns

string

_parseIPBoardMediaCode() 

_parseIPBoardMediaCode($message) 

Parameters

$message

Remove HTML line breaks and UTF-8 conversion

_parseIPBoardText(string $message) : string

Parameters

$message

string

Returns

string

_resolveUserConflicts() 

_resolveUserConflicts(array $users, array $resolve) 

Parameters

$users

$resolve

_rewriteQuotes() 

_rewriteQuotes($message, array $quotes, array $postIdMap) 

Parameters

$message

$quotes

$postIdMap

 Properties

 

$_adminPermissions

$_adminPermissions 

 

$_appCache

$_appCache 

 

$_charset

$_charset 

 

$_config

$_config 

 

Calling controller

$_controller : \XenForo_ControllerAdmin_Abstract
Inherited

inherited_from \XenForo_Importer_Abstract::$$_controller
 

$_db

$_db : \Zend_Db_Adapter_Abstract
Inherited

inherited_from \XenForo_Importer_Abstract::$$_db
 

$_groupCache

$_groupCache 

 

$_groupMap

$_groupMap 

 

$_importModel

$_importModel : \XenForo_Model_Import
Inherited

inherited_from \XenForo_Importer_Abstract::$$_importModel
 

$_moduleCache

$_moduleCache 

 

$_nodePermissionsGrouped

$_nodePermissionsGrouped 

 

$_prefix

$_prefix 

 

$_profileFieldMap

$_profileFieldMap 

 

Import session

$_session : \XenForo_ImportSession
Inherited

inherited_from \XenForo_Importer_Abstract::$$_session
 

Source database connection.

$_sourceDb : \Zend_Db_Adapter_Abstract

 

$_userFieldMap

$_userFieldMap