[TASK] Clean up phpDoc comments in t3lib classes
authorWouter Wolters <typo3@wouterwolters.nl>
Fri, 18 May 2012 19:18:11 +0000 (21:18 +0200)
committerChristian Kuhn <lolli@schwarzbu.ch>
Sat, 19 May 2012 19:43:22 +0000 (21:43 +0200)
Clean up phpDoc comments for the following classes:

* t3lib/class.t3lib_svbase.php
* t3lib/class.t3lib_syntaxhl.php
* t3lib/class.t3lib_tceforms_fe.php
* t3lib/class.t3lib_timetrack.php
* t3lib/class.t3lib_timetracknull.php
* t3lib/class.t3lib_transferdata.php
* t3lib/class.t3lib_transl8tools.php

Clean up provides:

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

Change-Id: I30f3f6819505751ff9339e0584ee58bff2944cc8
Resolves: #37290
Releases: 6.0
Reviewed-on: http://review.typo3.org/11288
Reviewed-by: Christian Kuhn
Tested-by: Christian Kuhn
t3lib/class.t3lib_svbase.php
t3lib/class.t3lib_syntaxhl.php
t3lib/class.t3lib_tceforms_fe.php
t3lib/class.t3lib_timetrack.php
t3lib/class.t3lib_timetracknull.php
t3lib/class.t3lib_transferdata.php
t3lib/class.t3lib_transl8tools.php

index 17fa1f1..d5a3b78 100644 (file)
  *
  * TODO: temp files are not removed
  *
- * @author     René Fritz <r.fritz@colorcube.de>
+ * @author René Fritz <r.fritz@colorcube.de>
  */
 
-
-define ('T3_ERR_SV_GENERAL', -1); // General error - something went wrong
-define ('T3_ERR_SV_NOT_AVAIL', -2); // During execution it showed that the service is not available and should be ignored. The service itself should call $this->setNonAvailable()
-define ('T3_ERR_SV_WRONG_SUBTYPE', -3); // passed subtype is not possible with this service
-define ('T3_ERR_SV_NO_INPUT', -4); // passed subtype is not possible with this service
-
-
-define ('T3_ERR_SV_FILE_NOT_FOUND', -20); // File not found which the service should process
-define ('T3_ERR_SV_FILE_READ', -21); // File not readable
-define ('T3_ERR_SV_FILE_WRITE', -22); // File not writable
-
-define ('T3_ERR_SV_PROG_NOT_FOUND', -40); // passed subtype is not possible with this service
-define ('T3_ERR_SV_PROG_FAILED', -41); // passed subtype is not possible with this service
-
-// define ('T3_ERR_SV_serviceType_myerr, -100); // All errors with prefix T3_ERR_SV_[serviceType]_ and lower than -99 are service type dependent error
-
+       // General error - something went wrong
+define ('T3_ERR_SV_GENERAL', -1);
+       // During execution it showed that the service is not available and should be ignored. The service itself should call $this->setNonAvailable()
+define ('T3_ERR_SV_NOT_AVAIL', -2);
+       // Passed subtype is not possible with this service
+define ('T3_ERR_SV_WRONG_SUBTYPE', -3);
+       // Passed subtype is not possible with this service
+define ('T3_ERR_SV_NO_INPUT', -4);
+       // File not found which the service should process
+define ('T3_ERR_SV_FILE_NOT_FOUND', -20);
+       // File not readable
+define ('T3_ERR_SV_FILE_READ', -21);
+       // File not writable
+define ('T3_ERR_SV_FILE_WRITE', -22);
+       // Passed subtype is not possible with this service
+define ('T3_ERR_SV_PROG_NOT_FOUND', -40);
+       // Passed subtype is not possible with this service
+define ('T3_ERR_SV_PROG_FAILED', -41);
 
 /**
  * Parent class for "Services" classes
  *
- * @author     René Fritz <r.fritz@colorcube.de>
+ * @author René Fritz <r.fritz@colorcube.de>
  * @package TYPO3
  * @subpackage t3lib
  */
@@ -73,7 +75,6 @@ abstract class t3lib_svbase {
         */
        var $writeDevLog = FALSE;
 
-
        /**
         * @var string The output content. That's what the services produced as result.
         */
@@ -99,7 +100,6 @@ abstract class t3lib_svbase {
         */
        var $outputFile = '';
 
-
        /**
         * Temporary files which have to be deleted
         *
@@ -116,44 +116,40 @@ abstract class t3lib_svbase {
         *
         ***************************************/
 
-
        /**
         * Returns internal information array for service
         *
-        * @return      array           service description array
+        * @return array Service description array
         */
        function getServiceInfo() {
                return $this->info;
        }
 
-
        /**
         * Returns the service key of the service
         *
-        * @return      string          service key
+        * @return string Service key
         */
        function getServiceKey() {
                return $this->info['serviceKey'];
        }
 
-
        /**
         * Returns the title of the service
         *
-        * @return      string          service title
+        * @return string Service title
         */
        function getServiceTitle() {
                return $this->info['title'];
        }
 
-
        /**
         * Returns service configuration values from the $TYPO3_CONF_VARS['SVCONF'] array
         *
-        * @param       string          Name of the config option
-        * @param       mixed           Default configuration if no special config is available
-        * @param       bool            If set the 'default' config will be returned if no special config for this service is available (default: TRUE)
-        * @return      mixed           configuration value for the service
+        * @param string $optionName Name of the config option
+        * @param mixed $defaultValue Default configuration if no special config is available
+        * @param boolean $includeDefaultConfig If set the 'default' config will be returned if no special config for this service is available (default: TRUE)
+        * @return mixed Configuration value for the service
         */
        function getServiceOption($optionName, $defaultValue = '', $includeDefaultConfig = TRUE) {
                $config = NULL;
@@ -171,21 +167,19 @@ abstract class t3lib_svbase {
                return $config;
        }
 
-
        /***************************************
         *
         *       Error handling
         *
         ***************************************/
 
-
        /**
         * Logs debug messages to t3lib_div::devLog()
         *
-        * @param       string          Debug message
-        * @param       integer         Severity: 0 is info, 1 is notice, 2 is warning, 3 is fatal error, -1 is "OK" message
-        * @param       array|bool      Additional data you want to pass to the logger.
-        * @return      void
+        * @param string $msg Debug message
+        * @param integer $severity Severity: 0 is info, 1 is notice, 2 is warning, 3 is fatal error, -1 is "OK" message
+        * @param array|boolean $dataVar dditional data you want to pass to the logger.
+        * @return void
         */
        function devLog($msg, $severity = 0, $dataVar = FALSE) {
                if ($this->writeDevLog) {
@@ -193,13 +187,12 @@ abstract class t3lib_svbase {
                }
        }
 
-
        /**
         * Puts an error on the error stack. Calling without parameter adds a general error.
         *
-        * @param       integer         error number (see T3_ERR_SV_* constants)
-        * @param       string          error message
-        * @return      void
+        * @param integer $errNum Error number (see T3_ERR_SV_* constants)
+        * @param string $errMsg Error message
+        * @return void
         */
        function errorPush($errNum = T3_ERR_SV_GENERAL, $errMsg = 'Unspecified error occured') {
                array_push($this->error, array('nr' => $errNum, 'msg' => $errMsg));
@@ -210,11 +203,10 @@ abstract class t3lib_svbase {
 
        }
 
-
        /**
         * Removes the last error from the error stack.
         *
-        * @return      void
+        * @return void
         */
        function errorPull() {
                array_pop($this->error);
@@ -222,14 +214,14 @@ abstract class t3lib_svbase {
                // pop for $GLOBALS['TT']->setTSlogMessage is not supported
        }
 
-
        /**
         * Returns the last error number from the error stack.
         *
-        * @return      int|bool                error number (or TRUE if no error)
+        * @return integer|boolean Error number (or TRUE if no error)
         */
        function getLastError() {
-               $lastError = TRUE; // means all is ok - no error
+                       // Means all is ok - no error
+               $lastError = TRUE;
                if (count($this->error)) {
                        $error = end($this->error);
                        $lastError = $error['nr'];
@@ -237,11 +229,10 @@ abstract class t3lib_svbase {
                return $lastError;
        }
 
-
        /**
         * Returns the last message from the error stack.
         *
-        * @return      string          error message
+        * @return string Error message
         */
        function getLastErrorMsg() {
                $lastErrorMessage = '';
@@ -252,11 +243,10 @@ abstract class t3lib_svbase {
                return $lastErrorMessage;
        }
 
-
        /**
         * Returns all error messages as array.
         *
-        * @return      array           error messages
+        * @return array Error messages
         */
        function getErrorMsgArray() {
                $errArr = array();
@@ -273,7 +263,7 @@ abstract class t3lib_svbase {
        /**
         * Returns the last array from the error stack.
         *
-        * @return      array           error nr and message
+        * @return array Error number and message
         */
        function getLastErrorArray() {
                return end($this->error);
@@ -282,25 +272,23 @@ abstract class t3lib_svbase {
        /**
         * Reset the error stack.
         *
-        * @return      void
+        * @return void
         */
        function resetErrors() {
                $this->error = array();
        }
 
-
        /***************************************
         *
         *       General service functions
         *
         ***************************************/
 
-
        /**
         * check the availability of external programs
         *
-        * @param       string          comma list of programs 'perl,python,pdftotext'
-        * @return      boolean         return FALSE if one program was not found
+        * @param string $progList Comma list of programs 'perl,python,pdftotext'
+        * @return boolean Return FALSE if one program was not found
         */
        function checkExec($progList) {
                $ret = TRUE;
@@ -308,7 +296,7 @@ abstract class t3lib_svbase {
                $progList = t3lib_div::trimExplode(',', $progList, 1);
                foreach ($progList as $prog) {
                        if (!t3lib_exec::checkCommand($prog)) {
-                                       // program not found
+                                       // Program not found
                                $this->errorPush(T3_ERR_SV_PROG_NOT_FOUND, 'External program not found: ' . $prog);
                                $ret = FALSE;
                        }
@@ -320,25 +308,23 @@ abstract class t3lib_svbase {
        /**
         * Deactivate the service. Use this if the service fails at runtime and will not be available.
         *
-        * @return      void
+        * @return void
         */
        function deactivateService() {
                t3lib_extMgm::deactivateService($this->info['serviceType'], $this->info['serviceKey']);
        }
 
-
        /***************************************
         *
         *       IO tools
         *
         ***************************************/
 
-
        /**
         * Check if a file exists and is readable.
         *
-        * @param       string          File name with absolute path.
-        * @return      string|bool     File name or FALSE.
+        * @param string $absFile File name with absolute path.
+        * @return string|boolean File name or FALSE.
         */
        function checkInputFile($absFile) {
                $checkResult = FALSE;
@@ -354,13 +340,12 @@ abstract class t3lib_svbase {
                return $checkResult;
        }
 
-
        /**
         * Read content from a file a file.
         *
-        * @param       string          File name to read from.
-        * @param       integer         Maximum length to read. If empty the whole file will be read.
-        * @return      string|bool     $content or FALSE
+        * @param string $absFile File name to read from.
+        * @param integer $length Maximum length to read. If empty the whole file will be read.
+        * @return string|boolean $content or FALSE
         */
        function readFile($absFile, $length = 0) {
                $out = FALSE;
@@ -374,13 +359,12 @@ abstract class t3lib_svbase {
                return $out;
        }
 
-
        /**
         * Write content to a file.
         *
-        * @param       string          Content to write to the file
-        * @param       string          File name to write into. If empty a temp file will be created.
-        * @return      string|bool     File name or FALSE
+        * @param string $content Content to write to the file
+        * @param string $absFile File name to write into. If empty a temp file will be created.
+        * @return string|boolean File name or FALSE
         */
        function writeFile($content, $absFile = '') {
                if (!$absFile) {
@@ -403,8 +387,8 @@ abstract class t3lib_svbase {
        /**
         * Create a temporary file.
         *
-        * @param       string          File prefix.
-        * @return      string|bool     File name or FALSE
+        * @param string $filePrefix File prefix.
+        * @return string|boolean File name or FALSE
         */
        function tempFile($filePrefix) {
                $absFile = t3lib_div::tempnam($filePrefix);
@@ -421,8 +405,8 @@ abstract class t3lib_svbase {
        /**
         * Register file which should be deleted afterwards.
         *
-        * @param       string          File name with absolute path.
-        * @return      void
+        * @param string File name with absolute path.
+        * @return void
         */
        function registerTempFile($absFile) {
                $this->tempFiles[] = $absFile;
@@ -430,8 +414,6 @@ abstract class t3lib_svbase {
 
        /**
         * Delete registered temporary files.
-        *
-        * @param       string          File name with absolute path.
         * @return      void
         */
        function unlinkTempFiles() {
@@ -441,20 +423,18 @@ abstract class t3lib_svbase {
                $this->tempFiles = array();
        }
 
-
        /***************************************
         *
         *       IO input
         *
         ***************************************/
 
-
        /**
         * Set the input content for service processing.
         *
-        * @param       mixed           Input content (going into ->inputContent)
-        * @param       string          The type of the input content (or file). Might be the same as the service subtypes.
-        * @return      void
+        * @param mixed $content Input content (going into ->inputContent)
+        * @param string $type The type of the input content (or file). Might be the same as the service subtypes.
+        * @return void
         */
        function setInput($content, $type = '') {
                $this->inputContent = $content;
@@ -462,13 +442,12 @@ abstract class t3lib_svbase {
                $this->inputType = $type;
        }
 
-
        /**
         * Set the input file name for service processing.
         *
-        * @param       string          file name
-        * @param       string          The type of the input content (or file). Might be the same as the service subtypes.
-        * @return      void
+        * @param string $absFile File name
+        * @param string $type The type of the input content (or file). Might be the same as the service subtypes.
+        * @return void
         */
        function setInputFile($absFile, $type = '') {
                $this->inputContent = '';
@@ -476,12 +455,11 @@ abstract class t3lib_svbase {
                $this->inputType = $type;
        }
 
-
        /**
         * Get the input content.
         * Will be read from input file if needed. (That is if ->inputContent is empty and ->inputFile is not)
         *
-        * @return      mixed
+        * @return mixed
         */
        function getInput() {
                if ($this->inputContent == '') {
@@ -495,8 +473,8 @@ abstract class t3lib_svbase {
         * Get the input file name.
         * If the content was set by setContent a file will be created.
         *
-        * @param       string          File name. If empty a temp file will be created.
-        * @return      string          File name or FALSE if no input or file error.
+        * @param string $createFile File name. If empty a temp file will be created.
+        * @return string File name or FALSE if no input or file error.
         */
        function getInputFile($createFile = '') {
                if ($this->inputFile) {
@@ -507,29 +485,26 @@ abstract class t3lib_svbase {
                return $this->inputFile;
        }
 
-
        /***************************************
         *
         *       IO output
         *
         ***************************************/
 
-
        /**
         * Set the output file name.
         *
-        * @param       string          file name
-        * @return      void
+        * @param string $absFile File name
+        * @return void
         */
        function setOutputFile($absFile) {
                $this->outputFile = $absFile;
        }
 
-
        /**
         * Get the output content.
         *
-        * @return      mixed
+        * @return mixed
         */
        function getOutput() {
                if ($this->outputFile) {
@@ -538,12 +513,11 @@ abstract class t3lib_svbase {
                return $this->out;
        }
 
-
        /**
         * Get the output file name. If no output file is set, the ->out buffer is written to the file given by input parameter filename
         *
-        * @param       string          Absolute filename to write to
-        * @return      mixed
+        * @param string $absFile Absolute filename to write to
+        * @return mixed
         */
        function getOutputFile($absFile = '') {
                if (!$this->outputFile) {
@@ -552,7 +526,6 @@ abstract class t3lib_svbase {
                return $this->outputFile;
        }
 
-
        /***************************************
         *
         *       Service implementation
@@ -565,32 +538,31 @@ abstract class t3lib_svbase {
         * The class have to do a strict check if the service is available.
         * example: check if the perl interpreter is available which is needed to run an extern perl script.
         *
-        * @return      boolean         TRUE if the service is available
+        * @return boolean TRUE if the service is available
         */
        function init() {
-                       // do not work :-(  but will not hurt
+                       // Does not work :-(  but will not hurt
                        // use it as inspiration for a service based on this class
                register_shutdown_function(array(&$this, '__destruct'));
                        // look in makeInstanceService()
 
                $this->reset();
 
-                       // check for external programs which are defined by $info['exec']
+                       // Check for external programs which are defined by $info['exec']
                if (trim($this->info['exec'])) {
                        if (!$this->checkExec($this->info['exec'])) {
-                               // nothing todo here or?
+                               // Nothing todo here or?
                        }
                }
 
                return ($this->getLastError() === TRUE);
        }
 
-
        /**
         * Resets the service.
         * Will be called by init(). Should be used before every use if a service instance is used multiple times.
         *
-        * @return      void
+        * @return void
         */
        function reset() {
                $this->unlinkTempFiles();
@@ -606,12 +578,11 @@ abstract class t3lib_svbase {
         * Clean up the service.
         * Child classes should explicitly call parent::__destruct() in their destructors for this to work
         *
-        * @return      void
+        * @return void
         */
        function __destruct() {
                $this->unlinkTempFiles();
        }
-
 }
 
 ?>
\ No newline at end of file
index 92c980a..73dab0e 100644 (file)
 /**
  * Contains a class for various syntax highlighting.
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  */
 
-
 /**
  * Syntax Highlighting class.
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  * @package TYPO3
  * @subpackage t3lib
  */
 class t3lib_syntaxhl {
 
                // Internal, dynamic:
-       var $htmlParse; // Parse object.
+               // Parse object.
+       var $htmlParse;
 
                // External, static:
        var $DS_wrapTags = array(
@@ -91,7 +91,6 @@ class t3lib_syntaxhl {
                'currentLangId' => array('<span style="color: #000080;">', '</span>'),
        );
 
-
        /*************************************
         *
         * Markup of Data Structure, <T3DataStructure>
@@ -101,20 +100,24 @@ class t3lib_syntaxhl {
        /**
         * Makes syntax highlighting of a Data Structure, <T3DataStructure>
         *
-        * @param       string          Data Structure XML, must be valid since it's parsed.
-        * @return      string          HTML code with highlighted content. Must be wrapped in <PRE> tags
+        * @param string $str Data Structure XML, must be valid since it's parsed.
+        * @return string HTML code with highlighted content. Must be wrapped in <PRE> tags
         */
        function highLight_DS($str) {
 
                        // Parse DS to verify that it is valid:
                $DS = t3lib_div::xml2array($str);
                if (is_array($DS)) {
-                       $completeTagList = array_unique($this->getAllTags($str)); // Complete list of tags in DS
+                               // Complete list of tags in DS
+                       $completeTagList = array_unique($this->getAllTags($str));
 
                                // Highlighting source:
-                       $this->htmlParse = t3lib_div::makeInstance('t3lib_parsehtml'); // Init parser object
-                       $struct = $this->splitXMLbyTags(implode(',', $completeTagList), $str); // Split the XML by the found tags, recursively into LARGE array.
-                       $markUp = $this->highLight_DS_markUpRecursively($struct); // Perform color-markup on the parsed content. Markup preserves the LINE formatting of the XML.
+                               // Init parser object
+                       $this->htmlParse = t3lib_div::makeInstance('t3lib_parsehtml');
+                               // Split the XML by the found tags, recursively into LARGE array.
+                       $struct = $this->splitXMLbyTags(implode(',', $completeTagList), $str);
+                               // Perform color-markup on the parsed content. Markup preserves the LINE formatting of the XML.
+                       $markUp = $this->highLight_DS_markUpRecursively($struct);
 
                                // Return content:
                        return $markUp;
@@ -128,10 +131,10 @@ class t3lib_syntaxhl {
         * Making syntax highlighting of the parsed Data Structure XML.
         * Called recursively.
         *
-        * @param       array           The structure, see splitXMLbyTags()
-        * @param       string          Parent tag.
-        * @param       string          "Application" - used to denote if we are 'inside' a section
-        * @return      string          HTML
+        * @param array $struct The structure, see splitXMLbyTags()
+        * @param string $parent Parent tag.
+        * @param string $app "Application" - used to denote if we are 'inside' a section
+        * @return string HTML
         */
        function highLight_DS_markUpRecursively($struct, $parent = '', $app = '') {
                $output = '';
@@ -186,7 +189,6 @@ class t3lib_syntaxhl {
                return $output;
        }
 
-
        /*************************************
         *
         * Markup of Data Structure, <T3FlexForms>
@@ -196,20 +198,24 @@ class t3lib_syntaxhl {
        /**
         * Makes syntax highlighting of a FlexForm Data, <T3FlexForms>
         *
-        * @param       string          Data Structure XML, must be valid since it's parsed.
-        * @return      string          HTML code with highlighted content. Must be wrapped in <PRE> tags
+        * @param string $str Data Structure XML, must be valid since it's parsed.
+        * @return string HTML code with highlighted content. Must be wrapped in <PRE> tags
         */
        function highLight_FF($str) {
 
                        // Parse DS to verify that it is valid:
                $DS = t3lib_div::xml2array($str);
                if (is_array($DS)) {
-                       $completeTagList = array_unique($this->getAllTags($str)); // Complete list of tags in DS
+                               // Complete list of tags in DS
+                       $completeTagList = array_unique($this->getAllTags($str));
 
                                // Highlighting source:
-                       $this->htmlParse = t3lib_div::makeInstance('t3lib_parsehtml'); // Init parser object
-                       $struct = $this->splitXMLbyTags(implode(',', $completeTagList), $str); // Split the XML by the found tags, recursively into LARGE array.
-                       $markUp = $this->highLight_FF_markUpRecursively($struct); // Perform color-markup on the parsed content. Markup preserves the LINE formatting of the XML.
+                               // Init parser object
+                       $this->htmlParse = t3lib_div::makeInstance('t3lib_parsehtml');
+                               // Split the XML by the found tags, recursively into LARGE array.
+                       $struct = $this->splitXMLbyTags(implode(',', $completeTagList), $str);
+                               // Perform color-markup on the parsed content. Markup preserves the LINE formatting of the XML.
+                       $markUp = $this->highLight_FF_markUpRecursively($struct);
 
                                // Return content:
                        return $markUp;
@@ -223,10 +229,10 @@ class t3lib_syntaxhl {
         * Making syntax highlighting of the parsed FlexForm XML.
         * Called recursively.
         *
-        * @param       array           The structure, see splitXMLbyTags()
-        * @param       string          Parent tag.
-        * @param       string          "Application" - used to denote if we are 'inside' a section
-        * @return      string          HTML
+        * @param array $struct The structure, see splitXMLbyTags()
+        * @param string $parent Parent tag.
+        * @param string $app "Application" - used to denote if we are 'inside' a section
+        * @return string HTML
         */
        function highLight_FF_markUpRecursively($struct, $parent = '', $app = '') {
                $output = '';
@@ -286,7 +292,6 @@ class t3lib_syntaxhl {
                return $output;
        }
 
-
        /*************************************
         *
         * Various
@@ -296,8 +301,8 @@ class t3lib_syntaxhl {
        /**
         * Returning all tag names found in XML/HTML input string
         *
-        * @param       string          HTML/XML input
-        * @return      array           Array with all found tags (starttags only)
+        * @param string $str HTML/XML input
+        * @return array Array with all found tags (starttags only)
         */
        function getAllTags($str) {
 
@@ -326,9 +331,9 @@ class t3lib_syntaxhl {
         * Splitting the input source by the tags listing in $tagList.
         * Called recursively.
         *
-        * @param       string          Commalist of tags to split source by (into blocks, ALL being block-tags!)
-        * @param       string          Input string.
-        * @return      array           Array with the content arranged hierarchically.
+        * @param string $tagList Commalist of tags to split source by (into blocks, ALL being block-tags!)
+        * @param string $str Input string.
+        * @return array Array with the content arranged hierarchically.
         */
        function splitXMLbyTags($tagList, $str) {
                $struct = $this->htmlParse->splitIntoBlock($tagList, $str);
index 6d7b686..4f90cd4 100644 (file)
 /**
  * Contains a frontend version of the TYPO3 Core Form generator - AKA "TCEforms"
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  */
 
-
 /**
  * Extension class for the rendering of TCEforms in the frontend
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  */
 class t3lib_TCEforms_FE extends t3lib_TCEforms {
 
@@ -50,8 +49,8 @@ class t3lib_TCEforms_FE extends t3lib_TCEforms {
        /**
         * Function for wrapping labels.
         *
-        * @param       string          The string to wrap
-        * @return      string
+        * @param string $str The string to wrap
+        * @return string
         */
        public function wrapLabels($str) {
                return '<font face="verdana" size="1" color="black">' . $str . '</font>';
@@ -60,8 +59,8 @@ class t3lib_TCEforms_FE extends t3lib_TCEforms {
        /**
         * Prints the palette in the frontend editing (forms-on-page?)
         *
-        * @param       array           The palette array to print
-        * @return      string          HTML output
+        * @param array $paletteArray The palette array to print
+        * @return string HTML output
         */
        public function printPalette(array $paletteArray) {
                $out = '';
@@ -85,7 +84,7 @@ class t3lib_TCEforms_FE extends t3lib_TCEforms {
         * Sets the fancy front-end design of the editor.
         * Frontend
         *
-        * @return      void
+        * @return void
         */
        public function setFancyDesign() {
                $this->fieldTemplate = '
@@ -113,24 +112,23 @@ class t3lib_TCEforms_FE extends t3lib_TCEforms {
         * backpath is automatically applied.
         * This method adds the library to $GLOBALS['TSFE']->additionalHeaderData[$lib].
         *
-        * @param       string          $lib: Library name. Call it with the full path like "contrib/prototype/prototype.js" to load it
-        * @return      void
+        * @param string $lib Library name. Call it with the full path like "contrib/prototype/prototype.js" to load it
+        * @return void
         */
        public function loadJavascriptLib($lib) {
                /** @var $pageRenderer t3lib_PageRenderer */
                $pageRenderer = $GLOBALS['TSFE']->getPageRenderer();
                $pageRenderer->addJsLibrary($lib, $this->prependBackPath($lib));
-
        }
 
        /**
         * Insert additional style sheet link
         *
-        * @param       string          $key: some key identifying the style sheet
-        * @param       string          $href: uri to the style sheet file
-        * @param       string          $title: value for the title attribute of the link element
-        * @return      string          $relation: value for the rel attribute of the link element
-        * @return      void
+        * @param string $key Some key identifying the style sheet
+        * @param string $href Uri to the style sheet file
+        * @param string $title Value for the title attribute of the link element
+        * @param string $relation Value for the rel attribute of the link element
+        * @return void
         */
        public function addStyleSheet($key, $href, $title = '', $relation = 'stylesheet') {
                /** @var $pageRenderer t3lib_PageRenderer */
@@ -142,7 +140,7 @@ class t3lib_TCEforms_FE extends t3lib_TCEforms {
         * Initializes an anonymous template container.
         * The created container can be compared to alt_doc.php in backend-only disposal.
         *
-        * @return      void
+        * @return void
         */
        public function initializeTemplateContainer() {
                t3lib_div::requireOnce(PATH_typo3 . 'template.php');
index cd87d8d..ebb272a 100644 (file)
  * @author  Kasper Skårhøj <kasperYYYY@typo3.com>
  */
 
-
 /**
  * Frontend Timetracking functions
  *
  * Is used to register how much time is used with operations in TypoScript
  * Used by index_ts
  *
- * @author  Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  * @package TYPO3
  * @subpackage t3lib
  * @see t3lib_tsfeBeUserAuth, tslib_fe, tslib_cObj, TSpagegen
  */
 final class t3lib_timeTrack {
-       var $starttime = 0; // Is loaded with the millisecond time when this object is created
+               // Is loaded with the millisecond time when this object is created
+       var $starttime = 0;
 
-       var $LR = 1; // Log Rendering flag. If set, ->push() and ->pull() is called from the cObj->cObjGetSingle(). This determines whether or not the TypoScript parsing activity is logged. But it also slows down the rendering
+               // Log Rendering flag. If set, ->push() and ->pull() is called from the cObj->cObjGetSingle(). This determines whether or not the TypoScript parsing activity is logged. But it also slows down the rendering
+       var $LR = 1;
        var $printConf = array(
                'showParentKeys' => 1,
                'contentLength' => 10000, // Determines max lenght of displayed content before it gets cropped.
@@ -70,9 +71,8 @@ final class t3lib_timeTrack {
        var $tsStackLog = array();
        var $tsStackPointer = 0;
        var $currentHashPointer = array();
-
-       var $highlightLongerThan = 0; // Log entries that take than this number of milliseconds (own time) will be highlighted during log display. Set 0 to disable highlighting.
-
+               // Log entries that take than this number of milliseconds (own time) will be highlighted during log display. Set 0 to disable highlighting.
+       var $highlightLongerThan = 0;
 
        /*******************************************
         *
@@ -84,7 +84,7 @@ final class t3lib_timeTrack {
         * Constructor
         * Sets the starting time
         *
-        * @return      void
+        * @return void
         */
        public function start() {
                $this->wrapError = array(
@@ -107,9 +107,9 @@ final class t3lib_timeTrack {
        /**
         * Pushes an element to the TypoScript tracking array
         *
-        * @param       string          Label string for the entry, eg. TypoScript property name
-        * @param       string          Additional value(?)
-        * @return      void
+        * @param string $tslabel Label string for the entry, eg. TypoScript property name
+        * @param string $value Additional value(?)
+        * @return void
         * @see tslib_cObj::cObjGetSingle(), pull()
         */
        public function push($tslabel, $value = '') {
@@ -133,8 +133,8 @@ final class t3lib_timeTrack {
        /**
         * Pulls an element from the TypoScript tracking array
         *
-        * @param       string          The content string generated within the push/pull part.
-        * @return      void
+        * @param string $content The content string generated within the push/pull part.
+        * @return void
         * @see tslib_cObj::cObjGetSingle(), push()
         */
        public function pull($content = '') {
@@ -150,16 +150,17 @@ final class t3lib_timeTrack {
        /**
         * Logs the TypoScript entry
         *
-        * @param       string          The message string
-        * @param       integer         Message type: 0: information, 1: message, 2: warning, 3: error
-        * @return      void
+        * @param string $content The message string
+        * @param integer $num Message type: 0: information, 1: message, 2: warning, 3: error
+        * @return void
         * @see tslib_cObj::CONTENT()
         */
        public function setTSlogMessage($content, $num = 0) {
                end($this->currentHashPointer);
                $k = current($this->currentHashPointer);
 
-               if (strlen($content) > 30) { // Enlarge the "details" column by adding a wide clear.gif
+                       // Enlarge the "details" column by adding a wide clear.gif
+               if (strlen($content) > 30) {
                        $placeholder = '<br /><img src="' . TYPO3_mainDir . 'clear.gif" width="300" height="1" alt="" />';
                }
                $this->tsStackLog[$k]['message'][] = $this->wrapIcon[$num] . $this->wrapError[$num][0] . htmlspecialchars($content) . $this->wrapError[$num][1] . $placeholder;
@@ -168,9 +169,9 @@ final class t3lib_timeTrack {
        /**
         * Set TSselectQuery - for messages in TypoScript debugger.
         *
-        * @param       array           Query array
-        * @param       string          Message/Label to attach
-        * @return      void
+        * @param array $data Query array
+        * @param string $msg Message/Label to attach
+        * @return void
         */
        public function setTSselectQuery(array $data, $msg = '') {
                end($this->currentHashPointer);
@@ -186,7 +187,7 @@ final class t3lib_timeTrack {
        /**
         * Increases the stack pointer
         *
-        * @return      void
+        * @return void
         * @see decStackPointer(), TSpagegen::renderContent(), tslib_cObj::cObjGetSingle()
         */
        public function incStackPointer() {
@@ -197,7 +198,7 @@ final class t3lib_timeTrack {
        /**
         * Decreases the stack pointer
         *
-        * @return      void
+        * @return void
         * @see incStackPointer(), TSpagegen::renderContent(), tslib_cObj::cObjGetSingle()
         */
        public function decStackPointer() {
@@ -208,8 +209,8 @@ final class t3lib_timeTrack {
        /**
         * Gets a microtime value as milliseconds value.
         *
-        * @param       float           $microtime: The microtime value - if not set the current time is used
-        * @return      integer         The microtime value as milliseconds value
+        * @param float $microtime The microtime value - if not set the current time is used
+        * @return integer The microtime value as milliseconds value
         */
        public function getMilliseconds($microtime = NULL) {
                if (!isset($microtime)) {
@@ -221,14 +222,13 @@ final class t3lib_timeTrack {
        /**
         * Gets the difference between a given microtime value and the starting time as milliseconds.
         *
-        * @param       float           $microtime: The microtime value - if not set the current time is used
-        * @return      integer         The difference between a given microtime value and starting time as milliseconds
+        * @param float $microtime The microtime value - if not set the current time is used
+        * @return integer The difference between a given microtime value and starting time as milliseconds
         */
        public function getDifferenceToStarttime($microtime = NULL) {
                return ($this->getMilliseconds($microtime) - $this->starttime);
        }
 
-
        /*******************************************
         *
         * Printing the parsing time information (for Admin Panel)
@@ -238,7 +238,7 @@ final class t3lib_timeTrack {
        /**
         * Print TypoScript parsing log
         *
-        * @return      string          HTML table with the information about parsing times.
+        * @return string HTML table with the information about parsing times.
         * @see t3lib_tsfeBeUserAuth::extGetCategory_tsdebug()
         */
        public function printTSlog() {
@@ -302,14 +302,14 @@ final class t3lib_timeTrack {
                        }
 
                        $item = '';
-                       if (!$c) { // If first...
+                               // If first...
+                       if (!$c) {
                                $data['icons'] = '';
                                $data['key'] = 'Script Start';
                                $data['value'] = '';
                        }
 
-
-                               // key label:
+                               // Key label:
                        $keyLabel = '';
                        if (!$flag_tree && $data['stackPointer']) {
                                $temp = array();
@@ -334,7 +334,7 @@ final class t3lib_timeTrack {
                        $keyLabel = $theLabel . $keyLabel;
                        $item .= '<td class="' . $logRowClass . '" style="padding-left:2px;">' . ($flag_tree ? $data['icons'] : '') . $this->fw($keyLabel) . '</td>';
 
-                               // key value:
+                               // Key value:
                        $keyValue = $data['value'];
                        $item .= '<td class="' . $logRowClass . ' typo3-adminPanel-tsLogTime">' . $this->fw(htmlspecialchars($keyValue)) . '</td>';
 
@@ -347,8 +347,7 @@ final class t3lib_timeTrack {
                                $item .= '<td class="' . $logRowClass . ' typo3-adminPanel-tsLogTime"> ' . $this->fw($data['owntime']) . '</td>';
                        }
 
-
-                               // messages:
+                               // Messages:
                        $msgArr = array();
                        $msg = '';
                        if ($flag_messages && is_array($data['message'])) {
@@ -361,7 +360,8 @@ final class t3lib_timeTrack {
                        }
                        if ($flag_content && strcmp($data['content'], '')) {
                                $maxlen = 120;
-                               if (preg_match_all('/(\S{' . $maxlen . ',})/', $data['content'], $reg)) { // Break lines which are too longer than $maxlen chars (can happen if content contains long paths...)
+                                       // Break lines which are too longer than $maxlen chars (can happen if content contains long paths...)
+                               if (preg_match_all('/(\S{' . $maxlen . ',})/', $data['content'], $reg)) {
                                        foreach ($reg[1] as $key => $match) {
                                                $match = preg_replace('/(.{' . $maxlen . '})/', '$1 ', $match);
                                                $data['content'] = str_replace($reg[0][$key], $match, $data['content']);
@@ -383,12 +383,12 @@ final class t3lib_timeTrack {
        /**
         * Recursively generates the content to display
         *
-        * @param       array           Array which is modified with content. Reference
-        * @param       string          Current content string for the level
-        * @param       string          Prefixed icons for new PM icons
-        * @param       boolean         Set this for the first call from outside.
-        * @param       string          Seems to be the previous tsStackLog key
-        * @return      string          Returns the $content string generated/modified. Also the $arr array is modified!
+        * @param array $arr Array which is modified with content. Reference
+        * @param string $content Current content string for the level
+        * @param string $depthData Prefixed icons for new PM icons
+        * @param boolean $first Set this for the first call from outside.
+        * @param string $vKey Seems to be the previous tsStackLog key
+        * @return string Returns the $content string generated/modified. Also the $arr array is modified!
         */
        protected function fixContent(&$arr, $content, $depthData = '', $first = 0, $vKey = '') {
                $ac = 0;
@@ -440,16 +440,16 @@ final class t3lib_timeTrack {
                                }
                        }
                }
-                       // return the content
+                       // Return the content
                return $content;
        }
 
        /**
         * Wraps the input content string in green colored span-tags IF the length o fthe input string exceeds $this->printConf['contentLength'] (or $this->printConf['contentLength_FILE'] if $v == "FILE"
         *
-        * @param       string          The content string
-        * @param       string          Command: If "FILE" then $this->printConf['contentLength_FILE'] is used for content length comparison, otherwise $this->printConf['contentLength']
-        * @return      string
+        * @param string $c The content string
+        * @param string $v Command: If "FILE" then $this->printConf['contentLength_FILE'] is used for content length comparison, otherwise $this->printConf['contentLength']
+        * @return string
         */
        protected function fixCLen($c, $v) {
                $len = $v == 'FILE' ? $this->printConf['contentLength_FILE'] : $this->printConf['contentLength'];
@@ -464,8 +464,8 @@ final class t3lib_timeTrack {
        /**
         * Wraps input string in a <span> tag with black verdana font
         *
-        * @param       string          The string to be wrapped
-        * @return      string
+        * @param string $str The string to be wrapped
+        * @return string
         */
        protected function fw($str) {
                return '<span style="font-family:Verdana,Arial,Helvetica,sans-serif; font-size:10px; color:black; vertical-align:top;">' . $str . '&nbsp;</span>';
@@ -474,10 +474,10 @@ final class t3lib_timeTrack {
        /**
         * Helper function for internal data manipulation
         *
-        * @param       array           Array (passed by reference) and modified
-        * @param       integer         Pointer value
-        * @param       string          Unique ID string
-        * @return      void
+        * @param array $arr Array (passed by reference) and modified
+        * @param integer $pointer Pointer value
+        * @param string $uniqueId Unique ID string
+        * @return void
         * @access private
         * @see printTSlog()
         */
index 1f12b6a..ad9326d 100644 (file)
@@ -27,7 +27,7 @@
  * A fake time tracker that does nothing but providing the methods of the real time tracker.
  * This is done to save some performance over the real time tracker.
  *
- * @author     Ingo Renner <ingo@typo3.org>
+ * @author Ingo Renner <ingo@typo3.org>
  * @package TYPO3
  * @subpackage t3lib
  */
@@ -38,7 +38,7 @@ final class t3lib_TimeTrackNull {
         *
         * does nothing
         *
-        * @return      void
+        * @return void
         */
        public function start() {
        }
@@ -48,9 +48,9 @@ final class t3lib_TimeTrackNull {
         *
         * does nothing
         *
-        * @param       string          Label string for the entry, eg. TypoScript property name
-        * @param       string          Additional value(?)
-        * @return      void
+        * @param string $tslabel Label string for the entry, eg. TypoScript property name
+        * @param string $value Additional value(?)
+        * @return void
         */
        public function push($tslabel, $value = '') {
        }
@@ -60,8 +60,8 @@ final class t3lib_TimeTrackNull {
         *
         * does nothing
         *
-        * @param       string          The content string generated within the push/pull part.
-        * @return      void
+        * @param string $content The content string generated within the push/pull part.
+        * @return void
         */
        public function pull($content = '') {
        }
@@ -71,9 +71,9 @@ final class t3lib_TimeTrackNull {
         *
         * does nothing
         *
-        * @param       array           Query array
-        * @param       string          Message/Label to attach
-        * @return      void
+        * @param array $data Query array
+        * @param string $msg Message/Label to attach
+        * @return void
         */
        public function setTSselectQuery(array $data, $msg = '') {
        }
@@ -83,9 +83,9 @@ final class t3lib_TimeTrackNull {
         *
         * does nothing
         *
-        * @param       string          The message string
-        * @param       integer         Message type: 0: information, 1: message, 2: warning, 3: error
-        * @return      void
+        * @param string $content The message string
+        * @param integer $num Message type: 0: information, 1: message, 2: warning, 3: error
+        * @return void
         */
        public function setTSlogMessage($content, $num = 0) {
        }
@@ -95,7 +95,7 @@ final class t3lib_TimeTrackNull {
         *
         * does nothing
         *
-        * @return      string          HTML table with the information about parsing times.
+        * @return string HTML table with the information about parsing times.
         */
        public function printTSlog() {
        }
@@ -105,7 +105,7 @@ final class t3lib_TimeTrackNull {
         *
         * does nothing
         *
-        * @return      void
+        * @return void
         */
        public function incStackPointer() {
        }
@@ -115,7 +115,7 @@ final class t3lib_TimeTrackNull {
         *
         * does nothing
         *
-        * @return      void
+        * @return void
         */
        public function decStackPointer() {
        }
@@ -123,12 +123,11 @@ final class t3lib_TimeTrackNull {
        /**
         * Gets a microtime value as milliseconds value.
         *
-        * @param       float           $microtime: The microtime value - if not set the current time is used
-        * @return      integer         The microtime value as milliseconds value
+        * @param float $microtime The microtime value - if not set the current time is used
+        * @return integer The microtime value as milliseconds value
         */
        public function getMilliseconds($microtime = NULL) {
        }
-
 }
 
 ?>
\ No newline at end of file
index a3b0c4b..05ea051 100644 (file)
  *
  * Revised for TYPO3 3.6 September/2003 by Kasper Skårhøj
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  */
 
-
 /**
  * Class for getting and transforming data for display in backend forms (TCEforms)
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  * @package TYPO3
  * @subpackage t3lib
  */
 class t3lib_transferData {
                // External, static:
-       var $lockRecords = 0; // If set, the records requested are locked.
-       var $disableRTE = 0; // Is set externally if RTE is disabled.
-       var $prevPageID = ''; // If the pid in the command is 'prev' then $prevPageID is used as pid for the record. This is used to attach new records to other previous records eg. new pages.
-       var $defVals = array(); // Can be set with an array of default values for tables. First key is table name, second level keys are field names. Originally this was a GLOBAL array used internally.
-       var $addRawData = FALSE; // If set, the processed data is overlaid the raw record.
+               // If set, the records requested are locked.
+       var $lockRecords = 0;
+               // Is set externally if RTE is disabled.
+       var $disableRTE = 0;
+               // If the pid in the command is 'prev' then $prevPageID is used as pid for the record. This is used to attach new records to other previous records eg. new pages.
+       var $prevPageID = '';
+               // Can be set with an array of default values for tables. First key is table name, second level keys are field names. Originally this was a GLOBAL array used internally.
+       var $defVals = array();
+               // If set, the processed data is overlaid the raw record.
+       var $addRawData = FALSE;
 
                // Internal, dynamic
-       var $regTableItems = array(); // Used to register, which items are already loaded!!
-       var $regTableItems_data = array(); // This stores the record data of the loaded records
-       var $loadModules = ''; // Contains loadModules object, if used. (for reuse internally)
-
+               // Used to register, which items are already loaded!!
+       var $regTableItems = array();
+               // This stores the record data of the loaded records
+       var $regTableItems_data = array();
+               // Contains loadModules object, if used. (for reuse internally)
+       var $loadModules = '';
 
        /***********************************************
         *
@@ -65,10 +71,10 @@ class t3lib_transferData {
         * The function is also used to produce proper default data for new records
         * Ultimately the function will call renderRecord()
         *
-        * @param       string          Table name, must be found in $GLOBALS['TCA']
-        * @param       string          Comma list of id values. If $idList is "prev" then the value from $this->prevPageID is used. NOTICE: If $operation is "new", then negative ids are meant to point to a "previous" record and positive ids are PID values for new records. Otherwise (for existing records that is) it is straight forward table/id pairs.
-        * @param       string          If "new", then a record with default data is returned. Further, the $id values are meant to be PID values (or if negative, pointing to a previous record). If NOT new, then the table/ids are just pointing to an existing record!
-        * @return      void
+        * @param string $table Table name, must be found in $GLOBALS['TCA']
+        * @param string $idList Comma list of id values. If $idList is "prev" then the value from $this->prevPageID is used. NOTICE: If $operation is "new", then negative ids are meant to point to a "previous" record and positive ids are PID values for new records. Otherwise (for existing records that is) it is straight forward table/id pairs.
+        * @param string $operation If "new", then a record with default data is returned. Further, the $id values are meant to be PID values (or if negative, pointing to a previous record). If NOT new, then the table/ids are just pointing to an existing record!
+        * @return void
         * @see renderRecord()
         */
        function fetchRecord($table, $idList, $operation) {
@@ -82,13 +88,15 @@ class t3lib_transferData {
                                // For each ID value (integer) we
                        $ids = t3lib_div::trimExplode(',', $idList, 1);
                        foreach ($ids as $id) {
-                               if (strcmp($id, '')) { // If ID is not blank:
+                                       // If ID is not blank:
+                               if (strcmp($id, '')) {
 
                                                // For new records to be created, find default values:
                                        if ($operation == 'new') {
 
                                                        // Default values:
-                                               $newRow = array(); // Used to store default values as found here:
+                                                       // Used to store default values as found here:
+                                               $newRow = array();
 
                                                        // Default values as set in userTS:
                                                $TCAdefaultOverride = $GLOBALS['BE_USER']->getTSConfigProp('TCAdefaults');
@@ -172,11 +180,11 @@ class t3lib_transferData {
         * Default values from outside/TSconfig is added by fetchRecord(). In this function default values from TCA is used if a field is NOT defined in $row.
         * The resulting, processed row is stored in $this->regTableItems_data[$uniqueItemRef], where $uniqueItemRef is "[tablename]_[id-value]"
         *
-        * @param       string          The table name
-        * @param       string          The uid value of the record (integer). Can also be a string (NEW-something) if the record is a NEW record.
-        * @param       integer         The pid integer. For existing records this is of course the row's "pid" field. For new records it can be either a page id (positive) or a pointer to another record from the SAME table (negative) after which the record should be inserted (or on same page)
-        * @param       array           The row of the current record. If NEW record, then it may be loaded with default values (by eg. fetchRecord()).
-        * @return      void
+        * @param string $table The table name
+        * @param string $id The uid value of the record (integer). Can also be a string (NEW-something) if the record is a NEW record.
+        * @param integer $pid The pid integer. For existing records this is of course the row's "pid" field. For new records it can be either a page id (positive) or a pointer to another record from the SAME table (negative) after which the record should be inserted (or on same page)
+        * @param array $row The row of the current record. If NEW record, then it may be loaded with default values (by eg. fetchRecord()).
+        * @return void
         * @see fetchRecord()
         */
        function renderRecord($table, $id, $pid, $row) {
@@ -214,13 +222,13 @@ class t3lib_transferData {
         * In opposite to renderRecord() this function do not prepare things like fetching TSconfig and others.
         * The resulting, processed row will be returned.
         *
-        * @param       string          The table name
-        * @param       string          The uid value of the record (integer). Can also be a string (NEW-something) if the record is a NEW record.
-        * @param       integer         The pid integer. For existing records this is of course the row's "pid" field. For new records it can be either a page id (positive) or a pointer to another record from the SAME table (negative) after which the record should be inserted (or on same page)
-        * @param       array           The row of the current record. If NEW record, then it may be loaded with default values (by eg. fetchRecord()).
-        * @param       array           Tsconfig array
-        * @param       integer         PAGE TSconfig pid
-        * @return      array           Processed record data
+        * @param string $table The table name
+        * @param string $id The uid value of the record (integer). Can also be a string (NEW-something) if the record is a NEW record.
+        * @param integer $pid The pid integer. For existing records this is of course the row's "pid" field. For new records it can be either a page id (positive) or a pointer to another record from the SAME table (negative) after which the record should be inserted (or on same page)
+        * @param array $row The row of the current record. If NEW record, then it may be loaded with default values (by eg. fetchRecord()).
+        * @param array $TSconfig Tsconfig array
+        * @param integer $tscPID PAGE TSconfig pid
+        * @return array Processed record data
         * @see renderRecord()
         */
        function renderRecordRaw($table, $id, $pid, $row, $TSconfig = '', $tscPID = 0) {
@@ -271,13 +279,13 @@ class t3lib_transferData {
        /**
         * Function with the switch() construct which triggers functions for processing of the data value depending on the TCA-config field type.
         *
-        * @param       string          Value to process
-        * @param       array           TCA/columns array for field     (independant of TCA for flexforms - coming from XML then)
-        * @param       array           TSconfig        (blank for flexforms for now)
-        * @param       string          Table name
-        * @param       array           The row array, always of the real record (also for flexforms)
-        * @param       string          The field (empty for flexforms!)
-        * @return      string          Modified $value
+        * @param string $data Value to process
+        * @param array $fieldConfig TCA/columns array for field        (independant of TCA for flexforms - coming from XML then)
+        * @param array $TSconfig TSconfig      (blank for flexforms for now)
+        * @param string $table Table name
+        * @param array $row The row array, always of the real record (also for flexforms)
+        * @param string $field The field (empty for flexforms!)
+        * @return string Modified $value
         */
        function renderRecord_SW($data, $fieldConfig, $TSconfig, $table, $row, $field) {
                switch ((string) $fieldConfig['config']['type']) {
@@ -301,13 +309,13 @@ class t3lib_transferData {
        /**
         * Processing of the data value in case the field type is "group"
         *
-        * @param       string          The field value
-        * @param       array           TCA field config
-        * @param       array           TCEform TSconfig for the record
-        * @param       string          Table name
-        * @param       array           The row
-        * @param       string          Field name
-        * @return      string          The processed input field value ($data)
+        * @param string $data The field value
+        * @param array $fieldConfig TCA field config
+        * @param array $TSconfig TCEform TSconfig for the record
+        * @param string $table Table name
+        * @param array $row The row
+        * @param string $field Field name
+        * @return string The processed input field value ($data)
         * @access private
         * @see renderRecord()
         */
@@ -340,7 +348,7 @@ class t3lib_transferData {
                        break;
                        case 'db':
                                $loadDB = t3lib_div::makeInstance('t3lib_loadDBGroup');
-                               /* @var $loadDB t3lib_loadDBGroup */
+                               /** @var $loadDB t3lib_loadDBGroup */
                                $loadDB->start($data, $fieldConfig['config']['allowed'], $fieldConfig['config']['MM'], $row['uid'], $table, $fieldConfig['config']);
                                $loadDB->getFromDB();
                                $data = $loadDB->readyForInterface();
@@ -353,21 +361,23 @@ class t3lib_transferData {
        /**
         * Processing of the data value in case the field type is "select"
         *
-        * @param       string          The field value
-        * @param       array           TCA field config
-        * @param       array           TCEform TSconfig for the record
-        * @param       string          Table name
-        * @param       array           The row
-        * @param       string          Field name
-        * @return      string          The processed input field value ($data)
+        * @param string $data The field value
+        * @param array $fieldConfig TCA field config
+        * @param array $TSconfig TCEform TSconfig for the record
+        * @param string $table Table name
+        * @param array $row The row
+        * @param string $field Field name
+        * @return string The processed input field value ($data)
         * @access private
         * @see renderRecord()
         */
        function renderRecord_selectProc($data, $fieldConfig, $TSconfig, $table, $row, $field) {
 
                        // Initialize:
-               $elements = t3lib_div::trimExplode(',', $data, 1); // Current data set.
-               $dataAcc = array(); // New data set, ready for interface (list of values, rawurlencoded)
+                       // Current data set.
+               $elements = t3lib_div::trimExplode(',', $data, 1);
+                       // New data set, ready for interface (list of values, rawurlencoded)
+               $dataAcc = array();
 
                        // For list selectors (multi-value):
                if (intval($fieldConfig['config']['maxitems']) > 1) {
@@ -418,13 +428,13 @@ class t3lib_transferData {
         * Processing of the data value in case the field type is "flex"
         * MUST NOT be called in case of already INSIDE a flexform!
         *
-        * @param       string          The field value
-        * @param       array           TCA field config
-        * @param       array           TCEform TSconfig for the record
-        * @param       string          Table name
-        * @param       array           The row
-        * @param       string          Field name
-        * @return      string          The processed input field value ($data)
+        * @param string $data The field value
+        * @param array $fieldConfig CA field config
+        * @param array $TSconfig TCEform TSconfig for the record
+        * @param string $table Table name
+        * @param array $row The row
+        * @param string $field Field name
+        * @return string The processed input field value ($data)
         * @access private
         * @see renderRecord()
         */
@@ -458,12 +468,12 @@ class t3lib_transferData {
        /**
         * Processing of the content in $totalRecordcontent based on settings in the types-configuration
         *
-        * @param       array           The array of values which has been processed according to their type (eg. "group" or "select")
-        * @param       array           The "types" configuration for the current display of fields.
-        * @param       integer         PAGE TSconfig PID
-        * @param       string          Table name
-        * @param       integer         PID value
-        * @return      array           The processed version of $totalRecordContent
+        * @param array $totalRecordContent The array of values which has been processed according to their type (eg. "group" or "select")
+        * @param array $types_fieldConfig The "types" configuration for the current display of fields.
+        * @param integer $tscPID PAGE TSconfig PID
+        * @param string $table Table name
+        * @param integer $pid PID value
+        * @return array The processed version of $totalRecordContent
         * @access private
         */
        function renderRecord_typesProc($totalRecordContent, $types_fieldConfig, $tscPID, $table, $pid) {
@@ -497,21 +507,23 @@ class t3lib_transferData {
         * Processing of the data value in case the field type is "inline"
         * In some parts nearly the same as type "select"
         *
-        * @param       string          The field value
-        * @param       array           TCA field config
-        * @param       array           TCEform TSconfig for the record
-        * @param       string          Table name
-        * @param       array           The row
-        * @param       string          Field name
-        * @return      string          The processed input field value ($data)
+        * @param string $data The field value
+        * @param array $fieldConfig TCA field config
+        * @param array $TSconfig TCEform TSconfig for the record
+        * @param string $table Table name
+        * @param array $row The row
+        * @param string $field Field name
+        * @return string The processed input field value ($data)
         * @access private
         * @see renderRecord()
         */
        function renderRecord_inlineProc($data, $fieldConfig, $TSconfig, $table, $row, $field) {
 
                        // Initialize:
-               $elements = t3lib_div::trimExplode(',', $data); // Current data set.
-               $dataAcc = array(); // New data set, ready for interface (list of values, rawurlencoded)
+                       // Current data set.
+               $elements = t3lib_div::trimExplode(',', $data);
+                       // New data set, ready for interface (list of values, rawurlencoded)
+               $dataAcc = array();
 
                        // At this point all records that CAN be selected is found in $recordList
                        // Now, get the data from loadDBgroup based on the input list of values.
@@ -533,7 +545,6 @@ class t3lib_transferData {
                return implode(',', $dataAcc);
        }
 
-
        /***********************************************
         *
         * FlexForm processing functions
@@ -543,10 +554,10 @@ class t3lib_transferData {
        /**
         * Function traversing sheets/languages for flex form data structures
         *
-        * @param       array           Data array
-        * @param       array           Data Structure array
-        * @param       array           Various parameters to pass-through
-        * @return      array           Modified $dataPart array.
+        * @param array $dataPart Data array
+        * @param array $dataStructArray Data Structure array
+        * @param array $pParams Various parameters to pass-through
+        * @return array Modified $dataPart array.
         * @access private
         * @see t3lib_TCEmain::checkValue_flex_procInData(), renderRecord_flexProc_procInData_travDS()
         */
@@ -573,10 +584,10 @@ class t3lib_transferData {
        /**
         * Traverse data array / structure
         *
-        * @param       array           Data array passed by reference.
-        * @param       array           Data structure
-        * @param       array           Various parameters pass-through.
-        * @return      void
+        * @param array $dataValues Data array passed by reference.
+        * @param array $DSelements Data structure
+        * @param array $pParams Various parameters pass-through.
+        * @return void
         * @see renderRecord_flexProc_procInData(), t3lib_TCEmain::checkValue_flex_procInData_travDS()
         */
        function renderRecord_flexProc_procInData_travDS(&$dataValues, $DSelements, $pParams) {
@@ -633,7 +644,6 @@ class t3lib_transferData {
                }
        }
 
-
        /***********************************************
         *
         * Selector box processing functions
@@ -643,10 +653,10 @@ class t3lib_transferData {
        /**
         * Adding "special" types to the $dataAcc array of selector items
         *
-        * @param       array           Array with numeric keys, containing values for the selector box, prepared for interface. We are going to add elements to this array as needed.
-        * @param       array           The array of original elements - basically the field value exploded by ","
-        * @param       string          The "special" key from the TCA config of the field. Determines the type of processing in here.
-        * @return      array           Modified $dataAcc array
+        * @param array $dataAcc Array with numeric keys, containing values for the selector box, prepared for interface. We are going to add elements to this array as needed.
+        * @param array $elements The array of original elements - basically the field value exploded by ","
+        * @param string $specialKey The "special" key from the TCA config of the field. Determines the type of processing in here.
+        * @return array Modified $dataAcc array
         * @access private
         * @see renderRecord_selectProc()
         */
@@ -654,7 +664,8 @@ class t3lib_transferData {
 
                        // Special select types:
                switch ((string) $specialKey) {
-                       case 'tables': // Listing all tables from $GLOBALS['TCA']:
+                               // Listing all tables from $GLOBALS['TCA']:
+                       case 'tables':
                                $tNames = array_keys($GLOBALS['TCA']);
                                foreach ($tNames as $tableName) {
                                        foreach ($elements as $eKey => $value) {
@@ -664,7 +675,8 @@ class t3lib_transferData {
                                        }
                                }
                        break;
-                       case 'pagetypes': // Listing all page types (doktype)
+                               // Listing all page types (doktype)
+                       case 'pagetypes':
                                $theTypes = $GLOBALS['TCA']['pages']['columns']['doktype']['config']['items'];
                                if (is_array($theTypes)) {
                                        foreach ($theTypes as $theTypesArrays) {
@@ -676,7 +688,8 @@ class t3lib_transferData {
                                        }
                                }
                        break;
-                       case 'exclude': // Listing exclude fields.
+                               // Listing exclude fields.
+                       case 'exclude':
                                $theExcludeFields = t3lib_BEfunc::getExcludeFields();
 
                                if (is_array($theExcludeFields)) {
@@ -732,8 +745,10 @@ class t3lib_transferData {
                                        }
                                }
                        break;
-                       case 'modListGroup': // Listing modules for GROUPS
-                       case 'modListUser': // Listing modules for USERS:
+                               // Listing modules for GROUPS
+                       case 'modListGroup':
+                               // Listing modules for USERS:
+                       case 'modListUser':
                                if (!$this->loadModules) {
                                        $this->loadModules = t3lib_div::makeInstance('t3lib_loadModules');
                                        $this->loadModules->load($GLOBALS['TBE_MODULES']);
@@ -765,14 +780,14 @@ class t3lib_transferData {
        /**
         * Adds the foreign record elements to $dataAcc, if any
         *
-        * @param       array           Array with numeric keys, containing values for the selector box, prepared for interface. We are going to add elements to this array as needed.
-        * @param       array           The array of original elements - basically the field value exploded by ","
-        * @param       array           Field configuration from TCA
-        * @param       string          The field name
-        * @param       array           TSconfig for the record
-        * @param       array           The record
-        * @param       array           The current table
-        * @return      array           Modified $dataAcc array
+        * @param array $dataAcc Array with numeric keys, containing values for the selector box, prepared for interface. We are going to add elements to this array as needed.
+        * @param array $elements The array of original elements - basically the field value exploded by ","
+        * @param array $fieldConfig Field configuration from TCA
+        * @param string $field The field name
+        * @param array $TSconfig TSconfig for the record
+        * @param array $row The record
+        * @param array $table The current table
+        * @return array Modified $dataAcc array
         * @access private
         * @see renderRecord_selectProc()
         */
@@ -781,7 +796,7 @@ class t3lib_transferData {
                        // Init:
                $recordList = array();
 
-                       // foreign_table
+                       // Foreign_table
                $subres = t3lib_BEfunc::exec_foreign_table_where_query($fieldConfig, $field, $TSconfig);
                while ($subrow = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($subres)) {
                        $recordList[$subrow['uid']] = t3lib_BEfunc::getRecordTitle($fieldConfig['config']['foreign_table'], $subrow);
@@ -824,11 +839,11 @@ class t3lib_transferData {
        /**
         * Returning the id-list processed by loadDBgroup for the foreign tables.
         *
-        * @param       array           The array of original elements - basically the field value exploded by ","
-        * @param       array           Field configuration from TCA
-        * @param       array           The data array, currently. Used to set the "local_uid" for selecting MM relation records.
-        * @param       string          Current table name. passed on to t3lib_loadDBGroup
-        * @return      array           An array with ids of the records from the input elements array.
+        * @param array $elements The array of original elements - basically the field value exploded by ","
+        * @param array $fieldConfig Field configuration from TCA
+        * @param array $row The data array, currently. Used to set the "local_uid" for selecting MM relation records.
+        * @param string $table Current table name. passed on to t3lib_loadDBGroup
+        * @return array An array with ids of the records from the input elements array.
         * @access private
         */
        function getDataIdList($elements, $fieldConfig, $row, $table) {
@@ -850,13 +865,13 @@ class t3lib_transferData {
        /**
         * Processing of selector box items. This includes the automated adding of elements plus user-function processing.
         *
-        * @param       array           The elements to process
-        * @param       array           TCA/columns configuration
-        * @param       array           TSconfig for the field
-        * @param       string          The table name
-        * @param       array           The current row
-        * @param       string          The field name
-        * @return      array           The modified input $selItems array
+        * @param array The elements to process
+        * @param array TCA/columns configuration
+        * @param array TSconfig for the field
+        * @param string The table name
+        * @param array The current row
+        * @param string The field name
+        * @return array The modified input $selItems array
         * @access private
         * @see renderRecord_selectProc()
         */
@@ -871,9 +886,9 @@ class t3lib_transferData {
        /**
         * Adding items from $iArray to $items array
         *
-        * @param       array           The array of selector box items to which key(value) / value(label) pairs from $iArray will be added.
-        * @param       array           The array of elements to add. The keys will become values. The value will become the label.
-        * @return      array           The modified input $items array
+        * @param array $items The array of selector box items to which key(value) / value(label) pairs from $iArray will be added.
+        * @param array $iArray The array of elements to add. The keys will become values. The value will become the label.
+        * @return array The modified input $items array
         * @access private
         * @see procesItemArray()
         */
@@ -889,13 +904,13 @@ class t3lib_transferData {
        /**
         * User processing of a selector box array of values.
         *
-        * @param       array           The array of selector box items
-        * @param       array           TSconfig for the fields itemProcFunc
-        * @param       array           TCA/columns configuration
-        * @param       string          The table name
-        * @param       array           The current row
-        * @param       string          The field name
-        * @return      array           The modified input $items array
+        * @param array $items The array of selector box items
+        * @param array $itemsProcFuncTSconfig TSconfig for the fields itemProcFunc
+        * @param array $config TCA/columns configuration
+        * @param string $table The table name
+        * @param array $row The current row
+        * @param string $field The field name
+        * @return array The modified input $items array
         * @access private
         * @see procesItemArray()
         */
@@ -912,7 +927,6 @@ class t3lib_transferData {
                return $items;
        }
 
-
        /***********************************************
         *
         * Helper functions
@@ -922,10 +936,10 @@ class t3lib_transferData {
        /**
         * Sets the lock for a record from table/id, IF $this->lockRecords is set!
         *
-        * @param       string          The table name
-        * @param       integer         The id of the record
-        * @param       integer         The pid of the record
-        * @return      void
+        * @param string $table The table name
+        * @param integer $id The id of the record
+        * @param integer $pid The pid of the record
+        * @return void
         */
        function lockRecord($table, $id, $pid = 0) {
                if ($this->lockRecords) {
@@ -936,11 +950,11 @@ class t3lib_transferData {
        /**
         * Dummy function, can be used to "register" records. Used by eg. the "show_item" script.
         *
-        * @param       string          Table name
-        * @param       integer         Record id
-        * @param       string          Field name
-        * @param       string          Field content.
-        * @return      void
+        * @param string $table Table name
+        * @param integer $id Record id
+        * @param string $field Field name
+        * @param string $content Field content.
+        * @return void
         * @access private
         * @see renderRecord()
         */
@@ -950,8 +964,8 @@ class t3lib_transferData {
        /**
         * Local wrapper function for LANG->sL (returning language labels)
         *
-        * @param       string          Language label key
-        * @return      string          Localized label value.
+        * @param string Language label key
+        * @return string Localized label value.
         * @access private
         */
        function sL($in) {
index af40d22..2ca3cdf 100644 (file)
 /**
  * Contains translation tools
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  */
 
-
 /**
  * Contains translation tools
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  * @package TYPO3
  * @subpackage t3lib
  */
@@ -48,9 +47,9 @@ class t3lib_transl8tools {
         * t3lib_iconWorks::getSpriteIcon(<flags-xx>) to get an HTML which will represent
         * the flag of this language.
         *
-        * @param       integer         page id (only used to get TSconfig configuration setting flag and label for default language)
-        * @param       string          Backpath for flags
-        * @return      array           Array with languages (title, uid, flagIcon)
+        * @param integer $page_id Page id (only used to get TSconfig configuration setting flag and label for default language)
+        * @param string $backPath Backpath for flags
+        * @return array Array with languages (title, uid, flagIcon)
         */
        function getSystemLanguages($page_id = 0, $backPath = '') {
                $modSharedTSconfig = t3lib_BEfunc::getModTSconfig($page_id, 'mod.SHARED');
@@ -103,12 +102,12 @@ class t3lib_transl8tools {
         * Information about translation for an element
         * Will overlay workspace version of record too!
         *
-        * @param       string          Table name
-        * @param       integer         Record uid
-        * @param       integer         Language uid. If zero, then all languages are selected.
-        * @param       array           The record to be translated
-        * @param       array           select fields for the query which fetches the translations of the current record
-        * @return      array           Array with information. Errors will return string with message.
+        * @param string $table Table name
+        * @param integer $uid Record uid
+        * @param integer $sys_language_uid Language uid. If zero, then all languages are selected.
+        * @param array $row The record to be translated
+        * @param array $selFieldList Select fields for the query which fetches the translations of the current record
+        * @return array Array with information. Errors will return string with message.
         */
        function translationInfo($table, $uid, $sys_language_uid = 0, $row = NULL, $selFieldList = '') {
                if ($GLOBALS['TCA'][$table] && $uid) {
@@ -174,8 +173,8 @@ class t3lib_transl8tools {
        /**
         * Returns the table in which translations for input table is found.
         *
-        * @param       [type]          $table: ...
-        * @return      [type]          ...
+        * @param string $table The table name
+        * @return boolean
         */
        function getTranslationTable($table) {
                return $this->isTranslationInOwnTable($table) ? $table : $this->foreignTranslationTable($table);
@@ -184,8 +183,8 @@ class t3lib_transl8tools {
        /**
         * Returns TRUE, if the input table has localization enabled and done so with records from the same table
         *
-        * @param       [type]          $table: ...
-        * @return      [type]          ...
+        * @param string $table The table name
+        * @return boolean
         */
        function isTranslationInOwnTable($table) {
                return $GLOBALS['TCA'][$table]['ctrl']['languageField']
@@ -196,8 +195,8 @@ class t3lib_transl8tools {
        /**
         * Returns foreign translation table, if any
         *
-        * @param       [type]          $table: ...
-        * @return      [type]          ...
+        * @param string $table The table name
+        * @return string Translation foreign table
         */
        function foreignTranslationTable($table) {
                $trTable = $GLOBALS['TCA'][$table]['ctrl']['transForeignTable'];