[TASK] Clean up phpDoc comments in typo3/classes
authorWouter Wolters <typo3@wouterwolters.nl>
Sun, 10 Jun 2012 16:21:47 +0000 (18:21 +0200)
committerSusanne Moog <typo3@susannemoog.de>
Mon, 11 Jun 2012 17:25:16 +0000 (19:25 +0200)
Clean up phpDoc comments for the following classes:

* typo3/classes/class.ajaxlogin.php
* typo3/classes/class.clearcachemenu.php
* typo3/classes/class.livesearch.php
* typo3/classes/class.modulemenu.php
* typo3/classes/class.shortcutmenu.php
* typo3/classes/class.typo3_tcefile.php
* typo3/classes/class.typo3ajax.php
* typo3/classes/class.typo3logo.php

Clean up provides:

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

Change-Id: I6246d7dd21a10cfeb4b0fa63b89241a8e0b0b630
Resolves: #37869
Releases: 6.0
Reviewed-on: http://review.typo3.org/11897
Reviewed-by: Susanne Moog
Tested-by: Susanne Moog
typo3/classes/class.ajaxlogin.php
typo3/classes/class.clearcachemenu.php
typo3/classes/class.livesearch.php
typo3/classes/class.modulemenu.php
typo3/classes/class.shortcutmenu.php
typo3/classes/class.typo3_tcefile.php
typo3/classes/class.typo3ajax.php
typo3/classes/class.typo3logo.php

index a97304c..88d739d 100644 (file)
@@ -27,7 +27,7 @@
 /**
  * This is the ajax handler for backend login after timeout.
  *
- * @author     Christoph Koehler <christoph@webempoweredchurch.org>
+ * @author Christoph Koehler <christoph@webempoweredchurch.org>
  */
 class AjaxLogin {
 
@@ -38,9 +38,9 @@ class AjaxLogin {
         * a BE user and reset the timer and hide the login window.
         * If it was unsuccessful, we display that and show the login box again.
         *
-        * @param       array           $parameters: Parameters (not used)
-        * @param       TYPO3AJAX       $ajaxObj: The calling parent AJAX object
-        * @return      void
+        * @param array $parameters Parameters (not used)
+        * @param TYPO3AJAX $ajaxObj The calling parent AJAX object
+        * @return void
         */
        public function login(array $parameters, TYPO3AJAX $ajaxObj) {
                if ($this->isAuthorizedBackendSession()) {
@@ -84,9 +84,9 @@ class AjaxLogin {
        /**
         * Logs out the current BE user
         *
-        * @param       array           $parameters: Parameters (not used)
-        * @param       TYPO3AJAX       $ajaxObj: The calling parent AJAX object
-        * @return      void
+        * @param array $parameters Parameters (not used)
+        * @param TYPO3AJAX $ajaxObj The calling parent AJAX object
+        * @return void
         */
        public function logout(array $parameters, TYPO3AJAX $ajaxObj) {
                $GLOBALS['BE_USER']->logoff();
@@ -102,9 +102,9 @@ class AjaxLogin {
         * Refreshes the login without needing login information. We just refresh the session.
         *
         *
-        * @param       array           $parameters: Parameters (not used)
-        * @param       TYPO3AJAX       $ajaxObj: The calling parent AJAX object
-        * @return      void
+        * @param array $parameters Parameters (not used)
+        * @param TYPO3AJAX $ajaxObj The calling parent AJAX object
+        * @return void
         */
        public function refreshLogin(array $parameters, TYPO3AJAX $ajaxObj) {
                $GLOBALS['BE_USER']->checkAuthentication();
@@ -112,13 +112,12 @@ class AjaxLogin {
                $ajaxObj->setContentFormat('json');
        }
 
-
        /**
         * Checks if the user session is expired yet
         *
-        * @param       array           $parameters: Parameters (not used)
-        * @param       TYPO3AJAX       $ajaxObj: The calling parent AJAX object
-        * @return      void
+        * @param array $parameters Parameters (not used)
+        * @param TYPO3AJAX $ajaxObj The calling parent AJAX object
+        * @return void
         */
        function isTimedOut(array $parameters, TYPO3AJAX $ajaxObj) {
                if (is_object($GLOBALS['BE_USER'])) {
@@ -133,8 +132,8 @@ class AjaxLogin {
                                $ses_tstamp = $GLOBALS['BE_USER']->user['ses_tstamp'];
                                $timeout = $GLOBALS['BE_USER']->auth_timeout_field;
 
-                               // if 120 seconds from now is later than the session timeout, we need to show the refresh dialog.
-                               // 120 is somewhat arbitrary to allow for a little room during the countdown and load times, etc.
+                                       // If 120 seconds from now is later than the session timeout, we need to show the refresh dialog.
+                                       // 120 is somewhat arbitrary to allow for a little room during the countdown and load times, etc.
                                if ($GLOBALS['EXEC_TIME'] >= $ses_tstamp + $timeout - 120) {
                                        $ajaxObj->addContent('login', array('will_time_out' => TRUE));
                                } else {
@@ -149,9 +148,9 @@ class AjaxLogin {
        /**
         * Gets a MD5 challenge.
         *
-        * @param       array           $parameters: Parameters (not used)
-        * @param       TYPO3AJAX       $parent: The calling parent AJAX object
-        * @return      void
+        * @param array $parameters Parameters (not used)
+        * @param TYPO3AJAX $parent The calling parent AJAX object
+        * @return void
         */
        public function getChallenge(array $parameters, TYPO3AJAX $parent) {
                session_start();
index 399c68c..db5ff04 100644 (file)
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
 
-
 /**
  * class to render the menu for the cache clearing actions
  *
- * @author     Ingo Renner <ingo@typo3.org>
+ * @author Ingo Renner <ingo@typo3.org>
  * @package TYPO3
  * @subpackage core
  */
 class ClearCacheMenu implements backend_toolbarItem {
 
+       /**
+        * @var array
+        */
        protected $cacheActions;
+
+       /**
+        * @var array
+        */
        protected $optionValues;
 
        /**
-        * reference back to the backend object
+        * Reference back to the backend object
         *
         * @var TYPO3backend
         */
        protected $backendReference;
 
        /**
-        * constructor
+        * Constructor
         *
-        * @param       TYPO3backend    TYPO3 backend object reference
+        * @param TYPO3backend $backendReference TYPO3 backend object reference
         */
        public function __construct(TYPO3backend &$backendReference = NULL) {
                $this->backendReference = $backendReference;
@@ -100,7 +106,7 @@ class ClearCacheMenu implements backend_toolbarItem {
                        );
                }
 
-                       // hook for manipulate cacheActions
+                       // Hook for manipulate cacheActions
                if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['additionalBackendItems']['cacheActions'])) {
                        foreach($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['additionalBackendItems']['cacheActions'] as $cacheAction) {
                                $hookObject = t3lib_div::getUserObj($cacheAction);
@@ -115,9 +121,9 @@ class ClearCacheMenu implements backend_toolbarItem {
        }
 
        /**
-        * checks whether the user has access to this toolbar item
+        * Checks whether the user has access to this toolbar item
         *
-        * @return  boolean  TRUE if user has access, FALSE if not
+        * @return boolean TRUE if user has access, FALSE if not
         */
        public function checkAccess() {
 
@@ -139,7 +145,7 @@ class ClearCacheMenu implements backend_toolbarItem {
        /**
         * Creates the selector for workspaces
         *
-        * @return      string          workspace selector as HTML select
+        * @return string Workspace selector as HTML select
         */
        public function render() {
                $title = $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xml:rm.clearCache_clearCache', TRUE);
@@ -162,18 +168,18 @@ class ClearCacheMenu implements backend_toolbarItem {
        }
 
        /**
-        * adds the necessary JavaScript to the backend
+        * Adds the necessary JavaScript to the backend
         *
-        * @return      void
+        * @return void
         */
        protected function addJavascriptToBackend() {
                $this->backendReference->addJavascriptFile('js/clearcachemenu.js');
        }
 
        /**
-        * returns additional attributes for the list item in the toolbar
+        * Returns additional attributes for the list item in the toolbar
         *
-        * @return      string          list item HTML attibutes
+        * @return string List item HTML attibutes
         */
        public function getAdditionalAttributes() {
                return ' id="clear-cache-actions-menu"';
index e81e75a..d34a1a2 100644 (file)
@@ -27,7 +27,7 @@
  ***************************************************************/
 
 /**
- * Adds backend live search. to the toolbar
+ * Adds backend live search to the toolbar
  *
  * @author Michael Klapper <michael.klapper@aoemedia.de>
  * @author Jeff Segars <jeff@webempoweredchurch.org>
 class LiveSearch implements backend_toolbarItem {
 
        /**
-        * reference back to the backend object
+        * Reference back to the backend object
         *
         * @var TYPO3backend
         */
        protected $backendReference;
 
        /**
-        * constructor
+        * Constructor
         *
-        * @param       TYPO3backend    TYPO3 backend object reference
+        * @param TYPO3backend $backendReference TYPO3 backend object reference
         */
        public function __construct(TYPO3backend &$backendReference = NULL) {
                $this->backendReference = $backendReference;
        }
 
        /**
-        * checks whether the user has access to this toolbar item
+        * Checks whether the user has access to this toolbar item
         *
-        * @return  boolean  TRUE if user has access, FALSE if not
+        * @return boolean TRUE if user has access, FALSE if not
         */
        public function checkAccess() {
                $access = FALSE;
@@ -76,7 +76,7 @@ class LiveSearch implements backend_toolbarItem {
        /**
         * Creates the selector for workspaces
         *
-        * @return      string          workspace selector as HTML select
+        * @return string Workspace selector as HTML select
         */
        public function render() {
                $this->addJavascriptToBackend();
@@ -87,9 +87,9 @@ class LiveSearch implements backend_toolbarItem {
        }
 
        /**
-        * adds the necessary JavaScript to the backend
+        * Adds the necessary JavaScript to the backend
         *
-        * @return      void
+        * @return void
         */
        protected function addJavascriptToBackend() {
                $pageRenderer = $GLOBALS['TBE_TEMPLATE']->getPageRenderer();
@@ -100,7 +100,7 @@ class LiveSearch implements backend_toolbarItem {
        /**
         * returns additional attributes for the list item in the toolbar
         *
-        * @return      string          list item HTML attibutes
+        * @return string List item HTML attibutes
         */
        public function getAdditionalAttributes() {
                return ' id="live-search-menu"';
index 7738fbb..7b1c205 100644 (file)
@@ -25,7 +25,6 @@
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
 
-
 if (TYPO3_REQUESTTYPE & TYPO3_REQUESTTYPE_AJAX) {
        $GLOBALS['LANG']->includeLLFile('EXT:lang/locallang_misc.xml');
 }
@@ -33,14 +32,14 @@ if (TYPO3_REQUESTTYPE & TYPO3_REQUESTTYPE_AJAX) {
 /**
  * class to render the TYPO3 backend menu for the modules
  *
- * @author     Ingo Renner <ingo@typo3.org>
+ * @author Ingo Renner <ingo@typo3.org>
  * @package TYPO3
  * @subpackage core
  */
 class ModuleMenu {
 
        /**
-        * module loading object
+        * Module loading object
         *
         * @var t3lib_loadModules
         */
@@ -50,11 +49,8 @@ class ModuleMenu {
        protected $linkModules;
        protected $loadedModules;
 
-
        /**
-        * constructor, initializes several variables
-        *
-        * @return      void
+        * Constructor, initializes several variables
         */
        public function __construct() {
 
@@ -66,14 +62,14 @@ class ModuleMenu {
                $this->moduleLoader->observeWorkspaces = TRUE;
                $this->moduleLoader->load($GLOBALS['TBE_MODULES']);
                $this->loadedModules = $this->moduleLoader->modules;
-
        }
 
        /**
         * sets the path back to /typo3/
         *
-        * @param       string  path back to /typo3/
-        * @return      void
+        * @param string $backPath Path back to /typo3/
+        * @throws InvalidArgumentException
+        * @return void
         */
        public function setBackPath($backPath) {
                if (!is_string($backPath)) {
@@ -86,7 +82,7 @@ class ModuleMenu {
        /**
         * loads the collapse states for the main modules from user's configuration (uc)
         *
-        * @return      array           collapse states
+        * @return array Collapse states
         */
        protected function getCollapsedStates() {
 
@@ -101,14 +97,15 @@ class ModuleMenu {
        /**
         * ModuleMenu Store loading data
         *
-        * @param array_type $params
-        * @param object $ajaxObj
+        * @param array $params
+        * @param TYPO3AJAX $ajaxObj
+        * @return array
         */
        public function getModuleData($params, $ajaxObj) {
                $data = array('success' => TRUE, 'root' => array());
                $rawModuleData = $this->getRawModuleData();
                $index = 0;
-               foreach($rawModuleData as $moduleKey => $moduleData) {
+               foreach ($rawModuleData as $moduleKey => $moduleData) {
                        $key = substr($moduleKey, 8);
                        $num = count($data['root']);
                        if ($moduleData['link'] != 'dummy.php' || ($moduleData['link'] == 'dummy.php' && is_array($moduleData['subitems'])) ) {
@@ -117,12 +114,11 @@ class ModuleMenu {
                                $data['root'][$num]['label'] = $moduleData['title'];
                                $data['root'][$num]['subitems'] = is_array($moduleData['subitems']) ? count($moduleData['subitems']) : 0;
 
-
                                if ($moduleData['link'] && $this->linkModules) {
                                        $data['root'][$num]['link'] = 'top.goToModule(\'' . $moduleData['name'] . '\')';
                                }
 
-                                       // traverse submodules
+                                       // Traverse submodules
                                if (is_array($moduleData['subitems'])) {
                                        foreach($moduleData['subitems'] as $subKey => $subData) {
                                                $data['root'][$num]['sub'][] = array(
@@ -145,16 +141,15 @@ class ModuleMenu {
                if ($ajaxObj) {
                        $ajaxObj->setContent($data);
                        $ajaxObj->setContentFormat('jsonbody');
-
                } else {
                        return $data;
                }
        }
 
        /**
-        * returns the loaded modules
+        * Returns the loaded modules
         *
-        * @return      array   array of loaded modules
+        * @return array Array of loaded modules
         */
        public function getLoadedModules() {
                return $this->loadedModules;
@@ -163,23 +158,22 @@ class ModuleMenu {
        /**
         * saves the menu's toggle state in the backend user's uc
         *
-        * @param       array           array of parameters from the AJAX interface, currently unused
-        * @param       TYPO3AJAX       object of type TYPO3AJAX
-        * @return      void
+        * @param array $params Array of parameters from the AJAX interface, currently unused
+        * @param TYPO3AJAX $ajaxObj Object of type TYPO3AJAX
+        * @return void
         */
        public function saveMenuState($params, $ajaxObj) {
                $menuItem = t3lib_div::_POST('menuid');
-               $state    = t3lib_div::_POST('state') === 'true' ? 1 : 0;
+               $state = t3lib_div::_POST('state') === 'true' ? 1 : 0;
 
                $GLOBALS['BE_USER']->uc['moduleData']['menuState'][$menuItem] = $state;
                $GLOBALS['BE_USER']->writeUC();
        }
 
-
        /**
         * gets the raw module data
         *
-        * @return      array           multi dimension array with module data
+        * @return array Multi dimension array with module data
         */
        public function getRawModuleData() {
                $modules = array();
@@ -189,7 +183,7 @@ class ModuleMenu {
                        unset($this->loadedModules['doc']);
                }
 
-               foreach($this->loadedModules as $moduleName => $moduleData) {
+               foreach ($this->loadedModules as $moduleName => $moduleData) {
                        $moduleLink = '';
                        if (!is_array($moduleData['sub'])) {
                                $moduleLink = $moduleData['script'];
@@ -258,8 +252,8 @@ class ModuleMenu {
        /**
         * gets the module icon and its size
         *
-        * @param       string          module key
-        * @return      array           icon data array with 'filename', 'size', and 'html'
+        * @param string $moduleKey Module key
+        * @return array Icon data array with 'filename', 'size', and 'html'
         */
        protected function getModuleIcon($moduleKey) {
                $icon = array(
@@ -290,8 +284,8 @@ class ModuleMenu {
         * That means absolute names are just returned while relative names are
         * prepended with the path pointing back to typo3/ dir
         *
-        * @param       string          icon filename
-        * @return      string          icon filename with absolute path
+        * @param string $iconFilename Icon filename
+        * @return string Icon filename with absolute path
         * @see getModuleIconRelative()
         */
        protected function getModuleIconAbsolute($iconFilename) {
@@ -306,8 +300,8 @@ class ModuleMenu {
        /**
         * Returns relative path to the icon filename for use in img-tags
         *
-        * @param       string          icon filename
-        * @return      string          icon filename with relative path
+        * @param string $iconFilename Icon filename
+        * @return string Icon filename with relative path
         * @see getModuleIconAbsolute()
         */
        protected function getModuleIconRelative($iconFilename) {
@@ -317,13 +311,11 @@ class ModuleMenu {
                return $this->backPath.$iconFilename;
        }
 
-
-
        /**
         * Appends a '?' if there is none in the string already
         *
-        * @param       string          Link URL
-        * @return      string          link URl appended with ? if there wasn't one
+        * @param string $link Link URL
+        * @return string Link URl appended with ? if there wasn't one
         */
        protected function appendQuestionmarkToLink($link) {
                if (!strstr($link, '?')) {
@@ -336,7 +328,7 @@ class ModuleMenu {
        /**
         * renders the logout button form
         *
-        * @return      string          html code snippet displaying the logout button
+        * @return string Html code snippet displaying the logout button
         */
        public function renderLogoutButton() {
                $buttonLabel      = $GLOBALS['BE_USER']->user['ses_backuserid'] ? 'LLL:EXT:lang/locallang_core.php:buttons.exit' : 'LLL:EXT:lang/locallang_core.php:buttons.logout';
@@ -352,7 +344,9 @@ class ModuleMenu {
        /**
         * turns linking of modules on or off
         *
-        * @param       boolean         status for linking modules with a-tags, set to FALSE to turn lining off
+        * @param boolean $linkModules Status for linking modules with a-tags, set to FALSE to turn lining off
+        * @throws InvalidArgumentException
+        * @return void
         */
        public function setLinkModules($linkModules) {
                if (!is_bool($linkModules)) {
index 889dc3c..60b13fc 100644 (file)
@@ -29,16 +29,15 @@ if (TYPO3_REQUESTTYPE & TYPO3_REQUESTTYPE_AJAX) {
        require_once(PATH_typo3 . 'interfaces/interface.backend_toolbaritem.php');
        $GLOBALS['LANG']->includeLLFile('EXT:lang/locallang_misc.xml');
 
-               // needed to get the correct icons when reloading the menu after saving it
+               // Needed to get the correct icons when reloading the menu after saving it
        $loadModules = t3lib_div::makeInstance('t3lib_loadModules');
        $loadModules->load($GLOBALS['TBE_MODULES']);
 }
 
-
 /**
- * class to render the shortcut menu
+ * Class to render the shortcut menu
  *
- * @author     Ingo Renner <ingo@typo3.org>
+ * @author Ingo Renner <ingo@typo3.org>
  * @package TYPO3
  * @subpackage core
  */
@@ -47,14 +46,14 @@ class ShortcutMenu implements backend_toolbarItem {
        protected $shortcutGroups;
 
        /**
-        * all available shortcuts
+        * All available shortcuts
         *
         * @var array
         */
        protected $shortcuts;
 
        /**
-        * labels of all groups.
+        * Labels of all groups.
         * If value is 1, the system will try to find a label in the locallang array.
         *
         * @var array
@@ -62,23 +61,22 @@ class ShortcutMenu implements backend_toolbarItem {
        protected $groupLabels;
 
        /**
-        * reference back to the backend object
+        * Reference back to the backend object
         *
         * @var TYPO3backend
         */
        protected $backendReference;
 
        /**
-        * constructor
+        * Constructor
         *
-        * @param       TYPO3backend    TYPO3 backend object reference
-        * @return      void
+        * @param TYPO3backend $backendReference TYPO3 backend object reference
         */
        public function __construct(TYPO3backend &$backendReference = NULL) {
                $this->backendReference = $backendReference;
                $this->shortcuts        = array();
 
-                       // by default, 5 groups are set
+                       // By default, 5 groups are set
                $this->shortcutGroups = array(
                        1 => '1',
                        2 => '1',
@@ -92,7 +90,7 @@ class ShortcutMenu implements backend_toolbarItem {
        }
 
        /**
-        * checks whether the user has access to this toolbar item
+        * Checks whether the user has access to this toolbar item
         *
         * @return boolean TRUE if user has access, FALSE if not
         */
@@ -103,7 +101,7 @@ class ShortcutMenu implements backend_toolbarItem {
        /**
         * Creates the shortcut menu (default renderer)
         *
-        * @return      string          workspace selector as HTML select
+        * @return string Workspace selector as HTML select
         */
        public function render() {
                $title = $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xml:toolbarItems.bookmarks', TRUE);
@@ -122,9 +120,9 @@ class ShortcutMenu implements backend_toolbarItem {
        }
 
        /**
-        * renders the pure contents of the menu
+        * Renders the pure contents of the menu
         *
-        * @return      string          the menu's content
+        * @return string The menu's content
         */
        public function renderMenu() {
 
@@ -138,9 +136,9 @@ class ShortcutMenu implements backend_toolbarItem {
 
                $shortcutMenu[] = '<table border="0" cellspacing="0" cellpadding="0" class="shortcut-list">';
 
-               // render shortcuts with no group (group id = 0) first
+                       // Render shortcuts with no group (group id = 0) first
                $noGroupShortcuts = $this->getShortcutsByGroup(0);
-               foreach($noGroupShortcuts as $shortcut) {
+               foreach ($noGroupShortcuts as $shortcut) {
                        $shortcutMenu[] = '
                        <tr id="shortcut-'.$shortcut['raw']['uid'].'" class="shortcut">
                                <td class="shortcut-icon">'.$shortcut['icon'].'</td>
@@ -152,7 +150,7 @@ class ShortcutMenu implements backend_toolbarItem {
                        </tr>';
                }
 
-                       // now render groups and the contained shortcuts
+                       // Now render groups and the contained shortcuts
                $groups = $this->getGroupsFromShortcuts();
                krsort($groups, SORT_NUMERIC);
                foreach($groups as $groupId => $groupLabel) {
@@ -166,7 +164,7 @@ class ShortcutMenu implements backend_toolbarItem {
 
                                $shortcuts = $this->getShortcutsByGroup($groupId);
                                $i = 0;
-                               foreach($shortcuts as $shortcut) {
+                               foreach ($shortcuts as $shortcut) {
                                        $i++;
 
                                        $firstRow = '';
@@ -190,7 +188,7 @@ class ShortcutMenu implements backend_toolbarItem {
                }
 
                if (count($shortcutMenu) == 1) {
-                               //no shortcuts added yet, show a small help message how to add shortcuts
+                               // No shortcuts added yet, show a small help message how to add shortcuts
                        $title = $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xml:toolbarItems.bookmarks', TRUE);
                        $icon = t3lib_iconWorks::getSpriteIcon('actions-system-shortcut-new', array(
                                'title' => $title
@@ -208,11 +206,11 @@ class ShortcutMenu implements backend_toolbarItem {
        }
 
        /**
-        * renders the menu so that it can be returned as response to an AJAX call
+        * Renders the menu so that it can be returned as response to an AJAX call
         *
-        * @param       array           array of parameters from the AJAX interface, currently unused
-        * @param       TYPO3AJAX       object of type TYPO3AJAX
-        * @return      void
+        * @param array $params Array of parameters from the AJAX interface, currently unused
+        * @param TYPO3AJAX $ajaxObj Object of type TYPO3AJAX
+        * @return void
         */
        public function renderAjax($params = array(), TYPO3AJAX &$ajaxObj = NULL) {
                $menuContent = $this->renderMenu();
@@ -221,27 +219,27 @@ class ShortcutMenu implements backend_toolbarItem {
        }
 
        /**
-        * adds the necessary JavaScript to the backend
+        * Adds the necessary JavaScript to the backend
         *
-        * @return      void
+        * @return void
         */
        protected function addJavascriptToBackend() {
                $this->backendReference->addJavascriptFile('js/shortcutmenu.js');
        }
 
        /**
-        * returns additional attributes for the list item in the toolbar
+        * Returns additional attributes for the list item in the toolbar
         *
-        * @return      string          list item HTML attibutes
+        * @return string List item HTML attibutes
         */
        public function getAdditionalAttributes() {
                return ' id="shortcut-menu"';
        }
 
        /**
-        * retrieves the shortcuts for the current user
+        * Retrieves the shortcuts for the current user
         *
-        * @return      array           array of shortcuts
+        * @return array Array of shortcuts
         */
        protected function initShortcuts() {
                $shortcuts    = array();
@@ -256,7 +254,7 @@ class ShortcutMenu implements backend_toolbarItem {
                );
 
                        // Traverse shortcuts
-               while($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
+               while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
                        $shortcut             = array('raw' => $row);
                        $moduleParts          = explode('|', $row['module_name']);
                        $row['module_name']   = $moduleParts[0];
@@ -285,22 +283,22 @@ class ShortcutMenu implements backend_toolbarItem {
                                $shortcut['type'] = 'other';
                        }
 
-                               // check for module access
+                               // Check for module access
                        $pageId = $this->getLinkedPageId($row['url']);
                        if (!$GLOBALS['BE_USER']->isAdmin()) {
                                if (!isset($GLOBALS['LANG']->moduleLabels['tabs_images'][implode('_', $moduleParts).'_tab'])) {
-                                               // nice hack to check if the user has access to this module
+                                               // Nice hack to check if the user has access to this module
                                                // - otherwise the translation label would not have been loaded :-)
                                        continue;
                                }
 
                                if (t3lib_utility_Math::canBeInterpretedAsInteger($pageId)) {
-                                               // check for webmount access
+                                               // Check for webmount access
                                        if (!$GLOBALS['BE_USER']->isInWebMount($pageId)) {
                                                continue;
                                        }
 
-                                               // check for record access
+                                               // Check for record access
                                        $pageRow = t3lib_BEfunc::getRecord('pages', $pageId);
                                        if (!$GLOBALS['BE_USER']->doesUserHaveAccess($pageRow, $perms = 1)) {
                                                continue;
@@ -332,15 +330,15 @@ class ShortcutMenu implements backend_toolbarItem {
        }
 
        /**
-        * gets shortcuts for a specific group
+        * Gets shortcuts for a specific group
         *
-        * @param       integer         group Id
-        * @return      array           array of shortcuts that matched the group
+        * @param integer $groupId Group Id
+        * @return array Array of shortcuts that matched the group
         */
        protected function getShortcutsByGroup($groupId) {
                $shortcuts = array();
 
-               foreach($this->shortcuts as $shortcut) {
+               foreach ($this->shortcuts as $shortcut) {
                        if ($shortcut['group'] == $groupId) {
                                $shortcuts[] = $shortcut;
                        }
@@ -350,15 +348,15 @@ class ShortcutMenu implements backend_toolbarItem {
        }
 
        /**
-        * gets a shortcut by its uid
+        * Gets a shortcut by its uid
         *
-        * @param       integer         shortcut id to get the complete shortcut for
-        * @return      mixed           an array containing the shortcut's data on success or FALSE on failure
+        * @param integer $shortcutId Shortcut id to get the complete shortcut for
+        * @return mixed An array containing the shortcut's data on success or FALSE on failure
         */
        protected function getShortcutById($shortcutId) {
                $returnShortcut = FALSE;
 
-               foreach($this->shortcuts as $shortcut) {
+               foreach ($this->shortcuts as $shortcut) {
                        if ($shortcut['raw']['uid'] == (int) $shortcutId) {
                                $returnShortcut = $shortcut;
                                continue;
@@ -369,19 +367,19 @@ class ShortcutMenu implements backend_toolbarItem {
        }
 
        /**
-        * gets the available shortcut groups from default gropups, user TSConfig,
+        * Gets the available shortcut groups from default gropups, user TSConfig,
         * and global groups
         *
-        * @param       array           array of parameters from the AJAX interface, currently unused
-        * @param       TYPO3AJAX       object of type TYPO3AJAX
-        * @return      array
+        * @param array $params Array of parameters from the AJAX interface, currently unused
+        * @param TYPO3AJAX $ajaxObj Object of type TYPO3AJAX
+        * @return array
         */
        protected function initShortcutGroups($params = array(), TYPO3AJAX &$ajaxObj = NULL) {
-                       // groups from TSConfig
+                       // Groups from TSConfig
                $bookmarkGroups = $GLOBALS['BE_USER']->getTSConfigProp('options.bookmarkGroups');
 
                if (is_array($bookmarkGroups) && count($bookmarkGroups)) {
-                       foreach($bookmarkGroups as $groupId => $label) {
+                       foreach ($bookmarkGroups as $groupId => $label) {
                                if (strcmp('', $label) && strcmp('0', $label)) {
                                        $this->shortcutGroups[$groupId] = (string) $label;
                                } elseif ($GLOBALS['BE_USER']->isAdmin()) {
@@ -390,32 +388,32 @@ class ShortcutMenu implements backend_toolbarItem {
                        }
                }
 
-                       // generate global groups, all global groups have negative IDs.
+                       // Generate global groups, all global groups have negative IDs.
                if (count($this->shortcutGroups)) {
                        $groups = $this->shortcutGroups;
-                       foreach($groups as $groupId => $groupLabel) {
+                       foreach ($groups as $groupId => $groupLabel) {
                                $this->shortcutGroups[($groupId * -1)] = $groupLabel;
                        }
                }
 
-                       // group -100 is kind of superglobal and can't be changed.
+                       // Group -100 is kind of superglobal and can't be changed.
                $this->shortcutGroups[-100] = 1;
 
-                       // add labels
-               foreach($this->shortcutGroups as $groupId => $groupLabel) {
+                       // Add labels
+               foreach ($this->shortcutGroups as $groupId => $groupLabel) {
                        $label = $groupLabel;
 
                        if ($groupLabel == '1') {
                                $label = $GLOBALS['LANG']->getLL('bookmark_group_'.abs($groupId), 1);
 
                                if (empty($label)) {
-                                               // fallback label
+                                               // Fallback label
                                        $label = $GLOBALS['LANG']->getLL('bookmark_group', 1).' '.abs($groupId);
                                }
                        }
 
                        if ($groupId < 0) {
-                                       // global group
+                                       // Global group
                                $label = $GLOBALS['LANG']->getLL('bookmark_global', 1).': '.
                                        (!empty($label) ?
                                                $label :
@@ -436,15 +434,15 @@ class ShortcutMenu implements backend_toolbarItem {
        /**
         * gets the available shortcut groups
         *
-        * @param       array           array of parameters from the AJAX interface, currently unused
-        * @param       TYPO3AJAX       object of type TYPO3AJAX
-        * @return      void
+        * @param array $params Array of parameters from the AJAX interface, currently unused
+        * @param TYPO3AJAX $ajaxObj Object of type TYPO3AJAX
+        * @return void
         */
        public function getAjaxShortcutGroups($params = array(), TYPO3AJAX &$ajaxObj = NULL) {
                $shortcutGroups = $this->shortcutGroups;
 
                if (!$GLOBALS['BE_USER']->isAdmin()) {
-                       foreach($shortcutGroups as $groupId => $groupName) {
+                       foreach ($shortcutGroups as $groupId => $groupName) {
                                if (intval($groupId) < 0) {
                                        unset($shortcutGroups[$groupId]);
                                }
@@ -456,11 +454,11 @@ class ShortcutMenu implements backend_toolbarItem {
        }
 
        /**
-        * deletes a shortcut through an AJAX call
+        * Deletes a shortcut through an AJAX call
         *
-        * @param       array           array of parameters from the AJAX interface, currently unused
-        * @param       TYPO3AJAX       object of type TYPO3AJAX
-        * @return      void
+        * @param array $params Array of parameters from the AJAX interface, currently unused
+        * @param TYPO3AJAX $ajaxObj Object of type TYPO3AJAX
+        * @return void
         */
        public function deleteAjaxShortcut($params = array(), TYPO3AJAX &$ajaxObj = NULL) {
                $shortcutId   = (int) t3lib_div::_POST('shortcutId');
@@ -482,22 +480,23 @@ class ShortcutMenu implements backend_toolbarItem {
        }
 
        /**
-        * creates a shortcut through an AJAX call
+        * Creates a shortcut through an AJAX call
         *
-        * @param       array           array of parameters from the AJAX interface, currently unused
-        * @param       TYPO3AJAX       object of type TYPO3AJAX
-        * @return      void
+        * @param array $params Array of parameters from the AJAX interface, currently unused
+        * @param TYPO3AJAX $ajaxObj Oject of type TYPO3AJAX
+        * @return void
         */
        public function createAjaxShortcut($params = array(), TYPO3AJAX &$ajaxObj = NULL) {
                $shortcutCreated     = 'failed';
-               $shortcutName        = 'Shortcut'; // default name
+                       // Default name
+               $shortcutName        = 'Shortcut';
                $shortcutNamePrepend = '';
 
                $url             = t3lib_div::_POST('url');
                $module          = t3lib_div::_POST('module');
                $motherModule    = t3lib_div::_POST('motherModName');
 
-                       // determine shortcut type
+                       // Determine shortcut type
                $queryParts      = parse_url($url);
                $queryParameters = t3lib_div::explodeUrl2Array($queryParts['query'], 1);
 
@@ -524,7 +523,7 @@ class ShortcutMenu implements backend_toolbarItem {
                        if (t3lib_utility_Math::canBeInterpretedAsInteger($pageId)) {
                                $page = t3lib_BEfunc::getRecord('pages', $pageId);
                                if (count($page)) {
-                                               // set the name to the title of the page
+                                               // Set the name to the title of the page
                                        if ($shortcut['type'] == 'other') {
                                                $shortcutName = $page['title'];
                                        } else {
@@ -534,7 +533,7 @@ class ShortcutMenu implements backend_toolbarItem {
                        } else {
                                $dirName = urldecode($pageId);
                                if (preg_match('/\/$/', $dirName)) {
-                                               // if $pageId is a string and ends with a slash,
+                                               // If $pageId is a string and ends with a slash,
                                                // assume it is a fileadmin reference and set
                                                // the description to the basename of that path
                                        $shortcutName .= ' ' . basename($dirName);
@@ -562,12 +561,12 @@ class ShortcutMenu implements backend_toolbarItem {
        }
 
        /**
-        * gets called when a shortcut is changed, checks whether the user has
+        * Gets called when a shortcut is changed, checks whether the user has
         * permissions to do so and saves the changes if everything is ok
         *
-        * @param       array           array of parameters from the AJAX interface, currently unused
-        * @param       TYPO3AJAX       object of type TYPO3AJAX
-        * @return      void
+        * @param array $params Array of parameters from the AJAX interface, currently unused
+        * @param TYPO3AJAX $ajaxObj Object of type TYPO3AJAX
+        * @return void
         */
        public function setAjaxShortcut($params = array(), TYPO3AJAX &$ajaxObj = NULL) {
 
@@ -576,7 +575,7 @@ class ShortcutMenu implements backend_toolbarItem {
                $shortcutGroupId = (int) t3lib_div::_POST('shortcut-group');
 
                if ($shortcutGroupId > 0 || $GLOBALS['BE_USER']->isAdmin()) {
-                               // users can delete only their own shortcuts (except admins)
+                               // Users can delete only their own shortcuts (except admins)
                        $addUserWhere = (!$GLOBALS['BE_USER']->isAdmin() ?
                                ' AND userid='.intval($GLOBALS['BE_USER']->user['uid'])
                                : ''
@@ -609,10 +608,10 @@ class ShortcutMenu implements backend_toolbarItem {
        }
 
        /**
-        * gets the label for a shortcut group
+        * Gets the label for a shortcut group
         *
-        * @param       integer         a shortcut group id
-        * @return      string          the shortcut group label, can be an empty string if no group was found for the id
+        * @param integer $groupId A shortcut group id
+        * @return string The shortcut group label, can be an empty string if no group was found for the id
         */
        protected function getShortcutGroupLabel($groupId) {
                $label = '';
@@ -625,14 +624,14 @@ class ShortcutMenu implements backend_toolbarItem {
        }
 
        /**
-        * gets a list of global groups, shortcuts in these groups are available to all users
+        * Gets a list of global groups, shortcuts in these groups are available to all users
         *
-        * @return      array           array of global groups
+        * @return array Array of global groups
         */
        protected function getGlobalShortcutGroups() {
                $globalGroups = array();
 
-               foreach($this->shortcutGroups as $groupId => $groupLabel) {
+               foreach ($this->shortcutGroups as $groupId => $groupLabel) {
                        if ($groupId < 0) {
                                $globalGroups[$groupId] = $groupLabel;
                        }
@@ -644,12 +643,12 @@ class ShortcutMenu implements backend_toolbarItem {
        /**
         * runs through the available shortcuts an collects their groups
         *
-        * @return      array   array of groups which have shortcuts
+        * @return array Array of groups which have shortcuts
         */
        protected function getGroupsFromShortcuts() {
                $groups = array();
 
-               foreach($this->shortcuts as $shortcut) {
+               foreach ($this->shortcuts as $shortcut) {
                        $groups[$shortcut['group']] = $this->shortcutGroups[$shortcut['group']];
                }
 
@@ -657,13 +656,14 @@ class ShortcutMenu implements backend_toolbarItem {
        }
 
        /**
-        * gets the icon for the shortcut
+        * Gets the icon for the shortcut
         *
-        * @param       string          backend module name
-        * @return      string          shortcut icon as img tag
+        * @param array $row
+        * @param array $shortcut
+        * @return string Shortcut icon as img tag
         */
        protected function getShortcutIcon($row, $shortcut) {
-               switch($row['module_name']) {
+               switch ($row['module_name']) {
                        case 'xMOD_alt_doc.php':
                                $table                          = $shortcut['table'];
                                $recordid                       = $shortcut['recordid'];
@@ -698,7 +698,8 @@ class ShortcutMenu implements backend_toolbarItem {
                                                $selectFields[] = 't3ver_state';
                                        }
 
-                                       $selectFields     = array_unique($selectFields); // Unique list!
+                                               // Unique list!
+                                       $selectFields     = array_unique($selectFields);
                                        $permissionClause = ($table=='pages' && $this->perms_clause) ?
                                                ' AND '.$this->perms_clause :
                                                '';
@@ -730,7 +731,7 @@ class ShortcutMenu implements backend_toolbarItem {
                                if ($GLOBALS['LANG']->moduleLabels['tabs_images'][$row['module_name'].'_tab']) {
                                        $icon = $GLOBALS['LANG']->moduleLabels['tabs_images'][$row['module_name'].'_tab'];
 
-                                               // change icon of fileadmin references - otherwise it doesn't differ with Web->List
+                                               // Change icon of fileadmin references - otherwise it doesn't differ with Web->List
                                        $icon = str_replace('mod/file/list/list.gif', 'mod/file/file.gif', $icon);
 
                                        if (t3lib_div::isAbsPath($icon)) {
@@ -747,10 +748,10 @@ class ShortcutMenu implements backend_toolbarItem {
        /**
         * Returns title for the shortcut icon
         *
-        * @param       string          shortcut label
-        * @param       string          backend module name (key)
-        * @param       string          parent module label
-        * @return      string          title for the shortcut icon
+        * @param string $shortcutLabel Shortcut label
+        * @param string $moduleName Backend module name (key)
+        * @param string $parentModuleName Parent module label
+        * @return string Title for the shortcut icon
         */
        protected function getShortcutIconTitle($shortcutLabel, $moduleName, $parentModuleName = '') {
                $title = '';
@@ -778,8 +779,8 @@ class ShortcutMenu implements backend_toolbarItem {
        /**
         * Return the ID of the page in the URL if found.
         *
-        * @param       string          The URL of the current shortcut link
-        * @return      string          If a page ID was found, it is returned. Otherwise: 0
+        * @param string $url The URL of the current shortcut link
+        * @return string If a page ID was found, it is returned. Otherwise: 0
         */
        protected function getLinkedPageId($url) {
                return preg_replace('/.*[\?&]id=([^&]+).*/', '$1', $url);
index 19914b7..56e8076 100644 (file)
@@ -38,7 +38,7 @@
  * Revised for TYPO3 3.6 July/2003 by Kasper Skårhøj
  * Revised for TYPO3 4.3 Mar/2009 by Benjamin Mack
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  */
 
 require_once(PATH_typo3 . 'template.php');
@@ -46,7 +46,7 @@ require_once(PATH_typo3 . 'template.php');
 /**
  * Script Class, handling the calling of methods in the file admin classes.
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  * @package TYPO3
  * @subpackage core
  */
@@ -71,15 +71,13 @@ class TYPO3_tcefile {
                // the result array from the file processor
        protected $fileData;
 
-
-
        /**
         * Registering incoming data
         *
-        * @return      void
+        * @return void
         */
        public function init() {
-                       // set the GPvars from outside
+                       // Set the GPvars from outside
                $this->file = t3lib_div::_GP('file');
                $this->CB = t3lib_div::_GP('CB');
                $this->overwriteExistingFiles = t3lib_div::_GP('overwriteExistingFiles');
@@ -92,7 +90,7 @@ class TYPO3_tcefile {
        /**
         * Initialize the Clipboard. This will fetch the data about files to paste/delete if such an action has been sent.
         *
-        * @return      void
+        * @return void
         */
        public function initClipboard() {
                if (is_array($this->CB)) {
@@ -113,7 +111,7 @@ class TYPO3_tcefile {
         * Performing the file admin action:
         * Initializes the objects, setting permissions, sending data to object.
         *
-        * @return      void
+        * @return void
         */
        public function main() {
                        // Initializing:
@@ -140,7 +138,7 @@ class TYPO3_tcefile {
         * Redirecting the user after the processing has been done.
         * Might also display error messages directly, if any.
         *
-        * @return      void
+        * @return void
         */
        public function finish() {
                        // Prints errors, if there are any
@@ -157,9 +155,8 @@ class TYPO3_tcefile {
         * but without calling the "finish" method, thus makes it simpler to deal with the
         * actual return value
         *
-        *
-        * @param string $params        always empty.
-        * @param string $ajaxObj       The Ajax object used to return content and set content types
+        * @param array $params Always empty.
+        * @param TYPO3AJAX $ajaxObj The Ajax object used to return content and set content types
         * @return void
         */
        public function processAjaxRequest(array $params, TYPO3AJAX $ajaxObj) {
index 0d2057e..94188ab 100644 (file)
 ***************************************************************/
 
 /**
- * class to hold all the information about an AJAX call and send
+ * Class to hold all the information about an AJAX call and send
  * the right headers for the request type
  *
- * @author     Benjamin Mack <mack@xnos.org>
- * @package    TYPO3
- * @subpackage core
+ * @author Benjamin Mack <mack@xnos.org>
+ * @package TYPO3
+ * @subpackage core
  */
 class TYPO3AJAX {
        protected $ajaxId        = NULL;
@@ -50,25 +50,24 @@ class TYPO3AJAX {
        ';
 
        /**
-        * sets the charset and the ID for the AJAX call
+        * Sets the charset and the ID for the AJAX call
         * due to some charset limitations in Javascript (prototype uses encodeURIcomponent, which converts
         * all data to utf-8), we need to detect if the encoding of the request differs from the
         * backend encoding, and then convert all incoming data (_GET and _POST)
         * in the expected backend encoding.
         *
-        * @param       string          the AJAX id
-        * @return      void
+        * @param string $ajaxId The AJAX id
         */
        public function __construct($ajaxId) {
 
-                       // get charset from current AJAX request (which is expected to be utf-8)
+                       // Get charset from current AJAX request (which is expected to be utf-8)
                preg_match('/;\s*charset\s*=\s*([a-zA-Z0-9_-]*)/i', $_SERVER['CONTENT_TYPE'], $contenttype);
                $charset = $GLOBALS['LANG']->csConvObj->parse_charset($contenttype[1]);
                if ($charset && $charset != $this->requestCharset) {
                        $this->requestCharset = $charset;
                }
 
-                       // if the AJAX request does not have the same encoding like the backend
+                       // If the AJAX request does not have the same encoding like the backend
                        // we need to convert the POST and GET parameters in the right charset
                if ($this->charset != $this->requestCharset) {
                        $GLOBALS['LANG']->csConvObj->convArray($_POST, $this->requestCharset, $this->charset);
@@ -78,22 +77,20 @@ class TYPO3AJAX {
                $this->ajaxId = $ajaxId;
        }
 
-
        /**
-        * returns the ID for the AJAX call
+        * Returns the ID for the AJAX call
         *
-        * @return      string          the AJAX id
+        * @return string The AJAX id
         */
        public function getAjaxID() {
                return $this->ajaxId;
        }
 
-
        /**
-        * overwrites the existing content with the first parameter
+        * Overwrites the existing content with the first parameter
         *
-        * @param       array           the new content
-        * @return      mixed           the old content as array; if the new content was not an array, FALSE is returned
+        * @param array $content The new content
+        * @return mixed The old content as array; if the new content was not an array, FALSE is returned
         */
        public function setContent($content) {
                $oldcontent = FALSE;
@@ -104,13 +101,12 @@ class TYPO3AJAX {
                return $oldcontent;
        }
 
-
        /**
-        * adds new content
+        * Adds new content
         *
-        * @param       string          the new content key where the content should be added in the content array
-        * @param       string          the new content to add
-        * @return      mixed           the old content; if the old content didn't exist before, FALSE is returned
+        * @param string $key The new content key where the content should be added in the content array
+        * @param string $content The new content to add
+        * @return mixed The old content; if the old content didn't exist before, FALSE is returned
         */
        public function addContent($key, $content) {
                $oldcontent = FALSE;
@@ -127,22 +123,20 @@ class TYPO3AJAX {
                return $oldcontent;
        }
 
-
        /**
-        * returns the content for the ajax call
+        * Returns the content for the ajax call
         *
-        * @return      mixed           the content for a specific key or the whole content
+        * @return mixed The content for a specific key or the whole content
         */
        public function getContent($key = '') {
                return ($key && array_key_exists($key, $this->content) ? $this->content[$key] : $this->content);
        }
 
-
        /**
-        * sets the content format for the ajax call
+        * Sets the content format for the ajax call
         *
-        * @param       string          can be one of 'plain' (default), 'xml', 'json', 'javascript', 'jsonbody' or 'jsonhead'
-        * @return      void
+        * @param string $format Can be one of 'plain' (default), 'xml', 'json', 'javascript', 'jsonbody' or 'jsonhead'
+        * @return void
         */
        public function setContentFormat($format) {
                if (t3lib_div::inArray(array('plain', 'xml', 'json', 'jsonhead', 'jsonbody', 'javascript'), $format)) {
@@ -155,7 +149,7 @@ class TYPO3AJAX {
         * The wrap used by default stores the results in a variable "response" and
         * adds <script>-Tags around it.
         *
-        * @param string $javascriptCallbackWrap the javascript callback wrap to be used
+        * @param string $javascriptCallbackWrap The javascript callback wrap to be used
         * @return void
         */
        public function setJavascriptCallbackWrap($javascriptCallbackWrap) {
@@ -163,31 +157,29 @@ class TYPO3AJAX {
        }
 
        /**
-        * sets an error message and the error flag
+        * Sets an error message and the error flag
         *
-        * @param       string          the error message
-        * @return      void
+        * @param string $errorMsg The error message
+        * @return void
         */
        public function setError($errorMsg = '') {
                $this->errorMessage = $errorMsg;
                $this->isError = TRUE;
        }
 
-
        /**
-        * checks whether an error occured during the execution or not
+        * Checks whether an error occured during the execution or not
         *
-        * @return      boolean         whether this AJAX call had errors
+        * @return boolean Whether this AJAX call had errors
         */
        public function isError() {
                return $this->isError;
        }
 
-
        /**
-        * renders the AJAX call based on the $contentFormat variable and exits the request
+        * Renders the AJAX call based on the $contentFormat variable and exits the request
         *
-        * @return      void
+        * @return void
         */
        public function render() {
                if ($this->isError) {
@@ -212,12 +204,11 @@ class TYPO3AJAX {
                exit;
        }
 
-
        /**
-        * renders the AJAX call in XML error style to handle with JS
+        * Renders the AJAX call in XML error style to handle with JS
         * the "responseXML" of the transport object will be filled with the error message then
         *
-        * @return      void
+        * @return void
         */
        protected function renderAsError() {
                header(t3lib_utility_Http::HTTP_STATUS_500 . ' (AJAX)');
@@ -226,12 +217,11 @@ class TYPO3AJAX {
                die('<t3err>'.htmlspecialchars($this->errorMessage).'</t3err>');
        }
 
-
        /**
-        * renders the AJAX call with text/html headers
+        * Renders the AJAX call with text/html headers
         * the content will be available in the "responseText" value of the transport object
         *
-        * @return      void
+        * @return void
         */
        protected function renderAsPlain() {
                header('Content-type: text/html; charset='.$this->charset);
@@ -239,12 +229,11 @@ class TYPO3AJAX {
                echo implode('', $this->content);
        }
 
-
        /**
-        * renders the AJAX call with text/xml headers
+        * Renders the AJAX call with text/xml headers
         * the content will be available in the "responseXML" value of the transport object
         *
-        * @return      void
+        * @return void
         */
        protected function renderAsXML() {
                header('Content-type: text/xml; charset='.$this->charset);
@@ -252,9 +241,8 @@ class TYPO3AJAX {
                echo implode('', $this->content);
        }
 
-
        /**
-        * renders the AJAX call with JSON evaluated headers
+        * Renders the AJAX call with JSON evaluated headers
         * note that you need to have requestHeaders: {Accept: 'application/json'},
         * in your AJAX options of your AJAX request object in JS
         *
@@ -263,10 +251,10 @@ class TYPO3AJAX {
         *    - and in the xhr.responseText as a string (except when contentFormat = 'jsonhead')
         *         you can evaluate this in JS with xhr.responseText.evalJSON();
         *
-        * @return      void
+        * @return void
         */
        protected function renderAsJSON() {
-                       // if the backend does not run in UTF-8 then we need to convert it to unicode as
+                       // If the backend does not run in UTF-8 then we need to convert it to unicode as
                        // the json_encode method will return empty otherwise
                if ($this->charset != $this->requestCharset) {
                        $GLOBALS['LANG']->csConvObj->convArray($this->content, $this->charset, $this->requestCharset);
@@ -277,7 +265,7 @@ class TYPO3AJAX {
                header('Content-type: application/json; charset='.$this->requestCharset);
                header('X-JSON: '.($this->contentFormat != 'jsonbody' ? $content : TRUE));
 
-                       // bring content in xhr.responseText except when in "json head only" mode
+                       // Bring content in xhr.responseText except when in "json head only" mode
                if ($this->contentFormat != 'jsonhead') {
                        echo $content;
                }
@@ -287,10 +275,10 @@ class TYPO3AJAX {
         * Renders the AJAX call as inline JSON inside a script tag. This is useful
         * when an iframe is used as the AJAX transport.
         *
-        * @return       void
+        * @return void
         */
        protected function renderAsJavascript() {
-                       // if the backend does not run in UTF-8 then we need to convert it to unicode as
+                       // If the backend does not run in UTF-8 then we need to convert it to unicode as
                        // the json_encode method will return empty otherwise
                if ($this->charset != $this->requestCharset) {
                        $GLOBALS['LANG']->csConvObj->convArray($this->content, $this->charset, $this->requestCharset);
index 31578b8..b29b100 100644 (file)
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
 
-
 /**
  * class to render the TYPO3 logo in the backend
  *
- * @author     Ingo Renner <ingo@typo3.org>
+ * @author Ingo Renner <ingo@typo3.org>
  * @package TYPO3
  * @subpackage core
  */
@@ -39,8 +38,6 @@ class TYPO3Logo {
 
        /**
         * constructor
-        *
-        * @return void
         */
        public function __construct() {
                $this->logo = NULL;
@@ -49,13 +46,14 @@ class TYPO3Logo {
        /**
         * renders the actual logo code
         *
-        * @return      string  logo html code snippet to use in the backend
+        * @return string Logo html code snippet to use in the backend
         */
        public function render() {
 
-               $logoFile = 'gfx/alt_backend_logo.gif'; // default
+                       // Default
+               $logoFile = 'gfx/alt_backend_logo.gif';
                if (is_string($this->logo)) {
-                               // overwrite
+                               // Overwrite
                        $logoFile = $this->logo;
                }
                $imgInfo = getimagesize(PATH_site . TYPO3_mainDir . $logoFile);
@@ -65,7 +63,7 @@ class TYPO3Logo {
                                '<img' . t3lib_iconWorks::skinImg('', $logoFile, $imgInfo[3]) . ' title="TYPO3 Content Management System" alt="" />' .
                                '</a>';
 
-                       // overwrite with custom logo
+                       // Overwrite with custom logo
                if ($GLOBALS['TBE_STYLES']['logo']) {
                        $imgInfo = @getimagesize(t3lib_div::resolveBackPath(PATH_typo3 . $GLOBALS['TBE_STYLES']['logo'], 3));
                        $logo = '<a href="' . TYPO3_URL_GENERAL . '" target="_blank">' .
@@ -77,9 +75,10 @@ class TYPO3Logo {
        }
 
        /**
-        * sets the logo
+        * Sets the logo
         *
-        * @param       string          path to logo file as seen from typo3/
+        * @param string $logo Path to logo file as seen from typo3/
+        * @throws InvalidArgumentException
         */
        public function setLogo($logo) {
                if (!is_string($logo)) {