[CLEANUP] Cleanup phpDoc in ext:frontend 89/33889/2
authorWouter Wolters <typo3@wouterwolters.nl>
Fri, 7 Nov 2014 18:16:20 +0000 (19:16 +0100)
committerChristian Kuhn <lolli@schwarzbu.ch>
Sat, 8 Nov 2014 14:50:51 +0000 (15:50 +0100)
Resolves: #62771
Releases: master
Change-Id: I6f79bd66765dc5fef0ac331d79855cb9ea3d8a39
Reviewed-on: http://review.typo3.org/33889
Reviewed-by: Christian Kuhn <lolli@schwarzbu.ch>
Tested-by: Christian Kuhn <lolli@schwarzbu.ch>
17 files changed:
typo3/sysext/frontend/Classes/Controller/DataSubmissionController.php
typo3/sysext/frontend/Classes/Controller/ExtDirectEidController.php
typo3/sysext/frontend/Classes/Controller/ShowImageController.php
typo3/sysext/frontend/Classes/Controller/TypoScriptFrontendController.php
typo3/sysext/frontend/Classes/Hooks/FrontendHooks.php
typo3/sysext/frontend/Classes/Hooks/MediaItemHooks.php
typo3/sysext/frontend/Classes/Hooks/TreelistCacheUpdateHooks.php
typo3/sysext/frontend/Classes/Imaging/GifBuilder.php
typo3/sysext/frontend/Classes/MediaWizard/MediaWizardProvider.php
typo3/sysext/frontend/Classes/MediaWizard/MediaWizardProviderInterface.php
typo3/sysext/frontend/Classes/MediaWizard/MediaWizardProviderManager.php
typo3/sysext/frontend/Classes/Page/CacheHashCalculator.php
typo3/sysext/frontend/Classes/Page/FramesetRenderer.php
typo3/sysext/frontend/Classes/Page/PageRepository.php
typo3/sysext/frontend/Classes/Page/PageRepositoryGetRecordOverlayHookInterface.php
typo3/sysext/frontend/Classes/Utility/CompressionUtility.php
typo3/sysext/frontend/Classes/View/AdminPanelViewHookInterface.php

index 3d5bb48..232fa01 100644 (file)
@@ -23,29 +23,66 @@ use TYPO3\CMS\Core\Utility;
  */
 class DataSubmissionController {
 
+       /**
+        * @var string
+        */
        protected $reserved_names = 'recipient,recipient_copy,auto_respond_msg,auto_respond_checksum,redirect,subject,attachment,from_email,from_name,replyto_email,replyto_name,organisation,priority,html_enabled,quoted_printable,submit_x,submit_y';
 
-       // Collection of suspicious header data, used for logging
+       /**
+        * Collection of suspicious header data, used for logging
+        *
+        * @var array
+        */
        protected $dirtyHeaders = array();
 
+       /**
+        * @var string
+        */
        protected $characterSet;
 
+       /**
+        * @var string
+        */
        protected $subject;
 
+       /**
+        * @var string
+        */
        protected $fromName;
 
+       /**
+        * @var string
+        */
        protected $replyToName;
 
+       /**
+        * @var string
+        */
        protected $organisation;
 
+       /**
+        * @var string
+        */
        protected $fromAddress;
 
+       /**
+        * @var string
+        */
        protected $replyToAddress;
 
+       /**
+        * @var int
+        */
        protected $priority;
 
+       /**
+        * @var string
+        */
        protected $autoRespondMessage;
 
+       /**
+        * @var string
+        */
        protected $encoding = 'quoted-printable';
 
        /**
@@ -53,8 +90,14 @@ class DataSubmissionController {
         */
        protected $mailMessage;
 
+       /**
+        * @var string
+        */
        protected $recipient;
 
+       /**
+        * @var string
+        */
        protected $plainContent = '';
 
        /**
index c097201..811cc8b 100644 (file)
@@ -13,6 +13,7 @@ namespace TYPO3\CMS\Frontend\Controller;
  *
  * The TYPO3 project - inspiring people to share!
  */
+
 /**
  * eID controller for ExtDirect
  *
index 7bcb266..45c42f2 100644 (file)
@@ -26,8 +26,9 @@ use \TYPO3\CMS\Core\Utility\MathUtility;
  */
 class ShowImageController {
 
-       // Parameters loaded into these internal variables:
        /**
+        * Parameters loaded into these internal variables:
+        *
         * @var \TYPO3\CMS\Core\Resource\File
         */
        protected $file;
@@ -93,6 +94,9 @@ class ShowImageController {
 </html>
 EOF;
 
+       /**
+        * @var string
+        */
        protected $imageTag = '<img src="###publicUrl###" alt="###alt###" title="###title###" />';
 
        /**
@@ -129,7 +133,7 @@ EOF;
                }
 
                try {
-                       if (\TYPO3\CMS\Core\Utility\MathUtility::canBeInterpretedAsInteger($fileUid)) {
+                       if (MathUtility::canBeInterpretedAsInteger($fileUid)) {
                                $this->file = \TYPO3\CMS\Core\Resource\ResourceFactory::getInstance()->getFileObject((int)$fileUid);
                        } else {
                                $this->file = \TYPO3\CMS\Core\Resource\ResourceFactory::getInstance()->retrieveFileOrFolderObject($fileUid);
@@ -169,6 +173,7 @@ EOF;
 
        /**
         * Does the actual image processing
+        *
         * @return \TYPO3\CMS\Core\Resource\ProcessedFile
         */
        protected function processImage() {
@@ -199,6 +204,7 @@ EOF;
        }
 
        /**
+        * Execute
         *
         * @return void
         */
index d2c95a0..406ab2d 100644 (file)
@@ -38,8 +38,6 @@ use TYPO3\CMS\Frontend\Page\PageRepository;
  */
 class TypoScriptFrontendController {
 
-       // CURRENT PAGE
-
        /**
         * The page id (int)
         * @var string
@@ -211,8 +209,6 @@ class TypoScriptFrontendController {
         */
        public $ADMCMD_preview_BEUSER_uid = 0;
 
-       // PREVIEW
-
        /**
         * Flag indication that preview is active. This is based on the login of a
         * backend user and whether the backend user has read access to the current
@@ -243,8 +239,6 @@ class TypoScriptFrontendController {
         */
        public $simUserGroup = 0;
 
-       // CONFIGURATION
-
        /**
         * Copy of $GLOBALS['TYPO3_CONF_VARS']
         *
@@ -259,8 +253,6 @@ class TypoScriptFrontendController {
         */
        public $config = '';
 
-       // TEMPLATE / CACHE
-
        /**
         * The TypoScript template object. Used to parse the TypoScript template
         *
@@ -365,8 +357,6 @@ class TypoScriptFrontendController {
         */
        public $pagesTSconfig = '';
 
-       // PAGE-GENERATION / cOBJ
-
        /**
         * Eg. insert JS-functions in this array ($additionalHeaderData) to include them
         * once. Use associative keys.
@@ -439,9 +429,6 @@ class TypoScriptFrontendController {
         */
        public $defaultBodyTag = '<body>';
 
-       // RENDERING configuration, settings from TypoScript is loaded into these
-       // vars. See pagegen.php
-
        /**
         * Debug flag, may output special debug html-code.
         * @var string
@@ -587,8 +574,6 @@ class TypoScriptFrontendController {
         */
        public $sys_language_isocode = '';
 
-       // RENDERING data
-
        /**
         * 'Global' Storage for various applications. Keys should be 'tx_'.extKey for
         * extensions.
@@ -705,16 +690,12 @@ class TypoScriptFrontendController {
         */
        public $cObj = '';
 
-       // CONTENT accumulation
-
        /**
         * All page content is accumulated in this variable. See pagegen.php
         * @var string
         */
        public $content = '';
 
-       // GENERAL
-
        /**
         * Set to the browser: net / msie if 4+ browsers
         * @var string
@@ -760,8 +741,6 @@ class TypoScriptFrontendController {
         */
        public $localeCharset = '';
 
-       // LANG
-
        /**
         * Set to the system language key (used on the site)
         * @var string
index 3154eb2..a695076 100644 (file)
@@ -13,9 +13,9 @@ namespace TYPO3\CMS\Frontend\Hooks;
  *
  * The TYPO3 project - inspiring people to share!
  */
+
 /**
  * Uses frontend hooks to show preview informations
- *
  */
 class FrontendHooks {
 
index 488f3b0..93a428e 100644 (file)
@@ -13,9 +13,9 @@ namespace TYPO3\CMS\Frontend\Hooks;
  *
  * The TYPO3 project - inspiring people to share!
  */
+
 /**
  * Adds extra fields into 'media' flexform
- *
  */
 class MediaItemHooks implements \TYPO3\CMS\Core\SingletonInterface {
 
index b93db80..063d666 100644 (file)
@@ -24,8 +24,12 @@ use TYPO3\CMS\Backend\Utility\BackendUtility;
  */
 class TreelistCacheUpdateHooks {
 
-       // Should not be manipulated from others except through the
-       // configuration provided @see __construct()
+       /**
+        * Should not be manipulated from others except through the
+        * configuration provided @see __construct()
+        *
+        * @var array
+        */
        private $updateRequiringFields = array(
                'pid',
                'php_tree_stop',
index e14711a..15098a4 100644 (file)
@@ -42,27 +42,30 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
  */
 class GifBuilder extends \TYPO3\CMS\Core\Imaging\GraphicalFunctions {
 
-       // Internal
-       // the main image
        /**
+        * the main image
+        *
         * @var string
         */
        public $im = '';
 
-       // the image-width
        /**
+        * the image-width
+        *
         * @var int
         */
        public $w = 0;
 
-       // the image-height
        /**
+        * the image-height
+        *
         * @var int
         */
        public $h = 0;
 
-       // map-data
        /**
+        * map-data
+        *
         * @var string
         */
        public $map;
@@ -72,26 +75,30 @@ class GifBuilder extends \TYPO3\CMS\Core\Imaging\GraphicalFunctions {
         */
        public $workArea;
 
-       // This holds the operational setup for gifbuilder. Basically this is a TypoScript array with properties.
        /**
+        * This holds the operational setup for gifbuilder. Basically this is a TypoScript array with properties.
+        *
         * @var array
         */
        public $setup = array();
 
-       // Contains all text strings used on this image
        /**
+        * Contains all text strings used on this image
+        *
         * @var array
         */
        public $combinedTextStrings = array();
 
-       // Contains all filenames (basename without extension) used on this image
        /**
+        * Contains all filenames (basename without extension) used on this image
+        *
         * @var array
         */
        public $combinedFileNames = array();
 
-       // This is the array from which data->field: [key] is fetched. So this is the current record!
        /**
+        * This is the array from which data->field: [key] is fetched. So this is the current record!
+        *
         * @var array
         */
        public $data = array();
index 44607a9..c40772c 100644 (file)
@@ -13,6 +13,7 @@ namespace TYPO3\CMS\Frontend\MediaWizard;
  *
  * The TYPO3 project - inspiring people to share!
  */
+
 /**
  * Contains an implementation of the mediaWizardProvider supporting some
  * well known providers.
index 851dd1a..780650c 100644 (file)
@@ -13,6 +13,7 @@ namespace TYPO3\CMS\Frontend\MediaWizard;
  *
  * The TYPO3 project - inspiring people to share!
  */
+
 /**
  * Interface for classes which hook into tslib_mediawizard adding additional
  * media wizard providers
@@ -20,6 +21,7 @@ namespace TYPO3\CMS\Frontend\MediaWizard;
  * @author Ernesto Baschny <ernst@cron-it.de>
  */
 interface MediaWizardProviderInterface {
+
        /**
         * Tells the calling party if we can handle the URL passed to the constructor
         *
index 47bcce3..8a40b77 100644 (file)
@@ -13,6 +13,7 @@ namespace TYPO3\CMS\Frontend\MediaWizard;
  *
  * The TYPO3 project - inspiring people to share!
  */
+
 /**
  * Manager to register and call registered media wizard providers
  *
index 2ace2f3..a890636 100644 (file)
@@ -13,6 +13,7 @@ namespace TYPO3\CMS\Frontend\Page;
  *
  * The TYPO3 project - inspiring people to share!
  */
+
 /**
  * Logic for cHash calculation
  *
index be77139..668f366 100644 (file)
@@ -13,6 +13,7 @@ namespace TYPO3\CMS\Frontend\Page;
  *
  * The TYPO3 project - inspiring people to share!
  */
+
 /**
  * Rendering of framesets
  *
index ea27a21..f92e90f 100644 (file)
@@ -55,8 +55,6 @@ class PageRepository {
         */
        public $sys_language_uid = 0;
 
-       // Versioning preview related
-
        /**
         * If TRUE, versioning preview of other record versions is allowed. THIS MUST
         * ONLY BE SET IF the page is not cached and truely previewed by a backend
@@ -78,8 +76,6 @@ class PageRepository {
         */
        public $workspaceCache = array();
 
-       // Internal, dynamic
-
        /**
         * Error string set by getRootLine()
         *
@@ -94,8 +90,6 @@ class PageRepository {
         */
        public $error_getRootLine_failPid = 0;
 
-       // Internal caching
-
        /**
         * @var array
         */
index 5883c84..172d133 100644 (file)
@@ -20,6 +20,7 @@ namespace TYPO3\CMS\Frontend\Page;
  * @author Tolleiv Nietsch <nietsch@aoemedia.de>
  */
 interface PageRepositoryGetRecordOverlayHookInterface {
+
        /**
         * Enables to preprocess a record overlay
         *
index cae94e5..86f8dd9 100644 (file)
@@ -13,6 +13,7 @@ namespace TYPO3\CMS\Frontend\Utility;
  *
  * The TYPO3 project - inspiring people to share!
  */
+
 /**
  * This class contains compression functions for the TYPO3 Frontend. It can be
  * used only in EXT:cms/tslib/index_ts.php
index 3668960..9621bc0 100644 (file)
@@ -20,6 +20,7 @@ namespace TYPO3\CMS\Frontend\View;
  * @author Georg Ringer <typo3@ringerge.org>
  */
 interface AdminPanelViewHookInterface {
+
        /**
         * Extend the adminPanel
         *