[TASK] Clean up phpDoc comments in t3lib classes
authorWouter Wolters <typo3@wouterwolters.nl>
Thu, 17 May 2012 11:13:35 +0000 (13:13 +0200)
committerChristian Kuhn <lolli@schwarzbu.ch>
Thu, 17 May 2012 17:22:05 +0000 (19:22 +0200)
Clean up phpDoc comments for the following classes:

* t3lib/class.t3lib_parsehtml_proc.php
* t3lib/class.t3lib_positionmap.php
* t3lib/class.t3lib_querygenerator.php
* t3lib/class.t3lib_readmail.php
* t3lib/class.t3lib_recordlist.php
* t3lib/class.t3lib_registry.php
* t3lib/class.t3lib_rteapi.php

Clean up provides:

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

Change-Id: I42a5b48a8eda5d77605a963ba8168d1d4342fa5f
Resolves: #37252
Releases: 6.0
Reviewed-on: http://review.typo3.org/11271
Reviewed-by: Oliver Klee
Reviewed-by: Christian Kuhn
Tested-by: Christian Kuhn
t3lib/class.t3lib_parsehtml_proc.php
t3lib/class.t3lib_positionmap.php
t3lib/class.t3lib_querygenerator.php
t3lib/class.t3lib_readmail.php
t3lib/class.t3lib_recordlist.php
t3lib/class.t3lib_registry.php
t3lib/class.t3lib_rteapi.php

index 7e78f85..b442508 100644 (file)
  * Revised for TYPO3 3.6 December/2003 by Kasper Skårhøj
  * XHTML compatible.
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  * @internal
  */
 
-
 /**
  * Class for parsing HTML for the Rich Text Editor. (also called transformations)
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  * @package TYPO3
  * @subpackage t3lib
  */
@@ -47,27 +46,37 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
        var $blockElementList = 'PRE,UL,OL,H1,H2,H3,H4,H5,H6,ADDRESS,DL,DD,HEADER,SECTION,FOOTER,NAV,ARTICLE,ASIDE'; // List of tags for these elements
 
                // Internal, static:
-       var $recPid = 0; // Set this to the pid of the record manipulated by the class.
-       var $elRef = ''; // Element reference [table]:[field], eg. "tt_content:bodytext"
-       var $relPath = ''; // Relative path
-       var $relBackPath = ''; // Relative back-path
-       public $tsConfig = array(); // Current Page TSConfig
-       var $procOptions = ''; // Set to the TSconfig options coming from Page TSconfig
+               // Set this to the pid of the record manipulated by the class.
+       var $recPid = 0;
+               // Element reference [table]:[field], eg. "tt_content:bodytext"
+       var $elRef = '';
+               // Relative path
+       var $relPath = '';
+               // Relative back-path
+       var $relBackPath = '';
+               // Current Page TSConfig
+       public $tsConfig = array();
+               // Set to the TSconfig options coming from Page TSconfig
+       var $procOptions = '';
 
                // Internal, dynamic
-       var $TS_transform_db_safecounter = 100; // Run-away brake for recursive calls.
-       var $rte_p = ''; // Parameters from TCA types configuration related to the RTE
-       var $getKeepTags_cache = array(); // Data caching for processing function
-       var $allowedClasses = array(); // Storage of the allowed CSS class names in the RTE
-       var $preserveTags = ''; // Set to tags to preserve from Page TSconfig configuration
-
+               // Run-away brake for recursive calls.
+       var $TS_transform_db_safecounter = 100;
+               // Parameters from TCA types configuration related to the RTE
+       var $rte_p = '';
+               // Data caching for processing function
+       var $getKeepTags_cache = array();
+               // Storage of the allowed CSS class names in the RTE
+       var $allowedClasses = array();
+               // Set to tags to preserve from Page TSconfig configuration
+       var $preserveTags = '';
 
        /**
         * Initialize, setting element reference and record PID
         *
-        * @param       string          Element reference, eg "tt_content:bodytext"
-        * @param       integer         PID of the record (page id)
-        * @return      void
+        * @param string $elRef Element reference, eg "tt_content:bodytext"
+        * @param integer $recPid PID of the record (page id)
+        * @return void
         */
        function init($elRef = '', $recPid = 0) {
                $this->recPid = $recPid;
@@ -78,8 +87,8 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
         * Setting the ->relPath and ->relBackPath to proper values so absolute references to links and images can be converted to relative dittos.
         * This is used when editing files with the RTE
         *
-        * @param       string          The relative path from PATH_site to the place where the file being edited is. Eg. "fileadmin/static".
-        * @return      void            There is no output, it is set in internal variables. With the above example of "fileadmin/static" as input this will yield ->relPath to be "fileadmin/static/" and ->relBackPath to be "../../"
+        * @param string $path The relative path from PATH_site to the place where the file being edited is. Eg. "fileadmin/static".
+        * @return void There is no output, it is set in internal variables. With the above example of "fileadmin/static" as input this will yield ->relPath to be "fileadmin/static/" and ->relBackPath to be "../../"
         */
        function setRelPath($path) {
                $path = trim($path);
@@ -100,9 +109,9 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
         * Evaluate the environment for editing a staticFileEdit file.
         * Called for almost all fields being saved in the database. Is called without an instance of the object: t3lib_parsehtml_proc::evalWriteFile()
         *
-        * @param       array           Parameters for the current field as found in types-config
-        * @param       array           Current record we are editing.
-        * @return      mixed           On success an array with various information is returned, otherwise a string with an error message
+        * @param array $pArr Parameters for the current field as found in types-config
+        * @param array $currentRecord Current record we are editing.
+        * @return mixed On success an array with various information is returned, otherwise a string with an error message
         * @see t3lib_TCEmain, t3lib_transferData
         */
        public static function evalWriteFile($pArr, $currentRecord) {
@@ -140,7 +149,6 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
                }
        }
 
-
        /**********************************************
         *
         * Main function
@@ -151,11 +159,11 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
         * Transform value for RTE based on specConf in the direction specified by $direction (rte/db)
         * This is the main function called from tcemain and transfer data classes
         *
-        * @param       string          Input value
-        * @param       array           Special configuration for a field; This is coming from the types-configuration of the field in the TCA. In the types-configuration you can setup features for the field rendering and in particular the RTE takes al its major configuration options from there!
-        * @param       string          Direction of the transformation. Two keywords are allowed; "db" or "rte". If "db" it means the transformation will clean up content coming from the Rich Text Editor and goes into the database. The other direction, "rte", is of course when content is coming from database and must be transformed to fit the RTE.
-        * @param       array           Parsed TypoScript content configuring the RTE, probably coming from Page TSconfig.
-        * @return      string          Output value
+        * @param string Input value
+        * @param array Special configuration for a field; This is coming from the types-configuration of the field in the TCA. In the types-configuration you can setup features for the field rendering and in particular the RTE takes al its major configuration options from there!
+        * @param string Direction of the transformation. Two keywords are allowed; "db" or "rte". If "db" it means the transformation will clean up content coming from the Rich Text Editor and goes into the database. The other direction, "rte", is of course when content is coming from database and must be transformed to fit the RTE.
+        * @param array Parsed TypoScript content configuring the RTE, probably coming from Page TSconfig.
+        * @return string Output value
         * @see t3lib_TCEmain::fillInFieldArray(), t3lib_transferData::renderRecord_typesProc()
         */
        function RTE_transform($value, $specConf, $direction = 'rte', $thisConfig = array()) {
@@ -238,7 +246,8 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
                                                break;
                                                case 'ts_transform':
                                                case 'css_transform':
-                                                       $value = str_replace(CR, '', $value); // Has a very disturbing effect, so just remove all '13' - depend on '10'
+                                                               // Has a very disturbing effect, so just remove all '13' - depend on '10'
+                                                       $value = str_replace(CR, '', $value);
                                                        $this->allowedClasses = t3lib_div::trimExplode(',', $this->procOptions['allowedClasses'], 1);
                                                        $value = $this->TS_transform_db($value, $cmd == 'css_transform');
                                                break;
@@ -273,7 +282,8 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
                                                break;
                                                case 'ts_transform':
                                                case 'css_transform':
-                                                       $value = str_replace(CR, '', $value); // Has a very disturbing effect, so just remove all '13' - depend on '10'
+                                                               // Has a very disturbing effect, so just remove all '13' - depend on '10'
+                                                       $value = str_replace(CR, '', $value);
                                                        $value = $this->TS_transform_rte($value, $cmd == 'css_transform');
                                                break;
                                                default:
@@ -290,15 +300,16 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
 
                        // Final clean up of linebreaks:
                if (!$this->procOptions['disableUnifyLineBreaks']) {
-                       $value = str_replace(CRLF, LF, $value); // Make sure no \r\n sequences has entered in the meantime...
-                       $value = str_replace(LF, CRLF, $value); // ... and then change all \n into \r\n
+                               // Make sure no \r\n sequences has entered in the meantime...
+                       $value = str_replace(CRLF, LF, $value);
+                               // ... and then change all \n into \r\n
+                       $value = str_replace(LF, CRLF, $value);
                }
 
                        // Return value:
                return $value;
        }
 
-
        /************************************
         *
         * Specific RTE TRANSFORMATION functions
@@ -313,34 +324,37 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
         * If it turns out that the URL is from another website than the current the image is read from that external URL and moved to the local server.
         * Also "magic" images are processed here.
         *
-        * @param       string          The content from RTE going to Database
-        * @return      string          Processed content
+        * @param string $value The content from RTE going to Database
+        * @return string Processed content
         */
        function TS_images_db($value) {
 
                        // Split content by <img> tags and traverse the resulting array for processing:
                $imgSplit = $this->splitTags('img', $value);
                foreach ($imgSplit as $k => $v) {
-                       if ($k % 2) { // image found, do processing:
+                               // image found, do processing:
+                       if ($k % 2) {
 
                                        // Init
                                $attribArray = $this->get_tag_attributes_classic($v, 1);
                                $siteUrl = $this->siteUrl();
                                $sitePath = str_replace(t3lib_div::getIndpEnv('TYPO3_REQUEST_HOST'), '', $siteUrl);
 
-                               $absRef = trim($attribArray['src']); // It's always a absolute URL coming from the RTE into the Database.
+                                       // It's always a absolute URL coming from the RTE into the Database.
+                               $absRef = trim($attribArray['src']);
 
-                                       // make path absolute if it is relative and we have a site path wich is not '/'
+                                       // Make path absolute if it is relative and we have a site path wich is not '/'
                                $pI = pathinfo($absRef);
                                if ($sitePath AND !$pI['scheme'] && t3lib_div::isFirstPartOfStr($absRef, $sitePath)) {
-                                               // if site is in a subpath (eg. /~user_jim/) this path needs to be removed because it will be added with $siteUrl
+                                               // If site is in a subpath (eg. /~user_jim/) this path needs to be removed because it will be added with $siteUrl
                                        $absRef = substr($absRef, strlen($sitePath));
                                        $absRef = $siteUrl . $absRef;
                                }
 
                                        // External image from another URL? In that case, fetch image (unless disabled feature).
                                if (!t3lib_div::isFirstPartOfStr($absRef, $siteUrl) && !$this->procOptions['dontFetchExtPictures']) {
-                                       $externalFile = $this->getUrl($absRef); // Get it
+                                               // Get it
+                                       $externalFile = $this->getUrl($absRef);
                                        if ($externalFile) {
                                                $pU = parse_url($absRef);
                                                $pI = pathinfo($pU['path']);
@@ -389,8 +403,10 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
 
                                        // Check image as local file (siteURL equals the one of the image)
                                if (t3lib_div::isFirstPartOfStr($absRef, $siteUrl)) {
-                                       $path = rawurldecode(substr($absRef, strlen($siteUrl))); // Rel-path, rawurldecoded for special characters.
-                                       $filepath = t3lib_div::getFileAbsFileName($path); // Abs filepath, locked to relative path of this project.
+                                               // Rel-path, rawurldecoded for special characters.
+                                       $path = rawurldecode(substr($absRef, strlen($siteUrl)));
+                                               // Abs filepath, locked to relative path of this project.
+                                       $filepath = t3lib_div::getFileAbsFileName($path);
 
                                                // Check file existence (in relative dir to this installation!)
                                        if ($filepath && @is_file($filepath)) {
@@ -465,20 +481,21 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
                                                                if ($curWH[1]) {
                                                                        $attribArray['height'] = $curWH[1];
                                                                }
-       
+
                                                                        // Removing width and heigth form style attribute
                                                                $attribArray['style'] = preg_replace('/((?:^|)\s*(?:width|height)\s*:[^;]*(?:$|;))/si', '', $attribArray['style']);
-       
+
                                                                        // Finding dimensions of image file:
                                                                $fI = @getimagesize($filepath);
-       
+
                                                                        // Perform corrections to aspect ratio based on configuration:
                                                                switch ((string) $this->procOptions['plainImageMode']) {
                                                                        case 'lockDimensions':
                                                                                $attribArray['width'] = $fI[0];
                                                                                $attribArray['height'] = $fI[1];
                                                                        break;
-                                                                       case 'lockRatioWhenSmaller': // If the ratio has to be smaller, then first set the width...:
+                                                                               // If the ratio has to be smaller, then first set the width...:
+                                                                       case 'lockRatioWhenSmaller':
                                                                                if ($attribArray['width'] > $fI[0]) {
                                                                                        $attribArray['width'] = $fI[0];
                                                                                }
@@ -488,7 +505,7 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
                                                                                }
                                                                        break;
                                                                }
-       
+
                                                                        // Compile the image tag again:
                                                                $params = t3lib_div::implodeAttributes($attribArray, 1);
                                                                $imgSplit[$k] = '<img ' . $params . ' />';
@@ -523,8 +540,8 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
         * Processing images from database content going into the RTE.
         * Processing includes converting the src attribute to an absolute URL.
         *
-        * @param       string          Content input
-        * @return      string          Content output
+        * @param string $value Content input
+        * @return string Content output
         */
        function TS_images_rte($value) {
 
@@ -534,7 +551,8 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
                        // Split content by <img> tags and traverse the resulting array for processing:
                $imgSplit = $this->splitTags('img', $value);
                foreach ($imgSplit as $k => $v) {
-                       if ($k % 2) { // image found:
+                               // image found:
+                       if ($k % 2) {
 
                                        // Init
                                $attribArray = $this->get_tag_attributes_classic($v, 1);
@@ -543,7 +561,7 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
                                        // Unless the src attribute is already pointing to an external URL:
                                if (strtolower(substr($absRef, 0, 4)) != 'http') {
                                        $attribArray['src'] = substr($attribArray['src'], strlen($this->relBackPath));
-                                               // if site is in a subpath (eg. /~user_jim/) this path needs to be removed because it will be added with $siteUrl
+                                               // If site is in a subpath (eg. /~user_jim/) this path needs to be removed because it will be added with $siteUrl
                                        $attribArray['src'] = preg_replace('#^' . preg_quote($sitePath, '#') . '#', '', $attribArray['src']);
                                        $attribArray['src'] = $siteUrl . $attribArray['src'];
                                        if (!isset($attribArray['alt'])) {
@@ -555,7 +573,7 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
                        }
                }
 
-                       // return processed content:
+                       // Return processed content:
                return implode('', $imgSplit);
        }
 
@@ -563,9 +581,9 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
         * Transformation handler: 'ts_reglinks' / direction: "db"+"rte" depending on $direction variable.
         * Converting <A>-tags to/from abs/rel
         *
-        * @param       string          Content input
-        * @param       string          Direction of conversion; "rte" (from database to RTE) or "db" (from RTE to database)
-        * @return      string          Content output
+        * @param string $value Content input
+        * @param string $direction Direction of conversion; "rte" (from database to RTE) or "db" (from RTE to database)
+        * @return string Content output
         */
        function TS_reglinks($value, $direction) {
                $retVal = '';
@@ -578,7 +596,8 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
                                $siteURL = $this->siteUrl();
                                $blockSplit = $this->splitIntoBlock('A', $value);
                                foreach ($blockSplit as $k => $v) {
-                                       if ($k % 2) { // block:
+                                               // Block
+                                       if ($k % 2) {
                                                $attribArray = $this->get_tag_attributes_classic($this->getFirstTag($v), 1);
                                                        // If the url is local, remove url-prefix
                                                if ($siteURL && substr($attribArray['href'], 0, strlen($siteURL)) == $siteURL) {
@@ -599,8 +618,8 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
         * Transformation handler: 'ts_links' / direction: "db"
         * Converting <A>-tags to <link tags>
         *
-        * @param       string          Content input
-        * @return      string          Content output
+        * @param string $value Content input
+        * @return string Content output
         * @see TS_links_rte()
         */
        function TS_links_db($value) {
@@ -609,7 +628,8 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
                        // Split content into <a> tag blocks and process:
                $blockSplit = $this->splitIntoBlock('A', $value);
                foreach ($blockSplit as $k => $v) {
-                       if ($k % 2) { // If an A-tag was found:
+                               // If an A-tag was found:
+                       if ($k % 2) {
                                $attribArray = $this->get_tag_attributes_classic($this->getFirstTag($v), 1);
                                $info = $this->urlInfoForLinkTags($attribArray['href']);
 
@@ -620,7 +640,8 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
                                unset($attribArray_copy['class']);
                                unset($attribArray_copy['title']);
                                unset($attribArray_copy['data-htmlarea-external']);
-                               if ($attribArray_copy['rteerror']) { // Unset "rteerror" and "style" attributes if "rteerror" is set!
+                                       // Unset "rteerror" and "style" attributes if "rteerror" is set!
+                               if ($attribArray_copy['rteerror']) {
                                        unset($attribArray_copy['style']);
                                        unset($attribArray_copy['rteerror']);
                                }
@@ -686,8 +707,8 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
         * Transformation handler: 'ts_links' / direction: "rte"
         * Converting <link tags> to <A>-tags
         *
-        * @param       string          Content input
-        * @return      string          Content output
+        * @param string $value Content input
+        * @return string Content output
         * @see TS_links_rte()
         */
        function TS_links_rte($value) {
@@ -700,7 +721,8 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
                foreach ($blockSplit as $k => $v) {
                        $error = '';
                        $external = FALSE;
-                       if ($k % 2) { // block:
+                               // Block
+                       if ($k % 2) {
                                $tagCode = t3lib_div::unQuoteFilenames(trim(substr($this->getFirstTag($v), 0, -1)), TRUE);
                                $link_param = $tagCode[1];
                                $href = '';
@@ -800,8 +822,8 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
        /**
         * Preserve special tags
         *
-        * @param       string          Content input
-        * @return      string          Content output
+        * @param string $value Content input
+        * @return string Content output
         */
        function TS_preserve_db($value) {
                if (!$this->preserveTags) {
@@ -811,7 +833,8 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
                        // Splitting into blocks for processing (span-tags are used for special tags)
                $blockSplit = $this->splitIntoBlock('span', $value);
                foreach ($blockSplit as $k => $v) {
-                       if ($k % 2) { // block:
+                               // Block
+                       if ($k % 2) {
                                $attribArray = $this->get_tag_attributes_classic($this->getFirstTag($v));
                                if ($attribArray['specialtag']) {
                                        $theTag = rawurldecode($attribArray['specialtag']);
@@ -826,8 +849,8 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
        /**
         * Preserve special tags
         *
-        * @param       string          Content input
-        * @return      string          Content output
+        * @param string $value Content input
+        * @return string Content output
         */
        function TS_preserve_rte($value) {
                if (!$this->preserveTags) {
@@ -836,7 +859,8 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
 
                $blockSplit = $this->splitIntoBlock($this->preserveTags, $value);
                foreach ($blockSplit as $k => $v) {
-                       if ($k % 2) { // block:
+                               // Block
+                       if ($k % 2) {
                                $blockSplit[$k] = '<span specialtag="' . rawurlencode($this->getFirstTag($v)) . '">' . $this->removeFirstAndLastTag($blockSplit[$k]) . '</span>';
                        }
                }
@@ -847,14 +871,14 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
         * Transformation handler: 'ts_transform' + 'css_transform' / direction: "db"
         * Cleaning (->db) for standard content elements (ts)
         *
-        * @param       string          Content input
-        * @param       boolean         If TRUE, the transformation was "css_transform", otherwise "ts_transform"
-        * @return      string          Content output
+        * @param string $value Content input
+        * @param boolean $css If TRUE, the transformation was "css_transform", otherwise "ts_transform"
+        * @return string Content output
         * @see TS_transform_rte()
         */
        function TS_transform_db($value, $css = FALSE) {
 
-                       // safety... so forever loops are avoided (they should not occur, but an error would potentially do this...)
+                       // Safety... so forever loops are avoided (they should not occur, but an error would potentially do this...)
                $this->TS_transform_db_safecounter--;
                if ($this->TS_transform_db_safecounter < 0) {
                        return $value;
@@ -989,13 +1013,14 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
        /**
         * Wraps a-tags that contain a style attribute with a span-tag
         *
-        * @param       string          Content input
-        * @return      string          Content output
+        * @param string $value Content input
+        * @return string Content output
         */
        function transformStyledATags($value) {
                $blockSplit = $this->splitIntoBlock('A', $value);
                foreach ($blockSplit as $k => $v) {
-                       if ($k % 2) { // If an A-tag was found:
+                               // If an A-tag was found
+                       if ($k % 2) {
                                $attribArray = $this->get_tag_attributes_classic($this->getFirstTag($v), 1);
                                        // If "style" attribute is set and rteerror is not set!
                                if ($attribArray['style'] && !$attribArray['rteerror']) {
@@ -1014,9 +1039,9 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
         * Transformation handler: 'ts_transform' + 'css_transform' / direction: "rte"
         * Set (->rte) for standard content elements (ts)
         *
-        * @param       string          Content input
-        * @param       boolean         If TRUE, the transformation was "css_transform", otherwise "ts_transform"
-        * @return      string          Content output
+        * @param string Content input
+        * @param boolean If TRUE, the transformation was "css_transform", otherwise "ts_transform"
+        * @return string Content output
         * @see TS_transform_db()
         */
        function TS_transform_rte($value, $css = 0) {
@@ -1097,15 +1122,14 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
         * Transformation handler: 'ts_strip' / direction: "db"
         * Removing all non-allowed tags
         *
-        * @param       string          Content input
-        * @return      string          Content output
+        * @param string $value Content input
+        * @return string Content output
         */
        function TS_strip_db($value) {
                $value = strip_tags($value, '<' . implode('><', explode(',', 'b,i,u,a,img,br,div,center,pre,font,hr,sub,sup,p,strong,em,li,ul,ol,blockquote')) . '>');
                return $value;
        }
 
-
        /***************************************************************
         *
         * Generic RTE transformation, analysis and helper functions
@@ -1115,8 +1139,8 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
        /**
         * Reads the file or url $url and returns the content
         *
-        * @param       string          Filepath/URL to read
-        * @return      string          The content from the resource given as input.
+        * @param string $url Filepath/URL to read
+        * @return string The content from the resource given as input.
         * @see t3lib_div::getUrl()
         */
        function getUrl($url) {
@@ -1128,9 +1152,9 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
         * Content is cleaned eg. by removing unallowed HTML and ds-HSC content
         * It is basically calling HTMLcleaner from the parent class with some preset configuration specifically set up for cleaning content going from the RTE into the db
         *
-        * @param       string          Content to clean up
-        * @param       string          Comma list of tags to specifically allow. Default comes from getKeepTags and is ""
-        * @return      string          Clean content
+        * @param string $content Content to clean up
+        * @param string $tagList Comma list of tags to specifically allow. Default comes from getKeepTags and is ""
+        * @return string Clean content
         * @see getKeepTags()
         */
        function HTMLcleaner_db($content, $tagList = '') {
@@ -1139,8 +1163,10 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
                } else {
                        $keepTags = $this->getKeepTags('db', $tagList);
                }
-               $kUknown = $this->procOptions['dontRemoveUnknownTags_db'] ? 1 : 0; // Default: remove unknown tags.
-               $hSC = $this->procOptions['dontUndoHSC_db'] ? 0 : -1; // Default: re-convert literals to characters (that is &lt; to <)
+                       // Default: remove unknown tags.
+               $kUknown = $this->procOptions['dontRemoveUnknownTags_db'] ? 1 : 0;
+                       // Default: re-convert literals to characters (that is &lt; to <)
+               $hSC = $this->procOptions['dontUndoHSC_db'] ? 0 : -1;
 
                        // Create additional configuration in order to honor the setting RTE.default.proc.HTMLparser_db.xhtml_cleaning=1
                $addConfig = array();
@@ -1155,16 +1181,17 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
         * Creates an array of configuration for the HTMLcleaner function based on whether content go TO or FROM the Rich Text Editor ($direction)
         * Unless "tagList" is given, the function will cache the configuration for next time processing goes on. (In this class that is the case only if we are processing a bulletlist)
         *
-        * @param       string          The direction of the content being processed by the output configuration; "db" (content going into the database FROM the rte) or "rte" (content going into the form)
-        * @param       string          Comma list of tags to keep (overriding default which is to keep all + take notice of internal configuration)
-        * @return      array           Configuration array
+        * @param string $direction The direction of the content being processed by the output configuration; "db" (content going into the database FROM the rte) or "rte" (content going into the form)
+        * @param string $tagList Comma list of tags to keep (overriding default which is to keep all + take notice of internal configuration)
+        * @return array Configuration array
         * @see HTMLcleaner_db()
         */
        function getKeepTags($direction = 'rte', $tagList = '') {
                if (!is_array($this->getKeepTags_cache[$direction]) || $tagList) {
 
                                // Setting up allowed tags:
-                       if (strcmp($tagList, '')) { // If the $tagList input var is set, this will take precedence
+                               // If the $tagList input var is set, this will take precedence
+                       if (strcmp($tagList, '')) {
                                $keepTags = array_flip(t3lib_div::trimExplode(',', $tagList, 1));
                        } else { // Default is to get allowed/denied tags from internal array of processing options:
                                        // Construct default list of tags to keep:
@@ -1285,10 +1312,10 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
         * The function ->setDivTags does the opposite.
         * This function processes content to go into the database.
         *
-        * @param       string          Value to process.
-        * @param       integer         Recursion brake. Decremented on each recursion down to zero. Default is 5 (which equals the allowed nesting levels of p/div tags).
-        * @param       boolean         If TRUE, an array with the lines is returned, otherwise a string of the processed input value.
-        * @return      string          Processed input value.
+        * @param string $value Value to process.
+        * @param integer $count Recursion brake. Decremented on each recursion down to zero. Default is 5 (which equals the allowed nesting levels of p/div tags).
+        * @param boolean $returnArray If TRUE, an array with the lines is returned, otherwise a string of the processed input value.
+        * @return string Processed input value.
         * @see setDivTags()
         */
        function divideIntoLines($value, $count = 5, $returnArray = FALSE) {
@@ -1325,11 +1352,13 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
 
                                        // Fetching 'sub-lines' - which will explode any further p/div nesting...
                                $subLines = $this->divideIntoLines($v, $count - 1, 1);
-                               if (is_array($subLines)) { // So, if there happend to be sub-nesting of p/div, this is written directly as the new content of THIS section. (This would be considered 'an error')
+                                       // So, if there happend to be sub-nesting of p/div, this is written directly as the new content of THIS section. (This would be considered 'an error')
+                               if (is_array($subLines)) {
                                        // No noting.
                                } else { //... but if NO subsection was found, we process it as a TRUE line without erronous content:
                                        $subLines = array($subLines);
-                                       if (!$this->procOptions['dontConvBRtoParagraph']) { // process break-tags, if configured for. Simply, the breaktags will here be treated like if each was a line of content...
+                                               // process break-tags, if configured for. Simply, the breaktags will here be treated like if each was a line of content...
+                                       if (!$this->procOptions['dontConvBRtoParagraph']) {
                                                $subLines = preg_split('/<br[[:space:]]*[\/]?>/i', $v);
                                        }
 
@@ -1360,7 +1389,8 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
                                                }
 
                                                        // CLASS attribute:
-                                               if (!$this->procOptions['skipClass'] && strcmp(trim($attribs[0]['class']), '')) { // Set to whatever value
+                                                       // Set to whatever value
+                                               if (!$this->procOptions['skipClass'] && strcmp(trim($attribs[0]['class']), '')) {
                                                        if (!count($this->allowedClasses) || in_array($attribs[0]['class'], $this->allowedClasses)) {
                                                                $newAttribs['class'] = $attribs[0]['class'];
                                                        } else {
@@ -1422,17 +1452,19 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
         * Converts all lines into <div></div>/<p></p>-sections (unless the line is a div-section already)
         * For processing of content going FROM database TO RTE.
         *
-        * @param       string          Value to convert
-        * @param       string          Tag to wrap with. Either "p" or "div" should it be. Lowercase preferably.
-        * @return      string          Processed value.
+        * @param string $value Value to convert
+        * @param string $dT Tag to wrap with. Either "p" or "div" should it be. Lowercase preferably.
+        * @return string Processed value.
         * @see divideIntoLines()
         */
        function setDivTags($value, $dT = 'p') {
 
                        // First, setting configuration for the HTMLcleaner function. This will process each line between the <div>/<p> section on their way to the RTE
                $keepTags = $this->getKeepTags('rte');
-               $kUknown = $this->procOptions['dontProtectUnknownTags_rte'] ? 0 : 'protect'; // Default: remove unknown tags.
-               $hSC = $this->procOptions['dontHSC_rte'] ? 0 : 1; // Default: re-convert literals to characters (that is &lt; to <)
+                       // Default: remove unknown tags.
+               $kUknown = $this->procOptions['dontProtectUnknownTags_rte'] ? 0 : 'protect';
+                       // Default: re-convert literals to characters (that is &lt; to <)
+               $hSC = $this->procOptions['dontHSC_rte'] ? 0 : 1;
                $convNBSP = !$this->procOptions['dontConvAmpInNBSP_rte'] ? 1 : 0;
 
                        // Divide the content into lines, based on LF:
@@ -1440,7 +1472,8 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
                foreach ($parts as $k => $v) {
 
                                // Processing of line content:
-                       if (!strcmp(trim($parts[$k]), '')) { // If the line is blank, set it to &nbsp;
+                               // If the line is blank, set it to &nbsp;
+                       if (!strcmp(trim($parts[$k]), '')) {
                                $parts[$k] = '&nbsp;';
                        } else { // Clean the line content:
                                $parts[$k] = $this->HTMLcleaner($parts[$k], $keepTags, $kUknown, $hSC);
@@ -1454,7 +1487,7 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
                                $testStr = strtolower(trim($parts[$k]));
                                if (substr($testStr, 0, 4) != '<div' || substr($testStr, -6) != '</div>') {
                                        if (substr($testStr, 0, 2) != '<p' || substr($testStr, -4) != '</p>') {
-                                               // Only set p-tags if there is not already div or p tags:
+                                                       // Only set p-tags if there is not already div or p tags:
                                                $parts[$k] = '<' . $dT . '>' . $parts[$k] . '</' . $dT . '>';
                                        }
                                }
@@ -1472,8 +1505,8 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
         * In that case the font-tags are normally on the OUTSIDE of the sections.
         * This function is used by eg. divideIntoLines() if the procesing option 'internalizeFontTags' is set.
         *
-        * @param       string          Input content
-        * @return      string          Output content
+        * @param string Input content
+        * @return string Output content
         * @see divideIntoLines()
         */
        function internalizeFontTags($value) {
@@ -1482,17 +1515,24 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
                $fontSplit = $this->splitIntoBlock('font', $value);
 
                foreach ($fontSplit as $k => $v) {
-                       if ($k % 2) { // Inside
-                               $fTag = $this->getFirstTag($v); // Fint font-tag
+                               // Inside
+                       if ($k % 2) {
+                                       // Fint font-tag
+                               $fTag = $this->getFirstTag($v);
 
                                $divSplit_sub = $this->splitIntoBlock('div,p', $this->removeFirstAndLastTag($v), 1);
-                               if (count($divSplit_sub) > 1) { // If there were div/p sections inside the font-tag, do something about it...
-                                               // traverse those sections:
+                                       // If there were div/p sections inside the font-tag, do something about it...
+                               if (count($divSplit_sub) > 1) {
+                                               // Traverse those sections:
                                        foreach ($divSplit_sub as $k2 => $v2) {
-                                               if ($k2 % 2) { // Inside
-                                                       $div_p = $this->getFirstTag($v2); // Fint font-tag
-                                                       $div_p_tagname = $this->getFirstTagName($v2); // Fint font-tag
-                                                       $v2 = $this->removeFirstAndLastTag($v2); // ... and remove it from original.
+                                                       // Inside
+                                               if ($k2 % 2) {
+                                                               // Fint font-tag
+                                                       $div_p = $this->getFirstTag($v2);
+                                                               // Fint font-tag
+                                                       $div_p_tagname = $this->getFirstTagName($v2);
+                                                               // ... and remove it from original.
+                                                       $v2 = $this->removeFirstAndLastTag($v2);
                                                        $divSplit_sub[$k2] = $div_p . $fTag . $v2 . '</font>' . '</' . $div_p_tagname . '>';
                                                } elseif (trim(strip_tags($v2))) {
                                                        $divSplit_sub[$k2] = $fTag . $v2 . '</font>';
@@ -1509,7 +1549,7 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
        /**
         * Returns SiteURL based on thisScript.
         *
-        * @return      string          Value of t3lib_div::getIndpEnv('TYPO3_SITE_URL');
+        * @return string Value of t3lib_div::getIndpEnv('TYPO3_SITE_URL');
         * @see t3lib_div::getIndpEnv()
         */
        function siteUrl() {
@@ -1520,7 +1560,7 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
         * Return the storage folder of RTE image files.
         * Default is $GLOBALS['TYPO3_CONF_VARS']['BE']['RTE_imageStorageDir'] unless something else is configured in the types configuration for the RTE.
         *
-        * @return      string
+        * @return string
         */
        function rteImageStorageDir() {
                return $this->rte_p['imgpath'] ? $this->rte_p['imgpath'] : $GLOBALS['TYPO3_CONF_VARS']['BE']['RTE_imageStorageDir'];
@@ -1530,9 +1570,9 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
         * Remove all tables from incoming code
         * The function is trying to to this is some more or less respectfull way. The approach is to resolve each table cells content and implode it all by <br /> chars. Thus at least the content is preserved in some way.
         *
-        * @param       string          Input value
-        * @param       string          Break character to use for linebreaks.
-        * @return      string          Output value
+        * @param string $value Input value
+        * @param string $breakChar Break character to use for linebreaks.
+        * @return string Output value
         */
        function removeTables($value, $breakChar = '<br />') {
 
@@ -1562,9 +1602,9 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
        /**
         * Default tag mapping for TS
         *
-        * @param       string          Input code to process
-        * @param       string          Direction To databsae (db) or from database to RTE (rte)
-        * @return      string          Processed value
+        * @param string $code Input code to process
+        * @param string $direction Direction To databsae (db) or from database to RTE (rte)
+        * @return string Processed value
         */
        function defaultTStagMapping($code, $direction = 'rte') {
                if ($direction == 'db') {
@@ -1586,8 +1626,8 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
         * Finds width and height from attrib-array
         * If the width and height is found in the style-attribute, use that!
         *
-        * @param       array           Array of attributes from tag in which to search. More specifically the content of the key "style" is used to extract "width:xxx / height:xxx" information
-        * @return      array           Integer w/h in key 0/1. Zero is returned if not found.
+        * @param array $attribArray Array of attributes from tag in which to search. More specifically the content of the key "style" is used to extract "width:xxx / height:xxx" information
+        * @return array Integer w/h in key 0/1. Zero is returned if not found.
         */
        function getWHFromAttribs($attribArray) {
                $style = trim($attribArray['style']);
@@ -1613,8 +1653,8 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
        /**
         * Parse <A>-tag href and return status of email,external,file or page
         *
-        * @param       string          URL to analyse.
-        * @return      array           Information in an array about the URL
+        * @param string $url URL to analyse.
+        * @return array Information in an array about the URL
         */
        function urlInfoForLinkTags($url) {
                $info = array();
@@ -1642,7 +1682,8 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
                        $siteUrl_parts = parse_url($url);
                        $curUrl_parts = parse_url($curURL);
 
-                       if ($siteUrl_parts['host'] == $curUrl_parts['host'] // Hosts should match
+                               // Hosts should match
+                       if ($siteUrl_parts['host'] == $curUrl_parts['host']
                                && (!$info['relScriptPath'] || (defined('TYPO3_mainDir') && substr($info['relScriptPath'], 0, strlen(TYPO3_mainDir)) == TYPO3_mainDir))) { // If the script path seems to match or is empty (FE-EDIT)
 
                                        // New processing order 100502
@@ -1679,18 +1720,20 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
        /**
         * Converting <A>-tags to absolute URLs (+ setting rtekeep attribute)
         *
-        * @param       string          Content input
-        * @param       boolean         If TRUE, then the "rtekeep" attribute will not be set.
-        * @return      string          Content output
+        * @param string $value Content input
+        * @param boolean $dontSetRTEKEEP If TRUE, then the "rtekeep" attribute will not be set.
+        * @return string Content output
         */
        function TS_AtagToAbs($value, $dontSetRTEKEEP = FALSE) {
                $blockSplit = $this->splitIntoBlock('A', $value);
                foreach ($blockSplit as $k => $v) {
-                       if ($k % 2) { // block:
+                               // Block
+                       if ($k % 2) {
                                $attribArray = $this->get_tag_attributes_classic($this->getFirstTag($v), 1);
 
                                        // Checking if there is a scheme, and if not, prepend the current url.
-                               if (strlen($attribArray['href'])) { // ONLY do this if href has content - the <a> tag COULD be an anchor and if so, it should be preserved...
+                                       // ONLY do this if href has content - the <a> tag COULD be an anchor and if so, it should be preserved...
+                               if (strlen($attribArray['href'])) {
                                        $uP = parse_url(strtolower($attribArray['href']));
                                        if (!$uP['scheme']) {
                                                $attribArray['href'] = $this->siteUrl() . substr($attribArray['href'], strlen($this->relBackPath));
@@ -1713,4 +1756,4 @@ class t3lib_parsehtml_proc extends t3lib_parsehtml {
        }
 }
 
-?>
+?>
\ No newline at end of file
index 51566fa..07ab3b1 100644 (file)
  * Revised for TYPO3 3.6 November/2003 by Kasper Skårhøj
  * XHTML compliant (should be)
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  */
 
-
 /**
  * Position map class - generating a page tree / content element list which links for inserting (copy/move) of records.
  * Used for pages / tt_content element wizards of various kinds.
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  * @package TYPO3
  * @subpackage t3lib
  */
@@ -48,14 +47,19 @@ class t3lib_positionMap {
        var $moveOrCopy = 'move';
        var $dontPrintPageInsertIcons = 0;
        var $backPath = '';
-       var $depth = 2; // How deep the position page tree will go.
-       var $cur_sys_language; // Can be set to the sys_language uid to select content elements for.
+               // How deep the position page tree will go.
+       var $depth = 2;
+               // Can be set to the sys_language uid to select content elements for.
+       var $cur_sys_language;
 
 
                // INTERNAL, dynamic:
-       var $R_URI = ''; // Request uri
-       var $elUid = ''; // Element id.
-       var $moveUid = ''; // tt_content element uid to move.
+               // Request uri
+       var $R_URI = '';
+               // Element id.
+       var $elUid = '';
+               // tt_content element uid to move.
+       var $moveUid = '';
 
                // Caching arrays:
        var $getModConfigCache = array();
@@ -67,7 +71,6 @@ class t3lib_positionMap {
 
        var $modConfigStr = 'mod.web_list.newPageWiz';
 
-
        /*************************************
         *
         * Page position map:
@@ -78,11 +81,11 @@ class t3lib_positionMap {
         * Creates a "position tree" based on the page tree.
         * Notice: A class, "localPageTree" must exist and probably it is an extension class of the t3lib_pageTree class. See "db_new.php" in the core for an example.
         *
-        * @param       integer         Current page id
-        * @param       array           Current page record.
-        * @param       string          Page selection permission clause.
-        * @param       string          Current REQUEST_URI
-        * @return      string          HTML code for the tree.
+        * @param integer $id Current page id
+        * @param array $pageinfo Current page record.
+        * @param string $perms_clause Page selection permission clause.
+        * @param string $R_URI Current REQUEST_URI
+        * @return string HTML code for the tree.
         */
        function positionTree($id, $pageinfo, $perms_clause, $R_URI) {
                $code = '';
@@ -118,7 +121,8 @@ class t3lib_positionMap {
 
                                        // If current page, subpage?
                                if ($prev_dat['row']['uid'] == $id) {
-                                       if (!$this->dontPrintPageInsertIcons && $this->checkNewPageInPid($id) && !($prev_dat['invertedDepth'] > $t3lib_pageTree->tree[$cc]['invertedDepth'])) { // 1) It must be allowed to create a new page and 2) If there are subpages there is no need to render a subpage icon here - it'll be done over the subpages...
+                                               // 1) It must be allowed to create a new page and 2) If there are subpages there is no need to render a subpage icon here - it'll be done over the subpages...
+                                       if (!$this->dontPrintPageInsertIcons && $this->checkNewPageInPid($id) && !($prev_dat['invertedDepth'] > $t3lib_pageTree->tree[$cc]['invertedDepth'])) {
                                                $code .= '<span class="nobr">' .
                                                                $this->insertQuadLines($dat['blankLineCode']) .
                                                                '<img src="clear.gif" width="18" height="8" align="top" alt="" />' .
@@ -128,7 +132,8 @@ class t3lib_positionMap {
                                        }
                                }
 
-                               if ($prev_dat['invertedDepth'] > $t3lib_pageTree->tree[$cc]['invertedDepth']) { // If going down
+                                       // If going down
+                               if ($prev_dat['invertedDepth'] > $t3lib_pageTree->tree[$cc]['invertedDepth']) {
                                        $prevPid = $t3lib_pageTree->tree[$cc]['row']['pid'];
                                } elseif ($prev_dat['invertedDepth'] < $t3lib_pageTree->tree[$cc]['invertedDepth']) { // If going up
                                        // First of all the previous level should have an icon:
@@ -145,10 +150,12 @@ class t3lib_positionMap {
                                                // Then set the current prevPid
                                        $prevPid = -$prev_dat['row']['pid'];
                                } else {
-                                       $prevPid = -$prev_dat['row']['uid']; // In on the same level
+                                               // In on the same level
+                                       $prevPid = -$prev_dat['row']['uid'];
                                }
                        } else {
-                               $prevPid = $dat['row']['pid']; // First in the tree
+                                       // First in the tree
+                               $prevPid = $dat['row']['pid'];
                        }
                        if (!$this->dontPrintPageInsertIcons && $this->checkNewPageInPid($dat['row']['pid'])) {
                                $code .= '<span class="nobr">' .
@@ -202,8 +209,8 @@ class t3lib_positionMap {
        /**
         * Creates the JavaScritp for insert new-record rollover image
         *
-        * @param       string          Insert record image prefix.
-        * @return      string          <script> section
+        * @param string $prefix Insert record image prefix.
+        * @return string <script> section
         */
        function JSimgFunc($prefix = '') {
                $code = $GLOBALS['TBE_TEMPLATE']->wrapScriptTags('
@@ -230,10 +237,10 @@ class t3lib_positionMap {
        /**
         * Wrap $t_code in bold IF the $dat uid matches $id
         *
-        * @param       string          Title string
-        * @param       array           Infomation array with record array inside.
-        * @param       integer         The current id.
-        * @return      string          The title string.
+        * @param string $t_code Title string
+        * @param array $dat Infomation array with record array inside.
+        * @param integer $id The current id.
+        * @return string The title string.
         */
        function boldTitle($t_code, $dat, $id) {
                if ($dat['row']['uid'] == $id) {
@@ -248,9 +255,9 @@ class t3lib_positionMap {
         * TSconfig mod.web_list.newPageWiz.overrideWithExtension may contain an extension which provides a module
         * to be used instead of the normal create new page wizard.
         *
-        * @param       integer         The pid.
-        * @param       integer         New page id.
-        * @return      string          Onclick attribute content
+        * @param integer $pid The pid.
+        * @param integer $newPagePID New page id.
+        * @return string Onclick attribute content
         */
        function onClickEvent($pid, $newPagePID) {
                $TSconfigProp = $this->getModConfig($newPagePID);
@@ -269,7 +276,7 @@ class t3lib_positionMap {
        /**
         * Get label, htmlspecialchars()'ed
         *
-        * @return      string          The localized label for "insert new page here"
+        * @return string The localized label for "insert new page here"
         */
        function insertlabel() {
                return $GLOBALS['LANG']->getLL($this->l_insertNewPageHere, 1);
@@ -278,9 +285,9 @@ class t3lib_positionMap {
        /**
         * Wrapping page title.
         *
-        * @param       string          Page title.
-        * @param       array           Page record (?)
-        * @return      string          Wrapped title.
+        * @param string $str Page title.
+        * @param array $rec Page record (?)
+        * @return string Wrapped title.
         */
        function linkPageTitle($str, $rec) {
                return $str;
@@ -290,8 +297,8 @@ class t3lib_positionMap {
         * Checks if the user has permission to created pages inside of the $pid page.
         * Uses caching so only one regular lookup is made - hence you can call the function multiple times without worrying about performance.
         *
-        * @param       integer         Page id for which to test.
-        * @return      boolean
+        * @param integer $pid Page id for which to test.
+        * @return boolean
         */
        function checkNewPageInPid($pid) {
                if (!isset($this->checkNewPageCache[$pid])) {
@@ -304,8 +311,8 @@ class t3lib_positionMap {
        /**
         * Returns module configuration for a pid.
         *
-        * @param       integer         Page id for which to get the module configuration.
-        * @return      array           The properties of teh module configuration for the page id.
+        * @param integer $pid Page id for which to get the module configuration.
+        * @return array The properties of teh module configuration for the page id.
         * @see onClickEvent()
         */
        function getModConfig($pid) {
@@ -319,11 +326,11 @@ class t3lib_positionMap {
        /**
         * Insert half/quad lines.
         *
-        * @param       string          keywords for which lines to insert.
-        * @param       boolean         If TRUE all lines are just blank clear.gifs
-        * @return      string          HTML content.
+        * @param string $codes Keywords for which lines to insert.
+        * @param boolean $allBlank If TRUE all lines are just blank clear.gifs
+        * @return string HTML content.
         */
-       function insertQuadLines($codes, $allBlank = 0) {
+       function insertQuadLines($codes, $allBlank = FALSE) {
                $codeA = t3lib_div::trimExplode(',', $codes . ",line", 1);
 
                $lines = array();
@@ -337,7 +344,6 @@ class t3lib_positionMap {
                return implode('', $lines);
        }
 
-
        /*************************************
         *
         * Content element positioning:
@@ -347,12 +353,12 @@ class t3lib_positionMap {
        /**
         * Creates HTML for inserting/moving content elements.
         *
-        * @param       integer         page id onto which to insert content element.
-        * @param       integer         Move-uid (tt_content element uid?)
-        * @param       string          List of columns to show
-        * @param       boolean         If not set, then hidden/starttime/endtime records are filtered out.
-        * @param       string          Request URI
-        * @return      string          HTML
+        * @param integer $pid page id onto which to insert content element.
+        * @param integer $moveUid Move-uid (tt_content element uid?)
+        * @param string $colPosList List of columns to show
+        * @param boolean $showHidden If not set, then hidden/starttime/endtime records are filtered out.
+        * @param string $R_URI Request URI
+        * @return string HTML
         */
        function printContentElementColumns($pid, $moveUid, $colPosList, $showHidden, $R_URI) {
                $this->R_URI = $R_URI;
@@ -390,10 +396,10 @@ class t3lib_positionMap {
        /**
         * Creates the table with the content columns
         *
-        * @param       array           Array with arrays of lines for each column
-        * @param       array           Column position array
-        * @param       integer         The id of the page
-        * @return      string          HTML
+        * @param array $lines Array with arrays of lines for each column
+        * @param array $colPosArray Column position array
+        * @param integer $pid The id of the page
+        * @return string HTML
         */
        function printRecordMap($lines, $colPosArray, $pid = 0) {
 
@@ -418,7 +424,7 @@ class t3lib_positionMap {
 
                        $tcaItems = t3lib_div::callUserFunction('EXT:cms/classes/class.tx_cms_backendlayout.php:tx_cms_BackendLayout->getColPosListItemsParsed', $pid, $this);
 
-                       // cycle through rows
+                               // Cycle through rows
                        for ($row = 1; $row <= $rowCount; $row++) {
                                $rowConfig = $backendLayout['__config']['backend_layout.']['rows.'][$row . '.'];
                                if (!isset($rowConfig)) {
@@ -433,7 +439,7 @@ class t3lib_positionMap {
                                                continue;
                                        }
 
-                                       // which tt_content colPos should be displayed inside this cell
+                                               // Which tt_content colPos should be displayed inside this cell
                                        $columnKey = intval($columnConfig['colPos']);
                                        $head = '';
 
@@ -446,7 +452,7 @@ class t3lib_positionMap {
                                                }
                                        }
 
-                                       // render the grid cell
+                                               // Render the grid cell
                                        $table .= '<td valign="top"' .
                                                        (isset($columnConfig['colspan']) ? ' colspan="' . $columnConfig['colspan'] . '"' : '') .
                                                        (isset($columnConfig['rowspan']) ? ' rowspan="' . $columnConfig['rowspan'] . '"' : '') .
@@ -473,7 +479,7 @@ class t3lib_positionMap {
                        }
                        $table .= '</table></div>';
                } else {
-                       // Traverse the columns here:
+                               // Traverse the columns here:
                        foreach ($colPosArray as $kk => $vv) {
                                $row1 .= '<td align="center" width="' . round(100 / $count) . '%"><div class="t3-page-colHeader t3-row-header">' .
                                                $this->wrapColumnHeader($GLOBALS['LANG']->sL(t3lib_BEfunc::getLabelFromItemlist('tt_content', 'colPos', $vv, $pid), 1), $vv) .
@@ -501,9 +507,9 @@ class t3lib_positionMap {
        /**
         * Wrapping the column header
         *
-        * @param       string          Header value
-        * @param       string          Column info.
-        * @return      string
+        * @param string $str Header value
+        * @param string $vv Column info.
+        * @return string
         * @see printRecordMap()
         */
        function wrapColumnHeader($str, $vv) {
@@ -513,12 +519,12 @@ class t3lib_positionMap {
        /**
         * Creates a linked position icon.
         *
-        * @param       array           Element row.
-        * @param       string          Column position value.
-        * @param       integer         Column key.
-        * @param       integer         Move uid
-        * @param       integer         PID value.
-        * @return      string
+        * @param array $row Element row.
+        * @param string $vv Column position value.
+        * @param integer $kk Column key.
+        * @param integer $moveUid Move uid
+        * @param integer $pid PID value.
+        * @return string
         */
        function insertPositionIcon($row, $vv, $kk, $moveUid, $pid) {
                $cc = hexdec(substr(md5($row['uid'] . '-' . $vv . '-' . $kk), 0, 4));
@@ -530,12 +536,12 @@ class t3lib_positionMap {
        /**
         * Create on-click event value.
         *
-        * @param       array           The record.
-        * @param       string          Column position value.
-        * @param       integer         Move uid
-        * @param       integer         PID value.
-        * @param       integer         System language (not used currently)
-        * @return      string
+        * @param array $row The record.
+        * @param string $vv Column position value.
+        * @param integer $moveUid Move uid
+        * @param integer $pid PID value.
+        * @param integer $sys_lang System language (not used currently)
+        * @return string
         */
        function onClickInsertRecord($row, $vv, $moveUid, $pid, $sys_lang = 0) {
                $table = 'tt_content';
@@ -553,9 +559,9 @@ class t3lib_positionMap {
        /**
         * Wrapping the record header  (from getRecordHeader())
         *
-        * @param       string          HTML content
-        * @param       array           Record array.
-        * @return      string          HTML content
+        * @param string $str HTML content
+        * @param array $row Record array.
+        * @return string HTML content
         */
        function wrapRecordHeader($str, $row) {
                return $str;
@@ -564,8 +570,8 @@ class t3lib_positionMap {
        /**
         * Create record header (includes teh record icon, record title etc.)
         *
-        * @param       array           Record row.
-        * @return      string          HTML
+        * @param array $row Record row.
+        * @return string HTML
         */
        function getRecordHeader($row) {
                $line = t3lib_iconWorks::getSpriteIconForRecord('tt_content', $row, array('title' => htmlspecialchars(t3lib_BEfunc::getRecordIconAltText($row, 'tt_content'))));
@@ -576,13 +582,13 @@ class t3lib_positionMap {
        /**
         * Wrapping the title of the record.
         *
-        * @param       string          The title value.
-        * @param       array           The record row.
-        * @return      string          Wrapped title string.
+        * @param string $str The title value.
+        * @param array $row The record row.
+        * @return string Wrapped title string.
         */
        function wrapRecordTitle($str, $row) {
                return '<a href="' . htmlspecialchars(t3lib_div::linkThisScript(array('uid' => intval($row['uid']), 'moveUid' => ''))) . '">' . $str . '</a>';
        }
 }
 
-?>
+?>
\ No newline at end of file
index 5cd0253..66c2621 100644 (file)
 /**
  * Class for generating front end for building queries
  *
- * @author     Christian Jul Jensen <christian@typo3.com>
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
- * @coauthor   Jo Hasenau <info@cybercraft.de>
+ * @author Christian Jul Jensen <christian@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @coauthor Jo Hasenau <info@cybercraft.de>
  */
 
-
 /**
  * Class for generating front end for building queries
  *
- * @author     Christian Jul Jensen <christian@typo3.com>
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Christian Jul Jensen <christian@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  * @package TYPO3
  * @subpackage t3lib
  */
@@ -169,21 +168,26 @@ class t3lib_queryGenerator {
        );
        var $noWrap = ' nowrap';
 
-       var $name; // Form data name prefix
-       var $table; // table for the query
-       var $fieldList; // field list
-       var $fields = array(); // Array of the fields possible
+               // Form data name prefix
+       var $name;
+               // Table for the query
+       var $table;
+               // Field list
+       var $fieldList;
+               // Array of the fields possible
+       var $fields = array();
        var $extFieldLists = array();
-       var $queryConfig = array(); // The query config
+               // The query config
+       var $queryConfig = array();
        var $enablePrefix = 0;
        var $enableQueryParts = 0;
        var $extJSCODE = '';
 
        protected $formName = '';
 
-
        /**
-        * @return      [type]          ...
+        * Make a list of fields for current table
+        * @return string Separated list of fields
         */
        function makeFieldList() {
                $fieldListArr = array();
@@ -376,15 +380,15 @@ class t3lib_queryGenerator {
 
                $POST = t3lib_div::_POST();
 
-                       // if delete...
+                       // If delete...
                if ($POST['qG_del']) {
-                               //initialize array to work on, save special parameters
+                               // Initialize array to work on, save special parameters
                        $ssArr = $this->getSubscript($POST['qG_del']);
                        $workArr =& $this->queryConfig;
                        for ($i = 0; $i < sizeof($ssArr) - 1; $i++) {
                                $workArr =& $workArr[$ssArr[$i]];
                        }
-                               // delete the entry and move the other entries
+                               // Delete the entry and move the other entries
                        unset($workArr[$ssArr[$i]]);
                        for ($j = $ssArr[$i]; $j < sizeof($workArr); $j++) {
                                $workArr[$j] = $workArr[$j + 1];
@@ -392,40 +396,40 @@ class t3lib_queryGenerator {
                        }
                }
 
-                       // if insert...
+                       // If insert...
                if ($POST['qG_ins']) {
-                               //initialize array to work on, save special parameters
+                               // Initialize array to work on, save special parameters
                        $ssArr = $this->getSubscript($POST['qG_ins']);
                        $workArr =& $this->queryConfig;
                        for ($i = 0; $i < sizeof($ssArr) - 1; $i++) {
                                $workArr =& $workArr[$ssArr[$i]];
                        }
-                               // move all entries above position where new entry is to be inserted
+                               // Move all entries above position where new entry is to be inserted
                        for ($j = sizeof($workArr); $j > $ssArr[$i]; $j--) {
                                $workArr[$j] = $workArr[$j - 1];
                        }
-                               //clear new entry position
+                               // Clear new entry position
                        unset($workArr[$ssArr[$i] + 1]);
                        $workArr[$ssArr[$i] + 1]['type'] = 'FIELD_';
                }
 
-                       // if move up...
+                       // If move up...
                if ($POST['qG_up']) {
-                               //initialize array to work on
+                               // Initialize array to work on
                        $ssArr = $this->getSubscript($POST['qG_up']);
                        $workArr =& $this->queryConfig;
                        for ($i = 0; $i < sizeof($ssArr) - 1; $i++) {
                                $workArr =& $workArr[$ssArr[$i]];
                        }
-                               //swap entries
+                               // Swap entries
                        $qG_tmp = $workArr[$ssArr[$i]];
                        $workArr[$ssArr[$i]] = $workArr[$ssArr[$i] - 1];
                        $workArr[$ssArr[$i] - 1] = $qG_tmp;
                }
 
-                       // if new level...
+                       // If new level...
                if ($POST['qG_nl']) {
-                               //initialize array to work on
+                               // Initialize array to work on
                        $ssArr = $this->getSubscript($POST['qG_nl']);
                        $workArr =& $this->queryConfig;
                        for ($i = 0; $i < sizeof($ssArr) - 1; $i++) {
@@ -444,9 +448,9 @@ class t3lib_queryGenerator {
                        }
                }
 
-                       // if collapse level...
+                       // If collapse level...
                if ($POST['qG_remnl']) {
-                               //initialize array to work on
+                               // Initialize array to work on
                        $ssArr = $this->getSubscript($POST['qG_remnl']);
                        $workArr =& $this->queryConfig;
                        for ($i = 0; $i < sizeof($ssArr) - 1; $i++) {
@@ -475,11 +479,11 @@ class t3lib_queryGenerator {
         * @return      [type]          ...
         */
        function cleanUpQueryConfig($queryConfig) {
-                       //since we dont traverse the array using numeric keys in the upcoming whileloop make sure it's fresh and clean before displaying
+                       // Since we dont traverse the array using numeric keys in the upcoming whileloop make sure it's fresh and clean before displaying
                if (is_array($queryConfig)) {
                        ksort($queryConfig);
                } else {
-                               //queryConfig should never be empty!
+                               // queryConfig should never be empty!
                        if (!$queryConfig[0] || !$queryConfig[0]['type']) {
                                $queryConfig[0] = array('type' => 'FIELD_');
                        }
@@ -496,7 +500,7 @@ class t3lib_queryGenerator {
                        } else {
                                $fType = 'ignore';
                        }
-                               //                      debug($fType);
+
                        switch ($fType) {
                                case 'newlevel':
                                        if (!$queryConfig[$key]['nl']) {
@@ -509,7 +513,6 @@ class t3lib_queryGenerator {
                                        break;
                                case 'ignore':
                                default:
-                                               //                                      debug($queryConfig[$key]);
                                        $verifiedName = $this->verifyType($fName);
                                        $queryConfig[$key]['type'] = 'FIELD_' . $this->verifyType($verifiedName);
 
@@ -521,7 +524,6 @@ class t3lib_queryGenerator {
                                        $queryConfig[$key]['inputValue'] = $this->cleanInputVal($queryConfig[$key]);
                                        $queryConfig[$key]['inputValue1'] = $this->cleanInputVal($queryConfig[$key], 1);
 
-                                               //                                      debug($queryConfig[$key]);
                                        break;
                        }
                }
@@ -903,7 +905,6 @@ class t3lib_queryGenerator {
                return $out;
        }
 
-
        /**
         * [Describe function...]
         *
@@ -1306,9 +1307,9 @@ class t3lib_queryGenerator {
 
                                // Query Generator:
                        $this->procesData($modSettings['queryConfig'] ? unserialize($modSettings['queryConfig']) : '');
-                               //              debug($this->queryConfig);
+
                        $this->queryConfig = $this->cleanUpQueryConfig($this->queryConfig);
-                               //              debug($this->queryConfig);
+
                        $this->enableQueryParts = $modSettings['search_query_smallparts'];
 
                        $codeArr = $this->getFormElements();
@@ -1470,8 +1471,8 @@ class t3lib_queryGenerator {
        /**
         * [Describe function...]
         *
-        * @param       [type]          $formname: ...
-        * @return      [type]          ...
+        * @param string $formname
+        * @return string
         */
        function JSbottom($formname) {
                $out = '';
@@ -1492,8 +1493,8 @@ class t3lib_queryGenerator {
        /**
         * Sets the current name of the input form.
         *
-        * @param       string          $formName: The name of the form.
-        * @return      void
+        * @param string $formName The name of the form.
+        * @return void
         */
        public function setFormName($formName) {
                $this->formName = trim($formName);
index a285e73..a773721 100644 (file)
@@ -29,7 +29,7 @@
  *
  * Revised for TYPO3 3.6 May 2003 by Kasper Skårhøj
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  */
 
 
@@ -37,7 +37,7 @@
  * Functions used to read email content
  * The class is still just a bunch of miscellaneous functions used to read content out of emails
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  * @package TYPO3
  * @subpackage t3lib
  */
@@ -56,7 +56,8 @@ class t3lib_readmail {
                'NOV' => 11,
                'DEC' => 12
        );
-       var $serverGMToffsetMinutes = 60; // = +0100 (CET)
+               // = +0100 (CET)
+       var $serverGMToffsetMinutes = 60;
 
        /*******************************
         *
@@ -68,8 +69,8 @@ class t3lib_readmail {
         * Returns the text content of a mail which has previously been parsed by eg. extractMailHeader()
         * Probably obsolete since the function fullParse() is more advanced and safer to use.
         *
-        * @param       array           Output from extractMailHeader()
-        * @return      string          The content.
+        * @param array $mailParts Output from extractMailHeader()
+        * @return string The content.
         */
        function getMessage($mailParts) {
                if ($mailParts['content-type']) {
@@ -94,8 +95,8 @@ class t3lib_readmail {
         * Returns the body part of a raw mail message (including headers)
         * Probably obsolete since the function fullParse() is more advanced and safer to use.
         *
-        * @param       string          Raw mail content
-        * @return      string          Body of message
+        * @param string $content Raw mail content
+        * @return string Body of message
         */
        function getTextContent($content) {
                $p = $this->extractMailHeader($content);
@@ -109,9 +110,9 @@ class t3lib_readmail {
         * Splits the body of a mail into parts based on the boundary string given.
         * Obsolete, use fullParse()
         *
-        * @param       string          Boundary string used to split the content.
-        * @param       string          BODY section of a mail
-        * @return      array           Parts of the mail based on this
+        * @param string $boundary Boundary string used to split the content.
+        * @param string $content BODY section of a mail
+        * @return array Parts of the mail based on this
         */
        function getMailBoundaryParts($boundary, $content) {
                $mParts = explode('--' . $boundary, $content);
@@ -131,8 +132,8 @@ class t3lib_readmail {
         * Returns Content Type plus more.
         * Obsolete, use fullParse()
         *
-        * @param       string          "ContentType" string with more
-        * @return      array           parts in key/value pairs
+        * @param string $str "ContentType" string with more
+        * @return array Parts in key/value pairs
         * @ignore
         */
        function getCType($str) {
@@ -156,21 +157,25 @@ class t3lib_readmail {
         * Analyses the return-mail content for the Dmailer module - used to find what reason there was for rejecting the mail
         * Used by the Dmailer, but not exclusively.
         *
-        * @param       string          message body/text
-        * @return      array           key/value pairs with analysis result. Eg. "reason", "content", "reason_text", "mailserver" etc.
+        * @param string $c Message body/text
+        * @return array Key/value pairs with analysis result. Eg. "reason", "content", "reason_text", "mailserver" etc.
         */
        function analyseReturnError($c) {
                $cp = array();
-               if (strstr($c, '--- Below this line is a copy of the message.')) { // QMAIL
-                       list($c) = explode('--- Below this line is a copy of the message.', $c); // Splits by the QMAIL divider
+                       // QMAIL
+               if (strstr($c, '--- Below this line is a copy of the message.')) {
+                               // Splits by the QMAIL divider
+                       list($c) = explode('--- Below this line is a copy of the message.', $c);
                        $cp['content'] = trim($c);
                        $parts = explode('>:', $c, 2);
                        $cp['reason_text'] = trim($parts[1]);
                        $cp['mailserver'] = 'Qmail';
                        if (preg_match('/550|no mailbox|account does not exist/i', $cp['reason_text'])) {
-                               $cp['reason'] = 550; // 550 Invalid recipient
+                                       // 550 Invalid recipient
+                               $cp['reason'] = 550;
                        } elseif (stristr($cp['reason_text'], 'couldn\'t find any host named')) {
-                               $cp['reason'] = 2; // Bad host
+                                       // Bad host
+                               $cp['reason'] = 2;
                        } elseif (preg_match('/Error in Header|invalid Message-ID header/i', $cp['reason_text'])) {
                                $cp['reason'] = 554;
                        } else {
@@ -182,11 +187,14 @@ class t3lib_readmail {
                        $cp['reason_text'] = trim($parts[1]);
                        $cp['mailserver'] = 'Postfix';
                        if (stristr($cp['reason_text'], '550')) {
-                               $cp['reason'] = 550; // 550 Invalid recipient, User unknown
+                                       // 550 Invalid recipient, User unknown
+                               $cp['reason'] = 550;
                        } elseif (stristr($cp['reason_text'], '553')) {
-                               $cp['reason'] = 553; // No such user
+                                       // No such user
+                               $cp['reason'] = 553;
                        } elseif (stristr($cp['reason_text'], '551')) {
-                               $cp['reason'] = 551; // Mailbox full
+                                       // Mailbox full
+                               $cp['reason'] = 551;
                        } else {
                                $cp['reason'] = -1;
                        }
@@ -195,7 +203,8 @@ class t3lib_readmail {
                        $cp['reason_text'] = trim(substr($c, 0, 1000));
                        $cp['mailserver'] = 'unknown';
                        if (preg_match('/Unknown Recipient|Delivery failed 550|Receiver not found|User not listed|recipient problem|Delivery to the following recipients failed|User unknown|recipient name is not recognized/i', $cp['reason_text'])) {
-                               $cp['reason'] = 550; // 550 Invalid recipient, User unknown
+                                       // 550 Invalid recipient, User unknown
+                               $cp['reason'] = 550;
                        } elseif (preg_match('/over quota|mailbox full/i', $cp['reason_text'])) {
                                $cp['reason'] = 551;
                        } elseif (preg_match('/Error in Header/i', $cp['reason_text'])) {
@@ -211,8 +220,8 @@ class t3lib_readmail {
        /**
         * Decodes a header-string with the =?....?= syntax including base64/quoted-printable encoding.
         *
-        * @param       string          A string (encoded or not) from a mail header, like sender name etc.
-        * @return      string          The input string, but with the parts in =?....?= decoded.
+        * @param string $str A string (encoded or not) from a mail header, like sender name etc.
+        * @return string The input string, but with the parts in =?....?= decoded.
         */
        function decodeHeaderString($str) {
                $parts = explode('=?', $str, 2);
@@ -231,7 +240,8 @@ class t3lib_readmail {
                                break;
                        }
 
-                       $parts[1] = $encContent . $this->decodeHeaderString($subparts[1]); // Calls decodeHeaderString recursively for any subsequent encoded section.
+                               // Calls decodeHeaderString recursively for any subsequent encoded section.
+                       $parts[1] = $encContent . $this->decodeHeaderString($subparts[1]);
                }
 
                return implode('', $parts);
@@ -240,8 +250,8 @@ class t3lib_readmail {
        /**
         * Extracts name/email parts from a header field (like 'To:' or 'From:' with name/email mixed up.
         *
-        * @param       string          Value from a header field containing name/email values.
-        * @return      array           Array with the name and email in. Email is validated, otherwise not set.
+        * @param string $str Value from a header field containing name/email values.
+        * @return array Array with the name and email in. Email is validated, otherwise not set.
         */
        function extractNameEmail($str) {
                $outArr = array();
@@ -272,13 +282,14 @@ class t3lib_readmail {
        /**
         * Returns the data from the 'content-type' field. That is the boundary, charset and mime-type
         *
-        * @param       string          "Content-type-string"
-        * @return      array           key/value pairs with the result.
+        * @param string $contentTypeStr "Content-type-string"
+        * @return array key/value pairs with the result.
         */
        function getContentTypeData($contentTypeStr) {
                $outValue = array();
                $cTypeParts = t3lib_div::trimExplode(';', $contentTypeStr, 1);
-               $outValue['_MIME_TYPE'] = $cTypeParts[0]; // content type, first value is supposed to be the mime-type, whatever after the first is something else.
+                       // Content type, first value is supposed to be the mime-type, whatever after the first is something else.
+               $outValue['_MIME_TYPE'] = $cTypeParts[0];
 
                reset($cTypeParts);
                next($cTypeParts);
@@ -296,8 +307,8 @@ class t3lib_readmail {
        /**
         * Makes a UNIX-date based on the timestamp in the 'Date' header field.
         *
-        * @param       string          String with a timestamp according to email standards.
-        * @return      integer         The timestamp converted to unix-time in seconds and compensated for GMT/CET ($this->serverGMToffsetMinutes);
+        * @param string $dateStr String with a timestamp according to email standards.
+        * @return integer The timestamp converted to unix-time in seconds and compensated for GMT/CET ($this->serverGMToffsetMinutes);
         */
        function makeUnixDate($dateStr) {
                $dateParts = explode(',', $dateStr);
@@ -310,7 +321,8 @@ class t3lib_readmail {
                $timeStamp = mktime($timeParts[0], $timeParts[1], $timeParts[2], $spaceParts[1], $spaceParts[0], $spaceParts[2]);
 
                $offset = $this->getGMToffset($spaceParts[4]);
-               $timeStamp -= ($offset * 60); // Compensates for GMT by subtracting the number of seconds which the date is offset from serverTime
+                       // Compensates for GMT by subtracting the number of seconds which the date is offset from serverTime
+               $timeStamp -= ($offset * 60);
 
                return $timeStamp;
        }
@@ -318,8 +330,8 @@ class t3lib_readmail {
        /**
         * Parsing the GMT offset value from a mail timestamp.
         *
-        * @param       string          A string like "+0100" or so.
-        * @return      integer         Minutes to offset the timestamp
+        * @param string $GMT A string like "+0100" or so.
+        * @return integer Minutes to offset the timestamp
         * @access private
         */
        function getGMToffset($GMT) {
@@ -333,9 +345,9 @@ class t3lib_readmail {
        /**
         * This returns the mail header items in an array with associative keys and the mail body part in another CONTENT field
         *
-        * @param       string          Raw mail content
-        * @param       integer         A safety limit that will put a upper length to how many header chars will be processed. Set to zero means that there is no limit. (Uses a simple substr() to limit the amount of mail data to process to avoid run-away)
-        * @return      array           An array where each key/value pair is a header-key/value pair. The mail BODY is returned in the key 'CONTENT' if $limit is not set!
+        * @param string $content Raw mail content
+        * @param integer $limit A safety limit that will put a upper length to how many header chars will be processed. Set to zero means that there is no limit. (Uses a simple substr() to limit the amount of mail data to process to avoid run-away)
+        * @return array An array where each key/value pair is a header-key/value pair. The mail BODY is returned in the key 'CONTENT' if $limit is not set!
         */
        function extractMailHeader($content, $limit = 0) {
                if ($limit) {
@@ -348,7 +360,7 @@ class t3lib_readmail {
                foreach ($lines as $k => $str) {
                        if (!trim($str)) {
                                break;
-                       } // header finished
+                       } // Header finished
                        $parts = explode(' ', $str, 2);
                        if ($parts[0] && substr($parts[0], -1) == ':') {
                                $p = strtolower(substr($parts[0], 0, -1));
@@ -372,8 +384,8 @@ class t3lib_readmail {
        /**
         * The extended version of the extractMailHeader() which will also parse all the content body into an array and further process the header fields and decode content etc. Returns every part of the mail ready to go.
         *
-        * @param       string          Raw email input.
-        * @return      array           Multidimensional array with all parts of the message organized nicely. Use t3lib_utility_Debug::debug() to analyse it visually.
+        * @param string $content Raw email input.
+        * @return array Multidimensional array with all parts of the message organized nicely. Use t3lib_utility_Debug::debug() to analyse it visually.
         */
        function fullParse($content) {
                // *************************
@@ -419,7 +431,8 @@ class t3lib_readmail {
                // *************************
 
                $cType = strtolower($mailParts['_CONTENT_TYPE_DAT']['_MIME_TYPE']);
-               $cType = substr($cType, 0, 9); // only looking for 'multipart' in string.
+                       // Only looking for 'multipart' in string.
+               $cType = substr($cType, 0, 9);
                switch ($cType) {
                        case 'multipart':
                                if ($mailParts['_CONTENT_TYPE_DAT']['boundary']) {
index cdb48bc..0fc9e71 100644 (file)
  * Revised for TYPO3 3.6 July/2003 by Kasper Skårhøj
  * XHTML compliant
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  */
 
-
 /**
  * This class is the base for listing of database records and files in the modules Web>List and File>Filelist
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  * @package TYPO3
  * @subpackage t3lib
  * @see typo3/db_list.php, typo3/file_list.php
 class t3lib_recordList {
 
                // Used in this class:
-       var $iLimit = 10; // default Max items shown
-       var $leftMargin = 0; // OBSOLETE - NOT USED ANYMORE. leftMargin
+               // default Max items shown
+       var $iLimit = 10;
+               // OBSOLETE - NOT USED ANYMORE. leftMargin
+       var $leftMargin = 0;
        var $showIcon = 1;
        var $no_noWrap = 0;
-       var $oddColumnsCssClass = ''; // If set this is <td> CSS-classname for odd columns in addElement. Used with db_layout / pages section
+               // If set this is <td> CSS-classname for odd columns in addElement. Used with db_layout / pages section
+       var $oddColumnsCssClass = '';
        var $backPath = '';
-       var $fieldArray = Array(); // Decides the columns shown. Filled with values that refers to the keys of the data-array. $this->fieldArray[0] is the title column.
-       var $addElement_tdParams = array(); // Keys are fieldnames and values are td-parameters to add in addElement(), please use $addElement_tdCSSClass for CSS-classes;
-       var $addElement_tdCssClass = array(); // Keys are fieldnames and values are td-css-classes to add in addElement();
+               // Decides the columns shown. Filled with values that refers to the keys of the data-array. $this->fieldArray[0] is the title column.
+       var $fieldArray = array();
+               // Keys are fieldnames and values are td-parameters to add in addElement(), please use $addElement_tdCSSClass for CSS-classes;
+       var $addElement_tdParams = array();
+               // Keys are fieldnames and values are td-css-classes to add in addElement();
+       var $addElement_tdCssClass = array();
 
                // Not used in this class - but maybe extension classes...
-       var $fixedL = 30; // Max length of strings
+               // Max length of strings
+       var $fixedL = 30;
        var $script = '';
-       var $setLMargin = 1; // Set to zero, if you don't want a left-margin with addElement function
+               // Set to zero, if you don't want a left-margin with addElement function
+       var $setLMargin = 1;
 
-       var $counter = 0; // Counter increased for each element. Used to index elements for the JavaScript-code that transfers to the clipboard
-       var $totalItems = ''; // This could be set to the total number of items. Used by the fwd_rew_navigation...
+               // Counter increased for each element. Used to index elements for the JavaScript-code that transfers to the clipboard
+       var $counter = 0;
+               // This could be set to the total number of items. Used by the fwd_rew_navigation...
+       var $totalItems = '';
 
                // Internal (used in this class.)
        var $firstElementNumber = 0;
        var $eCounter = 0;
-       var $HTMLcode = ''; // String with accumulated HTML content
+               // String with accumulated HTML content
+       var $HTMLcode = '';
 
-       var $pageOverlays = array(); // Contains page translation languages
-       var $languageIconTitles = array(); // Contains sys language icons and titles
-       var $translateTools; // translateTools object
+               // Contains page translation languages
+       var $pageOverlays = array();
+               // Contains sys language icons and titles
+       var $languageIconTitles = array();
+               // TranslateTools object
+       var $translateTools;
 
        /**
-        * constructor for t3lib_recordList
-        *
-        * @author      Ingo Renner <ingo@typo3.org>
+        * Constructor for t3lib_recordList
         */
        public function __construct() {
                if (isset($GLOBALS['BE_USER']->uc['titleLen']) && $GLOBALS['BE_USER']->uc['titleLen'] > 0) {
@@ -89,13 +100,13 @@ class t3lib_recordList {
         * Returns a table-row with the content from the fields in the input data array.
         * OBS: $this->fieldArray MUST be set! (represents the list of fields to display)
         *
-        * @param       integer         $h is an integer >=0 and denotes how tall a element is. Set to '0' makes a halv line, -1 = full line, set to 1 makes a 'join' and above makes 'line'
-        * @param       string          $icon is the <img>+<a> of the record. If not supplied the first 'join'-icon will be a 'line' instead
-        * @param       array           $data is the dataarray, record with the fields. Notice: These fields are (currently) NOT htmlspecialchar'ed before being wrapped in <td>-tags
-        * @param       string          $tdParams is insert in the <td>-tags. Must carry a ' ' as first character
-        * @param       integer         OBSOLETE - NOT USED ANYMORE. $lMargin is the leftMargin (integer)
-        * @param       string          $altLine is the HTML <img>-tag for an alternative 'gfx/ol/line.gif'-icon (used in the top)
-        * @return      string          HTML content for the table row
+        * @param integer $h Is an integer >=0 and denotes how tall a element is. Set to '0' makes a halv line, -1 = full line, set to 1 makes a 'join' and above makes 'line'
+        * @param string $icon Is the <img>+<a> of the record. If not supplied the first 'join'-icon will be a 'line' instead
+        * @param array $data Is the dataarray, record with the fields. Notice: These fields are (currently) NOT htmlspecialchar'ed before being wrapped in <td>-tags
+        * @param string $tdParams Is insert in the <td>-tags. Must carry a ' ' as first character
+        * @param integer OBSOLETE - NOT USED ANYMORE. $lMargin is the leftMargin (integer)
+        * @param string $altLine Is the HTML <img>-tag for an alternative 'gfx/ol/line.gif'-icon (used in the top)
+        * @return string HTML content for the table row
         */
        function addElement($h, $icon, $data, $trParams = '', $lMargin = '', $altLine = '') {
                $noWrap = ($this->no_noWrap) ? '' : ' nowrap="nowrap"';
@@ -184,7 +195,7 @@ class t3lib_recordList {
        /**
         * Dummy function, used to write the top of a table listing.
         *
-        * @return      void
+        * @return void
         */
        function writeTop() {
        }
@@ -192,7 +203,7 @@ class t3lib_recordList {
        /**
         * Finishes the list with the "stopper"-gif, adding the HTML code for that item to the internal ->HTMLcode string
         *
-        * @return      void
+        * @return void
         */
        function writeBottom() {
                $this->HTMLcode .= '
@@ -210,14 +221,14 @@ class t3lib_recordList {
        /**
         * Creates a forward/reverse button based on the status of ->eCounter, ->firstElementNumber, ->iLimit
         *
-        * @param       string          Table name
-        * @return      array           array([boolean], [HTML]) where [boolean] is 1 for reverse element, [HTML] is the table-row code for the element
+        * @param string $table Table name
+        * @return array array([boolean], [HTML]) where [boolean] is 1 for reverse element, [HTML] is the table-row code for the element
         */
        function fwd_rwd_nav($table = '') {
                $code = '';
                if ($this->eCounter >= $this->firstElementNumber && $this->eCounter < $this->firstElementNumber + $this->iLimit) {
                        if ($this->firstElementNumber && $this->eCounter == $this->firstElementNumber) {
-                                       //      reverse
+                                       //      Reverse
                                $theData = Array();
                                $titleCol = $this->fieldArray[0];
                                $theData[$titleCol] = $this->fwd_rwd_HTML('fwd', $this->eCounter, $table);
@@ -226,7 +237,7 @@ class t3lib_recordList {
                        return array(1, $code);
                } else {
                        if ($this->eCounter == $this->firstElementNumber + $this->iLimit) {
-                                       //      forward
+                                       //      Forward
                                $theData = Array();
                                $titleCol = $this->fieldArray[0];
                                $theData[$titleCol] = $this->fwd_rwd_HTML('rwd', $this->eCounter, $table);
@@ -240,10 +251,10 @@ class t3lib_recordList {
        /**
         * Creates the button with link to either forward or reverse
         *
-        * @param       string          Type: "fwd" or "rwd"
-        * @param       integer         Pointer
-        * @param       string          Table name
-        * @return      string
+        * @param string $type Type: "fwd" or "rwd"
+        * @param integer $pointer Pointer
+        * @param string $table Table name
+        * @return string
         * @access private
         */
        function fwd_rwd_HTML($type, $pointer, $table = '') {
@@ -269,8 +280,8 @@ class t3lib_recordList {
        /**
         * Creates the URL to this script, including all relevant GPvars
         *
-        * @param       string          Alternative id value. Enter blank string for the current id ($this->id)
-        * @return      string          URL
+        * @param string $altId Alternative id value. Enter blank string for the current id ($this->id)
+        * @return string URL
         */
        function listURL($altId = '') {
                return $this->script .
@@ -280,7 +291,7 @@ class t3lib_recordList {
        /**
         * Returning JavaScript for ClipBoard functionality.
         *
-        * @return      string
+        * @return string
         */
        function CBfunctions() {
                return '
@@ -318,7 +329,7 @@ class t3lib_recordList {
        /**
         * Initializes page languages and icons
         *
-        * @return      void
+        * @return void
         */
        function initializeLanguages() {
 
@@ -341,8 +352,8 @@ class t3lib_recordList {
        /**
         * Return the icon for the language
         *
-        * @param integer Sys language uid
-        * @param boolean If set to true, only the flag is returned
+        * @param integer $sys_language_uid Sys language uid
+        * @param boolean $addAsAdditionalText If set to true, only the flag is returned
         *
         * @return string Language icon
         */
@@ -364,7 +375,7 @@ class t3lib_recordList {
        /**
         * Gets an instance of t3lib_transl8tools.
         *
-        * @return      t3lib_transl8tools
+        * @return t3lib_transl8tools
         */
        protected function getTranslateTools() {
                if (!isset($this->translateTools)) {
index 0f4adc8..526ce87 100644 (file)
@@ -26,7 +26,6 @@
  *  This copyright notice MUST APPEAR in all copies of the script!
  ***************************************************************/
 
-
 /**
  * A class to store and retrieve entries in a registry database table.
  *
@@ -37,8 +36,8 @@
  *
  * Credits: Heavily inspired by Drupal's variable_*() functions.
  *
- * @author     Ingo Renner <ingo@typo3.org>
- * @author     Bastian Waidelich <bastian@typo3.org>
+ * @author Ingo Renner <ingo@typo3.org>
+ * @author Bastian Waidelich <bastian@typo3.org>
  * @package TYPO3
  * @subpackage t3lib
  */
@@ -49,15 +48,14 @@ class t3lib_Registry implements t3lib_Singleton {
         */
        protected $entries = array();
 
-
        /**
         * Returns a persistent entry.
         *
-        * @param       string  Extension key for extensions starting with 'tx_' / 'Tx_' / 'user_' or 'core' for core registry entries
-        * @param       string  The key of the entry to return.
-        * @param       mixed   Optional default value to use if this entry has never been set. Defaults to NULL.
-        * @return      mixed   The value of the entry.
-        * @throws      InvalidArgumentException        Throws an exception if the given namespace is not valid
+        * @param string $namespace Extension key for extensions starting with 'tx_' / 'Tx_' / 'user_' or 'core' for core registry entries
+        * @param string $key The key of the entry to return.
+        * @param mixed $defaultValue Optional default value to use if this entry has never been set. Defaults to NULL.
+        * @return mixed The value of the entry.
+        * @throws InvalidArgumentException Throws an exception if the given namespace is not valid
         */
        public function get($namespace, $key, $defaultValue = NULL) {
                if (!isset($this->entries[$namespace])) {
@@ -72,11 +70,11 @@ class t3lib_Registry implements t3lib_Singleton {
         * Do not store binary data into the registry, it's not build to do that,
         * instead use the proper way to store binary data: The filesystem.
         *
-        * @param       string  Extension key for extensions starting with 'tx_' / 'Tx_' / 'user_' or 'core' for core registry entries.
-        * @param       string  The key of the entry to set.
-        * @param       mixed   The value to set. This can be any PHP data type; this class takes care of serialization if necessary.
-        * @return      void
-        * @throws      InvalidArgumentException        Throws an exception if the given namespace is not valid
+        * @param string $namespace Extension key for extensions starting with 'tx_' / 'Tx_' / 'user_' or 'core' for core registry entries.
+        * @param string $key The key of the entry to set.
+        * @param mixed $value The value to set. This can be any PHP data type; this class takes care of serialization if necessary.
+        * @return void
+        * @throws InvalidArgumentException Throws an exception if the given namespace is not valid
         */
        public function set($namespace, $key, $value) {
                $this->validateNamespace($namespace);
@@ -114,10 +112,10 @@ class t3lib_Registry implements t3lib_Singleton {
        /**
         * Unsets a persistent entry.
         *
-        * @param       string  Namespace. extension key for extensions or 'core' for core registry entries
-        * @param       string  The key of the entry to unset.
-        * @return      void
-        * @throws      InvalidArgumentException        Throws an exception if the given namespace is not valid
+        * @param string $namespace Namespace. extension key for extensions or 'core' for core registry entries
+        * @param string $key The key of the entry to unset.
+        * @return void
+        * @throws InvalidArgumentException Throws an exception if the given namespace is not valid
         */
        public function remove($namespace, $key) {
                $this->validateNamespace($namespace);
@@ -134,9 +132,9 @@ class t3lib_Registry implements t3lib_Singleton {
        /**
         * Unsets all persistent entries of the given namespace.
         *
-        * @param       string  Namespace. extension key for extensions or 'core' for core registry entries
-        * @return      void
-        * @throws      InvalidArgumentException        Throws an exception if the given namespace is not valid
+        * @param string $namespace Namespace. extension key for extensions or 'core' for core registry entries
+        * @return void
+        * @throws InvalidArgumentException Throws an exception if the given namespace is not valid
         */
        public function removeAllByNamespace($namespace) {
                $this->validateNamespace($namespace);
@@ -152,9 +150,9 @@ class t3lib_Registry implements t3lib_Singleton {
        /**
         * Loads all entries of the given namespace into the internal $entries cache.
         *
-        * @param       string  Namespace. extension key for extensions or 'core' for core registry entries
-        * @return      void
-        * @throws      InvalidArgumentException        Throws an exception if the given namespace is not valid
+        * @param string $namespace Namespace. extension key for extensions or 'core' for core registry entries
+        * @return void
+        * @throws InvalidArgumentException Throws an exception if the given namespace is not valid
         */
        protected function loadEntriesByNamespace($namespace) {
                $this->validateNamespace($namespace);
@@ -176,9 +174,9 @@ class t3lib_Registry implements t3lib_Singleton {
         * exception is thrown.
         * Allowed namespaces are 'core', 'tx_*', 'Tx_*' and 'user_*'
         *
-        * @param       string  Namespace. extension key for extensions or 'core' for core registry entries
-        * @return      void
-        * @throws      InvalidArgumentException        Throws an exception if the given namespace is not valid
+        * @param string $namespace Namespace. extension key for extensions or 'core' for core registry entries
+        * @return void
+        * @throws InvalidArgumentException Throws an exception if the given namespace is not valid
         */
        protected function validateNamespace($namespace) {
                if (t3lib_div::hasValidClassPrefix($namespace)) {
index 776e89f..e4d22c2 100644 (file)
  * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
  */
 
-
 /**
  * RTE base class: Delivers browser-detection, TCEforms binding and transformation routines for the "rte" extension, registering it with the RTE API in TYPO3 3.6.0
  * See "rte" extension for usage.
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  * @package TYPO3
  * @subpackage t3lib
  */
 class t3lib_rteapi {
 
                // Internal, dynamic:
-       var $errorLog = array(); // Error messages regarding non-availability is collected here.
+               // Error messages regarding non-availability is collected here.
+       var $errorLog = array();
 
                // Internal, static:
-       var $ID = ''; // Set this to the extension key of the RTE so it can identify itself.
-
+               // Set this to the extension key of the RTE so it can identify itself.
+       var $ID = '';
 
        /***********************************
         *
@@ -60,7 +60,7 @@ class t3lib_rteapi {
         * Returns TRUE if the RTE is available. Here you check if the browser requirements are met.
         * If there are reasons why the RTE cannot be displayed you simply enter them as text in ->errorLog
         *
-        * @return      boolean         TRUE if this RTE object offers an RTE in the current browser environment
+        * @return boolean TRUE if this RTE object offers an RTE in the current browser environment
         */
        function isAvailable() {
                $this->errorLog = array();
@@ -77,17 +77,17 @@ class t3lib_rteapi {
         * Draws the RTE as a form field or whatever is needed (inserts JavaApplet, creates iframe, renders ....)
         * Default is to output the transformed content in a plain textarea field. This mode is great for debugging transformations!
         *
-        * @param       object          Reference to parent object, which is an instance of the TCEforms.
-        * @param       string          The table name
-        * @param       string          The field name
-        * @param       array           The current row from which field is being rendered
-        * @param       array           Array of standard content for rendering form fields from TCEforms. See TCEforms for details on this. Includes for instance the value and the form field name, java script actions and more.
-        * @param       array           "special" configuration - what is found at position 4 in the types configuration of a field from record, parsed into an array.
-        * @param       array           Configuration for RTEs; A mix between TSconfig and otherwise. Contains configuration for display, which buttons are enabled, additional transformation information etc.
-        * @param       string          Record "type" field value.
-        * @param       string          Relative path for images/links in RTE; this is used when the RTE edits content from static files where the path of such media has to be transformed forth and back!
-        * @param       integer         PID value of record (true parent page id)
-        * @return      string          HTML code for RTE!
+        * @param object $pObj Reference to parent object, which is an instance of the TCEforms.
+        * @param string $table The table name
+        * @param string $field The field name
+        * @param array $row The current row from which field is being rendered
+        * @param array $PA Array of standard content for rendering form fields from TCEforms. See TCEforms for details on this. Includes for instance the value and the form field name, java script actions and more.
+        * @param array $specConf "special" configuration - what is found at position 4 in the types configuration of a field from record, parsed into an array.
+        * @param array $thisConfig Configuration for RTEs; A mix between TSconfig and otherwise. Contains configuration for display, which buttons are enabled, additional transformation information etc.
+        * @param string $RTEtypeVal Record "type" field value.
+        * @param string $RTErelPath Relative path for images/links in RTE; this is used when the RTE edits content from static files where the path of such media has to be transformed forth and back!
+        * @param integer $thePidValue PID value of record (true parent page id)
+        * @return string HTML code for RTE!
         */
        function drawRTE(&$pObj, $table, $field, $row, $PA, $specConf, $thisConfig, $RTEtypeVal, $RTErelPath, $thePidValue) {
 
@@ -112,25 +112,22 @@ class t3lib_rteapi {
         * a) Right before content from database is sent to the RTE (see ->drawRTE()) it might need transformation
         * b) When content is sent from the RTE and into the database it might need transformation back again (going on in TCEmain class; You can't affect that.)
         *
-        * @param       string          Keyword: "rte" means direction from db to rte, "db" means direction from Rte to DB
-        * @param       string          Value to transform.
-        * @param       string          The table name
-        * @param       string          The field name
-        * @param       array           The current row from which field is being rendered
-        * @param       array           "special" configuration - what is found at position 4 in the types configuration of a field from record, parsed into an array.
-        * @param       array           Configuration for RTEs; A mix between TSconfig and otherwise. Contains configuration for display, which buttons are enabled, additional transformation information etc.
-        * @param       string          Relative path for images/links in RTE; this is used when the RTE edits content from static files where the path of such media has to be transformed forth and back!
-        * @param       integer         PID value of record (true parent page id)
-        * @return      string          Transformed content
+        * @param string $dirRTE Keyword: "rte" means direction from db to rte, "db" means direction from Rte to DB
+        * @param string $value Value to transform.
+        * @param string $table The table name
+        * @param string $field The field name
+        * @param array $row The current row from which field is being rendered
+        * @param array $specConf "special" configuration - what is found at position 4 in the types configuration of a field from record, parsed into an array.
+        * @param array $thisConfig Configuration for RTEs; A mix between TSconfig and otherwise. Contains configuration for display, which buttons are enabled, additional transformation information etc.
+        * @param string $RTErelPath Relative path for images/links in RTE; this is used when the RTE edits content from static files where the path of such media has to be transformed forth and back!
+        * @param integer $pid PID value of record (true parent page id)
+        * @return string Transformed content
         */
        function transformContent($dirRTE, $value, $table, $field, $row, $specConf, $thisConfig, $RTErelPath, $pid) {
-
-               #debug(array($dirRTE,$value,$table,$field,array(),$specConf,$thisConfig,$RTErelPath,$pid));
-
                if ($specConf['rte_transform']) {
                        $p = t3lib_BEfunc::getSpecConfParametersFromArray($specConf['rte_transform']['parameters']);
-                       if ($p['mode']) { // There must be a mode set for transformation
-                               #debug($p['mode'],'MODE');
+                               // There must be a mode set for transformation
+                       if ($p['mode']) {
 
                                        // Initialize transformation:
                                $parseHTML = t3lib_div::makeInstance('t3lib_parsehtml_proc');
@@ -142,11 +139,9 @@ class t3lib_rteapi {
                        }
                }
 
-               #debug(array($dirRTE,$value),'OUT: '.$dirRTE);
                return $value;
        }
 
-
        /***********************************
         *
         * Helper functions
@@ -156,8 +151,8 @@ class t3lib_rteapi {
        /**
         * Trigger field - this field tells the TCEmain that processing should be done on this value!
         *
-        * @param       string          Field name of the RTE field.
-        * @return      string          <input> field of type "hidden" with a flag telling the TCEmain that this fields content should be traansformed back to database state.
+        * @param string $fieldName Field name of the RTE field.
+        * @return string <input> field of type "hidden" with a flag telling the TCEmain that this fields content should be traansformed back to database state.
         */
        function triggerField($fieldName) {