[TASK] Clean up phpDoc comments in typo3/sysext/
authorWouter Wolters <typo3@wouterwolters.nl>
Thu, 14 Jun 2012 21:10:34 +0000 (23:10 +0200)
committerChristian Kuhn <lolli@schwarzbu.ch>
Thu, 14 Jun 2012 21:46:17 +0000 (23:46 +0200)
Clean up phpDoc comments for the following classes:

* typo3/sysext/cms/tslib/content/class.tslib_content_abstract.php
* typo3/sysext/cms/tslib/content/class.tslib_content_case.php
* typo3/sysext/cms/tslib/content/class.tslib_content_cleargif.php
* typo3/sysext/cms/tslib/content/class.tslib_content_columns.php
* typo3/sysext/cms/tslib/content/class.tslib_content_content.php
* typo3/sysext/cms/tslib/content/
class.tslib_content_contentobjectarray.php
* typo3/sysext/cms/tslib/content/
class.tslib_content_contentobjectarrayinternal.php
* typo3/sysext/cms/tslib/content/class.tslib_content_contenttable.php
* typo3/sysext/cms/tslib/content/class.tslib_content_editpanel.php
* typo3/sysext/cms/tslib/content/class.tslib_content_file.php
* typo3/sysext/cms/tslib/content/class.tslib_content_files.php
* typo3/sysext/cms/tslib/content/class.tslib_content_flowplayer.php
* typo3/sysext/cms/tslib/content/class.tslib_content_fluidtemplate.php
* typo3/sysext/cms/tslib/content/class.tslib_content_form.php
* typo3/sysext/cms/tslib/content/class.tslib_content_hierarchicalmenu.php
* typo3/sysext/cms/tslib/content/class.tslib_content_horizontalruler.php
* typo3/sysext/cms/tslib/content/class.tslib_content_image.php
* typo3/sysext/cms/tslib/content/class.tslib_content_imageresource.php

Clean up provides:

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

Change-Id: I2a6c88091a5f45c9a8a765e2ef6b43e562a83145
Resolves: #38058
Releases: 6.0
Reviewed-on: http://review.typo3.org/12072
Reviewed-by: Christian Kuhn
Tested-by: Christian Kuhn
18 files changed:
typo3/sysext/cms/tslib/content/class.tslib_content_abstract.php
typo3/sysext/cms/tslib/content/class.tslib_content_case.php
typo3/sysext/cms/tslib/content/class.tslib_content_cleargif.php
typo3/sysext/cms/tslib/content/class.tslib_content_columns.php
typo3/sysext/cms/tslib/content/class.tslib_content_content.php
typo3/sysext/cms/tslib/content/class.tslib_content_contentobjectarray.php
typo3/sysext/cms/tslib/content/class.tslib_content_contentobjectarrayinternal.php
typo3/sysext/cms/tslib/content/class.tslib_content_contenttable.php
typo3/sysext/cms/tslib/content/class.tslib_content_editpanel.php
typo3/sysext/cms/tslib/content/class.tslib_content_file.php
typo3/sysext/cms/tslib/content/class.tslib_content_files.php
typo3/sysext/cms/tslib/content/class.tslib_content_flowplayer.php
typo3/sysext/cms/tslib/content/class.tslib_content_fluidtemplate.php
typo3/sysext/cms/tslib/content/class.tslib_content_form.php
typo3/sysext/cms/tslib/content/class.tslib_content_hierarchicalmenu.php
typo3/sysext/cms/tslib/content/class.tslib_content_horizontalruler.php
typo3/sysext/cms/tslib/content/class.tslib_content_image.php
typo3/sysext/cms/tslib/content/class.tslib_content_imageresource.php

index e81e29e..5f7f554 100644 (file)
@@ -35,7 +35,7 @@
 abstract class tslib_content_Abstract {
 
        /**
-        * @var $cObj tslib_cObj
+        * @var tslib_cObj $cObj
         */
        protected $cObj;
 
@@ -72,4 +72,4 @@ abstract class tslib_content_Abstract {
        protected $fileFactory = NULL;
 }
 
-?>
+?>
\ No newline at end of file
index a68fc4a..4694776 100644 (file)
@@ -37,8 +37,8 @@ class tslib_content_Case extends tslib_content_Abstract {
        /**
         * Rendering the cObject, CASE
         *
-        * @param       array           Array of TypoScript properties
-        * @return      string          Output
+        * @param array $conf Array of TypoScript properties
+        * @return string Output
         */
        public function render($conf = array()) {
                if ($this->cObj->checkIf($conf['if.'])) {
index 9b35637..f80234d 100644 (file)
@@ -37,8 +37,8 @@ class tslib_content_ClearGif extends tslib_content_Abstract {
        /**
         * Rendering the cObject, CLEARGIF
         *
-        * @param       array           Array of TypoScript properties
-        * @return      string          Output
+        * @param array $conf Array of TypoScript properties
+        * @return string Output
         */
        public function render($conf = array()) {
 
@@ -74,7 +74,6 @@ class tslib_content_ClearGif extends tslib_content_Abstract {
                }
 
                return $theValue;
-
        }
 }
 ?>
\ No newline at end of file
index 30f49c8..ecbf926 100644 (file)
@@ -37,8 +37,8 @@ class tslib_content_Columns extends tslib_content_Abstract {
        /**
         * Rendering the cObject, COLUMNS
         *
-        * @param       array           Array of TypoScript properties
-        * @return      string          Output
+        * @param array $conf Array of TypoScript properties
+        * @return string Output
         */
        public function render($conf = array()) {
                $content = '';
@@ -87,16 +87,16 @@ class tslib_content_Columns extends tslib_content_Abstract {
                                                $gapLine = intval($gapConf['gapLineThickness']);
                                                if ($gapLine) {
                                                        $gapSurround = t3lib_utility_Math::forceIntegerInRange(($gapWidth - $gapLine) / 2, 1, 1000);
-                                                       // right gap
+                                                               // right gap
                                                        $content .= '<td' . $tdPar . '><img src="' . $GLOBALS['TSFE']->absRefPrefix . 'clear.gif" width="' .
                                                                $gapSurround . '" height="1" alt="" title="" /></td>';
                                                        $tdRowCount++;
-                                                       // line:
+                                                               // line:
                                                        $GtdPar = $gapConf['gapLineCol'] ? ' bgcolor="' . $gapConf['gapLineCol'] . '"' : ' bgcolor="black"';
                                                        $content .= '<td' . $GtdPar . '><img src="' . $GLOBALS['TSFE']->absRefPrefix . 'clear.gif" width="' .
                                                                $gapLine . '" height="1" alt="" title="" /></td>';
                                                        $tdRowCount++;
-                                                       // left gap
+                                                               // left gap
                                                        $content .= '<td' . $tdPar . '><img src="' . $GLOBALS['TSFE']->absRefPrefix . 'clear.gif" width="' .
                                                                $gapSurround . '" height="1" alt="" title="" /></td>';
                                                        $tdRowCount++;
index ab5ff41..1dd4574 100644 (file)
@@ -37,14 +37,16 @@ class tslib_content_Content extends tslib_content_Abstract {
        /**
         * Rendering the cObject, CONTENT
         *
-        * @param       array           Array of TypoScript properties
-        * @return      string          Output
+        * @param array $conf Array of TypoScript properties
+        * @return string Output
         */
        public function render($conf = array()) {
                $theValue = '';
 
                $originalRec = $GLOBALS['TSFE']->currentRecord;
-               if ($originalRec) { // If the currentRecord is set, we register, that this record has invoked this function. It's should not be allowed to do this again then!!
+                       // If the currentRecord is set, we register, that this record has invoked this function.
+                       // It's should not be allowed to do this again then!!
+               if ($originalRec) {
                        $GLOBALS['TSFE']->recordRegister[$originalRec]++;
                }
 
@@ -123,7 +125,8 @@ class tslib_content_Content extends tslib_content_Abstract {
                                                        }
                                                }
 
-                                               if (is_array($row)) { // Might be unset in the sys_language_contentOL
+                                                       // Might be unset in the sys_language_contentOL
+                                               if (is_array($row)) {
                                                                // Call hook for possible manipulation of database row for cObj->data
                                                        if (is_array($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_content_content.php']['modifyDBRow'])) {
                                                                foreach($this->TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_content_content.php']['modifyDBRow'] as $_classRef) {
@@ -181,10 +184,10 @@ class tslib_content_Content extends tslib_content_Abstract {
                        $theValue = $this->cObj->stdWrap($theValue, $conf['stdWrap.']);
                }
 
-               $GLOBALS['TSFE']->currentRecord = $originalRec; // Restore
+                       // Restore
+               $GLOBALS['TSFE']->currentRecord = $originalRec;
 
                return $theValue;
-
        }
 }
 ?>
\ No newline at end of file
index b8f48b0..14b87dd 100644 (file)
@@ -37,8 +37,8 @@ class tslib_content_ContentObjectArray extends tslib_content_Abstract {
        /**
         * Rendering the cObject, COBJ_ARRAY / COA
         *
-        * @param       array           Array of TypoScript properties
-        * @return      string          Output
+        * @param array $conf Array of TypoScript properties
+        * @return string Output
         */
        public function render($conf = array()) {
                if (is_array($conf)) {
index 0603995..8f3a17e 100644 (file)
@@ -37,8 +37,8 @@ class tslib_content_ContentObjectArrayInternal extends tslib_content_Abstract {
        /**
         * Rendering the cObject, COA_INT
         *
-        * @param       array           Array of TypoScript properties
-        * @return      string          Output
+        * @param array $conf Array of TypoScript properties
+        * @return string Output
         */
        public function render($conf = array()) {
                if (is_array($conf)) {
index 8ad5ff4..80ccc3b 100644 (file)
@@ -37,8 +37,8 @@ class tslib_content_ContentTable extends tslib_content_Abstract {
        /**
         * Rendering the cObject, CTABLE
         *
-        * @param       array           Array of TypoScript properties
-        * @return      string          Output
+        * @param array $conf Array of TypoScript properties
+        * @return string Output
         */
        public function render($conf = array()) {
 
@@ -56,7 +56,7 @@ class tslib_content_ContentTable extends tslib_content_Abstract {
                        : $conf['cWidth'];
                $controlTable->contentW = $conf['cWidth'];
 
-               // loads the menues if any
+                       // loads the menues if any
                if (is_array($conf['c.'])) {
                        $controlTable->content = $this->cObj->cObjGet($conf['c.'], 'c.');
                        $contentTDParams = isset($conf['c.']['TDParams.'])
@@ -118,7 +118,6 @@ class tslib_content_ContentTable extends tslib_content_Abstract {
                }
 
                return $theValue;
-
        }
 }
 ?>
\ No newline at end of file
index 2317233..b4cef9d 100644 (file)
@@ -35,8 +35,8 @@ class tslib_content_EditPanel extends tslib_content_Abstract {
        /**
         * Rendering the cObject, EDITPANEL
         *
-        * @param       array           Array of TypoScript properties
-        * @return      string          Output
+        * @param array $conf Array of TypoScript properties
+        * @return string Output
         */
        public function render($conf = array()) {
                $theValue = '';
index 01c1ba4..111efc8 100644 (file)
@@ -37,8 +37,8 @@ class tslib_content_File extends tslib_content_Abstract {
        /**
         * Rendering the cObject, FILE
         *
-        * @param       array           Array of TypoScript properties
-        * @return      string          Output
+        * @param array $conf Array of TypoScript properties
+        * @return string Output
         */
        public function render($conf = array()) {
 
@@ -67,7 +67,6 @@ class tslib_content_File extends tslib_content_Abstract {
                }
 
                return $theValue;
-
        }
 }
 ?>
\ No newline at end of file
index 49f8d38..fb93e2d 100644 (file)
@@ -34,7 +34,7 @@ class tslib_content_Files extends tslib_content_Abstract {
        /**
         * Rendering the cObject FILES
         *
-        * @param array Array of TypoScript properties
+        * @param array $conf Array of TypoScript properties
         * @return string Output
         */
        public function render($conf = array()) {
@@ -155,8 +155,8 @@ class tslib_content_Files extends tslib_content_Abstract {
         * Gets a configuration value by passing them through stdWrap first and taking a default value if stdWrap doesn't yield a result.
         *
         * @param string $key The config variable key (from TS array).
-        * @param array $config  The TypoScript array.
-        * @param string $defaultValue  Optional default value.
+        * @param array $config The TypoScript array.
+        * @param string $defaultValue Optional default value.
         * @return string Value of the config variable
         */
        protected function stdWrapValue($key, array $config, $defaultValue = '') {
index c7a287f..70931a2 100644 (file)
@@ -200,8 +200,8 @@ class tslib_content_FlowPlayer extends tslib_content_Abstract {
        /**
         * Rendering the cObject, SWFOBJECT
         *
-        * @param       array   $conf   Array of TypoScript properties
-        * @return      string  Output
+        * @param array $conf Array of TypoScript properties
+        * @return string Output
         */
        public function render($conf = array()) {
                $prefix = '';
@@ -547,7 +547,7 @@ class tslib_content_FlowPlayer extends tslib_content_Abstract {
                                }
                        }
                        $videoJsOptions = count($videoJsOptions) ? json_encode($videoJsOptions) : '{}';
-       
+
                                // videoJS setup and videoJS listeners for audio description synchronisation
                        if ($audioSources || isset($conf['audioFallback'])) {
                                $videoJsSetup = '
@@ -586,8 +586,8 @@ class tslib_content_FlowPlayer extends tslib_content_Abstract {
                                                }
                                                        // Create "track" elements
                                                if (isset($conf['caption'])) {
-                                                       // Assemble captions track tag
-                                                       // It will take a while before the captions are loaded and parsed...
+                                                               // Assemble captions track tag
+                                                               // It will take a while before the captions are loaded and parsed...
                                                        $videoTagAssembly .= '
                        var track  = document.createElement("track");
                        track.setAttribute("src", "' . $conf['caption'] . '");
@@ -785,7 +785,7 @@ class tslib_content_FlowPlayer extends tslib_content_Abstract {
                        $videoSourcesEmbedding .
                        $flowplayerHandlers;
                if ($jsInlineCode) {
-                       $jsInlineCode = 'VideoJS.DOMReady(function(){' . 
+                       $jsInlineCode = 'VideoJS.DOMReady(function(){' .
                        $jsInlineCode . LF .
                        '});';
                }
index a38f032..841a90b 100644 (file)
@@ -54,11 +54,11 @@ class tslib_content_FluidTemplate extends tslib_content_Abstract {
         *    mylabel.value = Label from TypoScript coming
         * }
         *
-        * @param       array           array of TypoScript properties
-        * @return      string          the HTML output
-        * @author      Steffen Ritter          <info@steffen-ritter.net>
-        * @author      Benjamin Mack           <benni@typo3.org>
-        * @author      Bastian Waidelich       <bastian@typo3.org>
+        * @param array $conf Array of TypoScript properties
+        * @return string The HTML output
+        * @author Steffen Ritter <info@steffen-ritter.net>
+        * @author Benjamin Mack <benni@typo3.org>
+        * @author Bastian Waidelich <bastian@typo3.org>
         */
        public function render($conf = array()) {
                        // check if the needed extensions are installed
@@ -70,14 +70,14 @@ class tslib_content_FluidTemplate extends tslib_content_Abstract {
                 * 1. initializing Fluid StandaloneView and setting configuration parameters
                 **/
                $view = t3lib_div::makeInstance('Tx_Fluid_View_StandaloneView');
-                       // fetch the Fluid template
+                       // Fetch the Fluid template
                $file = isset($conf['file.'])
                        ? $this->cObj->stdWrap($conf['file'], $conf['file.'])
                        : $conf['file'];
                $templatePathAndFilename = $GLOBALS['TSFE']->tmpl->getFileName($file);
                $view->setTemplatePathAndFilename($templatePathAndFilename);
 
-                       // override the default layout path via typoscript
+                       // Override the default layout path via typoscript
                $layoutRootPath = isset($conf['layoutRootPath.'])
                        ? $this->cObj->stdWrap($conf['layoutRootPath'], $conf['layoutRootPath.'])
                        : $conf['layoutRootPath'];
@@ -86,7 +86,7 @@ class tslib_content_FluidTemplate extends tslib_content_Abstract {
                        $view->setLayoutRootPath($layoutRootPath);
                }
 
-                       // override the default partials path via typoscript
+                       // Override the default partials path via typoscript
                $partialRootPath = isset($conf['partialRootPath.'])
                        ? $this->cObj->stdWrap($conf['partialRootPath'], $conf['partialRootPath.'])
                        : $conf['partialRootPath'];
@@ -95,7 +95,7 @@ class tslib_content_FluidTemplate extends tslib_content_Abstract {
                        $view->setPartialRootPath($partialRootPath);
                }
 
-                       // override the default format
+                       // Override the default format
                $format = isset($conf['format.'])
                        ? $this->cObj->stdWrap($conf['format'], $conf['format.'])
                        : $conf['format'];
@@ -103,7 +103,7 @@ class tslib_content_FluidTemplate extends tslib_content_Abstract {
                        $view->setFormat($format);
                }
 
-                       // set some default variables for initializing Extbase
+                       // Set some default variables for initializing Extbase
                $requestPluginName = isset($conf['extbase.']['pluginName.'])
                        ? $this->cObj->stdWrap($conf['extbase.']['pluginName'], $conf['extbase.']['pluginName.'])
                        : $conf['extbase.']['pluginName'];
@@ -136,7 +136,7 @@ class tslib_content_FluidTemplate extends tslib_content_Abstract {
                 * 2. variable assignment
                 */
                $reservedVariables = array('data', 'current');
-                       // accumulate the variables to be replaced
+                       // Accumulate the variables to be replaced
                        // and loop them through cObjGetSingle
                $variables = (array) $conf['variables.'];
                foreach ($variables as $variableName => $cObjType) {
@@ -162,8 +162,6 @@ class tslib_content_FluidTemplate extends tslib_content_Abstract {
                }
 
                return $theValue;
-
        }
-
 }
 ?>
\ No newline at end of file
index f7a754f..1e02f3f 100644 (file)
@@ -49,9 +49,9 @@ class tslib_content_Form extends tslib_content_Abstract {
         *
         * If $formData is an array the value of $conf['data'] is ignored.
         *
-        * @param       array           Array of TypoScript properties
-        * @param       array           Alternative formdata overriding whatever comes from TypoScript
-        * @return      string          Output
+        * @param array $conf Array of TypoScript properties
+        * @param array $formData Alternative formdata overriding whatever comes from TypoScript
+        * @return string Output
         */
        public function render($conf = array(), $formData = '') {
                $content = '';
@@ -123,7 +123,7 @@ class tslib_content_Form extends tslib_content_Abstract {
                                                        : $singleKeyArray['specialEval'];
                                                list ($temp[3]) = explode('|', $specialEval);
 
-                                                       // adding the form entry to the dataArray
+                                                       // Adding the form entry to the dataArray
                                                $dataArray[] = implode('|', $temp);
                                        }
                                }
@@ -145,7 +145,8 @@ class tslib_content_Form extends tslib_content_Abstract {
                if ($formName) {
                        $formName = $this->cObj->cleanFormName($formName);
                } else {
-                       $formName = 'a' . $GLOBALS['TSFE']->uniqueHash(); // form name has to start with a letter to reach XHTML compliance
+                               // form name has to start with a letter to reach XHTML compliance
+                       $formName = 'a' . $GLOBALS['TSFE']->uniqueHash();
                }
 
                $fieldPrefix = isset($conf['fieldPrefix.'])
@@ -167,7 +168,8 @@ class tslib_content_Form extends tslib_content_Abstract {
                        $confData = array();
                        if (is_array($formData)) {
                                $parts = $dataValue;
-                               $dataValue = 1; // TRUE...
+                                       // TRUE...
+                               $dataValue = 1;
                        } else {
                                $dataValue = trim($dataValue);
                                $parts = explode('|', $dataValue);
@@ -374,21 +376,25 @@ class tslib_content_Form extends tslib_content_Abstract {
                                                $size = trim($fParts[1]) ? t3lib_utility_Math::forceIntegerInRange($fParts[1], 1, 20) : 1;
                                                        // multiple
                                                $multiple = strtolower(trim($fParts[2])) == 'm' ? ' multiple="multiple"' : '';
-
-                                               $items = array(); // Where the items will be
-                                               $defaults = array(); //RTF
+                                                       // Where the items will be
+                                               $items = array();
+                                                       //RTF
+                                               $defaults = array();
                                                $pCount = count($valueParts);
                                                for ($a = 0; $a < $pCount; $a++) {
                                                        $valueParts[$a] = trim($valueParts[$a]);
-                                                       if (substr($valueParts[$a], 0, 1) == '*') { // Finding default value
+                                                               // Finding default value
+                                                       if (substr($valueParts[$a], 0, 1) == '*') {
                                                                $sel = 'selected';
                                                                $valueParts[$a] = substr($valueParts[$a], 1);
                                                        } else
                                                                $sel = '';
                                                                // Get value/label
                                                        $subParts = explode('=', $valueParts[$a]);
-                                                       $subParts[1] = (isset($subParts[1]) ? trim($subParts[1]) : trim($subParts[0])); // Sets the value
-                                                       $items[] = $subParts; // Adds the value/label pair to the items-array
+                                                               // Sets the value
+                                                       $subParts[1] = (isset($subParts[1]) ? trim($subParts[1]) : trim($subParts[0]));
+                                                               // Adds the value/label pair to the items-array
+                                                       $items[] = $subParts;
                                                        if ($sel) {
                                                                $defaults[] = $subParts[1];
                                                        } // Sets the default value if value/label pair is marked as default.
@@ -432,7 +438,8 @@ class tslib_content_Form extends tslib_content_Abstract {
                                                $option = '';
 
                                                $valueParts = explode(',', $parts[2]);
-                                               $items = array(); // Where the items will be
+                                                       // Where the items will be
+                                               $items = array();
                                                $default = '';
                                                $pCount = count($valueParts);
                                                for ($a = 0; $a < $pCount; $a++) {
@@ -444,8 +451,10 @@ class tslib_content_Form extends tslib_content_Abstract {
                                                                $sel = '';
                                                                // Get value/label
                                                        $subParts = explode('=', $valueParts[$a]);
-                                                       $subParts[1] = (isset($subParts[1]) ? trim($subParts[1]) : trim($subParts[0])); // Sets the value
-                                                       $items[] = $subParts; // Adds the value/label pair to the items-array
+                                                               // Sets the value
+                                                       $subParts[1] = (isset($subParts[1]) ? trim($subParts[1]) : trim($subParts[0]));
+                                                               // Adds the value/label pair to the items-array
+                                                       $items[] = $subParts;
                                                        if ($sel) {
                                                                $default = $subParts[1];
                                                        } // Sets the default value if value/label pair is marked as default.
@@ -598,7 +607,7 @@ class tslib_content_Form extends tslib_content_Abstract {
                                                $modeParameters = array();
                                        }
 
-                                       // Adding evaluation based on settings:
+                                               // Adding evaluation based on settings:
                                        switch ((string) $modeParameters[0]) {
                                                case 'EREG' :
                                                        $fieldlist[] = '_EREG';
@@ -606,13 +615,15 @@ class tslib_content_Form extends tslib_content_Abstract {
                                                        $fieldlist[] = $modeParameters[2];
                                                        $fieldlist[] = $confData['fieldname'];
                                                        $fieldlist[] = $confData['label'];
-                                                       $confData['required'] = 1; // Setting this so "required" layout is used.
+                                                               // Setting this so "required" layout is used.
+                                                       $confData['required'] = 1;
                                                break;
                                                case 'EMAIL' :
                                                        $fieldlist[] = '_EMAIL';
                                                        $fieldlist[] = $confData['fieldname'];
                                                        $fieldlist[] = $confData['label'];
-                                                       $confData['required'] = 1; // Setting this so "required" layout is used.
+                                                               // Setting this so "required" layout is used.
+                                                       $confData['required'] = 1;
                                                break;
                                                default :
                                                        if ($confData['required']) {
@@ -699,8 +710,7 @@ class tslib_content_Form extends tslib_content_Abstract {
                        $content = $this->cObj->stdWrap($content, $conf['stdWrap.']);
                }
 
-
-                       // redirect (external: where to go afterwards. internal: where to submit to)
+                       // Redirect (external: where to go afterwards. internal: where to submit to)
                $theRedirect = isset($conf['redirect.'])
                        ? $this->cObj->stdWrap($conf['redirect'], $conf['redirect.'])
                        : $conf['redirect']; // redirect should be set to the page to redirect to after an external script has been used. If internal scripts is used, and if no 'type' is set that dictates otherwise, redirect is used as the url to jump to as long as it's an integer (page)
@@ -711,7 +721,8 @@ class tslib_content_Form extends tslib_content_Abstract {
                        ? $this->cObj->stdWrap($conf['no_cache'], $conf['no_cache.'])
                        : $conf['no_cache']; // redirect should be set to the page to redirect to after an external script has been used. If internal scripts is used, and if no 'type' is set that dictates otherwise, redirect is used as the url to jump to as long as it's an integer (page)
                $page = $GLOBALS['TSFE']->page;
-               if (!$theRedirect) { // Internal: Just submit to current page
+                       // Internal: Just submit to current page
+               if (!$theRedirect) {
                        $LD = $GLOBALS['TSFE']->tmpl->linkData(
                                $page,
                                $target,
@@ -751,7 +762,8 @@ class tslib_content_Form extends tslib_content_Abstract {
                                ? $this->cObj->stdWrap($conf['type'], $conf['type.'])
                                : $conf['type'];
                }
-               if (t3lib_utility_Math::canBeInterpretedAsInteger($formtype)) { // Submit to a specific page
+                       // Submit to a specific page
+               if (t3lib_utility_Math::canBeInterpretedAsInteger($formtype)) {
                        $page = $GLOBALS['TSFE']->sys_page->getPage_noCheck($formtype);
                        $LD_A = $GLOBALS['TSFE']->tmpl->linkData(
                                $page,
@@ -807,7 +819,7 @@ class tslib_content_Form extends tslib_content_Abstract {
                        $hiddenfields .= '<input type="hidden" name="locationData" value="' . htmlspecialchars($locationData) . '" />';
                }
 
-                       // hidden fields:
+                       // Hidden fields:
                if (is_array($conf['hiddenFields.'])) {
                        foreach ($conf['hiddenFields.'] as $hF_key => $hF_conf) {
                                if (substr($hF_key, -1) != '.') {
index 7df4ed2..eb465b0 100644 (file)
@@ -37,8 +37,8 @@ class tslib_content_HierarchicalMenu extends tslib_content_Abstract {
        /**
         * Rendering the cObject, HMENU
         *
-        * @param       array           Array of TypoScript properties
-        * @return      string          Output
+        * @param array $conf Array of TypoScript properties
+        * @return string Output
         */
        public function render($conf = array()) {
 
@@ -70,7 +70,6 @@ class tslib_content_HierarchicalMenu extends tslib_content_Abstract {
                                $menu->makeMenu();
 
                                $theValue .= $menu->writeMenu();
-
                        }
 
                        $wrap =  isset($conf['wrap.'])
@@ -87,7 +86,6 @@ class tslib_content_HierarchicalMenu extends tslib_content_Abstract {
                }
 
                return $theValue;
-
        }
 }
 ?>
\ No newline at end of file
index fdc2e04..cf55fea 100644 (file)
@@ -37,8 +37,8 @@ class tslib_content_HorizontalRuler extends tslib_content_Abstract {
        /**
         * Rendering the cObject, HRULER
         *
-        * @param       array           Array of TypoScript properties
-        * @return      string          Output
+        * @param array $conf Array of TypoScript properties
+        * @return string Output
         */
        public function render($conf = array()) {
 
@@ -101,7 +101,6 @@ class tslib_content_HorizontalRuler extends tslib_content_Abstract {
                }
 
                return $theValue;
-
        }
 }
 ?>
\ No newline at end of file
index 82daca8..f31b7c3 100644 (file)
@@ -37,8 +37,8 @@ class tslib_content_Image extends tslib_content_Abstract {
        /**
         * Rendering the cObject, IMAGE
         *
-        * @param       array           Array of TypoScript properties
-        * @return      string          Output
+        * @param array $conf Array of TypoScript properties
+        * @return string Output
         */
        public function render($conf = array()) {
                if ($this->cObj->checkIf($conf['if.'])) {
index 13d73db..8fe4e90 100644 (file)
@@ -37,8 +37,8 @@ class tslib_content_ImageResource extends tslib_content_Abstract {
        /**
         * Rendering the cObject, IMG_RESOURCE
         *
-        * @param       array           Array of TypoScript properties
-        * @return      string          Output
+        * @param array $conf Array of TypoScript properties
+        * @return string Output
         */
        public function render($conf = array()) {