[TASK] Clean up phpDoc comments in typo3/sysext/
authorWouter Wolters <typo3@wouterwolters.nl>
Sat, 16 Jun 2012 15:32:59 +0000 (17:32 +0200)
committerChristian Kuhn <lolli@schwarzbu.ch>
Wed, 20 Jun 2012 20:57:32 +0000 (22:57 +0200)
Clean up phpDoc comments for the following classes:

* typo3/sysext/cms/tslib/class.tslib_controltable.php
* typo3/sysext/cms/tslib/class.tslib_eidtools.php
* typo3/sysext/cms/tslib/class.tslib_extdirecteid.php
* typo3/sysext/cms/tslib/class.tslib_fecompression.php
* typo3/sysext/cms/tslib/class.tslib_feuserauth.php
* typo3/sysext/cms/tslib/class.tslib_frameset.php
* typo3/sysext/cms/tslib/class.tslib_gifbuilder.php

Clean up provides:

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

Change-Id: I9f2f4aed1cb7b305be0a0f15aa8a32c8f14e21e1
Resolves: #38119
Releases: 6.0
Reviewed-on: http://review.typo3.org/12132
Reviewed-by: Christian Kuhn
Tested-by: Christian Kuhn
typo3/sysext/cms/tslib/class.tslib_controltable.php
typo3/sysext/cms/tslib/class.tslib_eidtools.php
typo3/sysext/cms/tslib/class.tslib_extdirecteid.php
typo3/sysext/cms/tslib/class.tslib_fecompression.php
typo3/sysext/cms/tslib/class.tslib_feuserauth.php
typo3/sysext/cms/tslib/class.tslib_frameset.php
typo3/sysext/cms/tslib/class.tslib_gifbuilder.php

index 2e605a9..d080634 100644 (file)
  * Rendering of tables for content positioning
  *
  * @see tslib_cObj::CTABLE()
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  * @package TYPO3
  * @subpackage tslib
  */
 class tslib_controlTable {
-       var $offX = 0; // offset, x
-       var $offY = 0; // offset, y
-
-
-       var $tm = ''; // top menu
-       var $lm = ''; // left menu
-       var $rm = ''; // right menu
-       var $bm = ''; // bottom menu
-       var $content = ''; // content
-
-
-       var $tmTDparams = 'valign="top"'; // top menu TDparams
-       var $lmTDparams = 'valign="top"'; // left menu TDparams
-       var $rmTDparams = 'valign="top"'; // right menu TDparams
-       var $bmTDparams = 'valign="top"'; // bottom menu TDparams
-       var $contentTDparams = 'valign="top"'; // content TDparams
-
-
-       var $cMl = 1; // content margin, left
-       var $cMr = 1; // content margin, right
-       var $cMt = 0; // content margin, top
-       var $cMb = 1; // content margin, bottom
-
-
-       var $contentW = 0; // Places a little gif-spacer in the bottom of the content frame
-
+               // offset, x
+       var $offX = 0;
+               // offset, y
+       var $offY = 0;
+               // top menu
+       var $tm = '';
+               // left menu
+       var $lm = '';
+               // right menu
+       var $rm = '';
+               // bottom menu
+       var $bm = '';
+               // content
+       var $content = '';
+               // top menu TDparams
+       var $tmTDparams = 'valign="top"';
+               // left menu TDparams
+       var $lmTDparams = 'valign="top"';
+               // right menu TDparams
+       var $rmTDparams = 'valign="top"';
+               // bottom menu TDparams
+       var $bmTDparams = 'valign="top"';
+               // content TDparams
+       var $contentTDparams = 'valign="top"';
+               // content margin, left
+       var $cMl = 1;
+               // content margin, right
+       var $cMr = 1;
+               // content margin, top
+       var $cMt = 0;
+               // content margin, bottom
+       var $cMb = 1;
+               // Places a little gif-spacer in the bottom of the content frame
+       var $contentW = 0;
 
        var $tableParams = 'border="0" cellspacing="0" cellpadding="0"';
 
@@ -67,9 +75,9 @@ class tslib_controlTable {
         * Wrapping internal vars ->tm, ->lm, ->rm, ->bm and ->content in a table where each content part is stored in a cell.
         * The two arguments to this function defines some offsets and margins to use in the arrangement of the content in the table.
         *
-        * @param       string          List of offset parameters; x,y
-        * @param       string          List of margin parameters; left, top, right, bottom
-        * @return      string          The content strings wrapped in a <table> as the parameters defined
+        * @param string $offset List of offset parameters; x,y
+        * @param string $cMargins List of margin parameters; left, top, right, bottom
+        * @return string The content strings wrapped in a <table> as the parameters defined
         * @see tslib_cObj::CTABLE()
         */
        function start($offset, $cMargins) {
@@ -79,36 +87,58 @@ class tslib_controlTable {
                $cols = 0;
                $rows = 0;
 
-               if ($this->lm)
+               if ($this->lm) {
                        $cols++;
-               if ($this->rm)
+               }
+
+               if ($this->rm) {
                        $cols++;
-               if ($cMargArr[0])
+               }
+
+               if ($cMargArr[0]) {
                        $cols++;
-               if ($cMargArr[2])
+               }
+
+               if ($cMargArr[2]) {
                        $cols++;
-               if ($cMargArr[1] || $cMargArr[3] || $this->tm || $this->bm || $this->content || $this->contentW)
+               }
+
+               if ($cMargArr[1] || $cMargArr[3] || $this->tm || $this->bm || $this->content || $this->contentW) {
                        $cols++;
+               }
 
-               if ($cMargArr[1])
+               if ($cMargArr[1]) {
                        $rows++;
-               if ($cMargArr[3])
+               }
+
+               if ($cMargArr[3]) {
                        $rows++;
-               if ($this->tm)
+               }
+
+               if ($this->tm) {
                        $rows++;
-               if ($this->bm)
+               }
+
+               if ($this->bm) {
                        $rows++;
-               if ($this->content)
+               }
+
+               if ($this->content) {
                        $rows++;
-               if ($this->contentW)
+               }
+
+               if ($this->contentW) {
                        $rows++;
-               if (!$rows && $cols)
-                       $rows = 1; // If there are no rows in the middle but still som columns...
+               }
 
+               if (!$rows && $cols) {
+                               // If there are no rows in the middle but still som columns...
+                       $rows = 1;
+               }
 
                if ($rows && $cols) {
                        $res = LF . '<table ' . $this->tableParams . '>';
-                               // top offset:
+                               // Top offset:
                        if ($offArr[1]) {
                                $xoff = $offArr[0] ? 1 : 0;
                                if ($cols + $xoff > 1) {
@@ -133,9 +163,7 @@ class tslib_controlTable {
                                $res .= '<td' . $rowspan . '><img src="' . $GLOBALS['TSFE']->absRefPrefix .
                                        'clear.gif" height="1" width="' . $cMargArr[0] . '" alt="" title="" /></td>';
                        }
-                               // content...
-
-
+                               // Content...
                        $middle = array();
                        if ($this->tm) {
                                $middle[] = '<td ' . $this->tmTDparams . '>' . $this->tm . '</td>';
index 1ade5eb..7e37536 100644 (file)
@@ -24,6 +24,7 @@
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
+
 /**
  * Tools for scripts using the eID feature of index.php
  * Included from index_ts.php
  * initialize parts of the FE environment as needed,
  * eg. Frontend User session, Database connection etc.
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  */
 
 /**
  * Tools for scripts using the eID feature of index.php
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
- * @author     Dmitry Dulepov <dmitry@typo3.org>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Dmitry Dulepov <dmitry@typo3.org>
  * @package TYPO3
  * @subpackage tslib
  */
@@ -50,22 +51,22 @@ final class tslib_eidtools {
         * Load and initialize Frontend User. Note, this process is slow because
         * it creates a calls many objects. Call this method only if necessary!
         *
-        * @return      object          Frontend User object (usually known as TSFE->fe_user)
+        * @return object Frontend User object (usually known as TSFE->fe_user)
         */
        public static function initFeUser() {
-               // Initialize the database. Do not use TSFE method as it may redirect to
-               // Install tool and call hooks, which do not expect to be called from eID
+                       // Initialize the database. Do not use TSFE method as it may redirect to
+                       // Install tool and call hooks, which do not expect to be called from eID
                self::connectDB();
 
-               // Get TSFE instance. It knows how to initialize the user. We also
-               // need TCA because services may need extra tables!
+                       // Get TSFE instance. It knows how to initialize the user. We also
+                       // need TCA because services may need extra tables!
                self::initTCA();
+               /** @var $tsfe tslib_fe */
                $tsfe = self::getTSFE();
-               /* @var $tsfe tslib_fe */
 
                $tsfe->initFEuser();
 
-               // Return FE user object:
+                       // Return FE user object:
                return $tsfe->fe_user;
        }
 
@@ -73,7 +74,7 @@ final class tslib_eidtools {
         * Connecting to database. If the function fails, last error message
         * can be retrieved using $GLOBALS['TYPO3_DB']->sql_error().
         *
-        * @return      boolean         TRUE if connection was successful
+        * @return boolean TRUE if connection was successful
         */
        public static function connectDB() {
                if (!$GLOBALS['TYPO3_DB']->isConnected()) {
@@ -88,8 +89,8 @@ final class tslib_eidtools {
        /**
         * Initializes $GLOBALS['LANG'] for use in eID scripts.
         *
-        * @param       string          $language       TYPO3 language code
-        * @return      void
+        * @param string $language TYPO3 language code
+        * @return void
         */
        public static function initLanguage($language = 'default') {
                if (!is_object($GLOBALS['LANG'])) {
@@ -101,15 +102,15 @@ final class tslib_eidtools {
        /**
         * Makes TCA available inside eID
         *
-        * @return      void
+        * @return void
         */
        public static function initTCA() {
-               // Some badly made extensions attempt to manipulate TCA in a wrong way
-               // (inside ext_localconf.php). Therefore $GLOBALS['TCA'] may become an array
-               // but in fact it is not loaded. The check below ensure that
-               // TCA is still loaded if such bad extensions are installed
+                       // Some badly made extensions attempt to manipulate TCA in a wrong way
+                       // (inside ext_localconf.php). Therefore $GLOBALS['TCA'] may become an array
+                       // but in fact it is not loaded. The check below ensure that
+                       // TCA is still loaded if such bad extensions are installed
                if (!is_array($GLOBALS['TCA']) || !isset($GLOBALS['TCA']['pages'])) {
-                       // Load TCA using TSFE
+                               // Load TCA using TSFE
                        self::getTSFE()->includeTCA(FALSE);
                }
        }
@@ -119,28 +120,28 @@ final class tslib_eidtools {
         * you need not to include the whole $GLOBALS['TCA']. However, you still need to call
         * t3lib_div::loadTCA() if you want to access column array!
         *
-        * @param       string          $extensionKey   Extension key
-        * @return      void
+        * @param string $extensionKey Extension key
+        * @return void
         */
        public static function initExtensionTCA($extensionKey) {
                $extTablesPath = t3lib_extMgm::extPath($extensionKey, 'ext_tables.php');
                if (file_exists($extTablesPath)) {
                        $GLOBALS['_EXTKEY'] = $extensionKey;
                        require_once($extTablesPath);
+                               // We do not need to save restore the value of $GLOBALS['_EXTKEY']
+                               // because it is not defined to anything real outside of
+                               // ext_tables.php or ext_localconf.php scope.
                        unset($GLOBALS['_EXTKEY']);
-                       // We do not need to save restore the value of $GLOBALS['_EXTKEY']
-                       // because it is not defined to anything real outside of
-                       // ext_tables.php or ext_localconf.php scope.
                }
        }
 
        /**
         * Creating a single static cached instance of TSFE to use with this class.
         *
-        * @return      tslib_fe                New instance of tslib_fe
+        * @return tslib_fe New instance of tslib_fe
         */
        private static function getTSFE() {
-               // Cached instance
+                       // Cached instance
                static $tsfe = NULL;
 
                if (is_null($tsfe)) {
index b285474..877c341 100644 (file)
@@ -28,14 +28,13 @@ require_once(PATH_site . 'typo3/classes/class.typo3ajax.php');
 /**
  * eID controller for ExtDirect
  *
- * @author     Stefan Galinski <stefan.galinski@gmail.com>
+ * @author Stefan Galinski <stefan.galinski@gmail.com>
  * @package    TYPO3
  */
 class tslib_ExtDirectEid {
        /**
         * Ajax Instance
-        * 
-        * @property TYPO3AJAX
+        *
         * @var TYPO3AJAX
         */
        protected $ajaxObjext = NULL;
@@ -43,7 +42,7 @@ class tslib_ExtDirectEid {
        /**
         * Routes the given eID action to the related ExtDirect method with the necessary
         * ajax object.
-        * 
+        *
         * @return void
         */
        public function routeAction() {
index 2ae9997..51010f9 100644 (file)
@@ -26,9 +26,9 @@
  * This class contains compression functions for the TYPO3 Frontend. It can be
  * used only in EXT:cms/tslib/index_ts.php
  *
- * @author     Dmitry Dulepov <dmitry@typo3.org>
- * @package    TYPO3
- * @subpackage tx_cms
+ * @author Dmitry Dulepov <dmitry@typo3.org>
+ * @package TYPO3
+ * @subpackage tx_cms
  */
 class tslib_fecompression implements t3lib_Singleton {
 
@@ -37,30 +37,30 @@ class tslib_fecompression implements t3lib_Singleton {
         * replace the Content-length HTTP header after compression if it was added
         * by TYPO3 before compression.
         *
-        * @var int
+        * @var integer
         */
-       protected       $contentLength = 0;
+       protected $contentLength = 0;
 
        /**
         * Corrects HTTP "Content-length" header if it was sent by TYPO3 and compression
         * is enabled.
         *
-        * @param       string  $outputBuffer   Output buffer to compress
-        * @param       int     $mode   One of PHP_OUTPUT_HANDLER_xxx contants
-        * @return      string  Compressed string
-        * @see ob_start()
-        * @see ob_gzhandler()
+        * @param string $outputBuffer Output buffer to compress
+        * @param integer $mode One of PHP_OUTPUT_HANDLER_xxx contants
+        * @return string Compressed string
+        * @see ob_start()
+        * @see ob_gzhandler()
         */
        function compressionOutputHandler($outputBuffer, $mode) {
-               // Compress the content
+                       // Compress the content
                $outputBuffer = ob_gzhandler($outputBuffer, $mode);
                if ($outputBuffer !== FALSE) {
-                       // Save compressed size
+                               // Save compressed size
                        $this->contentLength += strlen($outputBuffer);
 
-                       // Check if this was the last content chunk
+                               // Check if this was the last content chunk
                        if (0 != ($mode & PHP_OUTPUT_HANDLER_END)) {
-                               // Check if we have content-length header
+                                       // Check if we have content-length header
                                foreach (headers_list() as $header) {
                                        if (0 == strncasecmp('Content-length:', $header, 15)) {
                                                header('Content-length: ' . $this->contentLength);
index 0e5ce1d..c1f6d12 100644 (file)
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
+
 /**
  * Front End session user. Login and session data
  * Included from index_ts.php
  *
  * Revised for TYPO3 3.6 June/2003 by Kasper Skårhøj
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
- * @author     René Fritz <r.fritz@colorcube.de>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author René Fritz <r.fritz@colorcube.de>
  */
 
-
-
-
-
-
-
-
-
-
-
-
-
-
 /**
  * Extension class for Front End User Authentication.
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
- * @author     René Fritz <r.fritz@colorcube.de>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author René Fritz <r.fritz@colorcube.de>
  * @package TYPO3
  * @subpackage tslib
  */
 class tslib_feUserAuth extends t3lib_userAuth {
-       var $formfield_permanent = 'permalogin';        // formfield with 0 or 1 // 1 = permanent login enabled // 0 = session is valid for a browser session only
-
-       protected $sessionDataLifetime = 86400;         // Lifetime of session data in seconds.
+               // formfield with 0 or 1 // 1 = permanent login enabled // 0 = session is valid for a browser session only
+       var $formfield_permanent = 'permalogin';
+               // Lifetime of session data in seconds.
+       protected $sessionDataLifetime = 86400;
 
        var $usergroup_column = 'usergroup';
        var $usergroup_table = 'fe_groups';
@@ -67,10 +56,11 @@ class tslib_feUserAuth extends t3lib_userAuth {
                'uid' =>Array(),
                'pid' =>Array()
        );
-       var $TSdataArray=array();               // Used to accumulate the TSconfig data of the user
+               // Used to accumulate the TSconfig data of the user
+       var $TSdataArray = array();
        var $userTS = array();
-       var $userTSUpdated=0;
-       var $showHiddenRecords=0;
+       var $userTSUpdated = 0;
+       var $showHiddenRecords = 0;
 
                // Session and user data:
                /*
@@ -80,7 +70,7 @@ class tslib_feUserAuth extends t3lib_userAuth {
                                - 'recs': Array: Used to 'register' records, eg in a shopping basket. Structure: [recs][tablename][record_uid]=number
                                - sys: Reserved for TypoScript standard code.
                */
-       var $sesData = Array();
+       var $sesData = array();
        var $sesData_change = 0;
        var $userData_change = 0;
        protected $sessionDataTimestamp = NULL;
@@ -119,11 +109,9 @@ class tslib_feUserAuth extends t3lib_userAuth {
                $this->getMethodEnabled = TRUE;
        }
 
-
        /**
         * Returns the configured cookie name
         *
-        * @static
         * @return string
         */
        public static function getCookieName() {
@@ -134,11 +122,10 @@ class tslib_feUserAuth extends t3lib_userAuth {
                return $configuredCookieName;
        }
 
-
        /**
         * Starts a user session
         *
-        * @return      void
+        * @return void
         * @see t3lib_userAuth::start()
         */
        function start() {
@@ -158,7 +145,7 @@ class tslib_feUserAuth extends t3lib_userAuth {
        /**
         * Returns a new session record for the current user for insertion into the DB.
         *
-        * @return      array           user session record
+        * @return array User session record
         */
        function getNewSessionRecord($tempuser) {
                $insertFields = parent::getNewSessionRecord($tempuser);
@@ -170,7 +157,7 @@ class tslib_feUserAuth extends t3lib_userAuth {
        /**
         * Determine whether a session cookie needs to be set (lifetime=0)
         *
-        * @return      boolean
+        * @return boolean
         * @internal
         */
        function isSetSessionCookie() {
@@ -181,7 +168,7 @@ class tslib_feUserAuth extends t3lib_userAuth {
        /**
         * Determine whether a non-session cookie needs to be set (lifetime>0)
         *
-        * @return      boolean
+        * @return boolean
         * @internal
         */
        function isRefreshTimeBasedCookie() {
@@ -191,7 +178,7 @@ class tslib_feUserAuth extends t3lib_userAuth {
        /**
         * Returns an info array with Login/Logout data submitted by a form or params
         *
-        * @return      array
+        * @return array
         * @see t3lib_userAuth::getLoginFormData()
         */
        function getLoginFormData() {
@@ -205,7 +192,9 @@ class tslib_feUserAuth extends t3lib_userAuth {
                        if (strlen($isPermanent) != 1) {
                                $isPermanent = $GLOBALS['TYPO3_CONF_VARS']['FE']['permalogin'];
                        } elseif (!$isPermanent) {
-                               $this->forceSetCookie = TRUE; // To make sure the user gets a session cookie and doesn't keep a possibly existing time based cookie, we need to force seeting the session cookie here
+                                       // To make sure the user gets a session cookie and doesn't keep a possibly existing time based cookie,
+                                       // we need to force seeting the session cookie here
+                               $this->forceSetCookie = TRUE;
                        }
                        $isPermanent = $isPermanent?1:0;
                } elseif ($GLOBALS['TYPO3_CONF_VARS']['FE']['permalogin'] == 2) {
@@ -223,7 +212,7 @@ class tslib_feUserAuth extends t3lib_userAuth {
         * Will select all fe_groups records that the current fe_user is member of - and which groups are also allowed in the current domain.
         * It also accumulates the TSconfig for the fe_user/fe_groups in ->TSdataArray
         *
-        * @return      integer         Returns the number of usergroups for the frontend users (if the internal user record exists and the usergroup field contains a value)
+        * @return integer Returns the number of usergroups for the frontend users (if the internal user record exists and the usergroup field contains a value)
         */
        function fetchGroupData() {
                $this->TSdataArray = array();
@@ -238,7 +227,7 @@ class tslib_feUserAuth extends t3lib_userAuth {
                        // Setting default configuration:
                $this->TSdataArray[]=$GLOBALS['TYPO3_CONF_VARS']['FE']['defaultUserTSconfig'];
 
-                       // get the info data for auth services
+                       // Get the info data for auth services
                $authInfo = $this->getAuthInfoArray();
 
                if ($this->writeDevLog)         {
@@ -251,7 +240,7 @@ class tslib_feUserAuth extends t3lib_userAuth {
 
                $groupDataArr = array();
 
-                       // use 'auth' service to find the groups for the user
+                       // Use 'auth' service to find the groups for the user
                $serviceChain='';
                $subType = 'getGroups'.$this->loginType;
                while (is_object($serviceObj = t3lib_div::makeInstanceService('auth', $subType, $serviceChain))) {
@@ -260,18 +249,25 @@ class tslib_feUserAuth extends t3lib_userAuth {
 
                        $groupData = $serviceObj->getGroups($this->user, $groupDataArr);
                        if (is_array($groupData) && count($groupData)) {
-                               $groupDataArr = t3lib_div::array_merge($groupDataArr, $groupData);      // Keys in $groupData should be unique ids of the groups (like "uid") so this function will override groups.
+                                       // Keys in $groupData should be unique ids of the groups (like "uid") so this function will override groups.
+                               $groupDataArr = t3lib_div::array_merge($groupDataArr, $groupData);
                        }
                        unset($serviceObj);
                }
-               if ($this->writeDevLog AND $serviceChain)       t3lib_div::devLog($subType.' auth services called: '.$serviceChain, 'tslib_feUserAuth');
-               if ($this->writeDevLog AND !count($groupDataArr))       t3lib_div::devLog('No usergroups found by services', 'tslib_feUserAuth');
-               if ($this->writeDevLog AND count($groupDataArr))        t3lib_div::devLog(count($groupDataArr).' usergroup records found by services', 'tslib_feUserAuth');
+               if ($this->writeDevLog && $serviceChain) {
+                       t3lib_div::devLog($subType.' auth services called: '.$serviceChain, 'tslib_feUserAuth');
+               }
+               if ($this->writeDevLog && !count($groupDataArr)) {
+                       t3lib_div::devLog('No usergroups found by services', 'tslib_feUserAuth');
+               }
+               if ($this->writeDevLog && count($groupDataArr)) {
+                       t3lib_div::devLog(count($groupDataArr).' usergroup records found by services', 'tslib_feUserAuth');
+               }
 
 
-                       // use 'auth' service to check the usergroups if they are really valid
+                       // Use 'auth' service to check the usergroups if they are really valid
                foreach ($groupDataArr as $groupData) {
-                               // by default a group is valid
+                               // By default a group is valid
                        $validGroup = TRUE;
 
                        $serviceChain='';
@@ -282,7 +278,9 @@ class tslib_feUserAuth extends t3lib_userAuth {
 
                                if (!$serviceObj->authGroup($this->user, $groupData)) {
                                        $validGroup = FALSE;
-                                       if ($this->writeDevLog)         t3lib_div::devLog($subType.' auth service did not auth group: '.t3lib_div::arrayToLogString($groupData, 'uid,title'), 'tslib_feUserAuth', 2);
+                                       if ($this->writeDevLog) {
+                                               t3lib_div::devLog($subType.' auth service did not auth group: '.t3lib_div::arrayToLogString($groupData, 'uid,title'), 'tslib_feUserAuth', 2);
+                                       }
 
                                        break;
                                }
@@ -291,10 +289,10 @@ class tslib_feUserAuth extends t3lib_userAuth {
                        unset($serviceObj);
 
                        if ($validGroup) {
-                               $this->groupData['title'][$groupData['uid']]=$groupData['title'];
-                               $this->groupData['uid'][$groupData['uid']]=$groupData['uid'];
-                               $this->groupData['pid'][$groupData['uid']]=$groupData['pid'];
-                               $this->groupData['TSconfig'][$groupData['uid']]=$groupData['TSconfig'];
+                               $this->groupData['title'][$groupData['uid']] = $groupData['title'];
+                               $this->groupData['uid'][$groupData['uid']] = $groupData['uid'];
+                               $this->groupData['pid'][$groupData['uid']] = $groupData['pid'];
+                               $this->groupData['TSconfig'][$groupData['uid']] = $groupData['TSconfig'];
                        }
                }
 
@@ -304,7 +302,7 @@ class tslib_feUserAuth extends t3lib_userAuth {
                                $this->TSdataArray[]=$TSdata;
                        }
 
-                       $this->TSdataArray[]=$this->user['TSconfig'];
+                       $this->TSdataArray[] = $this->user['TSconfig'];
 
                                // Sort information
                        ksort($this->groupData['title']);
@@ -319,38 +317,22 @@ class tslib_feUserAuth extends t3lib_userAuth {
         * Returns the parsed TSconfig for the fe_user
         * First time this function is called it will parse the TSconfig and store it in $this->userTS. Subsequent requests will not re-parse the TSconfig but simply return what is already in $this->userTS
         *
-        * @return      array           TSconfig array for the fe_user
+        * @return array TSconfig array for the fe_user
         */
        function getUserTSconf() {
                if (!$this->userTSUpdated) {
                                // Parsing the user TS (or getting from cache)
                        $this->TSdataArray = t3lib_TSparser::checkIncludeLines_array($this->TSdataArray);
-                       $userTS = implode(LF.'[GLOBAL]'.LF, $this->TSdataArray);
+                       $userTS = implode(LF . '[GLOBAL]' . LF, $this->TSdataArray);
                        $parseObj = t3lib_div::makeInstance('t3lib_TSparser');
                        $parseObj->parse($userTS);
                        $this->userTS = $parseObj->setup;
 
-                       $this->userTSUpdated=1;
+                       $this->userTSUpdated = 1;
                }
                return $this->userTS;
        }
 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
        /*****************************************
         *
         * Session data management functions
@@ -362,7 +344,7 @@ class tslib_feUserAuth extends t3lib_userAuth {
         * The session data is restored to $this->sesData
         * 1/100 calls will also do a garbage collection.
         *
-        * @return      void
+        * @return void
         * @access private
         * @see storeSessionData()
         */
@@ -389,7 +371,7 @@ class tslib_feUserAuth extends t3lib_userAuth {
         * If the flag $this->sesData_change has been set, the fe_session_data table is updated with the content of $this->sesData
         * If the $this->sessionDataTimestamp is NULL there was no session record yet, so we need to insert it into the database
         *
-        * @return      void
+        * @return void
         * @see fetchSessionData(), getKey(), setKey()
         */
        function storeSessionData() {
@@ -423,7 +405,7 @@ class tslib_feUserAuth extends t3lib_userAuth {
        /**
         * Removes data of the current session.
         *
-        * @return      void
+        * @return void
         */
        public function removeSessionData() {
                $GLOBALS['TYPO3_DB']->exec_DELETEquery(
@@ -436,7 +418,7 @@ class tslib_feUserAuth extends t3lib_userAuth {
         * Executes the garbage collection of session data and session.
         * The lifetime of session data is defined by $TYPO3_CONF_VARS['FE']['sessionDataLifetime'].
         *
-        * @return      void
+        * @return void
         */
        public function gc() {
                $timeoutTimeStamp = intval($GLOBALS['EXEC_TIME'] - $this->sessionDataLifetime);
@@ -448,9 +430,9 @@ class tslib_feUserAuth extends t3lib_userAuth {
        /**
         * Returns session data for the fe_user; Either persistent data following the fe_users uid/profile (requires login) or current-session based (not available when browse is closed, but does not require login)
         *
-        * @param       string          Session data type; Either "user" (persistent, bound to fe_users profile) or "ses" (temporary, bound to current session cookie)
-        * @param       string          Key from the data array to return; The session data (in either case) is an array ($this->uc / $this->sesData) and this value determines which key to return the value for.
-        * @return      mixed           Returns whatever value there was in the array for the key, $key
+        * @param string $type Session data type; Either "user" (persistent, bound to fe_users profile) or "ses" (temporary, bound to current session cookie)
+        * @param string $key Key from the data array to return; The session data (in either case) is an array ($this->uc / $this->sesData) and this value determines which key to return the value for.
+        * @return mixed Returns whatever value there was in the array for the key, $key
         * @see setKey()
         */
        function getKey($type, $key) {
@@ -472,10 +454,10 @@ class tslib_feUserAuth extends t3lib_userAuth {
         * Notice: The key "recs" is already used by the function record_registration() which stores table/uid=value pairs in that key. This is used for the shopping basket among other things.
         * Notice: Simply calling this function will not save the data to the database! The actual saving is done in storeSessionData() which is called as some of the last things in index_ts.php. So if you exit before this point, nothing gets saved of course! And the solution is to call $GLOBALS['TSFE']->storeSessionData(); before you exit.
         *
-        * @param       string          Session data type; Either "user" (persistent, bound to fe_users profile) or "ses" (temporary, bound to current session cookie)
-        * @param       string          Key from the data array to store incoming data in; The session data (in either case) is an array ($this->uc / $this->sesData) and this value determines in which key the $data value will be stored.
-        * @param       mixed           The data value to store in $key
-        * @return      void
+        * @param string $type Session data type; Either "user" (persistent, bound to fe_users profile) or "ses" (temporary, bound to current session cookie)
+        * @param string $key Key from the data array to store incoming data in; The session data (in either case) is an array ($this->uc / $this->sesData) and this value determines in which key the $data value will be stored.
+        * @param mixed $data The data value to store in $key
+        * @return void
         * @see setKey(), storeSessionData(), record_registration()
         */
        function setKey($type, $key, $data) {
@@ -499,7 +481,7 @@ class tslib_feUserAuth extends t3lib_userAuth {
         * Returns the session data stored for $key.
         * The data will last only for this login session since it is stored in the session table.
         *
-        * @param  string  $key
+        * @param string $key
         * @return mixed
         */
        public function getSessionData($key) {
@@ -509,8 +491,8 @@ class tslib_feUserAuth extends t3lib_userAuth {
        /**
         * Saves the tokens so that they can be used by a later incarnation of this class.
         *
-        * @param  string  $key
-        * @param  mixed   $data
+        * @param string $key
+        * @param mixed $data
         * @return void
         */
        public function setAndSaveSessionData($key, $data) {
@@ -518,18 +500,16 @@ class tslib_feUserAuth extends t3lib_userAuth {
                $this->storeSessionData();
        }
 
-
-
        /**
         * Registration of records/"shopping basket" in session data
         * This will take the input array, $recs, and merge into the current "recs" array found in the session data.
         * If a change in the recs storage happens (which it probably does) the function setKey() is called in order to store the array again.
         *
-        * @param       array           The data array to merge into/override the current recs values. The $recs array is constructed as [table]][uid] = scalar-value (eg. string/integer).
-        * @param       integer         The maximum size of stored session data. If zero, no limit is applied and even confirmation of cookie session is discarded.
-        * @return      void
+        * @param array $recs The data array to merge into/override the current recs values. The $recs array is constructed as [table]][uid] = scalar-value (eg. string/integer).
+        * @param integer $maxSizeOfSessionData The maximum size of stored session data. If zero, no limit is applied and even confirmation of cookie session is discarded.
+        * @return void
         */
-       function record_registration($recs, $maxSizeOfSessionData=0) {
+       function record_registration($recs, $maxSizeOfSessionData = 0) {
 
                        // Storing value ONLY if there is a confirmed cookie set (->cookieID),
                        // otherwise a shellscript could easily be spamming the fe_sessions table
@@ -562,8 +542,8 @@ class tslib_feUserAuth extends t3lib_userAuth {
         *
         * This calls the parent function but additionally tries to look up the session ID in the "fe_session_data" table.
         *
-        * @param       integer         Claimed Session ID
-        * @return      boolean         Returns TRUE if a corresponding session was found in the database
+        * @param integer $id Claimed Session ID
+        * @return boolean Returns TRUE if a corresponding session was found in the database
         */
        function isExistingSessionRecord($id) {
                        // Perform check in parent function
index 70d093d..a56b48e 100644 (file)
@@ -37,8 +37,8 @@ class tslib_frameset {
        /**
         * Generates a frameset based on input configuration in a TypoScript array.
         *
-        * @param       array           The TypoScript properties of the PAGE object property "frameSet.". See link.
-        * @return      string          A <frameset> tag.
+        * @param array $setup The TypoScript properties of the PAGE object property "frameSet.". See link.
+        * @return string A <frameset> tag.
         * @see TSpagegen::renderContentWithHeader()
         */
        function make($setup) {
@@ -70,9 +70,9 @@ class tslib_frameset {
        /**
         * Creates the attributes for a <frame> tag based on a $conf array and the type number
         *
-        * @param       array           Configuration for the parameter generation for the FRAME set. See link
-        * @param       integer         The typenumber to use for the link.
-        * @return      string          String with attributes for the frame-tag. With a prefixed space character.
+        * @param array $setup Configuration for the parameter generation for the FRAME set. See link
+        * @param integer $typeNum The typenumber to use for the link.
+        * @return string String with attributes for the frame-tag. With a prefixed space character.
         * @access private
         * @link http://typo3.org/documentation/document-library/references/doc_core_tsref/current/view/7/9/
         * @see make(), t3lib_TStemplate::linkData()
@@ -114,8 +114,8 @@ class tslib_frameset {
        /**
         * Creates the attributes for a <frameset> tag based on a conf array($setup)
         *
-        * @param       array           The setup array(TypoScript properties)
-        * @return      string          Attributes with preceeding space.
+        * @param array $setup The setup array(TypoScript properties)
+        * @return string Attributes with preceeding space.
         * @access private
         * @see make()
         */
index 012df42..ef04ffe 100644 (file)
  *
  * Revised for TYPO3 3.6 June/2003 by Kasper Skårhøj
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  */
 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
 /**
  * GIFBUILDER extension class.
  * This class allows for advanced rendering of images with various layers of images, text and graphical primitives.
  * }
  * return $gifCreator->getImageDimensions($theImage);
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  * @package TYPO3
  * @subpackage tslib
  */
 class tslib_gifBuilder extends t3lib_stdGraphic {
 
                // Internal
-       var $im = '';           // the main image
-       var $w = 0;                     // the image-width
-       var $h = 0;                     // the image-height
-       var $map;                       // map-data
+               // the main image
+       var $im = '';
+               // the image-width
+       var $w = 0;
+               // the image-height
+       var $h = 0;
+               // map-data
+       var $map;
        var $workArea;
-       var $setup = Array ();          // This holds the operational setup for gifbuilder. Basically this is a TypoScript array with properties.
-       var $combinedTextStrings = array();             // Contains all text strings used on this image
-       var $combinedFileNames = array();               // Contains all filenames (basename without extension) used on this image
-       var $data = Array();            // This is the array from which data->field: [key] is fetched. So this is the current record!
-       var $objBB = Array();
+               // This holds the operational setup for gifbuilder. Basically this is a TypoScript array with properties.
+       var $setup = array();
+               // Contains all text strings used on this image
+       var $combinedTextStrings = array();
+               // Contains all filenames (basename without extension) used on this image
+       var $combinedFileNames = array();
+               // This is the array from which data->field: [key] is fetched. So this is the current record!
+       var $data = array();
+       var $objBB = array();
        var $myClassName = 'gifbuilder';
-       var $charRangeMap=array();
+       var $charRangeMap = array();
 
        /**
         * Initialization of the GIFBUILDER objects, in particular TEXT and IMAGE. This includes finding the bounding box, setting dimensions and offset values before the actual rendering is started.
@@ -97,9 +85,9 @@ class tslib_gifBuilder extends t3lib_stdGraphic {
         * Should be called after the ->init() function which initializes the parent class functions/variables in general.
         * The class tslib_gmenu also uses gifbuilder and here there is an interesting use since the function findLargestDims() from that class calls the init() and start() functions to find the total dimensions before starting the rendering of the images.
         *
-        * @param       array           TypoScript properties for the GIFBUILDER session. Stored internally in the variable ->setup
-        * @param       array           The current data record from tslib_cObj. Stored internally in the variable ->data
-        * @return      void
+        * @param array $conf TypoScript properties for the GIFBUILDER session. Stored internally in the variable ->setup
+        * @param array $data The current data record from tslib_cObj. Stored internally in the variable ->data
+        * @return void
         * @see tslib_cObj::getImgResource(), tslib_gmenu::makeGifs(), tslib_gmenu::findLargestDims()
         */
        function start($conf, $data) {
@@ -111,14 +99,12 @@ class tslib_gifBuilder extends t3lib_stdGraphic {
                        $this->cObj->start($this->data);
 
 
-                       /* Hook preprocess gifbuilder conf
-                        * Added by Julle for 3.8.0
-                        *
-                        * Let's you pre-process the gifbuilder configuration. for
-                        * example you can split a string up into lines and render each
-                        * line as TEXT obj, see extension julle_gifbconf
-                        */
-
+                       // Hook preprocess gifbuilder conf
+                       // Added by Julle for 3.8.0
+                       //
+                       // Let's you pre-process the gifbuilder configuration. for
+                       // example you can split a string up into lines and render each
+                       // line as TEXT obj, see extension julle_gifbconf
                        if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['tslib/class.tslib_gifbuilder.php']['gifbuilder-ConfPreProcess']))    {
                                foreach($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['tslib/class.tslib_gifbuilder.php']['gifbuilder-ConfPreProcess'] as $_funcRef)    {
                                        $_params = $this->setup;
@@ -317,9 +303,10 @@ class tslib_gifBuilder extends t3lib_stdGraphic {
                        $this->w = $XY[0];
                        $this->h = $XY[1];
                        $this->OFFSET = t3lib_div::intExplode(',', $this->setup['offset']);
-
-                       $this->setWorkArea($this->setup['workArea']);   // this sets the workArea
-                       $this->defaultWorkArea = $this->workArea;       // this sets the default to the current;
+                               // this sets the workArea
+                       $this->setWorkArea($this->setup['workArea']);
+                               // this sets the default to the current;
+                       $this->defaultWorkArea = $this->workArea;
                }
        }
 
@@ -328,13 +315,15 @@ class tslib_gifBuilder extends t3lib_stdGraphic {
         * Gets filename from fileName() and if file exists in typo3temp/ dir it will - of course - not be rendered again.
         * Otherwise rendering means calling ->make(), then ->output(), then ->destroy()
         *
-        * @return      string          The filename for the created GIF/PNG file. The filename will be prefixed "GB_"
+        * @return string The filename for the created GIF/PNG file. The filename will be prefixed "GB_"
         * @see make(), fileName()
         */
        function gifBuild() {
                if ($this->setup) {
-                       $gifFileName = $this->fileName('GB/');  // Relative to PATH_site
-                       if (!file_exists($gifFileName)) {               // File exists
+                               // Relative to PATH_site
+                       $gifFileName = $this->fileName('GB/');
+                               // File exists
+                       if (!file_exists($gifFileName)) {
 
                                        // Create temporary directory if not done:
                                $this->createTempSubDir('GB/');
@@ -354,7 +343,7 @@ class tslib_gifBuilder extends t3lib_stdGraphic {
         * Creates a GDlib resource in $this->im and works on that
         * Called by gifBuild()
         *
-        * @return      void
+        * @return void
         * @access private
         * @see gifBuild()
         */
@@ -497,10 +486,12 @@ class tslib_gifBuilder extends t3lib_stdGraphic {
                                                break;
                                                case 'WORKAREA':
                                                        if ($conf['set']) {
-                                                               $this->setWorkArea($conf['set']);       // this sets the workArea
+                                                                       // this sets the workArea
+                                                               $this->setWorkArea($conf['set']);
                                                        }
                                                        if (isset($conf['clear'])) {
-                                                               $this->workArea = $this->defaultWorkArea;       // this sets the current to the default;
+                                                                       // This sets the current to the default;
+                                                               $this->workArea = $this->defaultWorkArea;
                                                        }
                                                break;
                                                case 'ELLIPSE':
@@ -511,7 +502,7 @@ class tslib_gifBuilder extends t3lib_stdGraphic {
                        }
                }
 
-                       // preserve alpha transparency
+                       // Preserve alpha transparency
                if (!$this->saveAlphaLayer) {
                        if ($this->setup['transparentBackground']) {
                                        // Auto transparent background is set
@@ -533,30 +524,12 @@ class tslib_gifBuilder extends t3lib_stdGraphic {
                }
        }
 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
        /*********************************************
         *
         * Various helper functions
         *
         ********************************************/
 
-
        /**
         * Initializing/Cleaning of TypoScript properties for TEXT GIFBUILDER objects
         *
@@ -564,8 +537,8 @@ class tslib_gifBuilder extends t3lib_stdGraphic {
         * Finds the title if its a 'variable' (instantiates a cObj and loads it with the ->data record)
         * Performs caseshift if any.
         *
-        * @param       array           GIFBUILDER object TypoScript properties
-        * @return      array           Modified $conf array IF the "text" property is not blank
+        * @param array $conf GIFBUILDER object TypoScript properties
+        * @return array Modified $conf array IF the "text" property is not blank
         * @access private
         */
        function checkTextObj($conf) {
@@ -581,11 +554,18 @@ class tslib_gifBuilder extends t3lib_stdGraphic {
                        }
                }
                $conf['fontFile']=$this->checkFile($conf['fontFile']);
-               if (!$conf['fontFile']){$conf['fontFile']='t3lib/fonts/nimbus.ttf';}
-               if (!$conf['iterations']){$conf['iterations'] = 1;}
-               if (!$conf['fontSize']){$conf['fontSize']=12;}
-               if ($conf['spacing'] || $conf['wordSpacing'])   {               // If any kind of spacing applys, we cannot use angles!!
-                       $conf['angle']=0;
+               if (!$conf['fontFile']) {
+                       $conf['fontFile'] = 't3lib/fonts/nimbus.ttf';
+               }
+               if (!$conf['iterations']) {
+                       $conf['iterations'] = 1;
+               }
+               if (!$conf['fontSize']) {
+                       $conf['fontSize'] = 12;
+               }
+                       // If any kind of spacing applys, we cannot use angles!!
+               if ($conf['spacing'] || $conf['wordSpacing']) {
+                       $conf['angle'] = 0;
                }
                if (!isset($conf['antiAlias'])){$conf['antiAlias']=1;}
 
@@ -617,16 +597,17 @@ class tslib_gifBuilder extends t3lib_stdGraphic {
                                }
 
                                $cfgK = $this->charRangeMap[$fontBaseName]['cfgKey'];
-                               if (!isset($conf['splitRendering.'][$cfgK]))    {       // Do not impose settings if a splitRendering object already exists:
+                                       // Do not impose settings if a splitRendering object already exists:
+                               if (!isset($conf['splitRendering.'][$cfgK])) {
                                                // Set configuration:
                                        $conf['splitRendering.'][$cfgK] = 'charRange';
                                        $conf['splitRendering.'][$cfgK.'.'] = $this->charRangeMap[$fontBaseName]['charMapConfig'];
 
-                                               // multiplicator of fontsize:
+                                               // Multiplicator of fontsize:
                                        if ($this->charRangeMap[$fontBaseName]['multiplicator']) {
                                                $conf['splitRendering.'][$cfgK.'.']['fontSize'] = round($conf['fontSize'] * $this->charRangeMap[$fontBaseName]['multiplicator']);
                                        }
-                                               // multiplicator of pixelSpace:
+                                               // Multiplicator of pixelSpace:
                                        if ($this->charRangeMap[$fontBaseName]['pixelSpace']) {
                                                $travKeys = array('xSpaceBefore', 'xSpaceAfter', 'ySpaceBefore', 'ySpaceAfter');
                                                foreach($travKeys as $pxKey) {
@@ -658,8 +639,8 @@ class tslib_gifBuilder extends t3lib_stdGraphic {
         * Input: 2+2, 2*3, 123, [10.w]
         * Output: 4,6,123,45  (provided that the width of object in position 10 was 45 pixels wide)
         *
-        * @param       string          The string to resolve/calculate the result of. The string is divided by a comma first and each resulting part is calculated into an integer.
-        * @return      string          The resolved string with each part (separated by comma) returned separated by comma
+        * @param string $string The string to resolve/calculate the result of. The string is divided by a comma first and each resulting part is calculated into an integer.
+        * @return string The resolved string with each part (separated by comma) returned separated by comma
         * @access private
         */
        function calcOffset($string) {
@@ -681,9 +662,9 @@ class tslib_gifBuilder extends t3lib_stdGraphic {
        /**
         * Returns an "imgResource" creating an instance of the tslib_cObj class and calling tslib_cObj::getImgResource
         *
-        * @param       string          Filename value OR the string "GIFBUILDER", see documentation in TSref for the "datatype" called "imgResource"
-        * @param       array           TypoScript properties passed to the function. Either GIFBUILDER properties or imgResource properties, depending on the value of $file (whether that is "GIFBUILDER" or a file reference)
-        * @return      array           Returns an array with file information if an image was returned. Otherwise FALSE.
+        * @param string $file Filename value OR the string "GIFBUILDER", see documentation in TSref for the "datatype" called "imgResource"
+        * @param array $fileArray TypoScript properties passed to the function. Either GIFBUILDER properties or imgResource properties, depending on the value of $file (whether that is "GIFBUILDER" or a file reference)
+        * @return array Returns an array with file information if an image was returned. Otherwise FALSE.
         * @access private
         * @see tslib_cObj::getImgResource()
         */
@@ -699,8 +680,8 @@ class tslib_gifBuilder extends t3lib_stdGraphic {
        /**
         * Returns the reference to a "resource" in TypoScript.
         *
-        * @param       string          The resource value.
-        * @return      string          Returns the relative filepath
+        * @param string $file The resource value.
+        * @return string Returns the relative filepath
         * @access private
         * @see t3lib_TStemplate::getFileName()
         */
@@ -711,7 +692,7 @@ class tslib_gifBuilder extends t3lib_stdGraphic {
        /**
         * Calculates the GIFBUILDER output filename/path based on a serialized, hashed value of this->setup
         *
-        * @param $pre string Filename prefix, eg. "GB_"
+        * @param string $pre Filename prefix, eg. "GB_"
         * @return string The relative filepath (relative to PATH_site)
         * @access private
         */
@@ -727,7 +708,7 @@ class tslib_gifBuilder extends t3lib_stdGraphic {
                        $meaningfulPrefix = $basicFileFunctions->cleanFileName($meaningfulPrefix);
                        $meaningfulPrefixLength = intval($GLOBALS['TSFE']->config['config']['meaningfulTempFilePrefix']);
                        if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['UTF8filesystem']) {
-                                       /** @var $t3libCsInstance t3lib_cs */
+                               /** @var $t3libCsInstance t3lib_cs */
                                $t3libCsInstance = t3lib_div::makeInstance('t3lib_cs');
                                $meaningfulPrefix = $t3libCsInstance->substr('utf-8', $meaningfulPrefix, 0, $meaningfulPrefixLength);
                        } else {
@@ -736,7 +717,10 @@ class tslib_gifBuilder extends t3lib_stdGraphic {
                        $meaningfulPrefix .= '_';
                }
 
-                       // WARNING: In PHP5 I discovered that rendering with freetype of Japanese letters was totally corrupt. Not only the wrong glyphs are printed but also some memory stack overflow resulted in strange additional chars - and finally the reason for this investigation: The Bounding box data was changing all the time resulting in new images being generated all the time. With PHP4 it works fine.
+                       // WARNING: In PHP5 I discovered that rendering with freetype of Japanese letters was totally corrupt.
+                       // Not only the wrong glyphs are printed but also some memory stack overflow resulted in strange additional
+                       // chars - and finally the reason for this investigation: The Bounding box data was changing all the time
+                       // resulting in new images being generated all the time. With PHP4 it works fine.
                return $this->tempPath .
                                $pre .
                                $meaningfulPrefix .
@@ -747,7 +731,7 @@ class tslib_gifBuilder extends t3lib_stdGraphic {
        /**
         * Returns the file extension used in the filename
         *
-        * @return      string          Extension; "jpg" or "gif"/"png"
+        * @return string Extension; "jpg" or "gif"/"png"
         * @access private
         */
        function extension() {
@@ -771,9 +755,9 @@ class tslib_gifBuilder extends t3lib_stdGraphic {
        /**
         * Calculates the value concerning the dimensions of objects.
         *
-        * @param       string          $string: The string to be calculated (e.g. "[20.h]+13")
-        * @return      integer         The calculated value (e.g. "23")
-        * @see         calcOffset()
+        * @param string $string The string to be calculated (e.g. "[20.h]+13")
+        * @return integer The calculated value (e.g. "23")
+        * @see calcOffset()
         */
        protected function calculateValue($string) {
                $calculatedValue = 0;
@@ -824,8 +808,8 @@ class tslib_gifBuilder extends t3lib_stdGraphic {
         * Calculates special functions:
         * + max([10.h], [20.h])        -> gets the maximum of the given values
         *
-        * @param       string          $string: The raw string with functions to be calculated
-        * @return      string          The calculated values
+        * @param string $string The raw string with functions to be calculated
+        * @return string The calculated values
         */
        protected function calculateFunctions($string) {
                if (preg_match_all('#max\(([^)]+)\)#', $string, $matches)) {
@@ -846,8 +830,8 @@ class tslib_gifBuilder extends t3lib_stdGraphic {
        /**
         * Calculates the maximum of a set of values defined like "[10.h],[20.h],1000"
         *
-        * @param       string          $string: The string to be used to calculate the maximum (e.g. "[10.h],[20.h],1000")
-        * @return      integer         The maxium value of the given comma separated and calculated values
+        * @param string $string The string to be used to calculate the maximum (e.g. "[10.h],[20.h],1000")
+        * @return integer The maxium value of the given comma separated and calculated values
         */
        protected function calculateMaximum($string) {
                $parts = t3lib_div::trimExplode(',', $this->calcOffset($string), TRUE);