[TASK] Clean up phpDoc comments in typo3/sysext/
authorWouter Wolters <typo3@wouterwolters.nl>
Fri, 15 Jun 2012 17:24:35 +0000 (19:24 +0200)
committerChristian Kuhn <lolli@schwarzbu.ch>
Wed, 20 Jun 2012 21:14:14 +0000 (23:14 +0200)
Clean up phpDoc comments for the following classes:

* typo3/sysext/cms/tslib/interfaces/
interface.tslib_content_cobjgetsinglehook.php
* typo3/sysext/cms/tslib/interfaces/
interface.tslib_content_fileLinkHook.php
* typo3/sysext/cms/tslib/interfaces/
interface.tslib_content_getPublicUrlForFileHook.php
* typo3/sysext/cms/tslib/interfaces/
interface.tslib_content_getdatahook.php
* typo3/sysext/cms/tslib/interfaces/
interface.tslib_content_getimgresourcehook.php
* typo3/sysext/cms/tslib/interfaces/
interface.tslib_content_postinithook.php
* typo3/sysext/cms/tslib/interfaces/
interface.tslib_content_stdwraphook.php
* typo3/sysext/cms/tslib/interfaces/
interface.tslib_mediawizardprovider.php
* typo3/sysext/cms/tslib/interfaces/
interface.tslib_menu_filterMenuPagesHook.php
* typo3/sysext/cms/tslib/media/scripts/example_callfunction.php
* typo3/sysext/cms/tslib/media/scripts/example_itemArrayProcFunc.php
* typo3/sysext/cms/tslib/media/scripts/example_keepRollover.js
* typo3/sysext/cms/tslib/media/scripts/example_keepRollover.php
* typo3/sysext/cms/tslib/media/scripts/example_languageMenu.php
* typo3/sysext/cms/tslib/media/scripts/example_typolinkpop.php

Clean up provides:

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

Change-Id: Ia3cc5c19ae601f1ba3d485467a1c9c9c7025908f
Resolves: #38100
Releases: 6.0
Reviewed-on: http://review.typo3.org/12107
Reviewed-by: Oliver Klee
Reviewed-by: Christian Kuhn
Tested-by: Christian Kuhn
15 files changed:
typo3/sysext/cms/tslib/interfaces/interface.tslib_content_cobjgetsinglehook.php
typo3/sysext/cms/tslib/interfaces/interface.tslib_content_fileLinkHook.php
typo3/sysext/cms/tslib/interfaces/interface.tslib_content_getPublicUrlForFileHook.php
typo3/sysext/cms/tslib/interfaces/interface.tslib_content_getdatahook.php
typo3/sysext/cms/tslib/interfaces/interface.tslib_content_getimgresourcehook.php
typo3/sysext/cms/tslib/interfaces/interface.tslib_content_postinithook.php
typo3/sysext/cms/tslib/interfaces/interface.tslib_content_stdwraphook.php
typo3/sysext/cms/tslib/interfaces/interface.tslib_mediawizardprovider.php
typo3/sysext/cms/tslib/interfaces/interface.tslib_menu_filterMenuPagesHook.php
typo3/sysext/cms/tslib/media/scripts/example_callfunction.php
typo3/sysext/cms/tslib/media/scripts/example_itemArrayProcFunc.php
typo3/sysext/cms/tslib/media/scripts/example_keepRollover.js
typo3/sysext/cms/tslib/media/scripts/example_keepRollover.php
typo3/sysext/cms/tslib/media/scripts/example_languageMenu.php
typo3/sysext/cms/tslib/media/scripts/example_typolinkpop.php

index 689d681..9603e1b 100644 (file)
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
 
-
 /**
- * interface for classes which hook into tslib_content and do additional cObjGetSingle processing
+ * Interface for classes which hook into tslib_content and do additional cObjGetSingle processing
  *
- * @author     Ingo Renner <ingo@typo3.org>
+ * @author Ingo Renner <ingo@typo3.org>
  * @package TYPO3
  * @subpackage t3lib
  */
@@ -38,11 +37,11 @@ interface tslib_content_cObjGetSingleHook {
        /**
         * Renders content objects, that are not defined in the core
         *
-        * @param       string          The content object name, eg. "TEXT" or "USER" or "IMAGE"
-        * @param       array           array with TypoScript properties for the content object
-        * @param       string          label used for the internal debug tracking
-        * @param       tslib_cObj      parent content object
-        * @return      string          cObject output
+        * @param string $contentObjectName The content object name, eg. "TEXT" or "USER" or "IMAGE"
+        * @param array $configuration Array with TypoScript properties for the content object
+        * @param string $TypoScriptKey Label used for the internal debug tracking
+        * @param tslib_cObj $parentObject Parent content object
+        * @return string cObject output
         */
        public function getSingleContentObject($contentObjectName, array $configuration, $TypoScriptKey, tslib_cObj &$parentObject);
 
index 85b1a6a..60928bd 100644 (file)
@@ -25,7 +25,6 @@
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
 
-
 /**
  * Interface for classes which hook into tslib_content and do additional getImgResource processing
  *
@@ -38,9 +37,9 @@ interface tslib_content_fileLinkHook {
        /**
         * Finds alternative previewImage for given File.
         *
-        * @abstract
         * @param t3lib_file_File $file
         * @return t3lib_file_File
+        * @abstract
         */
        function getPreviewImage(t3lib_file_File $file);
 }
index 2c5732d..4e67ad0 100644 (file)
@@ -25,7 +25,6 @@
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
 
-
 /**
  * Interface for hooks to fetch the public URL of files
  *
index 9079f29..b1c315c 100644 (file)
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
 
-
 /**
  * interface for classes which hook into tslib_content and do additional getData processing
  *
- * @author     Ingo Renner <ingo@typo3.org>
+ * @author Ingo Renner <ingo@typo3.org>
  * @package TYPO3
  * @subpackage t3lib
  */
@@ -38,16 +37,15 @@ interface tslib_content_getDataHook {
        /**
         * Extends the getData()-Method of tslib_cObj to process more/other commands
         *
-        * @param       string          full content of getData-request e.g. "TSFE:id // field:title // field:uid"
-        * @param       array           current field-array
-        * @param       string          currently examined section value of the getData request e.g. "field:title"
-        * @param       string          current returnValue that was processed so far by getData
-        * @param       tslib_cObj      parent content object
-        * @return      string          get data result
+        * @param string $getDataString Full content of getData-request e.g. "TSFE:id // field:title // field:uid"
+        * @param array $fields Current field-array
+        * @param string $sectionValue Currently examined section value of the getData request e.g. "field:title"
+        * @param string $returnValue Current returnValue that was processed so far by getData
+        * @param tslib_cObj $parentObject Parent content object
+        * @return string Get data result
         */
        public function getDataExtension($getDataString, array $fields, $sectionValue, $returnValue, tslib_cObj &$parentObject);
 
 }
 
-
 ?>
\ No newline at end of file
index 08db277..a844c68 100644 (file)
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
 
-
 /**
  * Interface for classes which hook into tslib_content and do additional getImgResource processing
  *
- * @author     Oliver Hader <oliver@typo3.org>
+ * @author Oliver Hader <oliver@typo3.org>
  * @package TYPO3
  * @subpackage cms
  */
@@ -37,11 +36,11 @@ interface tslib_cObj_getImgResourceHook {
        /**
         * Hook for post-processing image resources
         *
-        * @param       string          $file: Original image file
-        * @param       array           $configuration: TypoScript getImgResource properties
-        * @param       array           $imageResource: Information of the created/converted image resource
-        * @param       tslib_cObj      $parent: Parent content object
-        * @return      array           Modified image resource information
+        * @param string $file Original image file
+        * @param array $configuration TypoScript getImgResource properties
+        * @param array $imageResource Information of the created/converted image resource
+        * @param tslib_cObj $parent Parent content object
+        * @return array Modified image resource information
         */
        public function getImgResourcePostProcess($file, array $configuration, array $imageResource, tslib_cObj $parent);
 }
index 57ccd4a..981bd0b 100644 (file)
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
 
-
 /**
  * Interface for classes which hook into tslib_content and do additional
  * initialization processing.
  *
- * @author     Ingo Renner <ingo@typo3.org>
+ * @author Ingo Renner <ingo@typo3.org>
  * @package TYPO3
  * @subpackage tslib
  */
@@ -39,7 +38,7 @@ interface tslib_content_PostInitHook {
        /**
         * Hook for post processing the initialization of tslib_cObj
         *
-        * @param       tslib_cObj      parent content object
+        * @param tslib_cObj $parentObject Parent content object
         */
        public function postProcessContentObjectInitialization(tslib_cObj &$parentObject);
 
index aaf25f6..53287ae 100644 (file)
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
 
-
 /**
  * interface for classes which hook into tslib_content and do additional stdWrap processing
  *
- * @author     Ingo Renner <ingo@typo3.org>
+ * @author Ingo Renner <ingo@typo3.org>
  * @package TYPO3
  * @subpackage t3lib
  */
@@ -38,40 +37,40 @@ interface tslib_content_stdWrapHook {
        /**
         * Hook for modifying $content before core's stdWrap does anything
         *
-        * @param       string          input value undergoing processing in this function. Possibly substituted by other values fetched from another source.
-        * @param       array           TypoScript stdWrap properties
-        * @param       tslib_cObj      parent content object
-        * @return      string          further processed $content
+        * @param string $content Input value undergoing processing in this function. Possibly substituted by other values fetched from another source.
+        * @param array $configuration TypoScript stdWrap properties
+        * @param tslib_cObj $parentObject Parent content object
+        * @return string Further processed $content
         */
        public function stdWrapPreProcess($content, array $configuration, tslib_cObj &$parentObject);
 
        /**
         * Hook for modifying $content after core's stdWrap has processed setContentToCurrent, setCurrent, lang, data, field, current, cObject, numRows, filelist and/or preUserFunc
         *
-        * @param       string          input value undergoing processing in this function. Possibly substituted by other values fetched from another source.
-        * @param       array           TypoScript stdWrap properties
-        * @param       tslib_cObj      parent content object
-        * @return      string          further processed $content
+        * @param string $content Input value undergoing processing in this function. Possibly substituted by other values fetched from another source.
+        * @param array $configuration TypoScript stdWrap properties
+        * @param tslib_cObj $parentObject Parent content object
+        * @return string Further processed $content
         */
        public function stdWrapOverride($content, array $configuration, tslib_cObj &$parentObject);
 
        /**
         * Hook for modifying $content after core's stdWrap has processed override, preIfEmptyListNum, ifEmpty, ifBlank, listNum, trim and/or more (nested) stdWraps
         *
-        * @param       string          input value undergoing processing in this function. Possibly substituted by other values fetched from another source.
-        * @param       array           TypoScript "stdWrap properties".
-        * @param       tslib_cObj      parent content object
-        * @return      string          further processed $content
+        * @param string $content Input value undergoing processing in this function. Possibly substituted by other values fetched from another source.
+        * @param array $configuration TypoScript "stdWrap properties".
+        * @param tslib_cObj $parentObject Parent content object
+        * @return string Further processed $content
         */
        public function stdWrapProcess($content, array $configuration, tslib_cObj &$parentObject);
 
        /**
         * Hook for modifying $content after core's stdWrap has processed anything but debug
         *
-        * @param       string          input value undergoing processing in this function. Possibly substituted by other values fetched from another source.
-        * @param       array           TypoScript stdWrap properties
-        * @param       tslib_cObj      parent content object
-        * @return      string          further processed $content
+        * @param string $content Input value undergoing processing in this function. Possibly substituted by other values fetched from another source.
+        * @param array $configuration TypoScript stdWrap properties
+        * @param tslib_cObj $parentObject Parent content object
+        * @return string Further processed $content
         */
        public function stdWrapPostProcess($content, array $configuration, tslib_cObj &$parentObject);
 
index fad5b13..9a60f53 100644 (file)
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
+
 /**
- * interface for classes which hook into tslib_mediawizard adding additional
+ * Interface for classes which hook into tslib_mediawizard adding additional
  * media wizard providers
  *
- * @author     Ernesto Baschny <ernst@cron-it.de>
+ * @author Ernesto Baschny <ernst@cron-it.de>
  * @package TYPO3
  * @subpackage tslib
  */
@@ -37,16 +38,16 @@ interface tslib_mediaWizardProvider {
        /**
         * Tells the calling party if we can handle the URL passed to the constructor
         *
-        * @param       string  URL to be handled
-        * @return      boolean
+        * @param string $url URL to be handled
+        * @return boolean
         */
        public function canHandle($url);
 
        /**
         * Rewrites a media provider URL into a canonized form that can be embedded
         *
-        * @param       string  URL to be handled
-        * @return      string  canonized URL that can be used to embedd
+        * @param string $url URL to be handled
+        * @return string Canonized URL that can be used to embedd
         */
        public function rewriteUrl($url);
 
index 9249eee..553287d 100644 (file)
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
 
-
 /**
  * interface for classes which hook into tslib_menu
  *
- * @author     Tolleiv Nietsch <nietsch@aoemedia.de>
+ * @author Tolleiv Nietsch <nietsch@aoemedia.de>
  * @package TYPO3
  */
-
 interface tslib_menu_filterMenuPagesHook {
 
        /**
         * Checks if a page is OK to include in the final menu item array.
         *
-        * @param       array           Array of menu items
-        * @param       array           Array of page uids which are to be excluded
-        * @param       boolean         If set, then the page is a spacer.
-        * @param       tslib_menu      The menu object
-        * @return      boolean         Returns TRUE if the page can be safely included.
+        * @param array $data Array of menu items
+        * @param array $banUidArray Array of page uids which are to be excluded
+        * @param boolean $spacer If set, then the page is a spacer.
+        * @param tslib_menu $obj The menu object
+        * @return boolean Returns TRUE if the page can be safely included.
         */
-       public function processFilter (array &$data, array $banUidArray, $spacer, tslib_menu $obj);
+       public function processFilter(array &$data, array $banUidArray, $spacer, tslib_menu $obj);
 }
 
 ?>
\ No newline at end of file
index b3e38fe..3795c5e 100755 (executable)
  * Revised for TYPO3 3.6 June/2003 by Kasper Skårhøj
  * XHTML compliant
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  */
 
-
-
-
-
-
-
 /**
  * Call custom function from TypoScript for data processing
  *
@@ -57,9 +51,9 @@
  *     preUserFunc.uppercase = 1
  * }
  *
- * @param      string          When custom functions are used for data processing the $content variable will hold the value to be processed. When functions are meant to just return some generated content this variable is empty.
- * @param      array           TypoScript properties passed on to this function.
- * @return     string          The input string reversed. If the TypoScript property "uppercase" was set it will also be in uppercase.
+ * @param string $content When custom functions are used for data processing the $content variable will hold the value to be processed. When functions are meant to just return some generated content this variable is empty.
+ * @param array $conf TypoScript properties passed on to this function.
+ * @return string The input string reversed. If the TypoScript property "uppercase" was set it will also be in uppercase.
  */
 function user_reverseString($content, $conf) {
        $content = strrev($content);
@@ -82,29 +76,27 @@ function user_reverseString($content, $conf) {
  *   userFunc = user_printTime
  * }
  *
- * @param      string          Empty string (no content to process)
- * @param      array           TypoScript configuration
- * @return     string          HTML output, showing the current server time.
+ * @param string $content Empty string (no content to process)
+ * @param array $conf TypoScript configuration
+ * @return string HTML output, showing the current server time.
  */
 function user_printTime($content, $conf) {
        return '<font color="red">Dynamic time: '.date('H:i:s').'</font><br />';
 }
 
-
-
 /**
  * Example of calling a method in a PHP class from TypoScript
- *
  */
 class user_various     {
-       var $cObj;              // Reference to the parent (calling) cObj set from TypoScript
+               // Reference to the parent (calling) cObj set from TypoScript
+       var $cObj;
 
        /**
         * Doing the same as user_reverseString() but with a class. Also demonstrates how this gives us the ability to use methods in the parent object.
         *
-        * @param       string          String to process (from stdWrap)
-        * @param       array           TypoScript properties passed on to this method.
-        * @return      string          The input string reversed. If the TypoScript property "uppercase" was set it will also be in uppercase. May also be linked.
+        * @param string $content String to process (from stdWrap)
+        * @param array $conf TypoScript properties passed on to this method.
+        * @return string The input string reversed. If the TypoScript property "uppercase" was set it will also be in uppercase. May also be linked.
         * @see user_reverseString()
         */
        function reverseString($content, $conf) {
@@ -132,9 +124,9 @@ class user_various  {
         *   reverseOrder = 1
         * }
         *
-        * @param       string          Empty string (no content to process)
-        * @param       array           TypoScript configuration
-        * @return      string          HTML output, showing content elements (in reverse order if configured.)
+        * @param string $content Empty string (no content to process)
+        * @param array $conf TypoScript configuration
+        * @return string HTML output, showing content elements (in reverse order if configured.)
         */
        function listContentRecordsOnPage($content, $conf) {
                $query = $GLOBALS['TYPO3_DB']->SELECTquery(
@@ -151,8 +143,8 @@ class user_various  {
        /**
         * Selecting the records by input $query and returning the header field values
         *
-        * @param       string          SQL query selecting the content elements.
-        * @return      string          The header field values of the content elements imploded by a <br /> tag
+        * @param string $query SQL query selecting the content elements.
+        * @return string The header field values of the content elements imploded by a <br /> tag
         * @access private
         */
        function selectThem($query) {
index 4bbc888..3fadad7 100755 (executable)
  * Revised for TYPO3 3.6 June/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 function basically adds the parent page to the sublevel but only if the sublevel is empty!
  * It is also used to demonstrate the menu state items
  *   linkWrap = <b> - |</b>
  * }
  *
- * @param      array           The $menuArr array which simply is a num-array of page records which goes into the menu.
- * @param      array           TypoScript configuration for the function. Notice that the property "parentObj" is a reference to the parent (calling) object (the tslib_Xmenu class instantiated)
- * @return     array           The modified $menuArr array
+ * @param array $menuArr The $menuArr array which simply is a num-array of page records which goes into the menu.
+ * @param array $conf TypoScript configuration for the function. Notice that the property "parentObj" is a reference to the parent (calling) object (the tslib_Xmenu class instantiated)
+ * @return array The modified $menuArr array
  */
 function user_itemArrayProcFuncTest($menuArr, $conf) {
-       if ($conf['demoItemStates'])    {               // Used in the example of item states
-               $c=0;
+               // Used in the example of item states
+       if ($conf['demoItemStates']) {
+               $c = 0;
                $teststates=explode(',', 'NO,ACT,IFSUB,CUR,USR,SPC,USERDEF1,USERDEF2');
                foreach ($menuArr as $k => $v) {
                        $menuArr[$k]['ITEM_STATE']=$teststates[$c];
@@ -80,10 +72,14 @@ function user_itemArrayProcFuncTest($menuArr, $conf) {
                        $c++;
                }
        } else {        // used in the fake menu item example!
-               if (!count($menuArr))   {               // There must be no menu items if we add the parent page to the submenu:
-                       $parentPageId = $conf['parentObj']->id; // id of the parent page
-                       $parentPageRow = $GLOBALS['TSFE']->sys_page->getPage($parentPageId);    // ... and get the record...
-                       if (is_array($parentPageRow))   {       // ... and if that page existed (a row was returned) then add it!
+                       // There must be no menu items if we add the parent page to the submenu:
+               if (!count($menuArr)) {
+                               // id of the parent page
+                       $parentPageId = $conf['parentObj']->id;
+                               // ... and get the record...
+                       $parentPageRow = $GLOBALS['TSFE']->sys_page->getPage($parentPageId);
+                               // ... and if that page existed (a row was returned) then add it!
+                       if (is_array($parentPageRow)) {
                                $menuArr[]=$parentPageRow;
                        }
                }
@@ -94,20 +90,22 @@ function user_itemArrayProcFuncTest($menuArr, $conf) {
 /**
  * Used in the menu item state example of the "testsite" package at page-path "/Intro/TypoScript examples/Menu object examples/Menu state test/"
  *
- * @param      array           The menu item array, $this->I (in the parent object)
- * @param      array           TypoScript configuration for the function. Notice that the property "parentObj" is a reference to the parent (calling) object (the tslib_Xmenu class instantiated)
- * @return     array           The processed $I array returned (and stored in $this->I of the parent object again)
+ * @param array $I The menu item array, $this->I (in the parent object)
+ * @param array $conf TypoScript configuration for the function. Notice that the property "parentObj" is a reference to the parent (calling) object (the tslib_Xmenu class instantiated)
+ * @return array The processed $I array returned (and stored in $this->I of the parent object again)
  * @see tslib_menu::userProcess(), tslib_tmenu::writeMenu(), tslib_gmenu::writeMenu()
  */
 function user_IProcFuncTest($I, $conf) {
        $itemRow = $conf['parentObj']->menuArr[$I['key']];
 
                // Setting the document status content to the value of the page title on mouse over
-       $I['linkHREF']['onMouseover'].='extraRollover(\''.rawurlencode($itemRow['title']).'\');';
+       $I['linkHREF']['onMouseover'] .= 'extraRollover(\'' . rawurlencode($itemRow['title']) . '\');';
        $conf['parentObj']->I = $I;
        $conf['parentObj']->setATagParts();
        $I = $conf['parentObj']->I;
-       if ($I['parts']['ATag_begin'])  $I['parts']['ATag_begin']=$I['A1'];
+       if ($I['parts']['ATag_begin']) {
+               $I['parts']['ATag_begin'] = $I['A1'];
+       }
 
        if ($conf['debug']) {
                        // Outputting for debug example:
@@ -120,5 +118,4 @@ function user_IProcFuncTest($I, $conf) {
        return $I;
 }
 
-
 ?>
\ No newline at end of file
index 1a61058..6f5a7a3 100755 (executable)
@@ -46,6 +46,4 @@ function ARO_out(name,imgObj,noOverAction)    {
        if (version == 'n3' && document[name]) {document[name].src = eval(name+'_n.src');}
                else if (imgObj)        {imgObj.src = eval(name+'_n.src');}
        if (!noOverAction)      ARO_over(ARO_Image,'',1);
-}
-
-
+}
\ No newline at end of file
index f474335..cb7ffa2 100755 (executable)
@@ -24,6 +24,7 @@
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
+
 /**
  * Demonstrates how to manipulate menu generation so that a click on a menu item will trigger two (or more) frames to load an URL
  * Used in the "testsite" package
  * Revised for TYPO3 3.6 June/2003 by Kasper Skårhøj
  * XHTML compliant
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  */
 
-
-
-
-
-
-
 /**
  * Example can be found in the testsite package at the page-path "/Intro/TypoScript examples/Menu object examples/Loading multiple.../"
  *
- * @param      array           The menu item array, $this->I (in the parent object)
- * @param      array           TypoScript configuration for the function. Notice that the property "parentObj" is a reference to the parent (calling) object (the tslib_Xmenu class instantiated)
- * @return     array           The processed $I array returned (and stored in $this->I of the parent object again)
+ * @param array $I The menu item array, $this->I (in the parent object)
+ * @param array $conf TypoScript configuration for the function. Notice that the property "parentObj" is a reference to the parent (calling) object (the tslib_Xmenu class instantiated)
+ * @return array The processed $I array returned (and stored in $this->I of the parent object again)
  * @see tslib_menu::userProcess(), tslib_tmenu::writeMenu(), tslib_gmenu::writeMenu()
  */
 function user_keepRolloverAtOnClick($I, $conf) {
@@ -73,10 +68,14 @@ function user_keepRolloverAtOnClick($I, $conf) {
        }
 
                // Update the link in the parent object:
-       $conf['parentObj']->I = $I;     // setting internal $I - needed by setATagParts() function!
-       $conf['parentObj']->setATagParts();     // Setting the A1 and A2 of the internal $I
-       $I = $conf['parentObj']->I;     // retrieving internal $I
-       $I['parts']['ATag_begin']=$I['A1'];     // Setting the ATag_begin to the value of this $I
+               // setting internal $I - needed by setATagParts() function!
+       $conf['parentObj']->I = $I;
+               // Setting the A1 and A2 of the internal $I
+       $conf['parentObj']->setATagParts();
+               // retrieving internal $I
+       $I = $conf['parentObj']->I;
+               // Setting the ATag_begin to the value of this $I
+       $I['parts']['ATag_begin'] = $I['A1'];
 
                // Debug:
        if ($conf['debug']) {
index 3e71e83..f9a619e 100755 (executable)
@@ -24,6 +24,7 @@
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
+
 /**
  * Creates a language-selector menu with three flags, an english, a danish and a german flag for each language supported on the site.
  *
  * Revised for TYPO3 3.6 June/2003 by Kasper Skårhøj
  * XHTML compliant
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  */
 
-
-if (!is_object($this)) die ('Error: No parent object present.');
-
-
-
+if (!is_object($this)) {
+       die('Error: No parent object present.');
+}
 
        // First, select all pages_language_overlay records on the current page. Each represents a possibility for a language.
 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', 'pages_language_overlay', 'pid='.intval($GLOBALS['TSFE']->id).$GLOBALS['TSFE']->sys_page->enableFields('pages_language_overlay'), 'sys_language_uid');
 
 $langArr = array();
-while($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
+while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
        $langArr[$row['sys_language_uid']] = $row['title'];
 }
 
-// Little red arrow, which is inserted to the left of the flag-icon if the TSFE->sys_language_uid equals the language uid (notice that 0=english, 1=danish and 2=german is SPECIFIC to this database, because these numbers refer to uid's of the table sys_language)
+       // Little red arrow, which is inserted to the left of the flag-icon if the TSFE->sys_language_uid equals the language uid (notice that 0=english, 1=danish and 2=german is SPECIFIC to this database, because these numbers refer to uid's of the table sys_language)
 $pointer = '<img src="'.t3lib_extMgm::siteRelPath('cms').'tslib/media/icons_misc/content_client.gif" width="7" height="10" align="middle" alt="" />';
 
-// Set each icon. If the language is the current, red arrow is printed to the left. If the language is NOT found (represented by a pages_language_overlay record on this page), the icon is dimmed.
+       // Set each icon. If the language is the current, red arrow is printed to the left. If the language is NOT found (represented by a pages_language_overlay record on this page), the icon is dimmed.
 $flags = array();
 $flags[] = ($GLOBALS['TSFE']->sys_language_uid==0?$pointer:'').'<a href="'.htmlspecialchars('index.php?id='.$GLOBALS['TSFE']->id.'&L=0').'" target="_top"><img src="typo3/sysext/cms/tslib/media/uploads/flag_uk.gif" width="21" height="13" hspace="5" border="0" alt="" /></a>';
 $flags[] = ($GLOBALS['TSFE']->sys_language_uid==1?$pointer:'').'<a href="'.htmlspecialchars('index.php?id='.$GLOBALS['TSFE']->id.'&L=1').'" target="_top"><img src="typo3/sysext/cms/tslib/media/uploads/flag_dk'.($langArr[1]?'':'_d').'.gif" width="21" height="13" hspace="5" border="0" alt="" /></a>';
 $flags[] = ($GLOBALS['TSFE']->sys_language_uid==2?$pointer:'').'<a href="'.htmlspecialchars('index.php?id='.$GLOBALS['TSFE']->id.'&L=2').'" target="_top"><img src="typo3/sysext/cms/tslib/media/uploads/flag_de'.($langArr[2]?'':'_d').'.gif" width="21" height="13" hspace="5" border="0" alt="" /></a>';
 
-// Make the little menu. Notice, the menu does ONLY transfer the page-id and the "L" variable (which is also SPECIFIC for this website because "L" has been used in the extension template used to control the language setup)
+       // Make the little menu. Notice, the menu does ONLY transfer the page-id and the "L" variable (which is also SPECIFIC for this website because "L" has been used in the extension template used to control the language setup)
 $content = '<table border="0" cellpadding="0" cellspacing="0"><tr><td><img src="clear.gif" width="30" height="1" alt="" /></td><td>'.implode('', $flags).'</td></tr></table>';
 
 ?>
\ No newline at end of file
index 0574cc8..1df6cd8 100755 (executable)
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
+
 /**
  * Typo Link PopUp EXAMPLE!
  *
  * Revised for TYPO3 3.6 June/2003 by Kasper Skårhøj
  * XHTML compliant
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  */
 
-
-
-
-
-
-
-
-
-
-
-
-
-
 /**
  * Demonstrates how to make typolink tags (<link ...>) open in a pop-up window
  *
@@ -61,9 +49,9 @@
  *
  * (Plus the "content (default)" static template included as well)
  *
- * @param      array           In this case: An array with data you can use for processing; keys "url" and "aTagParams" contains something at least
- * @param      array           TypoScript array with custom properties for this function call.
- * @return     string          Return the new <a> tag
+ * @param array $content In this case: An array with data you can use for processing; keys "url" and "aTagParams" contains something at least
+ * @param array $conf TypoScript array with custom properties for this function call.
+ * @return string Return the new <a> tag
  * @see tslib_cObj::typoLink()
  */
 function user_typoLinkPopUp($content, $conf) {
@@ -72,5 +60,4 @@ function user_typoLinkPopUp($content, $conf) {
        return $TAG;
 }
 
-
 ?>
\ No newline at end of file