[TASK] Clean up phpDoc comments in typo3/sysext/
authorWouter Wolters <typo3@wouterwolters.nl>
Thu, 21 Jun 2012 21:49:18 +0000 (23:49 +0200)
committerBenjamin Mack <benni@typo3.org>
Fri, 22 Jun 2012 13:59:57 +0000 (15:59 +0200)
Clean up phpDoc comments for the following classes:

* typo3/sysext/opendocs/class.tx_opendocs.php
* typo3/sysext/opendocs/ext_tables.php
* typo3/sysext/opendocs/registerToolbarItem.php
* typo3/sysext/perm/ext_tables.php
* typo3/sysext/perm/mod1/class.sc_mod_web_perm_ajax.php
* typo3/sysext/perm/mod1/conf.php
* typo3/sysext/perm/mod1/index.php

Clean up provides:

* Provide correct parameter names in phpDoc
* Provide correct data types in phpDoc
* CGLify phpDoc (remove tabs)

Change-Id: I9f5811b8f674f189cf033e50da110e1074cb48bb
Resolves: #38276
Releases: 6.0
Reviewed-on: http://review.typo3.org/12281
Reviewed-by: Benjamin Mack
Tested-by: Benjamin Mack
typo3/sysext/opendocs/class.tx_opendocs.php
typo3/sysext/opendocs/ext_tables.php
typo3/sysext/opendocs/registerToolbarItem.php
typo3/sysext/perm/ext_tables.php
typo3/sysext/perm/mod1/class.sc_mod_web_perm_ajax.php
typo3/sysext/perm/mod1/conf.php
typo3/sysext/perm/mod1/index.php

index b790752..3ad9faf 100644 (file)
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
 
-       // load the language file
+       // Load the language file
 $GLOBALS['LANG']->includeLLFile('EXT:opendocs/locallang_opendocs.xml');
 
-
 /**
  * Adding a list of all open documents of a user to the backend.php
  *
- * @author     Benjamin Mack <benni@typo3.org>
- * @author     Ingo Renner <ingo@typo3.org>
- * @package    TYPO3
- * @subpackage opendocs
+ * @author Benjamin Mack <benni@typo3.org>
+ * @author Ingo Renner <ingo@typo3.org>
+ * @package TYPO3
+ * @subpackage opendocs
  */
 class tx_opendocs implements backend_toolbarItem {
 
@@ -50,11 +49,10 @@ class tx_opendocs implements backend_toolbarItem {
        protected $recentDocs;
        protected $EXTKEY = 'opendocs';
 
-
        /**
-        * constructor, loads the documents from the user control
+        * Constructor, loads the documents from the user control
         *
-        * @param       TYPO3backend    TYPO3 backend object reference
+        * @param TYPO3backend TYPO3 backend object reference
         */
        public function __construct(TYPO3backend &$backendReference = NULL) {
                $this->backendReference = $backendReference;
@@ -62,9 +60,9 @@ class tx_opendocs implements backend_toolbarItem {
        }
 
        /**
-        * checks whether the user has access to this toolbar item
+        * Checks whether the user has access to this toolbar item
         *
-        * @return  boolean  TRUE if user has access, FALSE if not
+        * @return boolean TRUE if user has access, FALSE if not
         */
        public function checkAccess() {
                $conf = $GLOBALS['BE_USER']->getTSConfig('backendToolbarItem.tx_opendocs.disabled');
@@ -72,33 +70,33 @@ class tx_opendocs implements backend_toolbarItem {
        }
 
        /**
-        * loads the opened and recently opened documents from the user
+        * Loads the opened and recently opened documents from the user
         *
-        * @return  void
+        * @return void
         */
        public function loadDocsFromUserSession() {
-               list($this->openDocs, )  = $GLOBALS['BE_USER']->getModuleData('alt_doc.php', 'ses');
-               $this->recentDocs        = $GLOBALS['BE_USER']->getModuleData('opendocs::recent');
+               list($this->openDocs, ) = $GLOBALS['BE_USER']->getModuleData('alt_doc.php', 'ses');
+               $this->recentDocs = $GLOBALS['BE_USER']->getModuleData('opendocs::recent');
        }
 
        /**
-        * renders the toolbar item and the initial menu
+        * Renders the toolbar item and the initial menu
         *
-        * @return      string          the toolbar item including the initial menu content as HTML
+        * @return string The toolbar item including the initial menu content as HTML
         */
        public function render() {
                $this->addJavascriptToBackend();
                $this->addCssToBackend();
-               $numDocs      = count($this->openDocs);
+               $numDocs = count($this->openDocs);
                $opendocsMenu = array();
-               $title        = $GLOBALS['LANG']->getLL('toolbaritem', TRUE);
+               $title = $GLOBALS['LANG']->getLL('toolbaritem', TRUE);
 
-                       // toolbar item icon
+                       // Toolbar item icon
                $opendocsMenu[] = '<a href="#" class="toolbar-item">';
                $opendocsMenu[] = '<input type="text" id="tx-opendocs-counter" disabled="disabled" value="' . $numDocs . '" />';
                $opendocsMenu[] = t3lib_iconWorks::getSpriteIcon('apps-toolbar-menu-opendocs', array('title' => $title)) . '</a>';
 
-                       // toolbar item menu and initial content
+                       // Toolbar item menu and initial content
                $opendocsMenu[] = '<div class="toolbar-item-menu" style="display: none;">';
                $opendocsMenu[] = $this->renderMenu();
                $opendocsMenu[] = '</div>';
@@ -109,13 +107,13 @@ class tx_opendocs implements backend_toolbarItem {
        /**
         * renders the pure contents of the menu
         *
-        * @return      string          the menu's content
+        * @return string The menu's content
         */
        public function renderMenu() {
-               $openDocuments   = $this->openDocs;
+               $openDocuments = $this->openDocs;
                $recentDocuments = $this->recentDocs;
-               $entries         = array();
-               $content         = '';
+               $entries = array();
+               $content = '';
 
                if (count($openDocuments)) {
                        $entries[] = '<tr><th colspan="3">' . $GLOBALS['LANG']->getLL('open_docs', TRUE) . '</th></tr>';
@@ -148,16 +146,16 @@ class tx_opendocs implements backend_toolbarItem {
        }
 
        /**
-        * returns the recent documents list as an array
+        * Returns the recent documents list as an array
         *
-        * @return      array   all recent documents as list-items
+        * @return array All recent documents as list-items
         */
        public function renderMenuEntry($document, $md5sum, $isRecentDoc = FALSE, $isFirstDoc = FALSE) {
                $table  = $document[3]['table'];
                $uid    = $document[3]['uid'];
                $record = t3lib_BEfunc::getRecordWSOL($table, $uid);
                if (!is_array($record)) {
-                               // record seems to be deleted
+                               // Record seems to be deleted
                        return '';
                }
                $label  = htmlspecialchars(strip_tags(t3lib_div::htmlspecialchars_decode($document[0])));
@@ -177,7 +175,7 @@ class tx_opendocs implements backend_toolbarItem {
                if (!$isRecentDoc) {
                        $title = $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xml:rm.closeDoc', TRUE);
 
-                               // open document
+                               // Open document
                        $closeIcon = t3lib_iconWorks::getSpriteIcon('actions-document-close');
 
                        $entry = '
@@ -187,7 +185,7 @@ class tx_opendocs implements backend_toolbarItem {
                                        <td class="close" onclick="return TYPO3BackendOpenDocs.closeDocument(\'' . $md5sum . '\');">' . $closeIcon . '</td>
                                </tr>';
                } else {
-                               // recently used document
+                               // Recently used document
                        $entry = '
                                <tr class="recentdoc' . $firstRow . '">
                                        <td class="icon">' . $icon . '</td>
@@ -199,44 +197,43 @@ class tx_opendocs implements backend_toolbarItem {
        }
 
        /**
-        * returns additional attributes for the list item in the toolbar
+        * Returns additional attributes for the list item in the toolbar
         *
-        * @return      string          list item HTML attibutes
+        * @return string List item HTML attibutes
         */
        public function getAdditionalAttributes() {
                return ' id="tx-opendocs-menu"';
        }
 
        /**
-        * adds the neccessary javascript to the backend
+        * Adds the neccessary javascript to the backend
         *
-        * @return      void
+        * @return void
         */
        protected function addJavascriptToBackend() {
                $this->backendReference->addJavascriptFile(t3lib_extMgm::extRelPath($this->EXTKEY) . 'opendocs.js');
        }
 
        /**
-        * adds the neccessary CSS to the backend
+        * Adds the neccessary CSS to the backend
         *
-        * @return      void
+        * @return void
         */
        protected function addCssToBackend() {
                $this->backendReference->addCssFile('opendocs', t3lib_extMgm::extRelPath($this->EXTKEY) . 'opendocs.css');
        }
 
-
        /*******************
         ***    HOOKS    ***
         *******************/
 
        /**
-        * called as a hook in t3lib_BEfunc::setUpdateSignal, calls a JS function to change
+        * Called as a hook in t3lib_BEfunc::setUpdateSignal, calls a JS function to change
         * the number of opened documents
         *
-        * @param       array           $params
-        * @param       unknown_type            $ref
-        * @return      string          list item HTML attibutes
+        * @param array $params
+        * @param unknown_type $ref
+        * @return string list item HTML attibutes
         */
        public function updateNumberOfOpenDocsHook(&$params, $ref) {
                $params['JScode'] = '
@@ -246,35 +243,34 @@ class tx_opendocs implements backend_toolbarItem {
                ';
        }
 
-
        /******************
         *** AJAX CALLS ***
         ******************/
 
        /**
-        * closes a document in the session and
+        * Closes a document in the session and
         *
-        * @param       array           array of parameters from the AJAX interface, currently unused
-        * @param       TYPO3AJAX       object of type TYPO3AJAX
-        * @return      string          list item HTML attibutes
+        * @param array $params Array of parameters from the AJAX interface, currently unused
+        * @param TYPO3AJAX $ajaxObj Object of type TYPO3AJAX
+        * @return string List item HTML attibutes
         */
        public function closeDocument($params = array(), TYPO3AJAX &$ajaxObj = NULL) {
                $md5sum = t3lib_div::_GP('md5sum');
 
                if ($md5sum && isset($this->openDocs[$md5sum])) {
 
-                               // add the document to be closed to the recent documents
+                               // Add the document to be closed to the recent documents
                        $this->recentDocs = array_merge(
                                array($md5sum => $this->openDocs[$md5sum]),
                                $this->recentDocs
                        );
 
-                               // allow a maximum of 8 recent documents
+                               // Allow a maximum of 8 recent documents
                        if (count($this->recentDocs) > 8) {
                                $this->recentDocs = array_slice($this->recentDocs, 0, 8);
                        }
 
-                               // remove it from the list of the open documents, and store the status
+                               // Remove it from the list of the open documents, and store the status
                        unset($this->openDocs[$md5sum]);
                        list(, $docDat) = $GLOBALS['BE_USER']->getModuleData('alt_doc.php', 'ses');
                        $GLOBALS['BE_USER']->pushModuleData('alt_doc.php', array($this->openDocs, $docDat));
@@ -285,11 +281,11 @@ class tx_opendocs implements backend_toolbarItem {
        }
 
        /**
-        * renders the menu so that it can be returned as response to an AJAX call
+        * Renders the menu so that it can be returned as response to an AJAX call
         *
-        * @param       array           array of parameters from the AJAX interface, currently unused
-        * @param       TYPO3AJAX       object of type TYPO3AJAX
-        * @return      void
+        * @param array $params Array of parameters from the AJAX interface, currently unused
+        * @param TYPO3AJAX $ajaxObj Object of type TYPO3AJAX
+        * @return void
         */
        public function renderAjax($params = array(), TYPO3AJAX &$ajaxObj = NULL) {
                $menuContent = $this->renderMenu();
index f302260..eecd0bd 100644 (file)
@@ -1,27 +1,27 @@
 <?php
 
-if (!defined('TYPO3_MODE'))    die('Access denied.');
-
+if (!defined('TYPO3_MODE')) {
+       die('Access denied.');
+}
 
-if(TYPO3_MODE == 'BE') {
+if (TYPO3_MODE == 'BE') {
 
        $opendocsPath = t3lib_extMgm::extPath('opendocs');
 
-               // register toolbar item
+               // Register toolbar item
        $GLOBALS['TYPO3_CONF_VARS']['typo3/backend.php']['additionalBackendItems'][] = $opendocsPath.'registerToolbarItem.php';
 
 
-               // register AJAX calls
+               // Register AJAX calls
        $GLOBALS['TYPO3_CONF_VARS']['BE']['AJAX']['tx_opendocs::renderMenu']   = $opendocsPath.'class.tx_opendocs.php:tx_opendocs->renderAjax';
        $GLOBALS['TYPO3_CONF_VARS']['BE']['AJAX']['tx_opendocs::closeDocument'] = $opendocsPath.'class.tx_opendocs.php:tx_opendocs->closeDocument';
 
-               // register update signal to update the number of open documents
+               // Register update signal to update the number of open documents
        $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_befunc.php']['updateSignalHook']['tx_opendocs::updateNumber'] = $opendocsPath.'class.tx_opendocs.php:tx_opendocs->updateNumberOfOpenDocsHook';
 
-
-               // register menu module if option is wanted
+               // Register menu module if option is wanted
        $_EXTCONF = unserialize($_EXTCONF);
-       if($_EXTCONF['enableModule']) {
+       if ($_EXTCONF['enableModule']) {
                t3lib_extMgm::addModule('user', 'doc', 'after:ws', $opendocsPath.'mod/');
        }
 }
index 52edfb5..066140b 100644 (file)
@@ -1,13 +1,15 @@
 <?php
 
-if (!defined('TYPO3_MODE'))    die ('Access denied.');
+if (!defined('TYPO3_MODE')) {
+       die('Access denied.');
+}
 
 if (TYPO3_MODE == 'BE') {
 
-               // first include the class file
+               // First include the class file
        include_once(t3lib_extMgm::extPath('opendocs').'class.tx_opendocs.php');
 
-               // now register the class as toolbar item
+               // Now register the class as toolbar item
        $GLOBALS['TYPO3backend']->addToolbarItem('opendocs', 'tx_opendocs');
 }
 
index 255ed1e..0c5f71c 100644 (file)
@@ -1,6 +1,6 @@
 <?php
-if (!defined ('TYPO3_MODE')) {
-       die ('Access denied.');
+if (!defined('TYPO3_MODE')) {
+       die('Access denied.');
 }
 
 if (TYPO3_MODE === 'BE') {
index 8b7d9a7..e43fa23 100644 (file)
@@ -29,16 +29,17 @@ $GLOBALS['LANG']->includeLLFile('EXT:lang/locallang_mod_web_perm.xml');
  * convenient methods of editing of page permissions (including page ownership
  * (user and group)) via new TYPO3AJAX facility
  *
- * @author             Andreas Kundoch <typo3@mehrwert.de>
- * @package            TYPO3
- * @subpackage core
- * @license            GPL
- * @since              TYPO3_4-2
+ * @author Andreas Kundoch <typo3@mehrwert.de>
+ * @package TYPO3
+ * @subpackage core
+ * @license GPL
+ * @since TYPO3_4-2
  */
 class SC_mod_web_perm_ajax {
-
-       protected $conf = array();      // The local configuration array
-       protected $backPath = '../../../';      // TYPO3 Back Path
+               // The local configuration array
+       protected $conf = array();
+               // TYPO3 Back Path
+       protected $backPath = '../../../';
 
        /********************************************
         *
@@ -48,8 +49,6 @@ class SC_mod_web_perm_ajax {
 
        /**
         * The constructor of this class
-        *
-        * @return      Void
         */
        public function __construct() {
 
@@ -97,9 +96,9 @@ class SC_mod_web_perm_ajax {
        /**
         * The main dispatcher function. Collect data and prepare HTML output.
         *
-        * @param       array           $params: array of parameters from the AJAX interface, currently unused
-        * @param       TYPO3AJAX               $ajaxObj: object of type TYPO3AJAX
-        * @return      Void
+        * @param array $params array of parameters from the AJAX interface, currently unused
+        * @param TYPO3AJAX $ajaxObj object of type TYPO3AJAX
+        * @return void
         */
        public function dispatch($params = array(), TYPO3AJAX &$ajaxObj = NULL) {
                $content = '';
@@ -206,10 +205,10 @@ class SC_mod_web_perm_ajax {
        /**
         * Generate the user selector element
         *
-        * @param       Integer         $page: The page id to change the user for
-        * @param       Integer         $ownerUid: The page owner uid
-        * @param       String          $username: The username to display
-        * @return      String          The html select element
+        * @param integer $page The page id to change the user for
+        * @param integer $ownerUid The page owner uid
+        * @param string $username The username to display
+        * @return string The html select element
         */
        protected function renderUserSelector($page, $ownerUid, $username = '') {
 
@@ -244,10 +243,10 @@ class SC_mod_web_perm_ajax {
        /**
         * Generate the group selector element
         *
-        * @param       Integer         $page: The page id to change the user for
-        * @param       Integer         $groupUid: The page group uid
-        * @param       String          $username: The username to display
-        * @return      String          The html select element
+        * @param integer $page The page id to change the user for
+        * @param integer $groupUid The page group uid
+        * @param string $username The username to display
+        * @return string The html select element
         */
        protected function renderGroupSelector($page, $groupUid, $groupname = '') {
 
@@ -290,15 +289,14 @@ class SC_mod_web_perm_ajax {
                return $ret;
        }
 
-
        /**
         * Print the string with the new owner of a page record
         *
-        * @param       Integer         $page: The TYPO3 page id
-        * @param       Integer         $ownerUid: The new page user uid
-        * @param       String          $username: The TYPO3 BE username (used to display in the element)
-        * @param       Boolean         $validUser: Must be set to FALSE, if the user has no name or is deleted
-        * @return      String          The new group wrapped in HTML
+        * @param integer $page The TYPO3 page id
+        * @param integer $ownerUid The new page user uid
+        * @param string $username The TYPO3 BE username (used to display in the element)
+        * @param boolean $validUser Must be set to FALSE, if the user has no name or is deleted
+        * @return string The new group wrapped in HTML
         */
        public static function renderOwnername($page, $ownerUid, $username, $validUser = TRUE) {
                $elementId = 'o_'.$page;
@@ -306,15 +304,14 @@ class SC_mod_web_perm_ajax {
                return $ret;
        }
 
-
        /**
         * Print the string with the new group of a page record
         *
-        * @param       Integer         $page: The TYPO3 page id
-        * @param       Integer         $groupUid: The new page group uid
-        * @param       String          $groupname: The TYPO3 BE groupname (used to display in the element)
-        * @param       Boolean         $validGroup: Must be set to FALSE, if the group has no name or is deleted
-        * @return      String          The new group wrapped in HTML
+        * @param integer $page The TYPO3 page id
+        * @param integer $groupUid The new page group uid
+        * @param string $groupname The TYPO3 BE groupname (used to display in the element)
+        * @param boolean $validGroup Must be set to FALSE, if the group has no name or is deleted
+        * @return string The new group wrapped in HTML
         */
        public static function renderGroupname($page, $groupUid, $groupname, $validGroup = TRUE) {
                $elementId = 'g_'.$page;
@@ -322,13 +319,12 @@ class SC_mod_web_perm_ajax {
                return $ret;
        }
 
-
        /**
         * Print the string with the new edit lock state of a page record
         *
-        * @param       Integer         $page: The TYPO3 page id
-        * @param       String          $editlockstate: The state of the TYPO3 page (locked, unlocked)
-        * @return      String          The new edit lock string wrapped in HTML
+        * @param integer $page The TYPO3 page id
+        * @param string $editlockstate The state of the TYPO3 page (locked, unlocked)
+        * @return string The new edit lock string wrapped in HTML
         */
        protected function renderToggleEditLock($page, $editLockState) {
                if ($editLockState === 1) {
@@ -343,10 +339,10 @@ class SC_mod_web_perm_ajax {
        /**
         * Print a set of permissions. Also used in index.php
         *
-        * @param       integer         Permission integer (bits)
-        * @param       Integer         $page: The TYPO3 page id
-        * @param       String          $who: The scope (user, group or everybody)
-        * @return      string          HTML marked up x/* indications.
+        * @param integer $int Permission integer (bits)
+        * @param integer $page The TYPO3 page id
+        * @param string $who The scope (user, group or everybody)
+        * @return string HTML marked up x/* indications.
         */
        public static function renderPermissions($int, $pageId = 0, $who = 'user') {
                $str = '';
index 5b2034f..fb55077 100755 (executable)
@@ -1,9 +1,9 @@
 <?php
-$MCONF['script']='_DISPATCH';
+$MCONF['script'] = '_DISPATCH';
 
 $MLANG['default']['tabs_images']['tab'] = 'perm.gif';
-$MLANG['default']['ll_ref']='LLL:EXT:lang/locallang_mod_web_perm.xml';
+$MLANG['default']['ll_ref'] = 'LLL:EXT:lang/locallang_mod_web_perm.xml';
 
-$MCONF['access']='user,group';
-$MCONF['name']='web_perm';
+$MCONF['access'] = 'user,group';
+$MCONF['name'] = 'web_perm';
 ?>
\ No newline at end of file
index 031e3a0..da254fd 100755 (executable)
  * Revised for TYPO3 3.6 November/2003 by Kasper Skårhøj
  * XHTML compliant
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  */
 
 $LANG->includeLLFile('EXT:lang/locallang_mod_web_perm.xml');
 $BE_USER->modAccess($MCONF, 1);
 
-
 /**
  * Module: Permission setting
  *
@@ -47,10 +46,10 @@ $BE_USER->modAccess($MCONF, 1);
  * $this->MOD_SETTINGS['depth']: intval 1-3: decides the depth of the list
  * $this->MOD_SETTINGS['mode']: 'perms' / '': decides if we view a user-overview or the permissions.
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
- * @author     Andreas Kundoch <typo3@mehrwert.de>
- * @package    TYPO3
- * @subpackage core
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Andreas Kundoch <typo3@mehrwert.de>
+ * @package TYPO3
+ * @subpackage core
  */
 class SC_mod_web_perm_index {
 
@@ -155,7 +154,7 @@ class SC_mod_web_perm_index {
        /**
         * Initialization of the class
         *
-        * @return      void
+        * @return void
         */
        public function init() {
 
@@ -190,7 +189,7 @@ class SC_mod_web_perm_index {
        /**
         * Configuration of the menu and initialization of ->MOD_SETTINGS
         *
-        * @return      void
+        * @return void
         */
        public function menuConfig() {
                        // MENU-ITEMS:
@@ -219,7 +218,7 @@ class SC_mod_web_perm_index {
        /**
         * Main function, creating the content for the access editing forms/listings
         *
-        * @return      void
+        * @return void
         */
        public function main() {
                        // Access check...
@@ -284,7 +283,7 @@ class SC_mod_web_perm_index {
        /**
         * Outputting the accumulated content to screen
         *
-        * @return      void
+        * @return void
         */
        public function printContent() {
                $this->content = $this->doc->insertStylesAndJS($this->content);
@@ -328,13 +327,6 @@ class SC_mod_web_perm_index {
                return $buttons;
        }
 
-
-
-
-
-
-
-
        /*****************************
         *
         * Listing and Form rendering
@@ -345,7 +337,7 @@ class SC_mod_web_perm_index {
         * Creating form for editing the permissions    ($this->edit = TRUE)
         * (Adding content to internal content variable)
         *
-        * @return      void
+        * @return void
         */
        public function doEdit() {
                if ($GLOBALS['BE_USER']->workspace != 0) {
@@ -371,23 +363,25 @@ class SC_mod_web_perm_index {
                if (!$GLOBALS['BE_USER']->isAdmin()) {
                        $beGroupArray = t3lib_BEfunc::blindGroupNames($beGroupArray_o, $beGroupKeys, 1);
                }
-               $firstGroup = $beGroupKeys[0] ? $beGroupArray[$beGroupKeys[0]] : '';    // data of the first group, the user is member of
+                       // data of the first group, the user is member of
+               $firstGroup = $beGroupKeys[0] ? $beGroupArray[$beGroupKeys[0]] : '';
 
 
                        // Owner selector:
-               $options='';
-               $userset=0;     // flag: is set if the page-userid equals one from the user-list
-               foreach($beUserArray as $uid => $row) {
-                       if ($uid==$this->pageinfo['perms_userid']) {
+               $options = '';
+                       // flag: is set if the page-userid equals one from the user-list
+               $userset = 0;
+               foreach ($beUserArray as $uid => $row) {
+                       if ($uid == $this->pageinfo['perms_userid']) {
                                $userset = 1;
-                               $selected=' selected="selected"';
+                               $selected = ' selected="selected"';
                        } else {
-                               $selected='';
+                               $selected = '';
                        }
-                       $options.='
+                       $options .= '
                                <option value="'.$uid.'"'.$selected.'>'.htmlspecialchars($row['username']).'</option>';
                }
-               $options='
+               $options = '
                                <option value="0"></option>'.$options;
                $selector='
                        <select name="data[pages]['.$this->id.'][perms_userid]">
@@ -398,33 +392,34 @@ class SC_mod_web_perm_index {
 
 
                        // Group selector:
-               $options='';
-               $userset=0;
-               foreach($beGroupArray as $uid => $row) {
+               $options = '';
+               $userset = 0;
+               foreach ($beGroupArray as $uid => $row) {
                        if ($uid==$this->pageinfo['perms_groupid']) {
                                $userset = 1;
-                               $selected=' selected="selected"';
+                               $selected = ' selected="selected"';
                        } else {
-                               $selected='';
+                               $selected = '';
                        }
-                       $options.='
+                       $options .= '
                                <option value="'.$uid.'"'.$selected.'>'.htmlspecialchars($row['title']).'</option>';
                }
-               if (!$userset && $this->pageinfo['perms_groupid'])      {       // If the group was not set AND there is a group for the page
-                       $options='
+                       // If the group was not set AND there is a group for the page
+               if (!$userset && $this->pageinfo['perms_groupid']) {
+                       $options = '
                                <option value="'.$this->pageinfo['perms_groupid'].'" selected="selected">'.
                                                htmlspecialchars($beGroupArray_o[$this->pageinfo['perms_groupid']]['title']).
                                                '</option>'.
                                                $options;
                }
-               $options='
+               $options = '
                                <option value="0"></option>'.$options;
-               $selector='
+               $selector = '
                        <select name="data[pages]['.$this->id.'][perms_groupid]">
                                '.$options.'
                        </select>';
 
-               $this->content.=$this->doc->divider(5);
+               $this->content .= $this->doc->divider(5);
                $this->content .= $this->doc->section($GLOBALS['LANG']->getLL('Group') . ':', $selector);
 
                        // Permissions checkbox matrix:
@@ -476,7 +471,7 @@ class SC_mod_web_perm_index {
                        ' . t3lib_TCEforms::getHiddenTokenField('tceAction');
 
                        // Adding section with the permission setting matrix:
-               $this->content.=$this->doc->divider(5);
+               $this->content .= $this->doc->divider(5);
                $this->content .= $this->doc->section($GLOBALS['LANG']->getLL('permissions') . ':', $code);
 
                        // CSH for permissions setting
@@ -484,7 +479,7 @@ class SC_mod_web_perm_index {
 
                        // Adding help text:
                if ($GLOBALS['BE_USER']->uc['helpText']) {
-                       $this->content.=$this->doc->divider(20);
+                       $this->content .= $this->doc->divider(20);
                        $legendText = '<strong>' . $GLOBALS['LANG']->getLL('1', 1) . '</strong>: ' . $GLOBALS['LANG']->getLL('1_t', 1);
                        $legendText .= '<br /><strong>' . $GLOBALS['LANG']->getLL('16', 1) . '</strong>: ' . $GLOBALS['LANG']->getLL('16_t', 1);
                        $legendText .= '<br /><strong>' . $GLOBALS['LANG']->getLL('2', 1) . '</strong>: ' . $GLOBALS['LANG']->getLL('2_t', 1);
@@ -500,7 +495,7 @@ class SC_mod_web_perm_index {
         * Showing the permissions in a tree ($this->edit = FALSE)
         * (Adding content to internal content variable)
         *
-        * @return      void
+        * @return void
         */
        public function notEdit() {
                        // Get usernames and groupnames: The arrays we get in return contains only 1) users which are members of the groups of the current user, 2) groups that the current user is member of
@@ -517,10 +512,9 @@ class SC_mod_web_perm_index {
                        // Length of strings:
                $tLen= ($this->MOD_SETTINGS['mode']=='perms' ? 20 : 30);
 
-
                        // Selector for depth:
                $code = $GLOBALS['LANG']->getLL('Depth') . ': ';
-               $code.=t3lib_BEfunc::getFuncMenu($this->id, 'SET[depth]', $this->MOD_SETTINGS['depth'], $this->MOD_MENU['depth']);
+               $code .= t3lib_BEfunc::getFuncMenu($this->id, 'SET[depth]', $this->MOD_SETTINGS['depth'], $this->MOD_MENU['depth']);
                $this->content.=$this->doc->section('', $code);
                $this->content.=$this->doc->spacer(5);
 
@@ -540,16 +534,16 @@ class SC_mod_web_perm_index {
                $tree->addField('editlock');
 
                        // Creating top icon; the current page
-               $HTML=t3lib_iconWorks::getSpriteIconForRecord('pages', $this->pageinfo);
+               $HTML = t3lib_iconWorks::getSpriteIconForRecord('pages', $this->pageinfo);
                $tree->tree[] = array('row'=>$this->pageinfo, 'HTML'=>$HTML);
 
                        // Create the tree from $this->id:
                $tree->getTree($this->id, $this->MOD_SETTINGS['depth'], '');
 
                        // Make header of table:
-               $code='';
-               if ($this->MOD_SETTINGS['mode']=='perms') {
-                       $code.='
+               $code = '';
+               if ($this->MOD_SETTINGS['mode'] == 'perms') {
+                       $code .= '
                                <tr class="t3-row-header">
                                        <td colspan="2">&nbsp;</td>
                                        <td><img' . t3lib_iconWorks::skinImg($GLOBALS['BACK_PATH'], 'gfx/line.gif', 'width="5" height="16"') . ' alt="" /></td>
@@ -563,7 +557,7 @@ class SC_mod_web_perm_index {
                                </tr>
                        ';
                } else {
-                       $code.='
+                       $code .= '
                                <tr class="t3-row-header">
                                        <td colspan="2">&nbsp;</td>
                                        <td><img' . t3lib_iconWorks::skinImg($GLOBALS['BACK_PATH'], 'gfx/line.gif', 'width="5" height="16"') . ' alt="" /></td>
@@ -600,20 +594,19 @@ class SC_mod_web_perm_index {
                                // Seeing if editing of permissions are allowed for that page:
                        $editPermsAllowed = ($data['row']['perms_userid'] == $GLOBALS['BE_USER']->user['uid'] || $GLOBALS['BE_USER']->isAdmin());
 
-
                                // First column:
                        $cellAttrib = ($data['row']['_CSSCLASS'] ? ' class="'.$data['row']['_CSSCLASS'].'"' : '');
-                       $cells[]='
+                       $cells[] = '
                                        <td align="left" nowrap="nowrap"'.($cellAttrib ? $cellAttrib : $bgCol).'>'.$data['HTML'].htmlspecialchars(t3lib_div::fixed_lgd_cs($data['row']['title'], $tLen)).'&nbsp;</td>';
 
                                // "Edit permissions" -icon
                        if ($editPermsAllowed && $pageId) {
                                $aHref = t3lib_BEfunc::getModuleUrl('web_perm') . '&mode='.$this->MOD_SETTINGS['mode'].'&depth='.$this->MOD_SETTINGS['depth'].'&id='.($data['row']['_ORIG_uid'] ? $data['row']['_ORIG_uid'] : $pageId).'&return_id='.$this->id.'&edit=1';
-                               $cells[]='
+                               $cells[] = '
                                        <td' . $bgCol . '><a href="' . htmlspecialchars($aHref) . '" title="' . $GLOBALS['LANG']->getLL('ch_permissions', 1) . '">' . t3lib_iconWorks::getSpriteIcon('actions-document-open') . '</a></td>';
                        } else {
-                               $cells[]='
-                                       <td'.$bgCol.'></td>';
+                               $cells[] = '
+                                       <td'. $bgCol . '></td>';
                        }
 
                                // Rest of columns (depending on mode)
@@ -633,13 +626,13 @@ class SC_mod_web_perm_index {
                                                t3lib_iconWorks::getSpriteIcon('status-warning-lock') . '</a></span>' : ( $pageId === 0 ? '' : '<span id="el_'.$pageId.'" class="editlock"><a class="editlock" onclick="WebPermissions.toggleEditLock(\''.$pageId.'\', \'0\');" title="Enable the &raquo;Admin-only&laquo; edit lock for this page">[+]</a></span>')).'</td>
                                ';
                        } else {
-                               $cells[]='
+                               $cells[] = '
                                        <td' . $bgCol . ' class="center"><img' . t3lib_iconWorks::skinImg($GLOBALS['BACK_PATH'], 'gfx/line.gif', 'width="5" height="16"') . ' alt="" /></td>';
 
                                $bgCol = ($GLOBALS['BE_USER']->user['uid'] == $data['row']['perms_userid'] ? ' class="bgColor-20"' : $lE_bgCol);
 
                                // FIXME $owner undefined
-                               $cells[]='
+                               $cells[] = '
                                        <td'.$bgCol.' nowrap="nowrap" align="center">'.($pageId ? $owner.SC_mod_web_perm_ajax::renderPermissions($GLOBALS['BE_USER']->calcPerms($data['row']), $pageId, 'user') : '').'</td>
                                        ' . (!$GLOBALS['BE_USER']->isAdmin() ? '
                                        <td' . $bgCol . ' class="center"><img' . t3lib_iconWorks::skinImg($GLOBALS['BACK_PATH'], 'gfx/line.gif', 'width="5" height="16"') . ' alt="" /></td>
@@ -660,10 +653,10 @@ class SC_mod_web_perm_index {
                $code = '<table border="0" cellspacing="0" cellpadding="0" id="typo3-permissionList">' . $code . '</table>';
 
                        // Adding the content as a section:
-               $this->content.=$this->doc->section('', $code);
+               $this->content .= $this->doc->section('', $code);
 
                        // CSH for permissions setting
-               $this->content.= t3lib_BEfunc::cshItem('xMOD_csh_corebe', 'perm_module', $GLOBALS['BACK_PATH'], '<br />|');
+               $this->content .= t3lib_BEfunc::cshItem('xMOD_csh_corebe', 'perm_module', $GLOBALS['BACK_PATH'], '<br />|');
 
                        // Creating legend table:
                $legendText = '<strong>' . $GLOBALS['LANG']->getLL('1', 1) . '</strong>: ' . $GLOBALS['LANG']->getLL('1_t', 1);
@@ -672,7 +665,7 @@ class SC_mod_web_perm_index {
                $legendText .= '<br /><strong>' . $GLOBALS['LANG']->getLL('4', 1) . '</strong>: ' . $GLOBALS['LANG']->getLL('4_t', 1);
                $legendText .= '<br /><strong>' . $GLOBALS['LANG']->getLL('8', 1) . '</strong>: ' . $GLOBALS['LANG']->getLL('8_t', 1);
 
-               $code='<table border="0" id="typo3-legendTable">
+               $code = '<table border="0" id="typo3-legendTable">
                        <tr>
                                <td valign="top">
                                        <img' . t3lib_iconWorks::skinImg($GLOBALS['BACK_PATH'], 'gfx/legend.gif', 'width="86" height="75"') . ' alt="" />
@@ -680,22 +673,16 @@ class SC_mod_web_perm_index {
                                <td valign="top" nowrap="nowrap">'.$legendText.'</td>
                        </tr>
                </table>';
-               $code.='<div id="perm-legend">' . $GLOBALS['LANG']->getLL('def', 1 );
-               $code.='<br /><br />' . t3lib_iconWorks::getSpriteIcon('status-status-permission-granted') . ': ' . $GLOBALS['LANG']->getLL('A_Granted', 1);
-               $code.='<br />' . t3lib_iconWorks::getSpriteIcon('status-status-permission-denied') . ': ' . $GLOBALS['LANG']->getLL('A_Denied', 1);
-               $code.='</div>';
+               $code .= '<div id="perm-legend">' . $GLOBALS['LANG']->getLL('def', 1 );
+               $code .= '<br /><br />' . t3lib_iconWorks::getSpriteIcon('status-status-permission-granted') . ': ' . $GLOBALS['LANG']->getLL('A_Granted', 1);
+               $code .= '<br />' . t3lib_iconWorks::getSpriteIcon('status-status-permission-denied') . ': ' . $GLOBALS['LANG']->getLL('A_Denied', 1);
+               $code .= '</div>';
 
                        // Adding section with legend code:
                $this->content.=$this->doc->spacer(20);
                $this->content.=$this->doc->section($GLOBALS['LANG']->getLL('Legend') . ':', $code, 0, 1);
        }
 
-
-
-
-
-
-
        /*****************************
         *
         * Helper functions
@@ -705,9 +692,9 @@ class SC_mod_web_perm_index {
        /**
         * Print a checkbox for the edit-permission form
         *
-        * @param       string          Checkbox name key
-        * @param       integer         Checkbox number index
-        * @return      string          HTML checkbox
+        * @param string $checkName Checkbox name key
+        * @param integer $num Checkbox number index
+        * @return string HTML checkbox
         */
        public function printCheckBox($checkName, $num) {
                $onclick = 'checkChange(\'check['.$checkName.']\', \'data[pages]['.$GLOBALS['SOBE']->id.']['.$checkName.']\')';
@@ -718,9 +705,9 @@ class SC_mod_web_perm_index {
        /**
         * Returns the permissions for a group based of the perms_groupid of $row. If the $row[perms_groupid] equals the $firstGroup[uid] then the function returns perms_everybody OR'ed with perms_group, else just perms_everybody
         *
-        * @param       array           Row array (from pages table)
-        * @param       array           First group data
-        * @return      integer         Integer: Combined permissions.
+        * @param array $row Row array (from pages table)
+        * @param array $firstGroup First group data
+        * @return integer Integer: Combined permissions.
         */
        public function groupPerms($row, $firstGroup) {
                if (is_array($row)) {
@@ -735,9 +722,9 @@ class SC_mod_web_perm_index {
        /**
         * Finding tree and offer setting of values recursively.
         *
-        * @param       integer         Page id.
-        * @param       string          Select clause
-        * @return      string          Select form element for recursive levels (if any levels are found)
+        * @param integer $id Page id.
+        * @param string $perms_clause Select clause
+        * @return string Select form element for recursive levels (if any levels are found)
         */
        public function getRecursiveSelect($id, $perms_clause) {
 
@@ -745,7 +732,7 @@ class SC_mod_web_perm_index {
                $tree = t3lib_div::makeInstance('t3lib_pageTree');
                $tree->init('AND '.$perms_clause);
                $tree->addField('perms_userid', 1);
-               $tree->makeHTML=0;
+               $tree->makeHTML = 0;
                $tree->setRecs = 1;
 
                        // Make tree:
@@ -758,20 +745,20 @@ class SC_mod_web_perm_index {
                        $label_recur = $GLOBALS['LANG']->getLL('recursive');
                        $label_levels = $GLOBALS['LANG']->getLL('levels');
                        $label_pA = $GLOBALS['LANG']->getLL('pages_affected');
-                       $theIdListArr=array();
-                       $opts='
+                       $theIdListArr = array();
+                       $opts = '
                                                <option value=""></option>';
 
                                // Traverse the number of levels we want to allow recursive setting of permissions for:
-                       for ($a=$this->getLevels;$a>0;$a--) {
+                       for ($a = $this->getLevels; $a > 0; $a--) {
                                if (is_array($tree->orig_ids_hierarchy[$a])) {
-                                       foreach($tree->orig_ids_hierarchy[$a] as $theId) {
+                                       foreach ($tree->orig_ids_hierarchy[$a] as $theId) {
                                                if ($GLOBALS['BE_USER']->isAdmin() || $GLOBALS['BE_USER']->user['uid']==$tree->recs[$theId]['perms_userid']) {
                                                        $theIdListArr[]=$theId;
                                                }
                                        }
                                        $lKey = $this->getLevels-$a+1;
-                                       $opts.='
+                                       $opts .= '
                                                <option value="'.htmlspecialchars(implode(',', $theIdListArr)).'">'.
                                                        t3lib_div::deHSCentities(htmlspecialchars($label_recur.' '.$lKey.' '.$label_levels)).' ('.count($theIdListArr).' '.$label_pA.')'.
                                                        '</option>';
@@ -793,7 +780,7 @@ class SC_mod_web_perm_index {
        }
 }
 
-// Make instance:
+       // Make instance:
 $SOBE = t3lib_div::makeInstance('SC_mod_web_perm_index');
 $SOBE->init();
 $SOBE->main();