[TASK] Clean up the phpDoc of t3lib_treeview
authorWouter Wolters <typo3@wouterwolters.nl>
Mon, 28 May 2012 13:35:16 +0000 (15:35 +0200)
committerGeorg Ringer <mail@ringerge.org>
Mon, 28 May 2012 16:37:16 +0000 (18:37 +0200)
Clean up the phpDoc of t3lib_treeview

So I made a patch doing mostly:

* Provide correct parameter names in phpDoc
* Provide correct data types in phpDoc
* CGLify phpDoc (remove tabs)
* CGLify method signatures (the first line of the method)

Change-Id: I1a9dc3d3c920ce96ee231f032fc7e63f2d8754d3
Resolves: #37545
Releases: 6.0
Reviewed-on: http://review.typo3.org/11662
Reviewed-by: Oliver Klee
Tested-by: Oliver Klee
Reviewed-by: Georg Ringer
Tested-by: Georg Ringer
t3lib/class.t3lib_treeview.php

index 93c1368..7a4359a 100644 (file)
  *
  * Revised for TYPO3 3.6 November/2003 by Kasper Skårhøj
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
- * @coauthor   René Fritz <r.fritz@colorcube.de>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @coauthor René Fritz <r.fritz@colorcube.de>
  */
 
-
 /**
  * Base class for creating a browsable array/page/folder tree in HTML
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
- * @coauthor   René Fritz <r.fritz@colorcube.de>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @coauthor René Fritz <r.fritz@colorcube.de>
  * @package TYPO3
  * @subpackage t3lib
  * @see t3lib_browsetree, t3lib_pagetree, t3lib_foldertree
 class t3lib_treeView {
 
                // EXTERNAL, static:
-       var $expandFirst = 0; // If set, the first element in the tree is always expanded.
-       var $expandAll = 0; // If set, then ALL items will be expanded, regardless of stored settings.
-       var $thisScript = ''; // Holds the current script to reload to.
-       var $titleAttrib = 'title'; // Which HTML attribute to use: alt/title. See init().
-       var $ext_IconMode = FALSE; // If TRUE, no context menu is rendered on icons. If set to "titlelink" the icon is linked as the title is.
-       var $addSelfId = 0; // If set, the id of the mounts will be added to the internal ids array
-       var $title = 'no title'; // Used if the tree is made of records (not folders for ex.)
-       var $showDefaultTitleAttribute = FALSE; // If TRUE, a default title attribute showing the UID of the record is shown. This cannot be enabled by default because it will destroy many applications where another title attribute is in fact applied later.
-       var $highlightPagesWithVersions = TRUE; // If TRUE, pages containing child records which has versions will be highlighted in yellow. This might be too expensive in terms of processing power.
+               // If set, the first element in the tree is always expanded.
+       var $expandFirst = 0;
+               // If set, then ALL items will be expanded, regardless of stored settings.
+       var $expandAll = 0;
+               // Holds the current script to reload to.
+       var $thisScript = '';
+               // Which HTML attribute to use: alt/title. See init().
+       var $titleAttrib = 'title';
+               // If TRUE, no context menu is rendered on icons. If set to "titlelink" the
+               // icon is linked as the title is.
+       var $ext_IconMode = FALSE;
+               // If set, the id of the mounts will be added to the internal ids array
+       var $addSelfId = 0;
+               // Used if the tree is made of records (not folders for ex.)
+       var $title = 'no title';
+               // If TRUE, a default title attribute showing the UID of the record is shown.
+               // This cannot be enabled by default because it will destroy many applications
+               // where another title attribute is in fact applied later.
+       var $showDefaultTitleAttribute = FALSE;
+               // If TRUE, pages containing child records which has versions will be
+               // highlighted in yellow. This might be too expensive in terms
+               // of processing power.
+       var $highlightPagesWithVersions = TRUE;
 
        /**
         * Needs to be initialized with $GLOBALS['BE_USER']
@@ -67,11 +80,12 @@ class t3lib_treeView {
        /**
         * Needs to be initialized with e.g. $GLOBALS['WEBMOUNTS']
         * Default setting in init() is 0 => 0
-        * The keys are mount-ids (can be anything basically) and the values are the ID of the root element (COULD be zero or anything else. For pages that would be the uid of the page, zero for the pagetree root.)
+        * The keys are mount-ids (can be anything basically) and the
+        * values are the ID of the root element (COULD be zero or anything else.
+        * For pages that would be the uid of the page, zero for the pagetree root.)
         */
        var $MOUNTS = '';
 
-
        /**
         * Database table to get the tree data from.
         * Leave blank if data comes from an array.
@@ -110,7 +124,6 @@ class t3lib_treeView {
         */
        var $defaultList = 'uid,pid,tstamp,sorting,deleted,perms_userid,perms_groupid,perms_user,perms_group,perms_everybody,crdate,cruser_id';
 
-
        /**
         * Unique name for the tree.
         * Used as key for storing the tree into the BE users settings.
@@ -138,7 +151,6 @@ class t3lib_treeView {
         */
        var $iconPath = '';
 
-
        /**
         * Icon file name for item icons.
         */
@@ -161,52 +173,66 @@ class t3lib_treeView {
         */
        var $subLevelID = '_SUB_LEVEL';
 
-
                // *********
                // Internal
                // *********
                // For record trees:
-       var $ids = array(); // one-dim array of the uid's selected.
-       var $ids_hierarchy = array(); // The hierarchy of element uids
-       var $orig_ids_hierarchy = array(); // The hierarchy of versioned element uids
-       var $buffer_idH = array(); // Temporary, internal array
+               // one-dim array of the uid's selected.
+       var $ids = array();
+               // The hierarchy of element uids
+       var $ids_hierarchy = array();
+               // The hierarchy of versioned element uids
+       var $orig_ids_hierarchy = array();
+               // Temporary, internal array
+       var $buffer_idH = array();
 
                // For FOLDER trees:
-       var $specUIDmap = array(); // Special UIDs for folders (integer-hashes of paths)
+               // Special UIDs for folders (integer-hashes of paths)
+       var $specUIDmap = array();
 
                // For arrays:
-       var $data = FALSE; // Holds the input data array
-       var $dataLookup = FALSE; // Holds an index with references to the data array.
+               // Holds the input data array
+       var $data = FALSE;
+               // Holds an index with references to the data array.
+       var $dataLookup = FALSE;
 
                // For both types
-       var $tree = array(); // Tree is accumulated in this variable
-       var $stored = array(); // Holds (session stored) information about which items in the tree are unfolded and which are not.
-       var $bank = 0; // Points to the current mountpoint key
-       var $recs = array(); // Accumulates the displayed records.
-
+               // Tree is accumulated in this variable
+       var $tree = array();
+               // Holds (session stored) information about which items in the tree are unfolded and which are not.
+       var $stored = array();
+               // Points to the current mountpoint key
+       var $bank = 0;
+               // Accumulates the displayed records.
+       var $recs = array();
 
        /**
         * Initialize the tree class. Needs to be overwritten
         * Will set ->fieldsArray, ->backPath and ->clause
         *
-        * @param       string          record WHERE clause
-        * @param       string          record ORDER BY field
-        * @return      void
+        * @param string Record WHERE clause
+        * @param string Record ORDER BY field
+        * @return void
         */
        function init($clause = '', $orderByFields = '') {
-               $this->BE_USER = $GLOBALS['BE_USER']; // Setting BE_USER by default
-               $this->titleAttrib = 'title'; // Setting title attribute to use.
-               $this->backPath = $GLOBALS['BACK_PATH']; // Setting backpath.
-
+                       // Setting BE_USER by default
+               $this->BE_USER = $GLOBALS['BE_USER'];
+                       // Setting title attribute to use.
+               $this->titleAttrib = 'title';
+                       // Setting backpath.
+               $this->backPath = $GLOBALS['BACK_PATH'];
+
+                       // Setting clause
                if ($clause) {
                        $this->clause = $clause;
-               } // Setting clause
+               }
                if ($orderByFields) {
                        $this->orderByFields = $orderByFields;
                }
 
                if (!is_array($this->MOUNTS)) {
-                       $this->MOUNTS = array(0 => 0); // dummy
+                               // Dummy
+                       $this->MOUNTS = array(0 => 0);
                }
 
                $this->setTreeName();
@@ -215,7 +241,7 @@ class t3lib_treeView {
                        t3lib_div::loadTCA($this->table);
                }
 
-                       // setting this to FALSE disables the use of array-trees by default
+                       // Setting this to FALSE disables the use of array-trees by default
                $this->data = FALSE;
                $this->dataLookup = FALSE;
        }
@@ -225,8 +251,8 @@ class t3lib_treeView {
         * Sets the tree name which is used to identify the tree
         * Used for JavaScript and other things
         *
-        * @param       string          Default is the table name. Underscores are stripped.
-        * @return      void
+        * @param string $treeName Default is the table name. Underscores are stripped.
+        * @return void
         */
        function setTreeName($treeName = '') {
                $this->treeName = $treeName ? $treeName : $this->treeName;
@@ -234,13 +260,12 @@ class t3lib_treeView {
                $this->treeName = str_replace('_', '', $this->treeName);
        }
 
-
        /**
         * Adds a fieldname to the internal array ->fieldArray
         *
-        * @param       string          Field name to
-        * @param       boolean         If set, the fieldname will be set no matter what. Otherwise the field name must either be found as key in $GLOBALS['TCA'][$table]['columns'] or in the list ->defaultList
-        * @return      void
+        * @param string $field Field name to
+        * @param boolean $noCheck If set, the fieldname will be set no matter what. Otherwise the field name must either be found as key in $GLOBALS['TCA'][$table]['columns'] or in the list ->defaultList
+        * @return void
         */
        function addField($field, $noCheck = 0) {
                if ($noCheck || is_array($GLOBALS['TCA'][$this->table]['columns'][$field]) || t3lib_div::inList($this->defaultList, $field)) {
@@ -248,11 +273,10 @@ class t3lib_treeView {
                }
        }
 
-
        /**
         * Resets the tree, recs, ids, ids_hierarchy and orig_ids_hierarchy internal variables. Use it if you need it.
         *
-        * @return      void
+        * @return void
         */
        function reset() {
                $this->tree = array();
@@ -262,7 +286,6 @@ class t3lib_treeView {
                $this->orig_ids_hierarchy = array();
        }
 
-
        /*******************************************
         *
         * output
@@ -273,7 +296,7 @@ class t3lib_treeView {
         * Will create and return the HTML code for a browsable tree
         * Is based on the mounts found in the internal array ->MOUNTS (set in the constructor)
         *
-        * @return      string          HTML code for the browsable tree
+        * @return string HTML code for the browsable tree
         */
        function getBrowsableTree() {
 
@@ -297,7 +320,7 @@ class t3lib_treeView {
                        $this->ids = $curIds;
 
                                // Set PM icon for root of mount:
-                       $cmd = $this->bank . '_' . ($isOpen ? "0_" : "1_") . $uid . '_' . $this->treeName;
+                       $cmd = $this->bank . '_' . ($isOpen ? '0_' : '1_') . $uid . '_' . $this->treeName;
                        $icon = '<img' . t3lib_iconWorks::skinImg($this->backPath, 'gfx/ol/' . ($isOpen ? 'minus' : 'plus') . 'only.gif', 'width="18" height="16"') . ' alt="" />';
                        $firstHtml = $this->PM_ATagWrap($icon, $cmd);
 
@@ -312,7 +335,8 @@ class t3lib_treeView {
                        }
 
                        if (is_array($rootRec)) {
-                               $uid = $rootRec['uid']; // In case it was swapped inside getRecord due to workspaces.
+                                       // In case it was swapped inside getRecord due to workspaces.
+                               $uid = $rootRec['uid'];
 
                                        // Add the root of the mount to ->tree
                                $this->tree[] = array('HTML' => $firstHtml, 'row' => $rootRec, 'bank' => $this->bank);
@@ -337,8 +361,8 @@ class t3lib_treeView {
        /**
         * Compiles the HTML code for displaying the structure found inside the ->tree array
         *
-        * @param       array           "tree-array" - if blank string, the internal ->tree array is used.
-        * @return      string          The HTML code for the tree
+        * @param array $treeArr "tree-array" - if blank string, the internal ->tree array is used.
+        * @return string The HTML code for the tree
         */
        function printTree($treeArr = '') {
                $titleLen = intval($this->BE_USER->uc['titleLen']);
@@ -349,7 +373,9 @@ class t3lib_treeView {
 
                        // put a table around it with IDs to access the rows from JS
                        // not a problem if you don't need it
-                       // In XHTML there is no "name" attribute of <td> elements - but Mozilla will not be able to highlight rows if the name attribute is NOT there.
+                       // In XHTML there is no "name" attribute of <td> elements -
+                       // but Mozilla will not be able to highlight rows if the name
+                       // attribute is NOT there.
                $out .= '
 
                        <!--
@@ -375,23 +401,21 @@ class t3lib_treeView {
                return $out;
        }
 
-
        /*******************************************
         *
         * rendering parts
         *
         *******************************************/
 
-
        /**
         * Generate the plus/minus icon for the browsable tree.
         *
-        * @param       array           record for the entry
-        * @param       integer         The current entry number
-        * @param       integer         The total number of entries. If equal to $a, a "bottom" element is returned.
-        * @param       integer         The number of sub-elements to the current element.
-        * @param       boolean         The element was expanded to render subelements if this flag is set.
-        * @return      string          Image tag with the plus/minus icon.
+        * @param array $row Record for the entry
+        * @param integer $a The current entry number
+        * @param integer $c The total number of entries. If equal to $a, a "bottom" element is returned.
+        * @param integer $nextCount The number of sub-elements to the current element.
+        * @param boolean $exp The element was expanded to render subelements if this flag is set.
+        * @return string Image tag with the plus/minus icon.
         * @access private
         * @see t3lib_pageTree::PMicon()
         */
@@ -411,10 +435,10 @@ class t3lib_treeView {
        /**
         * Wrap the plus/minus icon in a link
         *
-        * @param       string          HTML string to wrap, probably an image tag.
-        * @param       string          Command for 'PM' get var
-        * @param       boolean         If set, the link will have a anchor point (=$bMark) and a name attribute (=$bMark)
-        * @return      string          Link-wrapped input string
+        * @param string $icon HTML string to wrap, probably an image tag.
+        * @param string $cmd Command for 'PM' get var
+        * @param boolean $bMark If set, the link will have a anchor point (=$bMark) and a name attribute (=$bMark)
+        * @return string Link-wrapped input string
         * @access private
         */
        function PM_ATagWrap($icon, $cmd, $bMark = '') {
@@ -433,10 +457,10 @@ class t3lib_treeView {
        /**
         * Wrapping $title in a-tags.
         *
-        * @param       string          Title string
-        * @param       string          Item record
-        * @param       integer         Bank pointer (which mount point number)
-        * @return      string
+        * @param string $title Title string
+        * @param string $row Item record
+        * @param integer $bank Bank pointer (which mount point number)
+        * @return string
         * @access private
         */
        function wrapTitle($title, $row, $bank = 0) {
@@ -447,9 +471,9 @@ class t3lib_treeView {
        /**
         * Wrapping the image tag, $icon, for the row, $row (except for mount points)
         *
-        * @param       string          The image tag for the icon
-        * @param       array           The row for the current element
-        * @return      string          The processed icon input value.
+        * @param string $icon The image tag for the icon
+        * @param array $row The row for the current element
+        * @return string The processed icon input value.
         * @access private
         */
        function wrapIcon($icon, $row) {
@@ -459,9 +483,9 @@ class t3lib_treeView {
        /**
         * Adds attributes to image tag.
         *
-        * @param       string          Icon image tag
-        * @param       string          Attributes to add, eg. ' border="0"'
-        * @return      string          Image tag, modified with $attr attributes added.
+        * @param string $icon Icon image tag
+        * @param string $attr Attributes to add, eg. ' border="0"'
+        * @return string Image tag, modified with $attr attributes added.
         */
        function addTagAttributes($icon, $attr) {
                return preg_replace('/ ?\/?>$/', '', $icon) . ' ' . $attr . ' />';
@@ -470,9 +494,9 @@ class t3lib_treeView {
        /**
         * Adds a red "+" to the input string, $str, if the field "php_tree_stop" in the $row (pages) is set
         *
-        * @param       string          Input string, like a page title for the tree
-        * @param       array           record row with "php_tree_stop" field
-        * @return      string          Modified string
+        * @param string $str Input string, like a page title for the tree
+        * @param array $row record row with "php_tree_stop" field
+        * @return string Modified string
         * @access private
         */
        function wrapStop($str, $row) {
@@ -482,20 +506,19 @@ class t3lib_treeView {
                return $str;
        }
 
-
        /*******************************************
         *
         * tree handling
         *
         *******************************************/
 
-
        /**
-        * Returns TRUE/FALSE if the next level for $id should be expanded - based on data in $this->stored[][] and ->expandAll flag.
+        * Returns TRUE/FALSE if the next level for $id should be expanded - based on
+        * data in $this->stored[][] and ->expandAll flag.
         * Extending parent function
         *
-        * @param       integer         record id/key
-        * @return      boolean
+        * @param integer $id Record id/key
+        * @return boolean
         * @access private
         * @see t3lib_pageTree::expandNext()
         */
@@ -506,7 +529,7 @@ class t3lib_treeView {
        /**
         * Get stored tree structure AND updating it if needed according to incoming PM GET var.
         *
-        * @return      void
+        * @return void
         * @access private
         */
        function initializePositionSaving() {
@@ -514,14 +537,18 @@ class t3lib_treeView {
                $this->stored = unserialize($this->BE_USER->uc['browseTrees'][$this->treeName]);
 
                        // PM action
-                       // (If an plus/minus icon has been clicked, the PM GET var is sent and we must update the stored positions in the tree):
-               $PM = explode('_', t3lib_div::_GP('PM')); // 0: mount key, 1: set/clear boolean, 2: item ID (cannot contain "_"), 3: treeName
+                       // (If an plus/minus icon has been clicked, the PM GET var is sent and we
+                       // must update the stored positions in the tree):
+                       // 0: mount key, 1: set/clear boolean, 2: item ID (cannot contain "_"), 3: treeName
+               $PM = explode('_', t3lib_div::_GP('PM'));
                if (count($PM) == 4 && $PM[3] == $this->treeName) {
                        if (isset($this->MOUNTS[$PM[0]])) {
-                               if ($PM[1]) { // set
+                                       // set
+                               if ($PM[1]) {
                                        $this->stored[$PM[0]][$PM[2]] = 1;
                                        $this->savePosition();
-                               } else { // clear
+                                       // Clear
+                               } else {
                                        unset($this->stored[$PM[0]][$PM[2]]);
                                        $this->savePosition();
                                }
@@ -533,7 +560,7 @@ class t3lib_treeView {
         * Saves the content of ->stored (keeps track of expanded positions in the tree)
         * $this->treeName will be used as key for BE_USER->uc[] to store it in
         *
-        * @return      void
+        * @return void
         * @access private
         */
        function savePosition() {
@@ -541,7 +568,6 @@ class t3lib_treeView {
                $this->BE_USER->writeUC();
        }
 
-
        /******************************
         *
         * Functions that might be overwritten by extended classes
@@ -551,20 +577,19 @@ class t3lib_treeView {
        /**
         * Returns the root icon for a tree/mountpoint (defaults to the globe)
         *
-        * @param       array           Record for root.
-        * @return      string          Icon image tag.
+        * @param array $rec Record for root.
+        * @return string Icon image tag.
         */
        function getRootIcon($rec) {
                return $this->wrapIcon(t3lib_iconWorks::getSpriteIcon('apps-pagetree-root'), $rec);
        }
 
-
        /**
         * Get icon for the row.
         * If $this->iconPath and $this->iconName is set, try to get icon based on those values.
         *
-        * @param       array           Item row.
-        * @return      string          Image tag.
+        * @param array $row Item row.
+        * @return string Image tag.
         */
        function getIcon($row) {
                if ($this->iconPath && $this->iconName) {
@@ -586,9 +611,9 @@ class t3lib_treeView {
         * Returns the title for the input record. If blank, a "no title" label (localized) will be returned.
         * Do NOT htmlspecialchar the string from this function - has already been done.
         *
-        * @param       array           The input row array (where the key "title" is used for the title)
-        * @param       integer         Title length (30)
-        * @return      string          The title.
+        * @param array $row The input row array (where the key "title" is used for the title)
+        * @param integer $titleLen Title length (30)
+        * @return string The title.
         */
        function getTitleStr($row, $titleLen = 30) {
                if ($this->ext_showNavTitle && strlen(trim($row['nav_title'])) > 0) {
@@ -607,8 +632,8 @@ class t3lib_treeView {
        /**
         * Returns the value for the image "title" attribute
         *
-        * @param       array           The input row array (where the key "title" is used for the title)
-        * @return      string          The attribute value (is htmlspecialchared() already)
+        * @param array $row The input row array (where the key "title" is used for the title)
+        * @return string The attribute value (is htmlspecialchared() already)
         * @see wrapIcon()
         */
        function getTitleAttrib($row) {
@@ -618,8 +643,8 @@ class t3lib_treeView {
        /**
         * Returns the id from the record (typ. uid)
         *
-        * @param       array           Record array
-        * @return      integer         The "uid" field value.
+        * @param array $row Record array
+        * @return integer The "uid" field value.
         */
        function getId($row) {
                return $row['uid'];
@@ -628,14 +653,13 @@ class t3lib_treeView {
        /**
         * Returns jump-url parameter value.
         *
-        * @param       array           The record array.
-        * @return      string          The jump-url parameter.
+        * @param array $row The record array.
+        * @return string The jump-url parameter.
         */
        function getJumpToParam($row) {
                return $this->getId($row);
        }
 
-
        /********************************
         *
         * tree data buidling
@@ -645,12 +669,12 @@ class t3lib_treeView {
        /**
         * Fetches the data for the tree
         *
-        * @param       integer         item id for which to select subitems (parent id)
-        * @param       integer         Max depth (recursivity limit)
-        * @param       string          HTML-code prefix for recursive calls.
-        * @param       string          ? (internal)
-        * @param       string          CSS class to use for <td> sub-elements
-        * @return      integer         The count of items on the level
+        * @param integer $uid item id for which to select subitems (parent id)
+        * @param integer $depth Max depth (recursivity limit)
+        * @param string $depthData HTML-code prefix for recursive calls.
+        * @param string $blankLineCode ? (internal)
+        * @param string $subCSSclass CSS class to use for <td> sub-elements
+        * @return integer The count of items on the level
         */
        function getTree($uid, $depth = 999, $depthData = '', $blankLineCode = '', $subCSSclass = '') {
 
@@ -679,9 +703,11 @@ class t3lib_treeView {
                                throw new RuntimeException('Endless recursion detected: TYPO3 has detected an error in the database. Please fix it manually (e.g. using phpMyAdmin) and change the UID of ' . $this->table . ':0 to a new value.<br /><br />See <a href="http://bugs.typo3.org/view.php?id=3495" target="_blank">bugs.typo3.org/view.php?id=3495</a> to get more information about a possible cause.', 1294586383);
                        }
 
-                       $this->tree[] = array(); // Reserve space.
+                               // Reserve space.
+                       $this->tree[] = array();
                        end($this->tree);
-                       $treeKey = key($this->tree); // Get the key for this space
+                               // Get the key for this space
+                       $treeKey = key($this->tree);
                        $LN = ($a == $c) ? 'blank' : 'line';
 
                                // If records should be accumulated, do so
@@ -707,10 +733,12 @@ class t3lib_treeView {
                                if (count($this->buffer_idH)) {
                                        $idH[$row['uid']]['subrow'] = $this->buffer_idH;
                                }
-                               $exp = 1; // Set "did expand" flag
+                                       // Set "did expand" flag
+                               $exp = 1;
                        } else {
                                $nextCount = $this->getCount($newID);
-                               $exp = 0; // Clear "did expand" flag
+                                       // Clear "did expand" flag
+                               $exp = 0;
                        }
 
                                // Set HTML-icons, if any:
@@ -735,7 +763,6 @@ class t3lib_treeView {
                return $c;
        }
 
-
        /********************************
         *
         * Data handling
@@ -746,8 +773,8 @@ class t3lib_treeView {
        /**
         * Returns the number of records having the parent id, $uid
         *
-        * @param       integer         id to count subitems for
-        * @return      integer
+        * @param integer $uid Id to count subitems for
+        * @return integer
         * @access private
         */
        function getCount($uid) {
@@ -766,25 +793,23 @@ class t3lib_treeView {
                }
        }
 
-
        /**
         * Returns root record for uid (<=0)
         *
-        * @param       integer         uid, <= 0 (normally, this does not matter)
-        * @return      array           Array with title/uid keys with values of $this->title/0 (zero)
+        * @param integer $uid uid, <= 0 (normally, this does not matter)
+        * @return array Array with title/uid keys with values of $this->title/0 (zero)
         */
        function getRootRecord($uid) {
                return array('title' => $this->title, 'uid' => 0);
        }
 
-
        /**
         * Returns the record for a uid.
         * For tables: Looks up the record in the database.
         * For arrays: Returns the fake record for uid id.
         *
-        * @param       integer         UID to look up
-        * @return      array           The record
+        * @param integer $uid UID to look up
+        * @return array The record
         */
        function getRecord($uid) {
                if (is_array($this->data)) {
@@ -799,9 +824,9 @@ class t3lib_treeView {
         * For tables: This will make a database query to select all children to "parent"
         * For arrays: This will return key to the ->dataLookup array
         *
-        * @param       integer         parent item id
-        * @param       string          Class for sub-elements.
-        * @return      mixed           data handle (Tables: An sql-resource, arrays: A parentId integer. -1 is returned if there were NO subLevel.)
+        * @param integer $parentId parent item id
+        * @param string $subCSSclass Class for sub-elements.
+        * @return mixed Data handle (Tables: An sql-resource, arrays: A parentId integer. -1 is returned if there were NO subLevel.)
         * @access private
         */
        function getDataInit($parentId, $subCSSclass = '') {
@@ -830,8 +855,8 @@ class t3lib_treeView {
        /**
         * Getting the tree data: Counting elements in resource
         *
-        * @param       mixed           data handle
-        * @return      integer         number of items
+        * @param mixed $res Data handle
+        * @return integer number of items
         * @access private
         * @see getDataInit()
         */
@@ -847,9 +872,9 @@ class t3lib_treeView {
        /**
         * Getting the tree data: next entry
         *
-        * @param       mixed           data handle
-        * @param       string          CSS class for sub elements (workspace related)
-        * @return      array           item data array OR FALSE if end of elements.
+        * @param mixed $res Data handle
+        * @param string $subCSSclass CSS class for sub elements (workspace related)
+        * @return array item data array OR FALSE if end of elements.
         * @access private
         * @see getDataInit()
         */
@@ -896,8 +921,8 @@ class t3lib_treeView {
        /**
         * Getting the tree data: frees data handle
         *
-        * @param       mixed           data handle
-        * @return      void
+        * @param mixed $res Data handle
+        * @return void
         * @access private
         */
        function getDataFree(&$res) {
@@ -913,16 +938,16 @@ class t3lib_treeView {
         * "uid" and "pid" "fakefields" are also set in each record.
         * All other fields are optional.
         *
-        * @param       array           The input array, see examples below in this script.
-        * @param       boolean         Internal, for recursion.
-        * @param       integer         Internal, for recursion.
-        * @return      void
+        * @param array $dataArr The input array, see examples below in this script.
+        * @param boolean $traverse Internal, for recursion.
+        * @param integer $pid Internal, for recursion.
+        * @return void
         */
        function setDataFromArray(&$dataArr, $traverse = FALSE, $pid = 0) {
                if (!$traverse) {
                        $this->data = &$dataArr;
                        $this->dataLookup = array();
-                               // add root
+                               // Add root
                        $this->dataLookup[0][$this->subLevelID] =& $dataArr;
                }
 
@@ -931,7 +956,7 @@ class t3lib_treeView {
                        $dataArr[$uid]['uid'] = $uid;
                        $dataArr[$uid]['pid'] = $pid;
 
-                               // gives quick access to id's
+                               // Gives quick access to id's
                        $this->dataLookup[$uid] = &$dataArr[$uid];
 
                        if (is_array($val[$this->subLevelID])) {
@@ -943,16 +968,15 @@ class t3lib_treeView {
        /**
         * Sets the internal data arrays
         *
-        * @param       array           Content for $this->data
-        * @param       array           Content for $this->dataLookup
-        * @return      void
+        * @param array $treeArr Content for $this->data
+        * @param array $treeLookupArr Content for $this->dataLookup
+        * @return void
         */
        function setDataFromTreeArray(&$treeArr, &$treeLookupArr) {
                $this->data = &$treeArr;
                $this->dataLookup =& $treeLookupArr;
        }
 
-
        /*
                array(
                        [id1] => array(