Add missing method and parameter documentation
authorMatthias Schmidt <gravatronics@live.com>
Sat, 21 May 2016 18:40:17 +0000 (20:40 +0200)
committerMatthias Schmidt <gravatronics@live.com>
Sat, 21 May 2016 18:40:17 +0000 (20:40 +0200)
15 files changed:
files/lib/system/exporter/IPB3xExporter.class.php
files/lib/system/exporter/IPB4xExporter.class.php
files/lib/system/exporter/Kunena3xExporter.class.php
files/lib/system/exporter/MyBB16xExporter.class.php
files/lib/system/exporter/NodeBB0xRedisExporter.class.php
files/lib/system/exporter/PhpBB31xExporter.class.php
files/lib/system/exporter/PhpBB3xExporter.class.php
files/lib/system/exporter/SMF2xExporter.class.php
files/lib/system/exporter/VB3or4xExporter.class.php
files/lib/system/exporter/VB5xExporter.class.php
files/lib/system/exporter/WBB2xExporter.class.php
files/lib/system/exporter/WBB3xExporter.class.php
files/lib/system/exporter/WBB4xExporter.class.php
files/lib/system/exporter/WordPress3xExporter.class.php
files/lib/system/exporter/XF12xExporter.class.php

index 8f9de702279c110933104647dbb8a4198e371b67..9f2cdec1737210b005192d843b8b10a811d2f198 100644 (file)
@@ -159,6 +159,9 @@ class IPB3xExporter extends AbstractExporter {
        
        /**
         * Exports users.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUsers($offset, $limit) {
                // cache profile fields
@@ -274,6 +277,9 @@ class IPB3xExporter extends AbstractExporter {
        
        /**
         * Exports user options.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserOptions($offset, $limit) {
                $conditionBuilder = new PreparedStatementConditionBuilder();
@@ -303,6 +309,9 @@ class IPB3xExporter extends AbstractExporter {
        
        /**
         * Exports user groups.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserGroups($offset, $limit) {
                $sql = "SELECT          *
@@ -347,6 +356,9 @@ class IPB3xExporter extends AbstractExporter {
        
        /**
         * Exports user avatars.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserAvatars($offset, $limit) {
                $sql = "SELECT          *
@@ -393,6 +405,9 @@ class IPB3xExporter extends AbstractExporter {
        
        /**
         * Exports status updates.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportStatusUpdates($offset, $limit) {
                $sql = "SELECT          status_updates.*, members.name
@@ -423,6 +438,9 @@ class IPB3xExporter extends AbstractExporter {
        
        /**
         * Exports status replies.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportStatusReplies($offset, $limit) {
                $sql = "SELECT          member_status_replies.*, members.name
@@ -453,6 +471,9 @@ class IPB3xExporter extends AbstractExporter {
        
        /**
         * Exports followers.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportFollowers($offset, $limit) {
                $sql = "SELECT          *
@@ -479,6 +500,9 @@ class IPB3xExporter extends AbstractExporter {
        
        /**
         * Exports conversations.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversations($offset, $limit) {
                $sql = "SELECT          message_topics.*, members.name
@@ -509,6 +533,9 @@ class IPB3xExporter extends AbstractExporter {
        
        /**
         * Exports conversation messages.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversationMessages($offset, $limit) {
                $sql = "SELECT          message_posts.*, members.name
@@ -539,6 +566,9 @@ class IPB3xExporter extends AbstractExporter {
        
        /**
         * Exports conversation recipients.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversationUsers($offset, $limit) {
                $sql = "SELECT          message_topic_user_map.*, members.name
@@ -570,6 +600,9 @@ class IPB3xExporter extends AbstractExporter {
        
        /**
         * Exports conversation attachments.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversationAttachments($offset, $limit) {
                $this->exportAttachments('msg', 'com.woltlab.wcf.conversation.attachment', $offset, $limit);
@@ -589,6 +622,9 @@ class IPB3xExporter extends AbstractExporter {
        
        /**
         * Exports boards.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportBoards($offset, $limit) {
                $sql = "SELECT          *
@@ -605,6 +641,8 @@ class IPB3xExporter extends AbstractExporter {
        
        /**
         * Exports the boards recursively.
+        * 
+        * @param       integer         $parentID
         */
        protected function exportBoardsRecursively($parentID = -1) {
                if (!isset($this->boardCache[$parentID])) return;
@@ -636,6 +674,9 @@ class IPB3xExporter extends AbstractExporter {
        
        /**
         * Exports threads.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportThreads($offset, $limit) {
                // get thread ids
@@ -695,6 +736,9 @@ class IPB3xExporter extends AbstractExporter {
        
        /**
         * Exports posts.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPosts($offset, $limit) {
                $sql = "SELECT          *
@@ -737,6 +781,9 @@ class IPB3xExporter extends AbstractExporter {
        
        /**
         * Exports watched threads.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportWatchedThreads($offset, $limit) {
                $sql = "SELECT          *
@@ -763,6 +810,9 @@ class IPB3xExporter extends AbstractExporter {
        
        /**
         * Exports polls.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPolls($offset, $limit) {
                $sql = "SELECT          polls.*, topics.topic_firstpost
@@ -809,6 +859,9 @@ class IPB3xExporter extends AbstractExporter {
        
        /**
         * Exports poll option votes.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPollOptionVotes($offset, $limit) {
                $sql = "SELECT          polls.*, voters.*
@@ -851,6 +904,9 @@ class IPB3xExporter extends AbstractExporter {
        
        /**
         * Exports likes.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportLikes($offset, $limit) {
                $sql = "SELECT          core_like.*, topics.topic_firstpost, topics.starter_id
@@ -883,11 +939,20 @@ class IPB3xExporter extends AbstractExporter {
        
        /**
         * Exports post attachments.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPostAttachments($offset, $limit) {
                $this->exportAttachments('post', 'com.woltlab.wbb.attachment', $offset, $limit);
        }
        
+       /**
+        * Returns the number of attachments of the given type.
+        *
+        * @param       string          $type
+        * @return      integer
+        */
        private function countAttachments($type) {
                $sql = "SELECT  COUNT(*) AS count
                        FROM    ".$this->databasePrefix."attachments
@@ -899,6 +964,14 @@ class IPB3xExporter extends AbstractExporter {
                return $row['count'];
        }
        
+       /**
+        * Exports attachments.
+        *
+        * @param       string          $type
+        * @param       string          $objectType
+        * @param       integer         $offset
+        * @param       integer         $limit
+        */
        private function exportAttachments($type, $objectType, $offset, $limit) {
                $sql = "SELECT          *
                        FROM            ".$this->databasePrefix."attachments
@@ -922,6 +995,14 @@ class IPB3xExporter extends AbstractExporter {
                }
        }
        
+       /**
+        * Returns the data of tags.
+        *
+        * @param       string          $app
+        * @param       string          $area
+        * @param       integer[]       $objectIDs
+        * @return      string[][]
+        */
        private function getTags($app, $area, array $objectIDs) {
                $tags = [];
                $conditionBuilder = new PreparedStatementConditionBuilder();
@@ -943,6 +1024,12 @@ class IPB3xExporter extends AbstractExporter {
                return $tags;
        }
        
+       /**
+        * Returns message with fixed formatting as used in WCF.
+        * 
+        * @param       string          $string
+        * @return      string
+        */
        private static function fixMessage($string) {
                // <br /> to newline
                $string = str_ireplace('<br />', "\n", $string);
@@ -1077,6 +1164,12 @@ class IPB3xExporter extends AbstractExporter {
                return $string;
        }
        
+       /**
+        * Returns subject with encoding as used in WCF.
+        * 
+        * @param       string          $string
+        * @return      string
+        */
        private static function fixSubject($string) {
                // decode html entities
                $string = StringUtil::decodeHTML($string);
@@ -1087,6 +1180,12 @@ class IPB3xExporter extends AbstractExporter {
                return $string;
        }
        
+       /**
+        * Returns status update with encoding as used in WCF.
+        *
+        * @param       string          $string
+        * @return      string
+        */
        private static function fixStatusUpdate($string) {
                // <br /> to newline
                $string = str_ireplace('<br />', "\n", $string);
index 15130875eb170617c20cd1d138366789847b8169..06d5ffcf36f09597726ac67c6e00fd363892e387 100644 (file)
@@ -170,6 +170,9 @@ class IPB4xExporter extends AbstractExporter {
        
        /**
         * Exports users.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUsers($offset, $limit) {
                // cache profile fields
@@ -260,6 +263,9 @@ class IPB4xExporter extends AbstractExporter {
        
        /**
         * Exports user options.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserOptions($offset, $limit) {
                $sql = "SELECT          *
@@ -285,6 +291,9 @@ class IPB4xExporter extends AbstractExporter {
        
        /**
         * Exports user groups.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserGroups($offset, $limit) {
                $sql = "SELECT          *
@@ -328,6 +337,9 @@ class IPB4xExporter extends AbstractExporter {
        
        /**
         * Exports user avatars.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserAvatars($offset, $limit) {
                $sql = "SELECT          *
@@ -358,6 +370,9 @@ class IPB4xExporter extends AbstractExporter {
        
        /**
         * Exports status updates.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportStatusUpdates($offset, $limit) {
                $sql = "SELECT          status_updates.*, members.name
@@ -388,6 +403,9 @@ class IPB4xExporter extends AbstractExporter {
        
        /**
         * Exports status replies.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportStatusReplies($offset, $limit) {
                $sql = "SELECT          member_status_replies.*, members.name
@@ -425,6 +443,9 @@ class IPB4xExporter extends AbstractExporter {
        
        /**
         * Exports followers.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportFollowers($offset, $limit) {
                $sql = "SELECT          *
@@ -452,6 +473,9 @@ class IPB4xExporter extends AbstractExporter {
        
        /**
         * Exports conversations.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversations($offset, $limit) {
                $sql = "SELECT          message_topics.*, members.name
@@ -482,6 +506,9 @@ class IPB4xExporter extends AbstractExporter {
        
        /**
         * Exports conversation messages.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversationMessages($offset, $limit) {
                $sql = "SELECT          message_posts.*, members.name
@@ -512,6 +539,9 @@ class IPB4xExporter extends AbstractExporter {
        
        /**
         * Exports conversation recipients.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversationUsers($offset, $limit) {
                $sql = "SELECT          message_topic_user_map.*, members.name
@@ -543,6 +573,9 @@ class IPB4xExporter extends AbstractExporter {
        
        /**
         * Exports conversation attachments.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversationAttachments($offset, $limit) {
                $this->exportAttachments('core_Messaging', 'com.woltlab.wcf.conversation.attachment', $offset, $limit);
@@ -562,6 +595,9 @@ class IPB4xExporter extends AbstractExporter {
        
        /**
         * Exports boards.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportBoards($offset, $limit) {
                $sql = "SELECT          *
@@ -578,6 +614,8 @@ class IPB4xExporter extends AbstractExporter {
        
        /**
         * Exports the boards recursively.
+        * 
+        * @param       integer         $parentID
         */
        protected function exportBoardsRecursively($parentID = -1) {
                if (!isset($this->boardCache[$parentID])) return;
@@ -596,7 +634,7 @@ class IPB4xExporter extends AbstractExporter {
                                'posts' => $board['posts'],
                                'threads' => $board['topics']
                        ]);
-                               
+                       
                        $this->exportBoardsRecursively($board['id']);
                }
        }
@@ -610,6 +648,9 @@ class IPB4xExporter extends AbstractExporter {
        
        /**
         * Exports threads.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportThreads($offset, $limit) {
                // get thread ids
@@ -667,6 +708,9 @@ class IPB4xExporter extends AbstractExporter {
        
        /**
         * Exports posts.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPosts($offset, $limit) {
                $sql = "SELECT          *
@@ -709,6 +753,9 @@ class IPB4xExporter extends AbstractExporter {
        
        /**
         * Exports watched threads.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportWatchedThreads($offset, $limit) {
                $sql = "SELECT          *
@@ -735,6 +782,9 @@ class IPB4xExporter extends AbstractExporter {
        
        /**
         * Exports polls.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPolls($offset, $limit) {
                $sql = "SELECT          polls.*, topics.topic_firstpost
@@ -790,6 +840,9 @@ class IPB4xExporter extends AbstractExporter {
        
        /**
         * Exports poll option votes.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPollOptionVotes($offset, $limit) {
                $sql = "SELECT          polls.*, voters.*
@@ -838,6 +891,9 @@ class IPB4xExporter extends AbstractExporter {
        
        /**
         * Exports likes.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportLikes($offset, $limit) {
                $sql = "SELECT          core_reputation_index.*, forums_posts.author_id
@@ -869,11 +925,20 @@ class IPB4xExporter extends AbstractExporter {
        
        /**
         * Exports post attachments.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPostAttachments($offset, $limit) {
                $this->exportAttachments('forums_Forums', 'com.woltlab.wbb.attachment', $offset, $limit);
        }
        
+       /**
+        * Returns the number of attachments of the given type.
+        * 
+        * @param       string          $type
+        * @return      integer
+        */
        private function countAttachments($type) {
                $sql = "SELECT  COUNT(*) AS count
                        FROM    ".$this->databasePrefix."core_attachments_map
@@ -885,6 +950,14 @@ class IPB4xExporter extends AbstractExporter {
                return $row['count'];
        }
        
+       /**
+        * Exports attachments.
+        * 
+        * @param       string          $type
+        * @param       string          $objectType
+        * @param       integer         $offset
+        * @param       integer         $limit
+        */
        private function exportAttachments($type, $objectType, $offset, $limit) {
                $sql = "SELECT          core_attachments.*, core_attachments_map.id2
                        FROM            ".$this->databasePrefix."core_attachments_map core_attachments_map
@@ -897,7 +970,7 @@ class IPB4xExporter extends AbstractExporter {
                $statement->execute([$type]);
                while ($row = $statement->fetchArray()) {
                        $fileLocation = $this->fileSystemPath.'uploads/'.$row['attach_location'];
-
+                       
                        ImportHandler::getInstance()->getImporter($objectType)->import($row['attach_id'], [
                                'objectID' => $row['id2'],
                                'userID' => ($row['attach_member_id'] ?: null),
@@ -910,6 +983,14 @@ class IPB4xExporter extends AbstractExporter {
                }
        }
        
+       /**
+        * Returns the data of tags.
+        * 
+        * @param       string          $app
+        * @param       string          $area
+        * @param       integer[]       $objectIDs
+        * @return      string[][]
+        */
        private function getTags($app, $area, array $objectIDs) {
                $tags = [];
                $conditionBuilder = new PreparedStatementConditionBuilder();
@@ -931,7 +1012,11 @@ class IPB4xExporter extends AbstractExporter {
                return $tags;
        }
        
-       
+       /**
+        * Returns the id of the default language in the imported board.
+        * 
+        * @return      integer
+        */
        private function getDefaultLanguageID() {
                if ($this->defaultLanguageID === null) {
                        $sql = "SELECT  lang_id
@@ -952,6 +1037,14 @@ class IPB4xExporter extends AbstractExporter {
                
        }
        
+       /**
+        * Returns the value of a language variable.
+        * 
+        * @param       string          $prefix
+        * @param       integer         $id
+        * @param       string          $suffix
+        * @return      string
+        */
        private function getLanguageVar($prefix, $id, $suffix = '') {
                if ($this->languageStatement === null) {
                        $sql = "SELECT  word_custom
@@ -969,6 +1062,12 @@ class IPB4xExporter extends AbstractExporter {
                return '';
        }
        
+       /**
+        * Returns message with fixed formatting as used in WCF.
+        *
+        * @param       string          $string
+        * @return      string
+        */
        private static function fixMessage($string) {
                // align
                $string = preg_replace('~<p style="text-align:(left|center|right);">(.*?)</p>~is', "[align=\\1]\\2[/align]\n\n", $string);
index de8742a4fcd4b6fa3aa6f70c9796dc2a5be7f938..2affb023017cf545255c717841d58011f20871dc 100644 (file)
@@ -126,6 +126,9 @@ class Kunena3xExporter extends AbstractExporter {
        
        /**
         * Exports user groups.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserGroups($offset, $limit) {
                $sql = "SELECT          *
@@ -173,6 +176,9 @@ class Kunena3xExporter extends AbstractExporter {
        
        /**
         * Exports users.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUsers($offset, $limit) {
                // prepare password update
@@ -256,6 +262,9 @@ class Kunena3xExporter extends AbstractExporter {
        
        /**
         * Exports user ranks.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserRanks($offset, $limit) {
                $sql = "SELECT          *
@@ -291,6 +300,9 @@ class Kunena3xExporter extends AbstractExporter {
        
        /**
         * Exports user avatars.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserAvatars($offset, $limit) {
                $sql = "SELECT          userid, avatar
@@ -325,6 +337,9 @@ class Kunena3xExporter extends AbstractExporter {
        
        /**
         * Exports boards.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportBoards($offset, $limit) {
                $sql = "SELECT          *
@@ -341,6 +356,8 @@ class Kunena3xExporter extends AbstractExporter {
        
        /**
         * Exports the boards recursively.
+        *
+        * @param       integer         $parentID
         */
        protected function exportBoardsRecursively($parentID = 0) {
                if (!isset($this->boardCache[$parentID])) return;
@@ -369,6 +386,9 @@ class Kunena3xExporter extends AbstractExporter {
        
        /**
         * Exports threads.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportThreads($offset, $limit) {
                $sql = "SELECT          kunena_topics.*
@@ -403,6 +423,9 @@ class Kunena3xExporter extends AbstractExporter {
        
        /**
         * Exports posts.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPosts($offset, $limit) {
                $sql = "SELECT          *
@@ -437,6 +460,9 @@ class Kunena3xExporter extends AbstractExporter {
        
        /**
         * Exports attachments.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportAttachments($offset, $limit) {
                $sql = "SELECT          *
@@ -462,6 +488,12 @@ class Kunena3xExporter extends AbstractExporter {
                }
        }
        
+       /**
+        * Returns message with fixed BBCodes as used in WCF.
+        * 
+        * @param       string          $message
+        * @return      string
+        */
        private static function fixBBCodes($message) {
                static $quoteRegex = null;
                static $quoteCallback = null;
index 61b50cdbaaf9948d7c75b9eae12106f3fc91b87f..239ef3ec49da192594dc4c737a347c0b9d4180fa 100644 (file)
@@ -201,6 +201,9 @@ class MyBB16xExporter extends AbstractExporter {
        
        /**
         * Exports user groups.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserGroups($offset, $limit) {
                $sql = "SELECT          *
@@ -241,6 +244,9 @@ class MyBB16xExporter extends AbstractExporter {
        
        /**
         * Exports users.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUsers($offset, $limit) {
                // cache profile fields
@@ -360,6 +366,9 @@ class MyBB16xExporter extends AbstractExporter {
        
        /**
         * Exports user options.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserOptions($offset, $limit) {
                $conditionBuilder = new PreparedStatementConditionBuilder();
@@ -424,6 +433,9 @@ class MyBB16xExporter extends AbstractExporter {
        
        /**
         * Exports user ranks.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserRanks($offset, $limit) {
                $sql = "(
@@ -467,6 +479,9 @@ class MyBB16xExporter extends AbstractExporter {
        
        /**
         * Exports followers.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportFollowers($offset, $limit) {
                $sql = "SELECT          uid, buddylist
@@ -503,6 +518,9 @@ class MyBB16xExporter extends AbstractExporter {
        
        /**
         * Exports user avatars.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserAvatars($offset, $limit) {
                $sql = "SELECT          uid, avatar, avatardimensions, avatartype
@@ -536,6 +554,9 @@ class MyBB16xExporter extends AbstractExporter {
        
        /**
         * Exports conversation folders.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversationFolders($offset, $limit) {
                $sql = "SELECT          uid, pmfolders
@@ -572,6 +593,9 @@ class MyBB16xExporter extends AbstractExporter {
        
        /**
         * Exports conversations.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversations($offset, $limit) {
                $sql = "SELECT          message_table.*, user_table.username
@@ -618,6 +642,9 @@ class MyBB16xExporter extends AbstractExporter {
        
        /**
         * Exports conversation recipients.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversationUsers($offset, $limit) {
                $sql = "SELECT          message_table.*, user_table.username
@@ -655,6 +682,9 @@ class MyBB16xExporter extends AbstractExporter {
        
        /**
         * Exports boards.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportBoards($offset, $limit) {
                $sql = "SELECT          *
@@ -671,6 +701,8 @@ class MyBB16xExporter extends AbstractExporter {
        
        /**
         * Exports the boards recursively.
+        *
+        * @param       integer         $parentID
         */
        protected function exportBoardsRecursively($parentID = 0) {
                if (!isset($this->boardCache[$parentID])) return;
@@ -704,6 +736,9 @@ class MyBB16xExporter extends AbstractExporter {
        
        /**
         * Exports threads.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportThreads($offset, $limit) {
                $sql = "SELECT          *
@@ -743,6 +778,9 @@ class MyBB16xExporter extends AbstractExporter {
        
        /**
         * Exports posts.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPosts($offset, $limit) {
                $sql = "SELECT          post_table.*, user_table.username AS editor
@@ -782,6 +820,9 @@ class MyBB16xExporter extends AbstractExporter {
        
        /**
         * Exports post attachments.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPostAttachments($offset, $limit) {
                static $uploadsPath = null;
@@ -838,6 +879,9 @@ class MyBB16xExporter extends AbstractExporter {
        
        /**
         * Exports watched threads.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportWatchedThreads($offset, $limit) {
                $sql = "SELECT          *
@@ -864,6 +908,9 @@ class MyBB16xExporter extends AbstractExporter {
        
        /**
         * Exports polls.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPolls($offset, $limit) {
                $sql = "SELECT          poll_table.*, thread_table.firstpost
@@ -897,6 +944,9 @@ class MyBB16xExporter extends AbstractExporter {
        
        /**
         * Exports poll options.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPollOptions($offset, $limit) {
                $sql = "SELECT          pid, options, votes
@@ -935,6 +985,9 @@ class MyBB16xExporter extends AbstractExporter {
        
        /**
         * Exports poll option votes.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPollOptionVotes($offset, $limit) {
                $sql = "SELECT          *
@@ -969,6 +1022,9 @@ class MyBB16xExporter extends AbstractExporter {
        
        /**
         * Exports likes.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportLikes($offset, $limit) {
                $sql = "SELECT          *
@@ -1004,6 +1060,9 @@ class MyBB16xExporter extends AbstractExporter {
        
        /**
         * Exports labels.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportLabels($offset, $limit) {
                $prefixMap = [];
@@ -1065,6 +1124,9 @@ class MyBB16xExporter extends AbstractExporter {
        
        /**
         * Exports ACLs.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportACLs($offset, $limit) {
                // get ids
@@ -1207,6 +1269,9 @@ class MyBB16xExporter extends AbstractExporter {
        
        /**
         * Exports smilies.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportSmilies($offset, $limit) {
                $sql = "SELECT          *
@@ -1225,6 +1290,12 @@ class MyBB16xExporter extends AbstractExporter {
                }
        }
        
+       /**
+        * Returns message with BBCodes as used in WCF.
+        * 
+        * @param       string          $message
+        * @return      string
+        */
        private static function fixBBCodes($message) {
                static $videoRegex = null;
                static $quoteRegex = null;
index d2e7e9169d036e24de7b90f94467aac0ef6aded2..7ea8c9459740698f60d62cafc9d8bcbac8371c69 100644 (file)
@@ -153,6 +153,10 @@ class NodeBB0xRedisExporter extends AbstractExporter {
        
        /**
         * Exports users.
+        * 
+        * @param       integer         $offset
+        * @param       integer         $limit
+        * @throws      SystemException
         */
        public function exportUsers($offset, $limit) {
                // prepare password update
@@ -223,6 +227,10 @@ class NodeBB0xRedisExporter extends AbstractExporter {
        
        /**
         * Exports boards.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
+        * @throws      SystemException
         */
        public function exportBoards($offset, $limit) {
                $boardIDs = $this->database->zrange('categories:cid', 0, -1);
@@ -240,6 +248,8 @@ class NodeBB0xRedisExporter extends AbstractExporter {
        
        /**
         * Exports the boards recursively.
+        * 
+        * @param       integer         $parentID
         */
        protected function exportBoardsRecursively($parentID = 0) {
                if (!isset($this->boardCache[$parentID])) return;
@@ -267,6 +277,10 @@ class NodeBB0xRedisExporter extends AbstractExporter {
        
        /**
         * Exports threads.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
+        * @throws      SystemException
         */
        public function exportThreads($offset, $limit) {
                $threadIDs = $this->database->zrange('topics:tid', $offset, $offset + $limit);
@@ -307,6 +321,10 @@ class NodeBB0xRedisExporter extends AbstractExporter {
        
        /**
         * Exports posts.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
+        * @throws      SystemException
         */
        public function exportPosts($offset, $limit) {
                $postIDs = $this->database->zrange('posts:pid', $offset, $offset + $limit);
@@ -345,6 +363,10 @@ class NodeBB0xRedisExporter extends AbstractExporter {
        
        /**
         * Exports likes.
+        * 
+        * @param       integer         $offset
+        * @param       integer         $limit
+        * @throws      SystemException
         */
        public function exportLikes($offset, $limit) {
                $userIDs = $this->database->zrange('users:joindate', $offset, $offset + $limit);
@@ -390,6 +412,10 @@ class NodeBB0xRedisExporter extends AbstractExporter {
        
        /**
         * Exports followers.
+        * 
+        * @param       integer         $offset
+        * @param       integer         $limit
+        * @throws      SystemException
         */
        public function exportFollowers($offset, $limit) {
                $userIDs = $this->database->zrange('users:joindate', $offset, $offset + $limit);
@@ -419,6 +445,10 @@ class NodeBB0xRedisExporter extends AbstractExporter {
        
        /**
         * Exports conversations.
+        * 
+        * @param       integer         $offset
+        * @param       integer         $limit
+        * @throws      SystemException
         */
        public function exportConversations($offset, $limit) {
                $userIDs = $this->database->zrange('users:joindate', $offset, $offset + $limit);
@@ -475,6 +505,9 @@ class NodeBB0xRedisExporter extends AbstractExporter {
        
        /**
         * Exports conversation messages.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversationMessages($offset, $limit) {
                for ($i = 1; $i <= $limit; $i++) {
@@ -497,6 +530,12 @@ class NodeBB0xRedisExporter extends AbstractExporter {
                }
        }
        
+       /**
+        * Returns message with markdown being convered into BBCodes.
+        * 
+        * @param       string          $message
+        * @return      string
+        */
        protected static function convertMarkdown($message) {
                static $parsedown = null;
                static $codeRegex = null;
index 441a5fad8a01dafcc04f7bb609fbb260ce929563..526b1a08a46c777c34cc883a934f29b54b86d1f1 100644 (file)
@@ -219,6 +219,9 @@ class PhpBB31xExporter extends AbstractExporter {
        
        /**
         * Exports user groups.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserGroups($offset, $limit) {
                $sql = "SELECT          *
@@ -269,6 +272,9 @@ class PhpBB31xExporter extends AbstractExporter {
        
        /**
         * Exports users.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUsers($offset, $limit) {
                // cache profile fields
@@ -405,6 +411,9 @@ class PhpBB31xExporter extends AbstractExporter {
        
        /**
         * Exports user options.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserOptions($offset, $limit) {
                $condition = new PreparedStatementConditionBuilder();
@@ -494,6 +503,9 @@ class PhpBB31xExporter extends AbstractExporter {
        
        /**
         * Exports user ranks.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserRanks($offset, $limit) {
                $sql = "SELECT          *
@@ -530,6 +542,9 @@ class PhpBB31xExporter extends AbstractExporter {
        
        /**
         * Exports followers.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportFollowers($offset, $limit) {
                $sql = "SELECT          *
@@ -562,6 +577,9 @@ class PhpBB31xExporter extends AbstractExporter {
        
        /**
         * Exports user avatars.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserAvatars($offset, $limit) {
                static $avatar_salt = null, $avatar_path = null, $avatar_gallery_path = null;
@@ -616,6 +634,9 @@ class PhpBB31xExporter extends AbstractExporter {
        
        /**
         * Exports conversation folders.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversationFolders($offset, $limit) {
                $sql = "SELECT          *
@@ -632,12 +653,14 @@ class PhpBB31xExporter extends AbstractExporter {
        }
        
        /**
-        * Creates a conversation id out of the old rootLevel
-        * and the participants.
+        * Creates a conversation id out of the old rootLevel and the participants.
         * 
-        * This ensures that only the actual receivers of a pm
-        * are able to see it after import, while minimizing the
-        * number of conversations.
+        * This ensures that only the actual receivers of a pm are able to see it
+        * after import, while minimizing the number of conversations.
+        *
+        * @param       integer         $rootLevel
+        * @param       integer[]       $participants
+        * @return      string
         */
        private function getConversationID($rootLevel, array $participants) {
                $conversationID = $rootLevel;
@@ -662,6 +685,9 @@ class PhpBB31xExporter extends AbstractExporter {
        
        /**
         * Exports conversations.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversations($offset, $limit) {
                $sql = "(
@@ -732,6 +758,9 @@ class PhpBB31xExporter extends AbstractExporter {
        
        /**
         * Exports conversation messages.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversationMessages($offset, $limit) {
                $sql = "(
@@ -811,6 +840,9 @@ class PhpBB31xExporter extends AbstractExporter {
        
        /**
         * Exports conversation recipients.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversationUsers($offset, $limit) {
                $sql = "SELECT          to_table.*, msg_table.root_level, msg_table.author_id, msg_table.bcc_address, user_table.username, msg_table.message_time,
@@ -853,6 +885,9 @@ class PhpBB31xExporter extends AbstractExporter {
        
        /**
         * Exports conversation attachments.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversationAttachments($offset, $limit) {
                return $this->exportAttachments(1, $offset, $limit);
@@ -872,6 +907,9 @@ class PhpBB31xExporter extends AbstractExporter {
        
        /**
         * Exports boards.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportBoards($offset, $limit) {
                $sql = "SELECT          *
@@ -888,6 +926,8 @@ class PhpBB31xExporter extends AbstractExporter {
        
        /**
         * Exports the boards recursively.
+        * 
+        * @param       integer         $parentID
         */
        protected function exportBoardsRecursively($parentID = 0) {
                if (!isset($this->boardCache[$parentID])) return;
@@ -924,6 +964,9 @@ class PhpBB31xExporter extends AbstractExporter {
        
        /**
         * Exports threads.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportThreads($offset, $limit) {
                $boardIDs = array_keys(BoardCache::getInstance()->getBoards());
@@ -968,6 +1011,9 @@ class PhpBB31xExporter extends AbstractExporter {
        
        /**
         * Exports posts.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPosts($offset, $limit) {
                $sql = "SELECT          post_table.*, user_table.username, editor.username AS editorName,
@@ -1017,6 +1063,9 @@ class PhpBB31xExporter extends AbstractExporter {
        
        /**
         * Exports post attachments.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPostAttachments($offset, $limit) {
                $this->exportAttachments(0, $offset, $limit);
@@ -1036,6 +1085,9 @@ class PhpBB31xExporter extends AbstractExporter {
        
        /**
         * Exports watched threads.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportWatchedThreads($offset, $limit) {
                // TODO: This is untested. I cannot find the button to watch a topic.
@@ -1069,6 +1121,9 @@ class PhpBB31xExporter extends AbstractExporter {
        
        /**
         * Exports polls.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPolls($offset, $limit) {
                $sql = "SELECT          topic_id, topic_first_post_id, poll_title, poll_start, poll_length, poll_max_options, poll_vote_change,
@@ -1106,6 +1161,9 @@ class PhpBB31xExporter extends AbstractExporter {
        
        /**
         * Exports poll options.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPollOptions($offset, $limit) {
                $sql = "SELECT          *
@@ -1138,6 +1196,9 @@ class PhpBB31xExporter extends AbstractExporter {
        
        /**
         * Exports poll option votes.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPollOptionVotes($offset, $limit) {
                $sql = "SELECT          *
@@ -1169,6 +1230,9 @@ class PhpBB31xExporter extends AbstractExporter {
        
        /**
         * Exports ACLs.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportACLs($offset, $limit) {
                $sql = "SELECT          *
@@ -1318,6 +1382,9 @@ class PhpBB31xExporter extends AbstractExporter {
        
        /**
         * Exports smilies.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportSmilies($offset, $limit) {
                $sql = "SELECT          MIN(smiley_id) AS smiley_id,
@@ -1346,6 +1413,12 @@ class PhpBB31xExporter extends AbstractExporter {
                }
        }
        
+       /**
+        * Returns the number of attachments.
+        * 
+        * @param       integer         $conversation
+        * @return      integer
+        */
        protected function countAttachments($conversation) {
                $sql = "SELECT  COUNT(*) AS count
                        FROM    ".$this->databasePrefix."attachments
@@ -1356,6 +1429,13 @@ class PhpBB31xExporter extends AbstractExporter {
                return $row['count'];
        }
        
+       /**
+        * Exports attachments.
+        * 
+        * @param       integer         $conversation
+        * @param       integer         $offset
+        * @param       integer         $limit
+        */
        protected function exportAttachments($conversation, $offset, $limit) {
                static $upload_path = null;
                if ($upload_path === null) {
@@ -1394,6 +1474,13 @@ class PhpBB31xExporter extends AbstractExporter {
                }
        }
        
+       /**
+        * Returns message with fixed BBCodes as used in WCF.
+        *
+        * @param       string          $text
+        * @param       string          $uid
+        * @return      string
+        */
        protected static function fixBBCodes($text, $uid) {
                // fix closing list tags
                $text = preg_replace('~\[/list:(u|o)~i', '[/list', $text);
index 1e8ada887a8ed822d7a23d6b5f38c7dd9c80371a..0a2f3ffccbf6494ee2c9dd49c51883126c535b5f 100644 (file)
@@ -208,6 +208,9 @@ class PhpBB3xExporter extends AbstractExporter {
        
        /**
         * Exports user groups.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserGroups($offset, $limit) {
                $sql = "SELECT          *
@@ -258,6 +261,9 @@ class PhpBB3xExporter extends AbstractExporter {
        
        /**
         * Exports users.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUsers($offset, $limit) {
                // cache profile fields
@@ -364,6 +370,9 @@ class PhpBB3xExporter extends AbstractExporter {
        
        /**
         * Exports user options.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserOptions($offset, $limit) {
                $sql = "SELECT          fields.*,
@@ -431,6 +440,9 @@ class PhpBB3xExporter extends AbstractExporter {
        
        /**
         * Exports user ranks.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserRanks($offset, $limit) {
                $sql = "SELECT          *
@@ -467,6 +479,9 @@ class PhpBB3xExporter extends AbstractExporter {
        
        /**
         * Exports followers.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportFollowers($offset, $limit) {
                $sql = "SELECT          *
@@ -499,6 +514,9 @@ class PhpBB3xExporter extends AbstractExporter {
        
        /**
         * Exports user avatars.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserAvatars($offset, $limit) {
                static $avatar_salt = null, $avatar_path = null, $avatar_gallery_path = null;
@@ -553,6 +571,9 @@ class PhpBB3xExporter extends AbstractExporter {
        
        /**
         * Exports conversation folders.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversationFolders($offset, $limit) {
                $sql = "SELECT          *
@@ -569,12 +590,14 @@ class PhpBB3xExporter extends AbstractExporter {
        }
        
        /**
-        * Creates a conversation id out of the old rootLevel
-        * and the participants.
+        * Creates a conversation id out of the old rootLevel and the participants.
         * 
-        * This ensures that only the actual receivers of a pm
-        * are able to see it after import, while minimizing the
-        * number of conversations.
+        * This ensures that only the actual receivers of a pm are able to see it
+        * after import, while minimizing the number of conversations.
+        * 
+        * @param       integer         $rootLevel
+        * @param       integer[]       $participants
+        * @return      string
         */
        private function getConversationID($rootLevel, array $participants) {
                $conversationID = $rootLevel;
@@ -599,6 +622,9 @@ class PhpBB3xExporter extends AbstractExporter {
        
        /**
         * Exports conversations.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversations($offset, $limit) {
                $sql = "(
@@ -669,6 +695,9 @@ class PhpBB3xExporter extends AbstractExporter {
        
        /**
         * Exports conversation messages.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversationMessages($offset, $limit) {
                $sql = "(
@@ -748,6 +777,9 @@ class PhpBB3xExporter extends AbstractExporter {
        
        /**
         * Exports conversation recipients.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversationUsers($offset, $limit) {
                $sql = "SELECT          to_table.*, msg_table.root_level, msg_table.author_id, msg_table.bcc_address, user_table.username, msg_table.message_time,
@@ -790,6 +822,9 @@ class PhpBB3xExporter extends AbstractExporter {
        
        /**
         * Exports conversation attachments.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversationAttachments($offset, $limit) {
                return $this->exportAttachments(1, $offset, $limit);
@@ -809,6 +844,9 @@ class PhpBB3xExporter extends AbstractExporter {
        
        /**
         * Exports boards.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportBoards($offset, $limit) {
                $sql = "SELECT          *
@@ -825,6 +863,8 @@ class PhpBB3xExporter extends AbstractExporter {
        
        /**
         * Exports the boards recursively.
+        *
+        * @param       integer         $parentID
         */
        protected function exportBoardsRecursively($parentID = 0) {
                if (!isset($this->boardCache[$parentID])) return;
@@ -861,6 +901,9 @@ class PhpBB3xExporter extends AbstractExporter {
        
        /**
         * Exports threads.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportThreads($offset, $limit) {
                $boardIDs = array_keys(BoardCache::getInstance()->getBoards());
@@ -903,6 +946,9 @@ class PhpBB3xExporter extends AbstractExporter {
        
        /**
         * Exports posts.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPosts($offset, $limit) {
                $sql = "SELECT          post_table.*, user_table.username, editor.username AS editorName,
@@ -950,6 +996,9 @@ class PhpBB3xExporter extends AbstractExporter {
        
        /**
         * Exports post attachments.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPostAttachments($offset, $limit) {
                return $this->exportAttachments(0, $offset, $limit);
@@ -969,6 +1018,9 @@ class PhpBB3xExporter extends AbstractExporter {
        
        /**
         * Exports watched threads.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportWatchedThreads($offset, $limit) {
                // TODO: This is untested. I cannot find the button to watch a topic.
@@ -1002,6 +1054,9 @@ class PhpBB3xExporter extends AbstractExporter {
        
        /**
         * Exports polls.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPolls($offset, $limit) {
                $sql = "SELECT          topic_id, topic_first_post_id, poll_title, poll_start, poll_length, poll_max_options, poll_vote_change,
@@ -1039,6 +1094,9 @@ class PhpBB3xExporter extends AbstractExporter {
        
        /**
         * Exports poll options.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPollOptions($offset, $limit) {
                $sql = "SELECT          *
@@ -1071,6 +1129,9 @@ class PhpBB3xExporter extends AbstractExporter {
        
        /**
         * Exports poll option votes.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPollOptionVotes($offset, $limit) {
                $sql = "SELECT          *
@@ -1102,6 +1163,9 @@ class PhpBB3xExporter extends AbstractExporter {
        
        /**
         * Exports ACLs.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportACLs($offset, $limit) {
                $sql = "SELECT          *
@@ -1251,6 +1315,9 @@ class PhpBB3xExporter extends AbstractExporter {
        
        /**
         * Exports smilies.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportSmilies($offset, $limit) {
                $sql = "SELECT          MIN(smiley_id) AS smiley_id,
@@ -1279,6 +1346,12 @@ class PhpBB3xExporter extends AbstractExporter {
                }
        }
        
+       /**
+        * Returns the number of atatchments.
+        * 
+        * @param       integer         $conversation
+        * @return      integer
+        */
        protected function countAttachments($conversation) {
                $sql = "SELECT  COUNT(*) AS count
                        FROM    ".$this->databasePrefix."attachments
@@ -1289,6 +1362,13 @@ class PhpBB3xExporter extends AbstractExporter {
                return $row['count'];
        }
        
+       /**
+        * Exports attachments.
+        * 
+        * @param       integer         $conversation
+        * @param       integer         $offset
+        * @param       integer         $limit
+        */
        protected function exportAttachments($conversation, $offset, $limit) {
                static $upload_path = null;
                if ($upload_path === null) {
@@ -1327,6 +1407,13 @@ class PhpBB3xExporter extends AbstractExporter {
                }
        }
        
+       /**
+        * Returns message with fixed BBCodes as used in WCF.
+        *
+        * @param       string          $text
+        * @param       string          $uid
+        * @return      string
+        */
        protected static function fixBBCodes($text, $uid) {
                // fix closing list tags
                $text = preg_replace('~\[/list:(u|o)~i', '[/list', $text);
index 9db1b145d69217c8eefc2918aa06dc90b86aa754..2fc25c6494ec494a353b188010093819faa45a56 100644 (file)
@@ -197,6 +197,9 @@ class SMF2xExporter extends AbstractExporter {
        
        /**
         * Exports user groups.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserGroups($offset, $limit) {
                // import everyone, guests and users pseudogroups
@@ -236,6 +239,9 @@ class SMF2xExporter extends AbstractExporter {
        
        /**
         * Exports users.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUsers($offset, $limit) {
                // cache profile fields
@@ -367,6 +373,9 @@ class SMF2xExporter extends AbstractExporter {
        
        /**
         * Exports user options.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserOptions($offset, $limit) {
                $sql = "SELECT          *
@@ -438,6 +447,9 @@ class SMF2xExporter extends AbstractExporter {
        
        /**
         * Exports user ranks.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserRanks($offset, $limit) {
                $sql = "SELECT          *
@@ -473,6 +485,9 @@ class SMF2xExporter extends AbstractExporter {
        
        /**
         * Exports followers.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportFollowers($offset, $limit) {
                $sql = "SELECT          id_member, buddy_list
@@ -507,6 +522,9 @@ class SMF2xExporter extends AbstractExporter {
        
        /**
         * Exports user avatars.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserAvatars($offset, $limit) {
                $sql = "(
@@ -557,6 +575,9 @@ class SMF2xExporter extends AbstractExporter {
        
        /**
         * Exports conversation folders.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversationFolders($offset, $limit) {
                $sql = "SELECT          id_member, message_labels
@@ -579,12 +600,14 @@ class SMF2xExporter extends AbstractExporter {
        }
        
        /**
-        * Creates a conversation id out of the old pmHead
-        * and the participants.
+        * Creates a conversation id out of the old pmHead and the participants.
         * 
-        * This ensures that only the actual receivers of a pm
-        * are able to see it after import, while minimizing the
-        * number of conversations.
+        * This ensures that only the actual receivers of a pm are able to see it
+        * after import, while minimizing the number of conversations.
+        *
+        * @param       integer         $pmHead
+        * @param       integer[]       $participants
+        * @return      string
         */
        private function getConversationID($pmHead, array $participants) {
                $conversationID = $pmHead;
@@ -604,6 +627,9 @@ class SMF2xExporter extends AbstractExporter {
        
        /**
         * Exports conversations.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversations($offset, $limit) {
                $sql = "SELECT          pm.*,
@@ -643,6 +669,9 @@ class SMF2xExporter extends AbstractExporter {
        
        /**
         * Exports conversation messages.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversationMessages($offset, $limit) {
                $sql = "SELECT          pm.*,
@@ -690,6 +719,9 @@ class SMF2xExporter extends AbstractExporter {
        
        /**
         * Exports conversation recipients.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversationUsers($offset, $limit) {
                $sql = "SELECT          recipients.*, pm.id_pm_head, members.member_name, pm.msgtime, pm.id_member_from,
@@ -743,6 +775,9 @@ class SMF2xExporter extends AbstractExporter {
        
        /**
         * Exports boards.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportBoards($offset, $limit) {
                $sql = "SELECT          *
@@ -773,6 +808,8 @@ class SMF2xExporter extends AbstractExporter {
        
        /**
         * Exports the boards recursively.
+        *
+        * @param       integer         $parentID
         */
        protected function exportBoardsRecursively($parentID = 0) {
                if (!isset($this->boardCache[$parentID])) return;
@@ -805,6 +842,9 @@ class SMF2xExporter extends AbstractExporter {
        
        /**
         * Exports threads.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportThreads($offset, $limit) {
                // get threads
@@ -843,6 +883,9 @@ class SMF2xExporter extends AbstractExporter {
        
        /**
         * Exports posts.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPosts($offset, $limit) {
                $sql = "SELECT          message.*, member.id_member AS editorID
@@ -892,6 +935,9 @@ class SMF2xExporter extends AbstractExporter {
        
        /**
         * Exports post attachments.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPostAttachments($offset, $limit) {
                $sql = "SELECT          attachment.*, message.id_member, message.poster_time
@@ -946,6 +992,9 @@ class SMF2xExporter extends AbstractExporter {
        
        /**
         * Exports watched threads.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportWatchedThreads($offset, $limit) {
                $sql = "SELECT          *
@@ -977,6 +1026,9 @@ class SMF2xExporter extends AbstractExporter {
        
        /**
         * Exports polls.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPolls($offset, $limit) {
                $sql = "SELECT          poll.*, topic.id_first_msg,
@@ -1014,6 +1066,9 @@ class SMF2xExporter extends AbstractExporter {
        
        /**
         * Exports poll options.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPollOptions($offset, $limit) {
                $sql = "SELECT          *
@@ -1046,6 +1101,9 @@ class SMF2xExporter extends AbstractExporter {
        
        /**
         * Exports poll option votes.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPollOptionVotes($offset, $limit) {
                $sql = "SELECT          *
@@ -1072,6 +1130,9 @@ class SMF2xExporter extends AbstractExporter {
        
        /**
         * Exports ACLs.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportACLs($offset, $limit) {
                // TODO: try to split this into several requests
@@ -1255,6 +1316,9 @@ class SMF2xExporter extends AbstractExporter {
        
        /**
         * Exports smilies.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportSmilies($offset, $limit) {
                $sql = "SELECT          MIN(id_smiley) AS id_smiley,
@@ -1283,6 +1347,12 @@ class SMF2xExporter extends AbstractExporter {
                }
        }
        
+       /**
+        * Returns the value of the given option in the imported board.
+        *
+        * @param       string          $optionName
+        * @return      mixed
+        */
        private function readOption($optionName) {
                static $optionCache = [];
                
@@ -1300,6 +1370,12 @@ class SMF2xExporter extends AbstractExporter {
                return $optionCache[$optionName];
        }
        
+       /**
+        * Returns message with fixed BBCodes as used in WCF.
+        * 
+        * @param       string          $message
+        * @return      string
+        */
        private static function fixBBCodes($message) {
                static $sizeRegex = null;
                static $quoteRegex = null;
index 7bc9e26eb615b4c58c55139a38e4ca0f38f290fa..cfdf3105060ca5619266ea2d8bca7356e780de3f 100644 (file)
@@ -302,6 +302,9 @@ class VB3or4xExporter extends AbstractExporter {
        
        /**
         * Exports user groups.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserGroups($offset, $limit) {
                $sql = "SELECT          *
@@ -340,6 +343,9 @@ class VB3or4xExporter extends AbstractExporter {
        
        /**
         * Exports users.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUsers($offset, $limit) {
                // cache user options
@@ -434,6 +440,9 @@ class VB3or4xExporter extends AbstractExporter {
        
        /**
         * Exports user ranks.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserRanks($offset, $limit) {
                $sql = "(
@@ -474,6 +483,9 @@ class VB3or4xExporter extends AbstractExporter {
        
        /**
         * Exports followers.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportFollowers($offset, $limit) {
                $sql = "SELECT          userid, buddylist
@@ -502,6 +514,9 @@ class VB3or4xExporter extends AbstractExporter {
        
        /**
         * Exports guestbook entries.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportGuestbookEntries($offset, $limit) {
                $sql = "SELECT          *
@@ -535,6 +550,10 @@ class VB3or4xExporter extends AbstractExporter {
        
        /**
         * Exports user avatars.
+        * 
+        * @param       integer         $offset
+        * @param       integer         $limit
+        * @throws      \Exception
         */
        public function exportUserAvatars($offset, $limit) {
                $sql = "SELECT          customavatar.*, user.avatarrevision
@@ -590,6 +609,9 @@ class VB3or4xExporter extends AbstractExporter {
        
        /**
         * Exports user options.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserOptions($offset, $limit) {
                $sql = "SELECT  *
@@ -719,6 +741,9 @@ class VB3or4xExporter extends AbstractExporter {
        
        /**
         * Exports conversation folders.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversationFolders($offset, $limit) {
                $sql = "SELECT          userid, pmfolders
@@ -755,12 +780,14 @@ class VB3or4xExporter extends AbstractExporter {
        }
        
        /**
-        * Creates a conversation id out of the old parentpmid
-        * and the participants.
+        * Creates a conversation id out of the old parentpmid and the participants.
         * 
-        * This ensures that only the actual receivers of a pm
-        * are able to see it after import, while minimizing the
-        * number of conversations.
+        * This ensures that only the actual receivers of a pm are able to see it
+        * after import, while minimizing the number of conversations.
+        *
+        * @param       integer         $parentpmid
+        * @param       integer[]       $participants
+        * @return      string
         */
        private function getConversationID($parentpmid, array $participants) {
                $conversationID = $parentpmid;
@@ -780,6 +807,9 @@ class VB3or4xExporter extends AbstractExporter {
        
        /**
         * Exports conversations.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversations($offset, $limit) {
                $sql = "SELECT          pm.*, text.*,
@@ -821,6 +851,9 @@ class VB3or4xExporter extends AbstractExporter {
        
        /**
         * Exports conversation messages.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversationMessages($offset, $limit) {
                $sql = "SELECT          pmtext.*,
@@ -870,6 +903,9 @@ class VB3or4xExporter extends AbstractExporter {
        
        /**
         * Exports conversation recipients.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversationUsers($offset, $limit) {
                $sql = "SELECT          pm.*, user.username, pmtext.touserarray, pmtext.dateline, pmtext.fromuserid,
@@ -922,6 +958,9 @@ class VB3or4xExporter extends AbstractExporter {
        
        /**
         * Exports boards.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportBoards($offset, $limit) {
                $sql = "SELECT          *
@@ -938,6 +977,8 @@ class VB3or4xExporter extends AbstractExporter {
        
        /**
         * Exports the boards recursively.
+        *
+        * @param       integer         $parentID
         */
        protected function exportBoardsRecursively($parentID = -1) {
                if (!isset($this->boardCache[$parentID])) return;
@@ -987,6 +1028,9 @@ class VB3or4xExporter extends AbstractExporter {
        
        /**
         * Exports threads.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportThreads($offset, $limit) {
                $sql = "SELECT          thread.*,
@@ -1040,6 +1084,9 @@ class VB3or4xExporter extends AbstractExporter {
        
        /**
         * Exports posts.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPosts($offset, $limit) {
                $sql = "SELECT          post.*,
@@ -1114,6 +1161,10 @@ class VB3or4xExporter extends AbstractExporter {
        
        /**
         * Exports post attachments.
+        * 
+        * @param       integer         $offset
+        * @param       integer         $limit
+        * @throws      \Exception
         */
        public function exportPostAttachments($offset, $limit) {
                try {
@@ -1203,6 +1254,9 @@ class VB3or4xExporter extends AbstractExporter {
        
        /**
         * Exports watched threads.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportWatchedThreads($offset, $limit) {
                $sql = "SELECT          *
@@ -1233,6 +1287,9 @@ class VB3or4xExporter extends AbstractExporter {
        
        /**
         * Exports polls.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPolls($offset, $limit) {
                $sql = "SELECT          poll.*, thread.firstpostid
@@ -1267,6 +1324,9 @@ class VB3or4xExporter extends AbstractExporter {
        
        /**
         * Exports poll options.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPollOptions($offset, $limit) {
                $sql = "SELECT          *
@@ -1301,6 +1361,9 @@ class VB3or4xExporter extends AbstractExporter {
        
        /**
         * Exports poll option votes.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPollOptionVotes($offset, $limit) {
                $sql = "SELECT          *
@@ -1327,6 +1390,9 @@ class VB3or4xExporter extends AbstractExporter {
        
        /**
         * Exports likes.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportLikes($offset, $limit) {
                $sql = "SELECT          *
@@ -1361,6 +1427,9 @@ class VB3or4xExporter extends AbstractExporter {
        
        /**
         * Exports labels.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportLabels($offset, $limit) {
                if (!$offset) {
@@ -1407,6 +1476,9 @@ class VB3or4xExporter extends AbstractExporter {
        
        /**
         * Exports ACLs.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportACLs($offset, $limit) {
                $mapping = [
@@ -1458,6 +1530,9 @@ class VB3or4xExporter extends AbstractExporter {
        
        /**
         * Exports smilies.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportSmilies($offset, $limit) {
                $sql = "SELECT          *
@@ -1492,6 +1567,9 @@ class VB3or4xExporter extends AbstractExporter {
        
        /**
         * Exports smiley categories.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportSmileyCategories($offset, $limit) {
                $sql = "SELECT          *
@@ -1523,6 +1601,9 @@ class VB3or4xExporter extends AbstractExporter {
        
        /**
         * Exports gallery albums.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportGalleryAlbums($offset, $limit) {
                $sql = "SELECT          album.*, user.username
@@ -1567,6 +1648,10 @@ class VB3or4xExporter extends AbstractExporter {
        
        /**
         * Exports gallery images.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
+        * @throws      \Exception
         */
        public function exportGalleryImages($offset, $limit) {
                try {
@@ -1674,6 +1759,9 @@ class VB3or4xExporter extends AbstractExporter {
        
        /**
         * Exports gallery comments.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportGalleryComments($offset, $limit) {
                $sql = "SELECT          comment.*, user.username
@@ -1709,6 +1797,9 @@ class VB3or4xExporter extends AbstractExporter {
        
        /**
         * Exports calendar categories.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportCalendarCategories($offset, $limit) {
                $sql = "SELECT          *
@@ -1735,6 +1826,9 @@ class VB3or4xExporter extends AbstractExporter {
        
        /**
         * Exports calendar events.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportCalendarEvents($offset, $limit) {
                $sql = "SELECT          event.*, user.username
@@ -1850,6 +1944,12 @@ class VB3or4xExporter extends AbstractExporter {
                }
        }
        
+       /**
+        * Returns the value of the given option in the imported board.
+        *
+        * @param       string          $optionName
+        * @return      mixed
+        */
        private function readOption($optionName) {
                static $optionCache = [];
                
@@ -1867,6 +1967,12 @@ class VB3or4xExporter extends AbstractExporter {
                return $optionCache[$optionName];
        }
        
+       /**
+        * Returns message with fixed BBCodes as used in WCF.
+        *
+        * @param       string          $message
+        * @return      string
+        */
        private static function fixBBCodes($message) {
                static $quoteRegex = null;
                static $quoteCallback = null;
index 485195c3517cb022b5db3f3864ebec43b4bfc4f9..6036d064e6f1c2df437bb8eb7e5cefcc578b3098 100644 (file)
@@ -212,6 +212,9 @@ class VB5xExporter extends AbstractExporter {
        
        /**
         * Exports user groups.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserGroups($offset, $limit) {
                $sql = "SELECT          *
@@ -252,6 +255,9 @@ class VB5xExporter extends AbstractExporter {
        
        /**
         * Exports users.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUsers($offset, $limit) {
                // prepare password update
@@ -319,6 +325,10 @@ class VB5xExporter extends AbstractExporter {
        
        /**
         * Exports user avatars.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
+        * @throws      \Exception
         */
        public function exportUserAvatars($offset, $limit) {
                $sql = "SELECT          customavatar.*, user.avatarrevision
@@ -380,6 +390,9 @@ class VB5xExporter extends AbstractExporter {
        
        /**
         * Exports boards.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportBoards($offset, $limit) {
                $sql = "SELECT          node.*
@@ -400,6 +413,8 @@ class VB5xExporter extends AbstractExporter {
        
        /**
         * Exports the boards recursively.
+        *
+        * @param       integer         $parentID
         */
        protected function exportBoardsRecursively($parentID = 0) {
                if (!isset($this->boardCache[$parentID])) return;
@@ -429,6 +444,9 @@ class VB5xExporter extends AbstractExporter {
        
        /**
         * Exports threads.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportThreads($offset, $limit) {
                $sql = "SELECT          child.*, view.count AS views
@@ -477,6 +495,9 @@ class VB5xExporter extends AbstractExporter {
        
        /**
         * Exports posts.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPosts($offset, $limit) {
                $sql = "SELECT          child.*, IF(parent.contenttypeid = child.contenttypeid, 0, 1) AS isFirstPost, text.*
@@ -528,6 +549,10 @@ class VB5xExporter extends AbstractExporter {
        
        /**
         * Exports post attachments.
+        * 
+        * @param       integer         $offset
+        * @param       integer         $limit
+        * @throws      \Exception
         */
        public function exportPostAttachments($offset, $limit) {
                $sql = "SELECT          child.*, attach.*, filedata.*
@@ -610,6 +635,9 @@ class VB5xExporter extends AbstractExporter {
        
        /**
         * Exports polls.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPolls($offset, $limit) {
                $sql = "SELECT          *
@@ -642,6 +670,9 @@ class VB5xExporter extends AbstractExporter {
        
        /**
         * Exports poll options.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPollOptions($offset, $limit) {
                $sql = "SELECT          polloption.*, poll.pollid
@@ -671,6 +702,9 @@ class VB5xExporter extends AbstractExporter {
        
        /**
         * Exports poll option votes.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPollOptionVotes($offset, $limit) {
                $sql = "SELECT          *
@@ -688,6 +722,12 @@ class VB5xExporter extends AbstractExporter {
                }
        }
        
+       /**
+        * Returns the value of the given option in the imported board.
+        * 
+        * @param       string          $optionName
+        * @return      mixed
+        */
        private function readOption($optionName) {
                static $optionCache = [];
                
@@ -705,6 +745,12 @@ class VB5xExporter extends AbstractExporter {
                return $optionCache[$optionName];
        }
        
+       /**
+        * Returns message with fixed BBCodes as used in WCF.
+        *
+        * @param       string          $message
+        * @return      string
+        */
        private static function fixBBCodes($message) {
                static $quoteRegex = null;
                static $quoteCallback = null;
index c960d29617f2079393698affc604722011de49ba..59060e18cc13889b190615b812ab5c9b08ca7bf1 100644 (file)
@@ -199,6 +199,9 @@ class WBB2xExporter extends AbstractExporter {
        
        /**
         * Exports user groups.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserGroups($offset, $limit) {
                $sql = "SELECT          *
@@ -238,6 +241,9 @@ class WBB2xExporter extends AbstractExporter {
        
        /**
         * Exports users.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUsers($offset, $limit) {
                // cache profile fields
@@ -333,6 +339,9 @@ class WBB2xExporter extends AbstractExporter {
        
        /**
         * Exports user ranks.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserRanks($offset, $limit) {
                $sql = "SELECT          *
@@ -365,6 +374,9 @@ class WBB2xExporter extends AbstractExporter {
        
        /**
         * Exports user avatars.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserAvatars($offset, $limit) {
                $sql = "SELECT          *
@@ -399,6 +411,9 @@ class WBB2xExporter extends AbstractExporter {
        
        /**
         * Exports user options.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserOptions($offset, $limit) {
                $sql = "SELECT          *
@@ -450,6 +465,9 @@ class WBB2xExporter extends AbstractExporter {
        
        /**
         * Exports conversation folders.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversationFolders($offset, $limit) {
                $sql = "SELECT          *
@@ -474,6 +492,9 @@ class WBB2xExporter extends AbstractExporter {
        
        /**
         * Exports conversations.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversations($offset, $limit) {
                $sql = "SELECT          pm.*, user_table.username
@@ -522,6 +543,9 @@ class WBB2xExporter extends AbstractExporter {
        
        /**
         * Exports conversation recipients.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversationUsers($offset, $limit) {
                $sql = "SELECT          *
@@ -550,6 +574,9 @@ class WBB2xExporter extends AbstractExporter {
        
        /**
         * Exports conversation attachments.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversationAttachments($offset, $limit) {
                $this->exportAttachments('privatemessageid', 'com.woltlab.wcf.conversation.attachment', $offset, $limit);
@@ -569,6 +596,9 @@ class WBB2xExporter extends AbstractExporter {
        
        /**
         * Exports boards.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportBoards($offset, $limit) {
                $sql = "SELECT          *
@@ -585,6 +615,8 @@ class WBB2xExporter extends AbstractExporter {
        
        /**
         * Exports the boards recursively.
+        *
+        * @param       integer         $parentID
         */
        protected function exportBoardsRecursively($parentID = 0) {
                if (!isset($this->boardCache[$parentID])) return;
@@ -615,6 +647,9 @@ class WBB2xExporter extends AbstractExporter {
        
        /**
         * Exports threads.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportThreads($offset, $limit) {
                // get global prefixes
@@ -728,6 +763,9 @@ class WBB2xExporter extends AbstractExporter {
        
        /**
         * Exports posts.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPosts($offset, $limit) {
                $sql = "SELECT          *
@@ -768,6 +806,9 @@ class WBB2xExporter extends AbstractExporter {
        
        /**
         * Exports post attachments.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPostAttachments($offset, $limit) {
                $this->exportAttachments('postid', 'com.woltlab.wbb.attachment', $offset, $limit);
@@ -787,6 +828,9 @@ class WBB2xExporter extends AbstractExporter {
        
        /**
         * Exports watched threads.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportWatchedThreads($offset, $limit) {
                $sql = "SELECT          *
@@ -816,6 +860,9 @@ class WBB2xExporter extends AbstractExporter {
        
        /**
         * Exports polls.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPolls($offset, $limit) {
                // prepare statements
@@ -875,6 +922,9 @@ class WBB2xExporter extends AbstractExporter {
        
        /**
         * Exports poll options.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPollOptions($offset, $limit) {
                $sql = "SELECT          *
@@ -884,9 +934,9 @@ class WBB2xExporter extends AbstractExporter {
                $statement->execute([]);
                while ($row = $statement->fetchArray()) {
                        ImportHandler::getInstance()->getImporter('com.woltlab.wbb.poll.option')->import($row['polloptionid'], [
-                       'pollID' => $row['pollid'],
-                       'optionValue' => $row['polloption'],
-                       'votes' => $row['votes']
+                               'pollID' => $row['pollid'],
+                               'optionValue' => $row['polloption'],
+                               'votes' => $row['votes']
                        ]);
                }
        }
@@ -906,6 +956,9 @@ class WBB2xExporter extends AbstractExporter {
        
        /**
         * Exports labels.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportLabels($offset, $limit) {
                $prefixMap = [];
@@ -995,6 +1048,9 @@ class WBB2xExporter extends AbstractExporter {
        
        /**
         * Exports ACLs.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportACLs($offset, $limit) {
                $sql = "SELECT          *
@@ -1032,6 +1088,9 @@ class WBB2xExporter extends AbstractExporter {
        
        /**
         * Exports smilies.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportSmilies($offset, $limit) {
                $sql = "SELECT          *
@@ -1056,6 +1115,12 @@ class WBB2xExporter extends AbstractExporter {
                }
        }
        
+       /**
+        * Returns the number of attachments.
+        * 
+        * @param       integer         $indexName
+        * @return      integer
+        */
        private function countAttachments($indexName) {
                $sql = "SELECT  COUNT(*) AS count
                        FROM    ".$this->databasePrefix."attachments
@@ -1066,6 +1131,14 @@ class WBB2xExporter extends AbstractExporter {
                return $row['count'];
        }
        
+       /**
+        * Exports attachments.
+        * 
+        * @param       integer         $indexName
+        * @param       string          $objectType
+        * @param       integer         $offset
+        * @param       integer         $limit
+        */
        private function exportAttachments($indexName, $objectType, $offset, $limit) {
                $sql = "SELECT          *
                        FROM            ".$this->databasePrefix."attachments
@@ -1095,6 +1168,12 @@ class WBB2xExporter extends AbstractExporter {
                }
        }
        
+       /**
+        * Returns message with BBCodes as used in WCF.
+        *
+        * @param       string          $text
+        * @return      string
+        */
        private static function fixBBCodes($text) {
                $text = str_ireplace('[center]', '[align=center]', $text);
                $text = str_ireplace('[/center]', '[/align]', $text);
index e53c326af92a8173818bb5303ce686cee0ac2cb8..aca820811577e5a1a7a243177248ff4a07e76a49 100644 (file)
@@ -312,6 +312,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports user groups.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserGroups($offset, $limit) {
                $sql = "SELECT          *
@@ -339,6 +342,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports users.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUsers($offset, $limit) {
                // cache existing user options
@@ -471,6 +477,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports user ranks.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserRanks($offset, $limit) {
                $sql = "SELECT          *
@@ -505,6 +514,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports followers.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportFollowers($offset, $limit) {
                $sql = "SELECT          *
@@ -530,6 +542,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports guestbook entries.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportGuestbookEntries($offset, $limit) {
                $sql = "SELECT          *
@@ -565,6 +580,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports guestbook responses.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportGuestbookResponses($offset, $limit) {
                $sql = "SELECT          user_guestbook.*, user_table.username AS ownerName
@@ -603,6 +621,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports user avatars.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserAvatars($offset, $limit) {
                $sql = "SELECT          *
@@ -645,6 +666,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports user options.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserOptions($offset, $limit) {
                // get existing option names
@@ -751,6 +775,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports conversation folders.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversationFolders($offset, $limit) {
                $sql = "SELECT          *
@@ -781,12 +808,14 @@ class WBB3xExporter extends AbstractExporter {
        }
        
        /**
-        * Creates a conversation id out of the old parentPmID
-        * and the participants.
+        * Creates a conversation id out of the old parentPmID and the participants.
         * 
-        * This ensures that only the actual receivers of a pm
-        * are able to see it after import, while minimizing the
-        * number of conversations.
+        * This ensures that only the actual receivers of a pm are able to see it
+        * after import, while minimizing the number of conversations.
+        *
+        * @param       integer         $parentPmID
+        * @param       integer[]       $participants
+        * @return      string
         */
        private function getConversationID($parentPmID, array $participants) {
                $conversationID = $parentPmID;
@@ -806,6 +835,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports conversations.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversations($offset, $limit) {
                $sql = "SELECT          pm.*,
@@ -845,6 +877,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports conversation messages.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversationMessages($offset, $limit) {
                $sql = "SELECT          pm.*,
@@ -892,6 +927,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports conversation recipients.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversationUsers($offset, $limit) {
                $sql = "SELECT          pm_to_user.*,
@@ -937,6 +975,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports conversation attachments.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversationAttachments($offset, $limit) {
                $this->exportAttachments('pm', 'com.woltlab.wcf.conversation.attachment', $offset, $limit);
@@ -956,6 +997,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports boards.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportBoards($offset, $limit) {
                $sql = "SELECT          board.*, structure.position
@@ -974,6 +1018,8 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports the boards recursively.
+        *
+        * @param       integer         $parentID
         */
        protected function exportBoardsRecursively($parentID = 0) {
                if (!isset($this->boardCache[$parentID])) return;
@@ -1022,6 +1068,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports threads.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportThreads($offset, $limit) {
                // get global prefixes
@@ -1157,6 +1206,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports posts.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPosts($offset, $limit) {
                $sql = "SELECT          *
@@ -1201,6 +1253,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports post attachments.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPostAttachments($offset, $limit) {
                $this->exportAttachments('post', 'com.woltlab.wbb.attachment', $offset, $limit);
@@ -1220,6 +1275,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports watched threads.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportWatchedThreads($offset, $limit) {
                $sql = "SELECT          *
@@ -1252,6 +1310,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports polls.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPolls($offset, $limit) {
                $sql = "SELECT          *
@@ -1296,6 +1357,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports poll options.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPollOptions($offset, $limit) {
                $sql = "SELECT          *
@@ -1339,6 +1403,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports poll option votes.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPollOptionVotes($offset, $limit) {
                $sql = "SELECT          *
@@ -1377,6 +1444,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports thread ratings.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportThreadRatings($offset, $limit) {
                $sql = "SELECT          thread_rating.*, thread.firstPostID, thread.userID AS objectUserID,
@@ -1425,6 +1495,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports labels.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportLabels($offset, $limit) {
                $prefixMap = [];
@@ -1525,6 +1598,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports ACLs.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportACLs($offset, $limit) {
                // get ids
@@ -1651,6 +1727,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports smilies.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportSmilies($offset, $limit) {
                $sql = "SELECT          *
@@ -1684,6 +1763,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports smiley categories.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportSmileyCategories($offset, $limit) {
                $sql = "SELECT          *
@@ -1715,6 +1797,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports blog categories.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportBlogCategories($offset, $limit) {
                $sql = "SELECT          *
@@ -1741,6 +1826,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports blog entries.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportBlogEntries($offset, $limit) {
                // get entry ids
@@ -1821,6 +1909,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports blog attachments.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportBlogAttachments($offset, $limit) {
                $this->exportAttachments('userBlogEntry', 'com.woltlab.blog.entry.attachment', $offset, $limit);
@@ -1835,6 +1926,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports blog comments.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportBlogComments($offset, $limit) {
                $sql = "SELECT          *
@@ -1871,6 +1965,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports blog entry likes.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportBlogEntryLikes($offset, $limit) {
                $sql = "SELECT          rating.*, blog.userID AS objectUserID
@@ -1907,6 +2004,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports gallery categories.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportGalleryCategories($offset, $limit) {
                $sql = "SELECT          *
@@ -1932,6 +2032,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports gallery albums.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportGalleryAlbums($offset, $limit) {
                $destVersion21 = version_compare(GALLERYCore::getInstance()->getPackage()->packageVersion, '2.1.0 Alpha 1', '>=');
@@ -1969,6 +2072,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports gallery images.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportGalleryImages($offset, $limit) {
                // get ids
@@ -2053,6 +2159,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports gallery comments.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportGalleryComments($offset, $limit) {
                $sql = "SELECT          *
@@ -2089,6 +2198,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports gallery image likes.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportGalleryImageLikes($offset, $limit) {
                $sql = "SELECT          rating.*, photo.ownerID AS objectUserID
@@ -2127,6 +2239,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports calendar categories.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportCalendarCategories($offset, $limit) {
                $sql = "SELECT          *
@@ -2154,6 +2269,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports calendar events.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportCalendarEvents($offset, $limit) {
                $sql = "SELECT          calendar_event_participation.*, calendar_event_message.*, calendar_event.*
@@ -2296,6 +2414,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports calendar attachments.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportCalendarAttachments($offset, $limit) {
                $this->exportAttachments('event', 'com.woltlab.calendar.event.attachment', $offset, $limit);
@@ -2315,6 +2436,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports calendar event dates.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportCalendarEventDates($offset, $limit) {
                $sql = "SELECT          *
@@ -2347,6 +2471,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports calendar event date comments.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportCalendarEventDateComments($offset, $limit) {
                $sql = "SELECT          startTime
@@ -2390,6 +2517,9 @@ class WBB3xExporter extends AbstractExporter {
        
        /**
         * Exports calendar event date participations.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportCalendarEventDateParticipation($offset, $limit) {
                $sql = "SELECT          startTime
@@ -2421,6 +2551,12 @@ class WBB3xExporter extends AbstractExporter {
                }
        }
        
+       /**
+        * Returns the number of attachments.
+        * 
+        * @param       string          $type
+        * @return      integer
+        */
        private function countAttachments($type) {
                if (substr($this->getPackageVersion('com.woltlab.wcf'), 0, 3) == '1.1') {
                        $sql = "SELECT  COUNT(*) AS count
@@ -2440,6 +2576,14 @@ class WBB3xExporter extends AbstractExporter {
                return $row['count'];
        }
        
+       /**
+        * Exports attachments.
+        * 
+        * @param       string          $type
+        * @param       string          $objectType
+        * @param       integer         $offset
+        * @param       integer         $limit
+        */
        private function exportAttachments($type, $objectType, $offset, $limit) {
                if (substr($this->getPackageVersion('com.woltlab.wcf'), 0, 3) == '1.1') {
                        $sql = "SELECT          *
@@ -2495,6 +2639,13 @@ class WBB3xExporter extends AbstractExporter {
                return $optionsNames;
        }
        
+       /**
+        * Returns the version of a package in the imported system or `false` if the package is
+        * not installed in the imported system. 
+        * 
+        * @param       string          $name
+        * @return      string|boolean
+        */
        private function getPackageVersion($name) {
                $sql = "SELECT  packageVersion
                        FROM    wcf".$this->dbNo."_package
@@ -2507,6 +2658,13 @@ class WBB3xExporter extends AbstractExporter {
                return false;
        }
        
+       /**
+        * Returns tags to import.
+        * 
+        * @param       string          $name
+        * @param       integer[]       $objectIDs
+        * @return      string[][]
+        */
        private function getTags($name, array $objectIDs) {
                $tags = [];
                if (substr($this->getPackageVersion('com.woltlab.wcf'), 0, 3) == '1.1' && $this->getPackageVersion('com.woltlab.wcf.tagging')) {
@@ -2540,6 +2698,12 @@ class WBB3xExporter extends AbstractExporter {
                return $tags;
        }
        
+       /**
+        * Returns message with fixed BBCodes as used in WCF.
+        *
+        * @param       string          $message
+        * @return      string
+        */
        private static function fixBBCodes($message) {
                // code bbcodes
                $message = preg_replace('~\[(php|java|css|html|xml|tpl|js|c)\]~', '[code=\\1]', $message);
index e7eceaef0e20da04de1467b282d40e0126c4cef8..5a33de37c62f67fed1ab276dbf261f419c425ddb 100644 (file)
@@ -330,6 +330,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports user groups.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserGroups($offset, $limit) {
                $sql = "SELECT          *
@@ -358,6 +361,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports users.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUsers($offset, $limit) {
                // cache existing user options
@@ -469,6 +475,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports user ranks.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserRanks($offset, $limit) {
                $sql = "SELECT          *
@@ -498,6 +507,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports followers.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportFollowers($offset, $limit) {
                $sql = "SELECT          *
@@ -524,6 +536,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports profile comments.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportProfileComments($offset, $limit) {
                $this->exportComments('com.woltlab.wcf.user.profileComment', 'com.woltlab.wcf.user.comment', $offset, $limit);
@@ -538,6 +553,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports profile comment responses.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportProfileCommentResponses($offset, $limit) {
                $this->exportCommentResponses('com.woltlab.wcf.user.profileComment', 'com.woltlab.wcf.user.comment.response', $offset, $limit);
@@ -552,6 +570,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports user avatars.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserAvatars($offset, $limit) {
                $sql = "SELECT          *
@@ -596,6 +617,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports user options.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserOptions($offset, $limit) {
                // get existing option names
@@ -647,6 +671,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports conversation labels.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversationLabels($offset, $limit) {
                $sql = "SELECT          *
@@ -673,6 +700,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports conversations.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversations($offset, $limit) {
                $sql = "SELECT          *
@@ -704,6 +734,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports conversation messages.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversationMessages($offset, $limit) {
                $sql = "SELECT          *
@@ -743,6 +776,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports conversation recipients.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversationUsers($offset, $limit) {
                $conversationIDs = $userID = $rows = [];
@@ -795,6 +831,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports conversation attachments.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversationAttachments($offset, $limit) {
                $this->exportAttachments('com.woltlab.wcf.conversation.message', 'com.woltlab.wcf.conversation.attachment', $offset, $limit);
@@ -814,6 +853,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports boards.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportBoards($offset, $limit) {
                $sql = "SELECT          *
@@ -830,6 +872,8 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports the boards recursively.
+        *
+        * @param       integer         $parentID
         */
        protected function exportBoardsRecursively($parentID = null) {
                if (!isset($this->boardCache[$parentID])) return;
@@ -876,6 +920,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports threads.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportThreads($offset, $limit) {
                // get thread ids
@@ -966,6 +1013,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports posts.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPosts($offset, $limit) {
                $sql = "SELECT          *
@@ -1010,6 +1060,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports post attachments.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPostAttachments($offset, $limit) {
                $this->exportAttachments('com.woltlab.wbb.post', 'com.woltlab.wbb.attachment', $offset, $limit);
@@ -1030,6 +1083,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports watched threads.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportWatchedThreads($offset, $limit) {
                $sql = "SELECT          *
@@ -1062,6 +1118,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports polls.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPolls($offset, $limit) {
                $sql = "SELECT          *
@@ -1105,6 +1164,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports poll options.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPollOptions($offset, $limit) {
                $sql = "SELECT          *
@@ -1146,6 +1208,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports poll option votes.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPollOptionVotes($offset, $limit) {
                $sql = "SELECT          *
@@ -1176,6 +1241,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports likes.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPostLikes($offset, $limit) {
                $this->exportLikes('com.woltlab.wbb.likeablePost', 'com.woltlab.wbb.like', $offset, $limit);
@@ -1195,6 +1263,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports labels.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportLabels($offset, $limit) {
                // get labels array($this->getObjectTypeID('com.woltlab.wcf.label.object', 'com.woltlab.wbb.thread'))
@@ -1267,6 +1338,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports ACLs.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportACLs($offset, $limit) {
                $objectTypeID = $this->getObjectTypeID('com.woltlab.wcf.acl', 'com.woltlab.wbb.board');
@@ -1317,6 +1391,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports smilies.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportSmilies($offset, $limit) {
                $sql = "SELECT          *
@@ -1352,11 +1429,14 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports smiley categories.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportSmileyCategories($offset, $limit) {
                $sql = "SELECT          *
                        FROM            wcf".$this->dbNo."_category
-                       WHERE           objectTypeID = ?                
+                       WHERE           objectTypeID = ?
                        ORDER BY        categoryID";
                $statement = $this->database->prepareStatement($sql, $limit, $offset);
                $statement->execute([$this->getObjectTypeID('com.woltlab.wcf.category', 'com.woltlab.wcf.bbcode.smiley')]);
@@ -1387,6 +1467,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports blogs.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportBlogs($offset, $limit) {
                $sql = "SELECT          blog.*, language.languageCode
@@ -1421,6 +1504,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports blog categories.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportBlogCategories($offset, $limit) {
                $this->exportCategories('com.woltlab.blog.category', 'com.woltlab.blog.category', $offset, $limit);
@@ -1435,6 +1521,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports blog entries.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportBlogEntries($offset, $limit) {
                $sourceVersion21 = version_compare($this->getPackageVersion('com.woltlab.blog'), '2.1.0 Alpha 1', '>=');
@@ -1528,6 +1617,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports blog attachments.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportBlogAttachments($offset, $limit) {
                $this->exportAttachments('om.woltlab.blog.entry', 'com.woltlab.blog.entry.attachment', $offset, $limit);
@@ -1542,6 +1634,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports blog comments.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportBlogComments($offset, $limit) {
                $this->exportComments('com.woltlab.blog.entryComment', 'com.woltlab.blog.entry.comment', $offset, $limit);
@@ -1556,6 +1651,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports blog comment responses.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportBlogCommentResponses($offset, $limit) {
                $this->exportCommentResponses('com.woltlab.blog.entryComment', 'com.woltlab.blog.entry.comment.response', $offset, $limit);
@@ -1570,6 +1668,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports blog entry likes.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportBlogEntryLikes($offset, $limit) {
                $this->exportLikes('com.woltlab.blog.likeableEntry', 'com.woltlab.blog.entry.like', $offset, $limit);
@@ -1624,6 +1725,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports gallery categories.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportGalleryCategories($offset, $limit) {
                $this->exportCategories('com.woltlab.gallery.category', 'com.woltlab.gallery.category', $offset, $limit);
@@ -1638,6 +1742,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports gallery images.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportGalleryImages($offset, $limit) {
                $sourceVersion21 = version_compare($this->getPackageVersion('com.woltlab.gallery'), '2.1.0 Alpha 1', '>=');
@@ -1770,6 +1877,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports gallery image markers.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportGalleryImageMarkers($offset, $limit) {
                $sql = "SELECT          *
@@ -1798,6 +1908,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports gallery comments.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportGalleryComments($offset, $limit) {
                $this->exportComments('com.woltlab.gallery.imageComment', 'com.woltlab.gallery.image.comment', $offset, $limit);
@@ -1812,6 +1925,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports gallery comment responses.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportGalleryCommentResponses($offset, $limit) {
                $this->exportCommentResponses('com.woltlab.gallery.imageComment', 'com.woltlab.gallery.image.comment.response', $offset, $limit);
@@ -1826,6 +1942,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports gallery image likes.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportGalleryImageLikes($offset, $limit) {
                $this->exportLikes('com.woltlab.gallery.likeableImage', 'com.woltlab.gallery.image.like', $offset, $limit);
@@ -1840,6 +1959,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports calendar events.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportCalendarEvents($offset, $limit) {
                // get event ids
@@ -1932,6 +2054,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports calendar event dates.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportCalendarEventDates($offset, $limit) {
                $sql = "SELECT          *
@@ -1960,6 +2085,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports calendar event date participations.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportCalendarEventDateParticipation($offset, $limit) {
                $sql = "SELECT          *
@@ -1990,6 +2118,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports calendar categories.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportCalendarCategories($offset, $limit) {
                $this->exportCategories('com.woltlab.calendar.category', 'com.woltlab.calendar.category', $offset, $limit);
@@ -2004,6 +2135,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports calendar attachments.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportCalendarAttachments($offset, $limit) {
                $this->exportAttachments('com.woltlab.calendar.event', 'com.woltlab.calendar.event.attachment', $offset, $limit);
@@ -2018,6 +2152,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports calendar event comments.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportCalendarEventDateComments($offset, $limit) {
                $this->exportComments('com.woltlab.calendar.eventDateComment', 'com.woltlab.calendar.event.date.comment', $offset, $limit);
@@ -2032,6 +2169,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports calendar event comment responses.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportCalendarEventDateCommentResponses($offset, $limit) {
                $this->exportCommentResponses('com.woltlab.calendar.eventDateComment', 'com.woltlab.calendar.event.date.comment.response', $offset, $limit);
@@ -2046,6 +2186,9 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports gallery image likes.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportCalendarEventLikes($offset, $limit) {
                $this->exportLikes('com.woltlab.calendar.likeableEvent', 'com.woltlab.calendar.event.like', $offset, $limit);
@@ -2053,6 +2196,8 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Counts comments.
+        *
+        * @param       integer         $objectType
         */
        private function countComments($objectType) {
                $sql = "SELECT  COUNT(*) AS count
@@ -2066,6 +2211,11 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports comments.
+        * 
+        * @param       string          $objectType
+        * @param       string          $importer
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        private function exportComments($objectType, $importer, $offset, $limit) {
                $sql = "SELECT          *
@@ -2087,6 +2237,8 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Counts comment responses.
+        *
+        * @param       string          $objectType
         */
        private function countCommentResponses($objectType) {
                $sql = "SELECT  COUNT(*) AS count
@@ -2100,6 +2252,11 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports profile Comment responses.
+        *
+        * @param       string          $objectType
+        * @param       string          $importer
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        private function exportCommentResponses($objectType, $importer, $offset, $limit) {
                $sql = "SELECT          *
@@ -2121,6 +2278,8 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Counts likes.
+        *
+        * @param       string          $objectType
         */
        private function countLikes($objectType) {
                $sql = "SELECT  COUNT(*) AS count
@@ -2134,6 +2293,11 @@ class WBB4xExporter extends AbstractExporter {
        
        /**
         * Exports likes.
+        *
+        * @param       string          $objectType
+        * @param       string          $importer
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        private function exportLikes($objectType, $importer, $offset, $limit) {
                $sql = "SELECT          *
@@ -2153,6 +2317,12 @@ class WBB4xExporter extends AbstractExporter {
                }
        }
        
+       /**
+        * Returns the number of attachments.
+        * 
+        * @param       string          $objectType
+        * @return      integer
+        */
        private function countAttachments($objectType) {
                $sql = "SELECT  COUNT(*) AS count
                        FROM    wcf".$this->dbNo."_attachment
@@ -2164,6 +2334,14 @@ class WBB4xExporter extends AbstractExporter {
                return $row['count'];
        }
        
+       /**
+        * Exports attachments.
+        * 
+        * @param       string          $objectType
+        * @param       string          $importer
+        * @param       integer         $offset
+        * @param       integer         $limit
+        */
        private function exportAttachments($objectType, $importer, $offset, $limit) {
                $sql = "SELECT          *
                        FROM            wcf".$this->dbNo."_attachment
@@ -2212,6 +2390,13 @@ class WBB4xExporter extends AbstractExporter {
                return $optionsNames;
        }
        
+       /**
+        * Returns the version of a package in the imported system or `false` if the package is
+        * not installed in the imported system.
+        *
+        * @param       string          $name
+        * @return      string|boolean
+        */
        private function getPackageVersion($name) {
                $sql = "SELECT  packageVersion
                        FROM    wcf".$this->dbNo."_package
@@ -2224,6 +2409,13 @@ class WBB4xExporter extends AbstractExporter {
                return false;
        }
        
+       /**
+        * Returns tags to import.
+        *
+        * @param       string          $objectType
+        * @param       integer[]       $objectIDs
+        * @return      string[][]
+        */
        private function getTags($objectType, array $objectIDs) {
                $tags = [];
                $conditionBuilder = new PreparedStatementConditionBuilder();
@@ -2245,6 +2437,13 @@ class WBB4xExporter extends AbstractExporter {
                return $tags;
        }
        
+       /**
+        * Returns the ids of labels to import.
+        * 
+        * @param       string          $objectType
+        * @param       integer[]       $objectIDs
+        * @return      integer[][]
+        */
        private function getLabels($objectType, array $objectIDs) {
                $labels = [];
                $conditionBuilder = new PreparedStatementConditionBuilder();
@@ -2264,6 +2463,14 @@ class WBB4xExporter extends AbstractExporter {
                return $labels;
        }
        
+       /**
+        * Returns the id of an object type in the imported system or null if no such
+        * object type exists.
+        * 
+        * @param       string          $definitionName
+        * @param       string          $objectTypeName
+        * @return      integer|null
+        */
        private function getObjectTypeID($definitionName, $objectTypeName) {
                $sql = "SELECT  objectTypeID
                        FROM    wcf".$this->dbNo."_object_type
@@ -2279,6 +2486,12 @@ class WBB4xExporter extends AbstractExporter {
                return null;
        }
        
+       /**
+        * Returns the number of categories.
+        * 
+        * @param       string          $objectType
+        * @return      integer
+        */
        private function countCategories($objectType) {
                $sql = "SELECT  COUNT(*)
                        FROM    wcf".$this->dbNo."_category
@@ -2289,6 +2502,14 @@ class WBB4xExporter extends AbstractExporter {
                return $statement->fetchColumn();
        }
        
+       /**
+        * Exports categories.
+        * 
+        * @param       string          $objectType
+        * @param       string          $importer
+        * @param       integer         $offset
+        * @param       integer         $limit
+        */
        private function exportCategories($objectType, $importer, $offset, $limit) {
                $sql = "SELECT          *
                        FROM            wcf".$this->dbNo."_category
index edfa29e8c9cdaf2df2f589d85b4d6b6b3b24c61b..6d3e49cd260c62ab6a66f2cf9377f3a4e9d3b2d7 100644 (file)
@@ -108,6 +108,9 @@ class WordPress3xExporter extends AbstractExporter {
        
        /**
         * Exports users.
+        * 
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUsers($offset, $limit) {
                // prepare password update
@@ -156,6 +159,9 @@ class WordPress3xExporter extends AbstractExporter {
        
        /**
         * Exports categories.
+        * 
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportBlogCategories($offset, $limit) {
                $sql = "SELECT          term_taxonomy.*, term.name
@@ -175,6 +181,8 @@ class WordPress3xExporter extends AbstractExporter {
        
        /**
         * Exports the categories recursively.
+        * 
+        * @param       integer         $parentID
         */
        protected function exportBlogCategoriesRecursively($parentID = 0) {
                if (!isset($this->categoryCache[$parentID])) return;
@@ -205,6 +213,9 @@ class WordPress3xExporter extends AbstractExporter {
        
        /**
         * Exports blog entries.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportBlogEntries($offset, $limit) {
                // get entry ids
@@ -307,6 +318,9 @@ class WordPress3xExporter extends AbstractExporter {
        
        /**
         * Exports blog comments.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportBlogComments($offset, $limit) {
                $sql = "SELECT  comment_ID, comment_parent
@@ -376,6 +390,9 @@ class WordPress3xExporter extends AbstractExporter {
        
        /**
         * Exports blog attachments.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportBlogAttachments($offset, $limit) {
                $sql = "SELECT          posts.*, postmeta.*
@@ -416,6 +433,12 @@ class WordPress3xExporter extends AbstractExporter {
                }
        }
        
+       /**
+        * Returns message with fixed syntax as used in WCF.
+        * 
+        * @param       string          $string
+        * @return      string
+        */
        private static function fixMessage($string) {
                $string = str_replace("\n", "<br />\n", StringUtil::unifyNewlines($string));
                
index efa4869626477e76047dd636a9302b2f10be80bf..d1fa8fede3df35f9bf002681c3c9b4dfd31d3a7e 100644 (file)
@@ -221,6 +221,9 @@ class XF12xExporter extends AbstractExporter {
        
        /**
         * Exports user groups.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserGroups($offset, $limit) {
                $sql = "SELECT          *
@@ -247,6 +250,9 @@ class XF12xExporter extends AbstractExporter {
        
        /**
         * Exports users.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUsers($offset, $limit) {
                // prepare password update
@@ -377,6 +383,9 @@ class XF12xExporter extends AbstractExporter {
        
        /**
         * Exports user options.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserOptions($offset, $limit) {
                $condition = new PreparedStatementConditionBuilder();
@@ -451,6 +460,9 @@ class XF12xExporter extends AbstractExporter {
        
        /**
         * Exports user ranks.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserRanks($offset, $limit) {
                try {
@@ -493,6 +505,9 @@ class XF12xExporter extends AbstractExporter {
        
        /**
         * Exports followers.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportFollowers($offset, $limit) {
                $sql = "SELECT          *
@@ -518,6 +533,9 @@ class XF12xExporter extends AbstractExporter {
        
        /**
         * Exports wall entries.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportWallEntries($offset, $limit) {
                $sql = "SELECT          *
@@ -546,6 +564,9 @@ class XF12xExporter extends AbstractExporter {
        
        /**
         * Exports wall responses.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportWallResponses($offset, $limit) {
                $sql = "SELECT          *
@@ -580,6 +601,9 @@ class XF12xExporter extends AbstractExporter {
        
        /**
         * Exports user avatars.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportUserAvatars($offset, $limit) {
                $sql = "SELECT          user_id
@@ -622,6 +646,9 @@ class XF12xExporter extends AbstractExporter {
        
        /**
         * Exports conversation folders.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversationFolders($offset, $limit) {
                $sql = "SELECT          user_id
@@ -646,6 +673,9 @@ class XF12xExporter extends AbstractExporter {
        
        /**
         * Exports conversations.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversations($offset, $limit) {
                $sql = "SELECT          *
@@ -676,6 +706,9 @@ class XF12xExporter extends AbstractExporter {
        
        /**
         * Exports conversation messages.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversationMessages($offset, $limit) {
                $sql = "SELECT          message_table.*, INET_NTOA(ip_table.ip) AS ip
@@ -712,6 +745,9 @@ class XF12xExporter extends AbstractExporter {
        
        /**
         * Exports conversation recipients.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportConversationUsers($offset, $limit) {
                $sql = "SELECT          recipient_table.*, user_table.username, cuser_table.is_starred
@@ -751,6 +787,9 @@ class XF12xExporter extends AbstractExporter {
        
        /**
         * Exports boards.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportBoards($offset, $limit) {
                $sql = "SELECT          node.node_id AS nodeID, node.*, forum.*, link_forum.*
@@ -792,6 +831,9 @@ class XF12xExporter extends AbstractExporter {
        
        /**
         * Exports threads.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportThreads($offset, $limit) {
                $sql = "SELECT          *
@@ -831,6 +873,9 @@ class XF12xExporter extends AbstractExporter {
        
        /**
         * Exports posts.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPosts($offset, $limit) {
                $sql = "SELECT          post.*, user.username AS editor, INET_NTOA(ip.ip) AS ip, thread.title
@@ -874,6 +919,9 @@ class XF12xExporter extends AbstractExporter {
        
        /**
         * Exports post attachments.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPostAttachments($offset, $limit) {
                $this->exportAttachments('post', 'com.woltlab.wbb.attachment', $offset, $limit);
@@ -893,6 +941,9 @@ class XF12xExporter extends AbstractExporter {
        
        /**
         * Exports watched threads.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportWatchedThreads($offset, $limit) {
                $sql = "SELECT          *
@@ -923,6 +974,9 @@ class XF12xExporter extends AbstractExporter {
        
        /**
         * Exports polls.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPolls($offset, $limit) {
                $sql = "SELECT          poll.*, thread.first_post_id,
@@ -961,6 +1015,9 @@ class XF12xExporter extends AbstractExporter {
        
        /**
         * Exports poll options.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPollOptions($offset, $limit) {
                $sql = "SELECT          *
@@ -992,6 +1049,9 @@ class XF12xExporter extends AbstractExporter {
        
        /**
         * Exports poll option votes.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportPollOptionVotes($offset, $limit) {
                $sql = "SELECT          *
@@ -1022,6 +1082,9 @@ class XF12xExporter extends AbstractExporter {
        
        /**
         * Exports labels.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportLabels($offset, $limit) {
                $objectType = ObjectTypeCache::getInstance()->getObjectTypeByName('com.woltlab.wcf.label.objectType', 'com.woltlab.wbb.board');
@@ -1066,6 +1129,9 @@ class XF12xExporter extends AbstractExporter {
        
        /**
         * Exports ACLs.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportACLs($offset, $limit) {
                static $mapping = [
@@ -1129,6 +1195,9 @@ class XF12xExporter extends AbstractExporter {
        
        /**
         * Exports blog categories.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportBlogCategories($offset, $limit) {
                $sql = "SELECT          *
@@ -1168,6 +1237,9 @@ class XF12xExporter extends AbstractExporter {
        
        /**
         * Exports blog entries.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportBlogEntries($offset, $limit) {
                $sql = "(
@@ -1230,6 +1302,9 @@ class XF12xExporter extends AbstractExporter {
        
        /**
         * Exports blog comments.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportBlogComments($offset, $limit) {
                $sql = "SELECT          comment.*, user.username
@@ -1265,6 +1340,9 @@ class XF12xExporter extends AbstractExporter {
        
        /**
         * Exports blog entry likes.
+        *
+        * @param       integer         $offset
+        * @param       integer         $limit
         */
        public function exportBlogEntryLikes($offset, $limit) {
                $sql = "SELECT          *
@@ -1284,14 +1362,31 @@ class XF12xExporter extends AbstractExporter {
                }
        }
        
+       /**
+        * Returns the number of blog attachments.
+        * 
+        * @return      integer
+        */
        public function countBlogAttachments() {
                return $this->countAttachments('xfa_blog_entry');
        }
        
+       /**
+        * Exports blog attachments.
+        * 
+        * @param       integer         $offset
+        * @param       integer         $limit
+        */
        public function exportBlogAttachments($offset, $limit) {
                $this->exportAttachments('xfa_blog_entry', 'com.woltlab.blog.entry.attachment', $offset, $limit);
        }
        
+       /**
+        * Returns the number of attachments.
+        * 
+        * @param       string          $type
+        * @return      integer
+        */
        public function countAttachments($type) {
                $sql = "SELECT  COUNT(*) AS count
                FROM    xf_attachment
@@ -1302,6 +1397,14 @@ class XF12xExporter extends AbstractExporter {
                return $row['count'];
        }
        
+       /**
+        * Exports attachments.
+        * 
+        * @param       string          $type
+        * @param       string          $objectType
+        * @param       integer         $offset
+        * @param       integer         $limit
+        */
        public function exportAttachments($type, $objectType, $offset, $limit) {
                $sql = "SELECT          attachment.*, data.*
                FROM            xf_attachment attachment
@@ -1341,6 +1444,11 @@ class XF12xExporter extends AbstractExporter {
                }
        }
        
+       /**
+        * Returns the configuration data of the imported board.
+        * 
+        * @return      array
+        */
        public function getConfig() {
                $config = [
                        'db' => [
@@ -1401,6 +1509,12 @@ class XF12xExporter extends AbstractExporter {
                return $config;
        }
        
+       /**
+        * Returns message with fixed BBCodes as used in WCF.
+        *
+        * @param       string          $message
+        * @return      string
+        */
        private static function fixBBCodes($message) {
                static $mediaRegex = null;
                static $mediaCallback = null;
@@ -1514,6 +1628,12 @@ class XF12xExporter extends AbstractExporter {
                return $message;
        }
        
+       /**
+        * Returns comment text with fixed formatting as used in WCF.
+        * 
+        * @param       string          $message
+        * @return      string
+        */
        private static function fixComment($message) {
                static $mentionRegex = null;
                if ($mentionRegex === null) {