[TASK] Clean up phpDoc comments in typo3/sysext/
authorWouter Wolters <typo3@wouterwolters.nl>
Wed, 20 Jun 2012 23:02:36 +0000 (01:02 +0200)
committerChristian Kuhn <lolli@schwarzbu.ch>
Wed, 20 Jun 2012 23:57:29 +0000 (01:57 +0200)
Clean up phpDoc comments for the following classes:

* typo3/sysext/cshmanual/ext_tables.php
* typo3/sysext/extra_page_cm_options/class.tx_extrapagecmoptions.php
* typo3/sysext/extra_page_cm_options/ext_tables.php
* typo3/sysext/feedit/ext_localconf.php
* typo3/sysext/feedit/view/class.tx_feedit_editpanel.php
* typo3/sysext/felogin/ext_localconf.php
* typo3/sysext/felogin/ext_tables.php
* typo3/sysext/felogin/pi1/class.tx_felogin_pi1.php
* typo3/sysext/felogin/tests/tx_feloginTest.php

Clean up provides:

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

Change-Id: Id09ec3f662b432098eb3b3897008cbeee76e0871
Resolves: #38242
Releases: 6.0
Reviewed-on: http://review.typo3.org/12245
Reviewed-by: Oliver Klee
Reviewed-by: Christian Kuhn
Tested-by: Christian Kuhn
typo3/sysext/cshmanual/ext_tables.php
typo3/sysext/extra_page_cm_options/class.tx_extrapagecmoptions.php
typo3/sysext/extra_page_cm_options/ext_tables.php
typo3/sysext/feedit/ext_localconf.php
typo3/sysext/feedit/view/class.tx_feedit_editpanel.php
typo3/sysext/felogin/ext_localconf.php
typo3/sysext/felogin/ext_tables.php
typo3/sysext/felogin/pi1/class.tx_felogin_pi1.php
typo3/sysext/felogin/tests/tx_feloginTest.php

index 4eee0bf..34b8147 100644 (file)
@@ -1,5 +1,7 @@
 <?php
-if (!defined ('TYPO3_MODE'))   die ('Access denied.');
+if (!defined ('TYPO3_MODE')) {
+       die('Access denied.');
+}
 
 if (TYPO3_MODE=='BE') {
        t3lib_extMgm::addModule('help', 'cshmanual', 'top', t3lib_extMgm::extPath($_EXTKEY).'mod/');
index 787add5..f19dac5 100755 (executable)
  *
  * Revised for TYPO3 3.6 November/2003 by Kasper Skårhøj
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  */
 
-
-
-
-
-
-
-
-
-
-
-
 /**
  * Class, adding extra context menu options
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  * @package TYPO3
  * @subpackage tx_extrapagecmoptions
  */
@@ -56,18 +45,19 @@ class tx_extrapagecmoptions {
         * Adding various standard options to the context menu.
         * This includes both first and second level.
         *
-        * @param       object          The calling object. Value by reference.
-        * @param       array           Array with the currently collected menu items to show.
-        * @param       string          Table name of clicked item.
-        * @param       integer         UID of clicked item.
-        * @return      array           Modified $menuItems array
+        * @param object $backRef The calling object. Value by reference.
+        * @param array $menuItems Array with the currently collected menu items to show.
+        * @param string $table Table name of clicked item.
+        * @param integer $uid UID of clicked item.
+        * @return array Modified $menuItems array
         */
        function main(&$backRef, $menuItems, $table, $uid) {
-               $localItems = array();  // Accumulation of local items.
+                       // Accumulation of local items.
+               $localItems = array();
                $subname = t3lib_div::_GP('subname');
 
                        // Detecting menu level
-               // LEVEL: Primary menu.
+                       // LEVEL: Primary menu.
                if (!in_array('moreoptions', $backRef->disabledItems) && !$backRef->cmLevel) {
                                // Creating menu items here:
                        if ($backRef->editOK) {
@@ -82,16 +72,22 @@ class tx_extrapagecmoptions {
                                        1
                                );
 
-                               if (!in_array('hide', $backRef->disabledItems) && is_array($GLOBALS['TCA'][$table]['ctrl']['enablecolumns']) && $GLOBALS['TCA'][$table]['ctrl']['enablecolumns']['disabled'])
-                                               $localItems['hide'] = $backRef->DB_hideUnhide($table, $backRef->rec, $GLOBALS['TCA'][$table]['ctrl']['enablecolumns']['disabled']);
-                               if (!in_array('edit_access', $backRef->disabledItems) && is_array($GLOBALS['TCA'][$table]['ctrl']['enablecolumns']))
-                                               $localItems['edit_access'] = $backRef->DB_editAccess($table, $uid);
-                               if (!in_array('edit_pageproperties', $backRef->disabledItems) && $table=='pages' && $backRef->editPageIconSet)
-                                               $localItems['edit_pageproperties'] = $backRef->DB_editPageProperties($uid);
+                               if (!in_array('hide', $backRef->disabledItems) && is_array($GLOBALS['TCA'][$table]['ctrl']['enablecolumns']) && $GLOBALS['TCA'][$table]['ctrl']['enablecolumns']['disabled']) {
+                                       $localItems['hide'] = $backRef->DB_hideUnhide($table, $backRef->rec, $GLOBALS['TCA'][$table]['ctrl']['enablecolumns']['disabled']);
+                               }
+
+                               if (!in_array('edit_access', $backRef->disabledItems) && is_array($GLOBALS['TCA'][$table]['ctrl']['enablecolumns'])) {
+                                       $localItems['edit_access'] = $backRef->DB_editAccess($table, $uid);
+                               }
+
+                               if (!in_array('edit_pageproperties', $backRef->disabledItems) && $table == 'pages' && $backRef->editPageIconSet) {
+                                       $localItems['edit_pageproperties'] = $backRef->DB_editPageProperties($uid);
+                               }
+
                        }
 
                                // Find delete element among the input menu items and insert the local items just before that:
-                       $c=0;
+                       $c = 0;
                        $deleteFound = FALSE;
                        foreach ($menuItems as $k => $value) {
                                $c++;
@@ -103,7 +99,7 @@ class tx_extrapagecmoptions {
 
                        if ($deleteFound) {
                                        // .. subtract two... (delete item + its spacer element...)
-                               $c-=2;
+                               $c -= 2;
                                        // and insert the items just before the delete element.
                                array_splice(
                                        $menuItems,
@@ -113,19 +109,19 @@ class tx_extrapagecmoptions {
                                );
                                // If no delete item was found, then just merge in the items:
                        } else {
-                               $menuItems=array_merge($menuItems, $localItems);
+                               $menuItems = array_merge($menuItems, $localItems);
                        }
                        // LEVEL: Secondary level of menus (activated by an item on the first level).
                } elseif ($subname === 'moreoptions') {
                                // If the page can be edited, then show this:
                        if ($backRef->editOK)   {
-                               if (!in_array('move_wizard', $backRef->disabledItems) && ($table=='pages' || $table=='tt_content')) {
+                               if (!in_array('move_wizard', $backRef->disabledItems) && ($table == 'pages' || $table == 'tt_content')) {
                                        $localItems['move_wizard']=$backRef->DB_moveWizard($table, $uid, $backRef->rec);
                                }
-                               if (!in_array('new_wizard', $backRef->disabledItems) && ($table=='pages' || $table=='tt_content')) {
+                               if (!in_array('new_wizard', $backRef->disabledItems) && ($table == 'pages' || $table == 'tt_content')) {
                                        $localItems['new_wizard']=$backRef->DB_newWizard($table, $uid, $backRef->rec);
                                }
-                               if (!in_array('perms', $backRef->disabledItems) && $table=='pages' && $GLOBALS['BE_USER']->check('modules', 'web_perm')) {
+                               if (!in_array('perms', $backRef->disabledItems) && $table == 'pages' && $GLOBALS['BE_USER']->check('modules', 'web_perm')) {
                                        $localItems['perms']=$backRef->DB_perms($table, $uid, $backRef->rec);
                                }
                                if (!in_array('db_list', $backRef->disabledItems) && $GLOBALS['BE_USER']->check('modules', 'web_list')) {
@@ -134,7 +130,7 @@ class tx_extrapagecmoptions {
                        }
 
                                // Temporary mount point item:
-                       if ($table=='pages') {
+                       if ($table == 'pages') {
                                $localItems['temp_mount_point'] = $backRef->DB_tempMountPoint($uid);
                        }
 
@@ -147,7 +143,7 @@ class tx_extrapagecmoptions {
        /**
         * Include local lang file.
         *
-        * @return      array           Local lang array.
+        * @return array Local lang array.
         */
        function includeLL() {
                $LOCAL_LANG = $GLOBALS['LANG']->includeLLFile('EXT:extra_page_cm_options/locallang.php', FALSE);
index 92741fa..7967658 100755 (executable)
@@ -1,5 +1,7 @@
 <?php
-if (!defined ('TYPO3_MODE'))   die ('Access denied.');
+if (!defined('TYPO3_MODE')) {
+       die('Access denied.');
+}
 
 if (TYPO3_MODE=='BE') {
        $GLOBALS['TBE_MODULES_EXT']['xMOD_alt_clickmenu']['extendCMclasses'][]=array(
index 443f474..115c261 100644 (file)
@@ -1,5 +1,7 @@
 <?php
-if (!defined ('TYPO3_MODE'))   die ('Access denied.');
+if (!defined('TYPO3_MODE')) {
+       die('Access denied.');
+}
 
        // Register the edit panel view.
 $TYPO3_CONF_VARS['SC_OPTIONS']['typo3/classes/class.frontendedit.php']['edit'] = 'EXT:feedit/view/class.tx_feedit_editpanel.php:tx_feedit_editpanel';
index 2491cec..80f429d 100644 (file)
@@ -28,8 +28,8 @@
 /**
  * View class for the edit panels in frontend editing.
  *
- * @author     Jeff Segars <jeff@webempoweredchurch.org>
- * @author     David Slayback <dave@webempoweredchurch.org>
+ * @author Jeff Segars <jeff@webempoweredchurch.org>
+ * @author David Slayback <dave@webempoweredchurch.org>
  * @package TYPO3
  * @subpackage feedit
  */
@@ -45,7 +45,7 @@ class tx_feedit_editpanel {
        /**
         * Constructor for the edit panel. Creates a new cObject instance to be used in wrapping, etc.
         *
-        * @return      void
+        * @return void
         */
        public function __construct() {
                $this->cObj = t3lib_div::makeInstance('tslib_cObj');
@@ -57,13 +57,17 @@ class tx_feedit_editpanel {
         * With the "edit panel" the user will see buttons with links to editing, moving, hiding, deleting the element
         * This function is used for the cObject EDITPANEL and the stdWrap property ".editPanel"
         *
-        * @param       string          A content string containing the content related to the edit panel. For cObject "EDITPANEL" this is empty but not so for the stdWrap property. The edit panel is appended to this string and returned.
-        * @param       array           TypoScript configuration properties for the editPanel
-        * @param       string          The "table:uid" of the record being shown. If empty string then $this->currentRecord is used. For new records (set by $conf['newRecordFromTable']) it's auto-generated to "[tablename]:NEW"
-        * @param       array           Alternative data array to use. Default is $this->data
-        * @return      string          The input content string with the editPanel appended. This function returns only an edit panel appended to the content string if a backend user is logged in (and has the correct permissions). Otherwise the content string is directly returned.
+        * @param string $content A content string containing the content related to the edit panel. For cObject "EDITPANEL" this is empty but not so for the stdWrap property. The edit panel is appended to this string and returned.
+        * @param array $conf TypoScript configuration properties for the editPanel
+        * @param string $currentRecord The "table:uid" of the record being shown. If empty string then $this->currentRecord is used. For new records (set by $conf['newRecordFromTable']) it's auto-generated to "[tablename]:NEW"
+        * @param array $dataArr Alternative data array to use. Default is $this->data
+        * @param string $table
+        * @param string $allow
+        * @param integer $newUID
+        * @param array $hiddenFields
+        * @return string The input content string with the editPanel appended. This function returns only an edit panel appended to the content string if a backend user is logged in (and has the correct permissions). Otherwise the content string is directly returned.
         */
-       public function editPanel($content, array $conf, $currentRecord='', array $dataArr=array(), $table='', $allow='', $newUID=0, array $hiddenFields=array()) {
+       public function editPanel($content, array $conf, $currentRecord = '', array $dataArr = array(), $table = '', $allow = '', $newUID = 0, array $hiddenFields = array()) {
                        // Special content is about to be shown, so the cache must be disabled.
                $GLOBALS['TSFE']->set_no_cache();
                $formName = 'TSFE_EDIT_FORM_' . substr($GLOBALS['TSFE']->uniqueHash(), 0, 4);
@@ -79,7 +83,7 @@ class tx_feedit_editpanel {
                        $theCmd =$TSFE_EDIT['cmd'];
                }
 
-               switch($theCmd) {
+               switch ($theCmd) {
                        case 'edit':
                        case 'new':
                                $finalOut = $this->editContent($formTag, $formName, $theCmd, $newUID, $dataArr, $table, $currentRecord, $blackLine);
@@ -119,7 +123,7 @@ class tx_feedit_editpanel {
                                        //      Final
                                $labelTxt = $this->cObj->stdWrap($conf['label'], $conf['label.']);
 
-                               foreach((array) $hiddenFields as $name => $value) {
+                               foreach ((array) $hiddenFields as $name => $value) {
                                        $hiddenFieldString .= '<input type="hidden" name="TSFE_EDIT[' . $name . ']" value="' . $value . '"/>' . LF;
                                }
 
@@ -137,7 +141,7 @@ class tx_feedit_editpanel {
                                                                        </tr>
                                                                </table>
                                                        </form>';
-                                       // wrap the panel
+                                       // Wrap the panel
                                if ($conf['innerWrap']) {
                                        $panel = $this->cObj->wrap($panel, $conf['innerWrap']);
                                }
@@ -145,10 +149,10 @@ class tx_feedit_editpanel {
                                        $panel = $this->cObj->stdWrap($panel, $conf['innerWrap.']);
                                }
 
-                                       // add black line:
+                                       // Add black line:
                                $panel .= $blackLine;
 
-                                       // wrap the complete panel
+                                       // Wrap the complete panel
                                if ($conf['outerWrap']) {
                                        $panel = $this->cObj->wrap($panel, $conf['outerWrap']);
                                }
@@ -177,15 +181,18 @@ class tx_feedit_editpanel {
         * Adds an edit icon to the content string. The edit icon links to alt_doc.php with proper parameters for editing the table/fields of the context.
         * This implements TYPO3 context sensitive editing facilities. Only backend users will have access (if properly configured as well).
         *
-        * @param       string          The content to which the edit icons should be appended
-        * @param       string          The parameters defining which table and fields to edit. Syntax is [tablename]:[fieldname],[fieldname],[fieldname],... OR [fieldname],[fieldname],[fieldname],... (basically "[tablename]:" is optional, default table is the one of the "current record" used in the function). The fieldlist is sent as "&columnsOnly=" parameter to alt_doc.php
-        * @param       array           TypoScript properties for configuring the edit icons.
-        * @param       string          The "table:uid" of the record being shown. If empty string then $this->currentRecord is used. For new records (set by $conf['newRecordFromTable']) it's auto-generated to "[tablename]:NEW"
-        * @param       array           Alternative data array to use. Default is $this->data
-        * @param       string          Additional URL parameters for the link pointing to alt_doc.php
-        * @return      string          The input content string, possibly with edit icons added (not necessarily in the end but just after the last string of normal content.
+        * @param string $content The content to which the edit icons should be appended
+        * @param string $params The parameters defining which table and fields to edit. Syntax is [tablename]:[fieldname],[fieldname],[fieldname],... OR [fieldname],[fieldname],[fieldname],... (basically "[tablename]:" is optional, default table is the one of the "current record" used in the function). The fieldlist is sent as "&columnsOnly=" parameter to alt_doc.php
+        * @param array $conf TypoScript properties for configuring the edit icons.
+        * @param string $currentRecord The "table:uid" of the record being shown. If empty string then $this->currentRecord is used. For new records (set by $conf['newRecordFromTable']) it's auto-generated to "[tablename]:NEW"
+        * @param array $dataArr Alternative data array to use. Default is $this->data
+        * @param string $addUrlParamStr Additional URL parameters for the link pointing to alt_doc.php
+        * @param string $table
+        * @param integer $editUid
+        * @param string $fieldList
+        * @return string The input content string, possibly with edit icons added (not necessarily in the end but just after the last string of normal content.
         */
-       public function editIcons($content, $params, array $conf=array(), $currentRecord='', array $dataArr=array(), $addUrlParamStr='', $table, $editUid, $fieldList) {
+       public function editIcons($content, $params, array $conf  =array(), $currentRecord = '', array $dataArr = array(), $addUrlParamStr = '', $table, $editUid, $fieldList) {
                        // Special content is about to be shown, so the cache must be disabled.
                $GLOBALS['TSFE']->set_no_cache();
                $style = $conf['styleAttribute'] ? ' style="' . htmlspecialchars($conf['styleAttribute']) . '"' : '';
@@ -216,16 +223,16 @@ class tx_feedit_editpanel {
         * Helper function for editPanel() which wraps icons in the panel in a link with the action of the panel.
         * The links are for some of them not simple hyperlinks but onclick-actions which submits a little form which the panel is wrapped in.
         *
-        * @param       string          The string to wrap in a link, typ. and image used as button in the edit panel.
-        * @param       string          The name of the form wrapping the edit panel.
-        * @param       string          The command of the link. There is a predefined list available: edit, new, up, down etc.
-        * @param       string          The "table:uid" of the record being processed by the panel.
-        * @param       string          Text string with confirmation message; If set a confirm box will be displayed before carrying out the action (if Yes is pressed)
-        * @param       integer         "New pid" - for new records
-        * @return      string          A <a> tag wrapped string.
+        * @param string $string The string to wrap in a link, typ. and image used as button in the edit panel.
+        * @param string $formName The name of the form wrapping the edit panel.
+        * @param string $cmd The command of the link. There is a predefined list available: edit, new, up, down etc.
+        * @param string $currentRecord The "table:uid" of the record being processed by the panel.
+        * @param string $confirm Text string with confirmation message; If set a confirm box will be displayed before carrying out the action (if Yes is pressed)
+        * @param integer $nPid "New pid" - for new records
+        * @return string A <a> tag wrapped string.
         * @see editPanel(), editIcons(), t3lib_tsfeBeUserAuth::extEditAction()
         */
-       protected function editPanelLinkWrap($string, $formName, $cmd, $currentRecord='', $confirm='', $nPid='') {
+       protected function editPanelLinkWrap($string, $formName, $cmd, $currentRecord = '', $confirm = '', $nPid = '') {
                        // Editing forms on page only supported in Live workspace (because of incomplete implementation)
                $editFormsOnPage = $GLOBALS['BE_USER']->uc['TSFE_adminConfig']['edit_editFormsOnPage'] && $GLOBALS['BE_USER']->workspace === 0;
                $nV=t3lib_div::_GP('ADMCMD_view') ? 1 : 0;
@@ -263,10 +270,10 @@ class tx_feedit_editpanel {
        /**
         * Creates a link to a script (eg. typo3/alt_doc.php or typo3/db_new.php) which either opens in the current frame OR in a pop-up window.
         *
-        * @param       string          The string to wrap in a link, typ. and image used as button in the edit panel.
-        * @param       string          The URL of the link. Should be absolute if supposed to work with <base> path set.
-        * @param       string          The "table:uid" of the record being processed by the panel.
-        * @return      string          A <a> tag wrapped string.
+        * @param string $string The string to wrap in a link, typ. and image used as button in the edit panel.
+        * @param string $url The URL of the link. Should be absolute if supposed to work with <base> path set.
+        * @param string $currentRecord The "table:uid" of the record being processed by the panel.
+        * @return string A <a> tag wrapped string.
         * @see editPanelLinkWrap()
         */
        protected function editPanelLinkWrap_doWrap($string, $url, $currentRecord) {
@@ -289,12 +296,12 @@ class tx_feedit_editpanel {
         * Wraps the input content string in a table with a gray border if the table/row combination evaluates to being disabled/hidden.
         * Used for marking previewed records in the frontend.
         *
-        * @param       string          The table name
-        * @param       array           The data record from $table
-        * @param       string          The content string to wrap
-        * @param       integer         The thickness of the border
-        * @param       array           The array with TypoScript properties for the content object
-        * @return      string          The input string wrapped in a table with a border color of #cccccc and thickness = $thick
+        * @param string $table The table name
+        * @param array $row The data record from $table
+        * @param string $content The content string to wrap
+        * @param integer $thick The thickness of the border
+        * @param array $conf The array with TypoScript properties for the content object
+        * @return string The input string wrapped in a table with a border color of #cccccc and thickness = $thick
         * @see editPanel()
         */
        protected function editPanelPreviewBorder($table, array $row, $content, $thick, array $conf = array()) {
@@ -322,9 +329,9 @@ class tx_feedit_editpanel {
        /**
         * Returns TRUE if the input table/row would be hidden in the frontend (according nto the current time and simulate user group)
         *
-        * @param       string          The table name
-        * @param       array           The data record
-        * @return      boolean
+        * @param string $table The table name
+        * @param array $row The data record
+        * @return boolean
         * @see editPanelPreviewBorder()
         */
        protected function isDisabled($table, $row) {
@@ -339,15 +346,15 @@ class tx_feedit_editpanel {
        /**
         * Returns the editing form for a content element.
         *
-        * @param       string          Form tag
-        * @param       string          Form name
-        * @param       string          the command
-        * @param       integer         newUID
-        * @param       array           dataArray for element
-        * @param       string          Table name of element
-        * @param       string          Current record
-        * @param       string          Blackline
-        * @return      string
+        * @param string $formTag Form tag
+        * @param string $formName Form name
+        * @param string $theCmd The command
+        * @param integer $newUID newUID
+        * @param array $dataArray dataArray for element
+        * @param string $table Table name of element
+        * @param string $currentRecord Current record
+        * @param string $blackLine Blackline
+        * @return string
         */
        protected function editContent($formTag, $formName, $theCmd, $newUID, array $dataArray, $table, $currentRecord, $blackLine) {
                $tceforms = t3lib_div::makeInstance('t3lib_TCEforms_FE');
@@ -363,7 +370,7 @@ class tx_feedit_editpanel {
 
                        // Icon only mode for CSH destroys the layout for frontend editing so force full text mode instead.
                        // @todo        Make sure the necessary Javascript and CSS are included so that CSH can work properly in all modes.
-               if($tceforms->edit_showFieldHelp == 'icon') {
+               if ($tceforms->edit_showFieldHelp == 'icon') {
                        $tceforms->edit_showFieldHelp = 'text';
                }
 
@@ -390,7 +397,7 @@ class tx_feedit_editpanel {
                $panel .= $tceforms->intoTemplate(array('ITEM' => $buttons));
                $panel .= $tceforms->getMainFields($table, $processedDataArr);
 
-               $hiddenF = "";
+               $hiddenF = '';
                if ($theCmd == 'new') {
                        $hiddenF .= '<input type="hidden" name="TSFE_EDIT[data][' . $table . '][NEW][pid]" value="' . $newUID . '" />';
                        if ($table == 'pages') {
index 2cfd310..3412aea 100644 (file)
@@ -1,5 +1,7 @@
 <?php
-if (!defined ('TYPO3_MODE'))   die ('Access denied.');
+if (!defined('TYPO3_MODE')) {
+       die('Access denied.');
+}
 
        //replace old Login
 $pluginContent = trim('
@@ -40,7 +42,7 @@ mod.wizards.newContentElement.wizardItems.forms {
 }
 ');
 
-//activate support for kb_md5fepw
+       // Activate support for kb_md5fepw
 if (t3lib_extMgm::isLoaded('kb_md5fepw') && (TYPO3_MODE == 'FE')) {
        $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['felogin']['loginFormOnSubmitFuncs'][] = 'tx_kbmd5fepw_newloginbox->loginFormOnSubmit';
        require_once(t3lib_extMgm::extPath('kb_md5fepw').'pi1/class.tx_kbmd5fepw_newloginbox.php');
index 27e94fb..196b18a 100644 (file)
@@ -1,10 +1,12 @@
 <?php
-if (!defined ('TYPO3_MODE'))   die ('Access denied.');
+if (!defined('TYPO3_MODE')) {
+       die('Access denied.');
+}
 $_EXTCONF = unserialize($GLOBALS['TYPO3_CONF_VARS']['EXT']['extConf']['felogin']);
 
 t3lib_div::loadTCA('tt_content');
 
-if(t3lib_utility_VersionNumber::convertVersionNumberToInteger(TYPO3_version) >= 4002000) {
+if (t3lib_utility_VersionNumber::convertVersionNumberToInteger(TYPO3_version) >= 4002000) {
        t3lib_extMgm::addPiFlexFormValue('*', 'FILE:EXT:' . $_EXTKEY . '/flexform.xml', 'login');
 } else {
        t3lib_extMgm::addPiFlexFormValue('default', 'FILE:EXT:' . $_EXTKEY . '/flexform.xml');
index d84dfc0..1d99107 100644 (file)
 /**
  * Plugin 'Website User Login' for the 'felogin' extension.
  *
- * @author     Steffen Kamper <info@sk-typo3.de>
+ * @author Steffen Kamper <info@sk-typo3.de>
  * @package    TYPO3
- * @subpackage tx_felogin
+ * @subpackage tx_felogin
  */
 class tx_felogin_pi1 extends tslib_pibase {
-       var $prefixId      = 'tx_felogin_pi1';          // Same as class name
-       var $scriptRelPath = 'pi1/class.tx_felogin_pi1.php';    // Path to this script relative to the extension dir.
-       var $extKey        = 'felogin'; // The extension key.
+               // Same as class name
+       var $prefixId = 'tx_felogin_pi1';
+               // Path to this script relative to the extension dir.
+       var $scriptRelPath = 'pi1/class.tx_felogin_pi1.php';
+               // The extension key.
+       var $extKey = 'felogin';
        public $pi_checkCHash = FALSE;
        public $pi_USER_INT_obj = TRUE;
-
-       protected $userIsLoggedIn;      // Is user logged in?
-       protected $template;    // holds the template for FE rendering
-       protected $uploadDir;   // upload dir, used for flexform template files
-       protected $redirectUrl; // URL for the redirect
-       protected $noRedirect = FALSE;  // flag for disable the redirect
-       protected $logintype;   // logintype (given as GPvar), possible: login, logout
+               // Is user logged in?
+       protected $userIsLoggedIn;
+               // holds the template for FE rendering
+       protected $template;
+               // upload dir, used for flexform template files
+       protected $uploadDir;
+               // URL for the redirect
+       protected $redirectUrl;
+               // flag for disable the redirect
+       protected $noRedirect = FALSE;
+               // logintype (given as GPvar), possible: login, logout
+       protected $logintype;
 
        /**
         * The main method of the plugin
         *
-        * @param       string          $content: The PlugIn content
-        * @param       array           $conf: The PlugIn configuration
+        * @param string $content The PlugIn content
+        * @param array $conf The PlugIn configuration
         *
-        * @return      string          The     content that is displayed on the website
+        * @return string The content that is displayed on the website
         */
        public function main($content, $conf) {
 
@@ -87,7 +95,7 @@ class tx_felogin_pi1 extends tslib_pibase {
                $this->referer = $this->validateRedirectUrl(t3lib_div::_GP('referer'));
                $this->noRedirect = ($this->piVars['noredirect'] || $this->conf['redirectDisable']);
 
-                       // if config.typolinkLinkAccessRestrictedPages is set, the var is return_url
+                       // If config.typolinkLinkAccessRestrictedPages is set, the var is return_url
                $returnUrl =  t3lib_div::_GP('return_url');
                if ($returnUrl) {
                        $this->redirectUrl = $returnUrl;
@@ -114,7 +122,7 @@ class tx_felogin_pi1 extends tslib_pibase {
                }
 
                        // What to display
-               $content='';
+               $content = '';
                if ($this->piVars['forgot']) {
                        $content .= $this->showForgot();
                } elseif ($this->piVars['forgothash']) {
@@ -164,7 +172,7 @@ class tx_felogin_pi1 extends tslib_pibase {
        /**
         * Shows the forgot password form
         *
-        * @return      string          content
+        * @return string Content
         */
        protected function showForgot() {
                $subpart = $this->cObj->getSubpart($this->template, '###TEMPLATE_FORGOT###');
@@ -173,14 +181,14 @@ class tx_felogin_pi1 extends tslib_pibase {
 
                if ($postData['forgot_email']) {
 
-                               // get hashes for compare
+                               // Get hashes for compare
                        $postedHash = $postData['forgot_hash'];
                        $hashData = $GLOBALS['TSFE']->fe_user->getKey('ses', 'forgot_hash');
 
                        if ($postedHash === $hashData['forgot_hash']) {
                                $row = FALSE;
 
-                                       // look for user record
+                                       // Look for user record
                                $data = $GLOBALS['TYPO3_DB']->fullQuoteStr($this->piVars['forgot_email'], 'fe_users');
                                $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
                                        'uid, username, password, email',
@@ -194,13 +202,13 @@ class tx_felogin_pi1 extends tslib_pibase {
 
                                $error = NULL;
                                if ($row) {
-                                               // generate an email with the hashed link
+                                               // Generate an email with the hashed link
                                        $error = $this->generateAndSendHash($row);
                                } elseif ($this->conf['exposeNonexistentUserInForgotPasswordDialog']) {
                                        $error = $this->pi_getLL('ll_forgot_reset_message_error');
                                }
 
-                                       // generate message
+                                       // Generate message
                                if ($error) {
                                        $markerArray['###STATUS_MESSAGE###'] = $this->cObj->stdWrap($error, $this->conf['forgotErrorMessage_stdWrap.']);
                                } else {
@@ -208,7 +216,7 @@ class tx_felogin_pi1 extends tslib_pibase {
                                }
                                $subpartArray['###FORGOT_FORM###'] = '';
                        } else {
-                                       //wrong email
+                                       // Wrong email
                                $markerArray['###STATUS_MESSAGE###'] = $this->getDisplayText('forgot_reset_message', $this->conf['forgotMessage_stdWrap.']);
                                $markerArray['###BACKLINK_LOGIN###'] = '';
                        }
@@ -229,10 +237,10 @@ class tx_felogin_pi1 extends tslib_pibase {
 
                $markerArray = array_merge($markerArray, $this->getUserFieldMarkers());
 
-                       // generate hash
+                       // Generate hash
                $hash = md5($this->generatePassword(3));
                $markerArray['###FORGOTHASH###'] = $hash;
-                       // set hash in feuser session
+                       // Set hash in feuser session
                $GLOBALS['TSFE']->fe_user->setKey('ses', 'forgot_hash', array('forgot_hash' => $hash));
 
                return $this->cObj->substituteMarkerArrayCached($subpart, $markerArray, $subpartArray, $linkpartArray);
@@ -242,7 +250,7 @@ class tx_felogin_pi1 extends tslib_pibase {
         * This function checks the hash from link and checks the validity. If it's valid it shows the form for
         * changing the password and process the change of password after submit, if not valid it returns the error message
         *
-        * @return      string          The content.
+        * @return string The content.
         */
        protected function changePassword() {
 
@@ -273,7 +281,7 @@ class tx_felogin_pi1 extends tslib_pibase {
                                $markerArray['###STATUS_MESSAGE###'] = $this->getDisplayText('change_password_notvalid_message', $this->conf['changePasswordNotValidMessage_stdWrap.']);
                                $subpartArray['###CHANGEPASSWORD_FORM###'] = '';
                        } else {
-                                       // all is fine, continue with new password
+                                       // All is fine, continue with new password
                                $postData = t3lib_div::_POST($this->prefixId);
 
                                if (isset($postData['changepasswordsubmit'])) {
@@ -297,7 +305,7 @@ class tx_felogin_pi1 extends tslib_pibase {
                                                        $newPass = $_params['newPassword'];
                                                }
 
-                                                       // save new password and clear DB-hash
+                                                       // Save new password and clear DB-hash
                                                $res = $GLOBALS['TYPO3_DB']->exec_UPDATEquery(
                                                                'fe_users',
                                                                'uid=' . $user['uid'],
@@ -314,7 +322,7 @@ class tx_felogin_pi1 extends tslib_pibase {
                                }
 
                                if (!$done) {
-                                       // Change password form
+                                               // Change password form
                                        $markerArray['###ACTION_URI###'] = $this->pi_getPageLink($GLOBALS['TSFE']->id, '', array(
                                                $this->prefixId . '[user]' => $user['uid'],
                                                $this->prefixId . '[forgothash]' => $piHash
@@ -335,10 +343,10 @@ class tx_felogin_pi1 extends tslib_pibase {
        }
 
        /**
-        * generates a hashed link and send it with email
+        * Generates a hashed link and send it with email
         *
-        * @param       array           $user   contains user data
-        * @return      string          Empty string with success, error message with no success
+        * @param array $user Contains user data
+        * @return string Empty string with success, error message with no success
         */
        protected function generateAndSendHash($user) {
                $hours = intval($this->conf['forgotLinkHashValidTime']) > 0 ? intval($this->conf['forgotLinkHashValidTime']) : 24;
@@ -349,10 +357,10 @@ class tx_felogin_pi1 extends tslib_pibase {
                $randHash = $validEnd . '|' . $hash;
                $randHashDB = $validEnd . '|' . md5($hash);
 
-               //write hash to DB
+                       // Write hash to DB
                $res = $GLOBALS['TYPO3_DB']->exec_UPDATEquery('fe_users', 'uid=' . $user['uid'], array('felogin_forgotHash' => $randHashDB));
 
-               // send hashlink to user
+                       // Send hashlink to user
                $this->conf['linkPrefix'] = -1;
                $isAbsRelPrefix = !empty($GLOBALS['TSFE']->absRefPrefix);
                $isBaseURL  = !empty($GLOBALS['TSFE']->baseUrl);
@@ -372,15 +380,15 @@ class tx_felogin_pi1 extends tslib_pibase {
                        }
                        $link = $this->conf['feloginBaseURL'] . $link;
                } elseif ($isAbsRelPrefix) {
-                       // Second priority
-                       // absRefPrefix must not necessarily contain a hostname and URL scheme, so add it if needed
+                               // Second priority
+                               // absRefPrefix must not necessarily contain a hostname and URL scheme, so add it if needed
                        $link = t3lib_div::locationHeaderUrl($link);
                } elseif ($isBaseURL) {
                                // Third priority
                                // Add the global base URL to the link
                        $link = $GLOBALS['TSFE']->baseUrlWrap($link);
                } else {
-                               // no prefix is set, return the error
+                               // No prefix is set, return the error
                        return $this->pi_getLL('ll_change_password_nolinkprefix_message');
                }
 
@@ -404,9 +412,9 @@ class tx_felogin_pi1 extends tslib_pibase {
                        // no RDCT - Links for security reasons
                $oldSetting = $GLOBALS['TSFE']->config['config']['notification_email_urlmode'];
                $GLOBALS['TSFE']->config['config']['notification_email_urlmode'] = 0;
-                       // send the email
+                       // Send the email
                $this->cObj->sendNotifyEmail($msg, $user['email'], '', $this->conf['email_from'], $this->conf['email_fromName'], $this->conf['replyTo']);
-                       // restore settings
+                       // Restore settings
                $GLOBALS['TSFE']->config['config']['notification_email_urlmode'] = $oldSetting;
 
                return '';
@@ -415,7 +423,7 @@ class tx_felogin_pi1 extends tslib_pibase {
        /**
         * Shows logout form
         *
-        * @return      string          The content.
+        * @return string The content.
         */
        protected function showLogout() {
                $subpart = $this->cObj->getSubpart($this->template, '###TEMPLATE_LOGOUT###');
@@ -437,7 +445,7 @@ class tx_felogin_pi1 extends tslib_pibase {
                $markerArray = array_merge($markerArray, $this->getUserFieldMarkers());
 
                if ($this->redirectUrl) {
-                               // use redirectUrl for action tag because of possible access restricted pages
+                               // Use redirectUrl for action tag because of possible access restricted pages
                        $markerArray['###ACTION_URI###'] = htmlspecialchars($this->redirectUrl);
                        $this->redirectUrl = '';
                }
@@ -447,7 +455,7 @@ class tx_felogin_pi1 extends tslib_pibase {
        /**
         * Shows login form
         *
-        * @return      string          content
+        * @return string Content
         */
        protected function showLogin() {
                $subpart = $this->cObj->getSubpart($this->template, '###TEMPLATE_LOGIN###');
@@ -515,7 +523,7 @@ class tx_felogin_pi1 extends tslib_pibase {
                $onSubmitAr = array();
                $extraHiddenAr = array();
 
-                       // check for referer redirect method. if present, save referer in form field
+                       // Check for referer redirect method. if present, save referer in form field
                if (t3lib_div::inList($this->conf['redirectMode'], 'referer') || t3lib_div::inList($this->conf['redirectMode'], 'refererDomains')) {
                        $referer = $this->referer ? $this->referer : t3lib_div::getIndpEnv('HTTP_REFERER');
                        if ($referer) {
@@ -528,7 +536,7 @@ class tx_felogin_pi1 extends tslib_pibase {
 
                if (is_array($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['felogin']['loginFormOnSubmitFuncs'])) {
                        $_params = array();
-                       foreach($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['felogin']['loginFormOnSubmitFuncs'] as $funcRef) {
+                       foreach ($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['felogin']['loginFormOnSubmitFuncs'] as $funcRef) {
                                list($onSub, $hid) = t3lib_div::callUserFunction($funcRef, $_params, $this);
                                $onSubmitAr[] = $onSub;
                                $extraHiddenAr[] = $hid;
@@ -547,10 +555,12 @@ class tx_felogin_pi1 extends tslib_pibase {
 
                        // Login form
                $markerArray['###ACTION_URI###'] = $this->getPageLink('', array(), TRUE);
-               $markerArray['###EXTRA_HIDDEN###'] = $extraHidden; // used by kb_md5fepw extension...
+                       // Used by kb_md5fepw extension...
+               $markerArray['###EXTRA_HIDDEN###'] = $extraHidden;
                $markerArray['###LEGEND###'] = $this->pi_getLL('login', '', 1);
                $markerArray['###LOGIN_LABEL###'] = $this->pi_getLL('login', '', 1);
-               $markerArray['###ON_SUBMIT###'] = $onSubmit; // used by kb_md5fepw extension...
+                       // Used by kb_md5fepw extension...
+               $markerArray['###ON_SUBMIT###'] = $onSubmit;
                $markerArray['###PASSWORD_LABEL###'] = $this->pi_getLL('password', '', 1);
                $markerArray['###STORAGE_PID###'] = $this->spid;
                $markerArray['###USERNAME_LABEL###'] = $this->pi_getLL('username', '', 1);
@@ -585,7 +595,7 @@ class tx_felogin_pi1 extends tslib_pibase {
        /**
         * Process redirect methods. The function searches for a redirect url using all configured methods.
         *
-        * @return      string          redirect url
+        * @return string Redirect url
         */
        protected function processRedirect() {
                $redirect_url = array();
@@ -593,7 +603,7 @@ class tx_felogin_pi1 extends tslib_pibase {
                        $redirectMethods = t3lib_div::trimExplode(',', $this->conf['redirectMode'], TRUE);
                        foreach ($redirectMethods as $redirMethod) {
                                if ($GLOBALS['TSFE']->loginUser && $this->logintype === 'login') {
-                                               // logintype is needed because the login-page wouldn't be accessible anymore after a login (would always redirect)
+                                               // Logintype is needed because the login-page wouldn't be accessible anymore after a login (would always redirect)
                                        switch ($redirMethod) {
                                                case 'groupLogin': // taken from dkd_redirect_at_login written by Ingmar Schlecht; database-field changed
                                                        $groupData = $GLOBALS['TSFE']->fe_user->groupData;
@@ -603,7 +613,8 @@ class tx_felogin_pi1 extends tslib_pibase {
                                                                'felogin_redirectPid<>\'\' AND uid IN (' . implode(',', $groupData['uid']) . ')'
                                                        );
                                                        if ($row = $GLOBALS['TYPO3_DB']->sql_fetch_row($res)) {
-                                                               $redirect_url[] = $this->pi_getPageLink($row[0]); // take the first group with a redirect page
+                                                                       // take the first group with a redirect page
+                                                               $redirect_url[] = $this->pi_getPageLink($row[0]);
                                                        }
                                                break;
                                                case 'userLogin':
@@ -625,9 +636,9 @@ class tx_felogin_pi1 extends tslib_pibase {
                                                        $redirect_url[] = $this->redirectUrl;
                                                break;
                                                case 'referer':
-                                                               // avoid redirect when logging in after changing password
+                                                               // Avoid redirect when logging in after changing password
                                                        if ($this->piVars['redirectReferrer'] !== 'off') {
-                                                                       // avoid forced logout, when trying to login immediatly after a logout
+                                                                       // Avoid forced logout, when trying to login immediatly after a logout
                                                                $redirect_url[] = preg_replace('/[&?]logintype=[a-z]+/', '', $this->referer);
                                                        }
                                                break;
@@ -639,12 +650,12 @@ class tx_felogin_pi1 extends tslib_pibase {
                                                                // also avoid redirect when logging in after changing password
                                                        if ($this->conf['domains'] && $this->piVars['redirectReferrer'] !== 'off') {
                                                                $url = $this->referer;
-                                                                       // is referring url allowed to redirect?
+                                                                       // Is referring url allowed to redirect?
                                                                $match = array();
                                                                if (preg_match('/^http://([[:alnum:]._-]+)//', $url, $match)) {
                                                                        $redirect_domain = $match[1];
                                                                        $found = FALSE;
-                                                                       foreach(t3lib_div::trimExplode(',', $this->conf['domains'], TRUE) as $d) {
+                                                                       foreach (t3lib_div::trimExplode(',', $this->conf['domains'], TRUE) as $d) {
                                                                                if (preg_match('/(^|\.)/'.$d.'$', $redirect_domain)) {
                                                                                        $found = TRUE;
                                                                                        break;
@@ -671,7 +682,7 @@ class tx_felogin_pi1 extends tslib_pibase {
                                                break;
                                        }
                                } elseif (($this->logintype == '') && ($redirMethod == 'login') && $this->conf['redirectPageLogin']) {
-                                               // if login and page not accessible
+                                               // If login and page not accessible
                                        $this->cObj->typolink('', array(
                                                'parameter'                             => $this->conf['redirectPageLogin'],
                                                'linkAccessRestrictedPages' => TRUE,
@@ -679,12 +690,12 @@ class tx_felogin_pi1 extends tslib_pibase {
                                        $redirect_url[] = $this->cObj->lastTypoLinkUrl;
 
                                } elseif (($this->logintype == '') && ($redirMethod == 'logout') && $this->conf['redirectPageLogout'] && $GLOBALS['TSFE']->loginUser) {
-                                               // if logout and page not accessible
+                                               // If logout and page not accessible
                                        $redirect_url[] = $this->pi_getPageLink(intval($this->conf['redirectPageLogout']));
 
                                } elseif ($this->logintype === 'logout') { // after logout
 
-                                       // Hook for general actions after after logout has been confirmed
+                                               // Hook for general actions after after logout has been confirmed
                                        if ($this->logintype === 'logout' && $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['felogin']['logout_confirmed']) {
                                                $_params = array();
                                                foreach($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['felogin']['logout_confirmed'] as $_funcRef) {
@@ -705,14 +716,14 @@ class tx_felogin_pi1 extends tslib_pibase {
                                                // Placeholder for maybe future options
                                        switch ($redirMethod) {
                                                case 'getpost':
-                                                       // preserve the get/post value
+                                                               // Preserve the get/post value
                                                        $redirect_url[] = $this->redirectUrl;
                                                break;
                                        }
                                }
                        }
                }
-                       // remove empty values
+                       // Remove empty values
                if (count($redirect_url)) {
                        return t3lib_div::trimExplode(',', implode(',', $redirect_url), TRUE);
                } else {
@@ -723,7 +734,7 @@ class tx_felogin_pi1 extends tslib_pibase {
        /**
         * Reads flexform configuration and merge it with $this->conf
         *
-        * @return      void
+        * @return void
         */
        protected function mergeflexFormValuesIntoConf() {
                $flex = array();
@@ -786,9 +797,9 @@ class tx_felogin_pi1 extends tslib_pibase {
        /**
         * Loads a variable from the flexform
         *
-        * @param       string          name of variable
-        * @param       string          name of sheet
-        * @return      string          value of var
+        * @param string $var Name of variable
+        * @param string $sheet Name of sheet
+        * @return string Value of var
         */
        protected function flexFormValue($var, $sheet) {
                return $this->pi_getFFvalue($this->cObj->data['pi_flexform'], $var, $sheet);
@@ -797,11 +808,11 @@ class tx_felogin_pi1 extends tslib_pibase {
        /**
         * Generate link with typolink function
         *
-        * @param       string          linktext
-        * @param       array           link vars
-        * @param       boolean         TRUE: returns only url  FALSE (default) returns the link)
+        * @param string $label Linktext
+        * @param array $piVars Link vars
+        * @param boolean $returnUrl TRUE: returns only url  FALSE (default) returns the link)
         *
-        * @return      string          link or url
+        * @return string Link or url
         */
        protected function getPageLink($label, $piVars, $returnUrl = FALSE) {
                $additionalParams = '';
@@ -811,7 +822,7 @@ class tx_felogin_pi1 extends tslib_pibase {
                                $additionalParams .= '&' . $key . '=' . $val;
                        }
                }
-                       // should GETvars be preserved?
+                       // Should GETvars be preserved?
                if ($this->conf['preserveGETvars']) {
                        $additionalParams .= $this->getPreserveGetVars();
                }
@@ -833,7 +844,7 @@ class tx_felogin_pi1 extends tslib_pibase {
         * possible values are "all" or a commaseperated list of GET-vars
         * they are used as additionalParams for link generation
         *
-        * @return      string          additionalParams-string
+        * @return string additionalParams-string
         */
        protected function getPreserveGetVars() {
 
@@ -862,10 +873,10 @@ class tx_felogin_pi1 extends tslib_pibase {
        /**
         * Is used by forgot password - function with md5 option.
         *
-        * @author      Bernhard Kraft
+        * @author Bernhard Kraft
         *
-        * @param       int                     length of new password
-        * @return      string          new password
+        * @param integer $len Length of new password
+        * @return string New password
         */
        protected function generatePassword($len) {
                $pass = '';
@@ -883,11 +894,11 @@ class tx_felogin_pi1 extends tslib_pibase {
        /**
         * Returns the header / message value from flexform if present, else from locallang.xml
         *
-        * @param       string          label name
-        * @param       string          TS stdWrap array
-        * @return      string          label text
+        * @param string $label label name
+        * @param string $stdWrapArray TS stdWrap array
+        * @return string label text
         */
-       protected function getDisplayText($label, $stdWrapArray=array()) {
+       protected function getDisplayText($label, $stdWrapArray = array()) {
                $text = $this->flexFormValue($label, 's_messages') ? $this->cObj->stdWrap($this->flexFormValue($label, 's_messages'), $stdWrapArray) : $this->cObj->stdWrap($this->pi_getLL('ll_'.$label, '', 1), $stdWrapArray);
                $replace = $this->getUserFieldMarkers();
                return strtr($text, $replace);
@@ -896,17 +907,17 @@ class tx_felogin_pi1 extends tslib_pibase {
        /**
         * Returns Array of markers filled with user fields
         *
-        * @return      array           marker array
+        * @return array Marker array
         */
        protected function getUserFieldMarkers() {
                $marker = array();
-               // replace markers with fe_user data
+                       // replace markers with fe_user data
                if ($GLOBALS['TSFE']->fe_user->user) {
-                       // all fields of fe_user will be replaced, scheme is ###FEUSER_FIELDNAME###
+                               // All fields of fe_user will be replaced, scheme is ###FEUSER_FIELDNAME###
                        foreach ($GLOBALS['TSFE']->fe_user->user as $field => $value) {
                                $marker['###FEUSER_' . t3lib_div::strtoupper($field) . '###'] = $this->cObj->stdWrap($value, $this->conf['userfields.'][$field . '.']);
                        }
-                       // add ###USER### for compatibility
+                               // Add ###USER### for compatibility
                        $marker['###USER###'] = $marker['###FEUSER_USERNAME###'];
                }
                return $marker;
index f3feb12..e4b9c74 100644 (file)
@@ -22,7 +22,6 @@
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
 
-
 require_once t3lib_extMgm::extPath('felogin', 'pi1/class.tx_felogin_pi1.php');
 
 /**
@@ -70,7 +69,7 @@ class tx_feloginTest extends tx_phpunit_testcase {
                $this->testHostName = 'hostname.tld';
                $this->testSitePath = '/';
 
-               // we need to subclass because the method we want to test is protected
+                       // We need to subclass because the method we want to test is protected
                $className = uniqid('FeLogin_');
                eval('
                        class ' . $className. ' extends tx_felogin_pi1 {
@@ -110,10 +109,10 @@ class tx_feloginTest extends tx_phpunit_testcase {
         * Callback method for pageIdCanBeDetermined test cases.
         * Simulates TYPO3_DB->exec_SELECTgetRows().
         *
-        * @param       string          $fields
-        * @param       string          $table
-        * @param       string          $where
-        * @return      mixed
+        * @param string $fields
+        * @param string $table
+        * @param string $where
+        * @return mixed
         * @see setUpDatabaseMock
         */
        public function getDomainRecordsCallback($fields, $table, $where) {
@@ -310,8 +309,5 @@ class tx_feloginTest extends tx_phpunit_testcase {
                $this->setUpDatabaseMock();
                $this->assertEquals($url, $this->txFelogin->validateRedirectUrl($url));
        }
-
-
-
 }
 ?>
\ No newline at end of file