[TASK] Add proper comments to PHP code 00/52200/3
authorBenni Mack <benni@typo3.org>
Mon, 27 Mar 2017 20:58:56 +0000 (22:58 +0200)
committerFrank Naegler <frank.naegler@typo3.org>
Tue, 28 Mar 2017 07:42:49 +0000 (09:42 +0200)
There are some places where PHP comments have been done wrong (using doccomments)
or where there is no comment at all.

Resolves: #80503
Releases: master
Change-Id: Ib12d3b82755d801abcbefe7127f1189239f766af
Reviewed-on: https://review.typo3.org/52200
Reviewed-by: Wouter Wolters <typo3@wouterwolters.nl>
Tested-by: Wouter Wolters <typo3@wouterwolters.nl>
Tested-by: TYPO3com <no-reply@typo3.com>
Reviewed-by: Frank Naegler <frank.naegler@typo3.org>
Tested-by: Frank Naegler <frank.naegler@typo3.org>
34 files changed:
components/testing_framework/Classes/Core/Functional/Framework/Frontend/RequestBootstrap.php
components/testing_framework/Classes/Fluid/Unit/ViewHelpers/ViewHelperBaseTestcase.php
typo3/sysext/backend/Classes/Controller/ContentElement/ElementInformationController.php
typo3/sysext/backend/Classes/Controller/FormInlineAjaxController.php
typo3/sysext/backend/Classes/Form/Container/PaletteAndSingleContainer.php
typo3/sysext/core/Classes/DataHandling/DataHandler.php
typo3/sysext/core/Classes/Messaging/FlashMessageQueue.php
typo3/sysext/core/Classes/Resource/Driver/DriverRegistry.php
typo3/sysext/core/Classes/Resource/ProcessedFile.php
typo3/sysext/core/Tests/Acceptance/Backend/Formhandler/ElementsBasicInputDateCest.php
typo3/sysext/extbase/Classes/Command/HelpCommandController.php
typo3/sysext/extbase/Classes/Persistence/Generic/QueryResult.php
typo3/sysext/extensionmanager/Classes/Controller/DownloadController.php
typo3/sysext/filelist/Classes/ViewHelpers/Link/ClickMenuOnIconViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Be/Widget/Controller/PaginateController.php
typo3/sysext/fluid/Classes/ViewHelpers/Debug/RenderViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Form/Select/OptgroupViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Form/Select/OptionViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Widget/Controller/AutocompleteController.php
typo3/sysext/fluid/Classes/ViewHelpers/Widget/Controller/PaginateController.php
typo3/sysext/form/Classes/Domain/Model/FormElements/DatePicker.php
typo3/sysext/form/Classes/Domain/Model/FormElements/FileUpload.php
typo3/sysext/form/Classes/Domain/Runtime/FormRuntime.php
typo3/sysext/frontend/Classes/DataProcessing/MenuProcessor.php
typo3/sysext/impexp/Classes/Controller/ImportExportController.php
typo3/sysext/indexed_search/Classes/ViewHelpers/Format/FlagValueViewHelper.php
typo3/sysext/install/Classes/Controller/Action/Step/AbstractStepAction.php
typo3/sysext/recordlist/Classes/Browser/DatabaseBrowser.php
typo3/sysext/recordlist/Classes/Browser/FileBrowser.php
typo3/sysext/recordlist/Classes/Browser/FolderBrowser.php
typo3/sysext/recordlist/Classes/LinkHandler/AbstractLinkHandler.php
typo3/sysext/recordlist/Classes/LinkHandler/PageLinkHandler.php
typo3/sysext/rtehtmlarea/Classes/Controller/ParseHtmlController.php
typo3/sysext/rtehtmlarea/Classes/Controller/UserElementsController.php

index 8f7babb..683c0ab 100644 (file)
@@ -20,6 +20,10 @@ namespace TYPO3\TestingFramework\Core\Functional\Framework\Frontend;
 class RequestBootstrap
 {
     /**
+     * This method is necessary to set any superglobals like $_SERVER, $_POST, $_COOKIE, $_GET
+     * to start clean for a functional test.
+     *
+     * @param array $requestArguments usually JSON encoded arguments, should include "documentRoot" and "requestUrl"
      * @return void
      */
     public static function setGlobalVariables(array $requestArguments = null)
@@ -84,7 +88,7 @@ class RequestBootstrap
     }
 
     /**
-     * @return void
+     * Calls the set SCRIPT_FILENAME and outputs the contents as JSON
      */
     public static function executeAndOutput()
     {
index ee9fec9..7a06118 100644 (file)
@@ -74,6 +74,7 @@ abstract class ViewHelperBaseTestcase extends \TYPO3\TestingFramework\Core\Unit\
     protected $mvcPropertyMapperConfigurationService;
 
     /**
+     * Sets up all properties of a viewhelper needed to test a viewhelper
      * @return void
      */
     protected function setUp()
index 7641696..a8c3017 100644 (file)
@@ -200,7 +200,8 @@ class ElementInformationController
     }
 
     /**
-     * @return void
+     * Compiles the whole content to be outputted, which is then set as content to the moduleTemplate
+     * There is a hook to do a custom rendering of a record.
      */
     public function main()
     {
index 97a8e44..2a2884e 100644 (file)
@@ -102,7 +102,7 @@ class FormInlineAjaxController extends AbstractFormEngineAjaxController
         // @todo: of children are only created with the "synchronize" button that will trigger a different ajax action.
         // @todo: The edge case of new page overlay together with localized media field, this code won't kick in either.
         // @deprecated: IRRE 'localizationMode' is deprecated and will be removed in TYPO3 CMS 9
-        /**
+        /*
         if ($parent['localizationMode'] === 'select' && MathUtility::canBeInterpretedAsInteger($parent['uid'])) {
             $parentRecord = $inlineRelatedRecordResolver->getRecord($parent['table'], $parent['uid']);
             $parentLanguageField = $GLOBALS['TCA'][$parent['table']]['ctrl']['languageField'];
index daa4ab3..73c8b8d 100644 (file)
@@ -45,7 +45,7 @@ class PaletteAndSingleContainer extends AbstractContainer
     {
         $languageService = $this->getLanguageService();
 
-        /**
+        /*
          * The first code block creates a target structure array to later create the final
          * HTML string. The single fields and sub containers are rendered here already and
          * other parts of the return array from children except html are accumulated in
index 16811a8..0d61157 100644 (file)
@@ -705,7 +705,7 @@ class DataHandler
     protected $cachePrefixNestedElementCalls = 'core-datahandler-nestedElementCalls-';
 
     /**
-     *
+     * Sets up the data handler cache and some additional options, the main logic is done in the start() method.
      */
     public function __construct()
     {
index cac6dde..7500df4 100644 (file)
@@ -79,6 +79,7 @@ class FlashMessageQueue extends \SplQueue
     }
 
     /**
+     * This method is empty, as it will not move any flash message (e.g. from the session)
      * @return void
      */
     public function dequeue()
index ec56dfc..5143b78 100644 (file)
@@ -30,7 +30,7 @@ class DriverRegistry implements \TYPO3\CMS\Core\SingletonInterface
     protected $driverConfigurations = [];
 
     /**
-     * Creates this object.
+     * Creates this object by detecting all available drivers registered in $TYPO3_CONF_VARS.
      */
     public function __construct()
     {
@@ -83,6 +83,9 @@ class DriverRegistry implements \TYPO3\CMS\Core\SingletonInterface
     }
 
     /**
+     * Adds the TCA information so the registered drivers can be selected when creating a sys_file_storage
+     * in the TYPO3 Backend.
+     *
      * @return void
      */
     public function addDriversToTCA()
index 808abc7..1ba8b0f 100644 (file)
@@ -388,6 +388,8 @@ class ProcessedFile extends AbstractFile
     }
 
     /**
+     * Defines that the original file should be used.
+     *
      * @return void
      */
     public function setUsesOriginalFile()
index ecd424c..5a212c1 100644 (file)
@@ -179,7 +179,7 @@ class ElementsBasicInputDateCest extends AbstractElementsBasicCest
     /**
      * @param Admin $I
      */
-    /**
+    /*
     public function checkThatValidationWorks_EvalDateTime_DbTypeDateTime(Admin $I)
     {
         // @todo fix these unstable test
index 0f20eb7..8886577 100644 (file)
@@ -82,6 +82,8 @@ class HelpCommandController extends \TYPO3\CMS\Extbase\Mvc\Controller\CommandCon
     }
 
     /**
+     * Builds an index of all commands that are available
+     *
      * @return void
      */
     protected function displayHelpIndex()
index aa18658..382a5d6 100644 (file)
@@ -254,6 +254,8 @@ class QueryResult implements QueryResultInterface
     }
 
     /**
+     * Ensures that the objectManager, persistenceManager and dataMapper are back when loading the QueryResult
+     * from the cache
      * @return void
      */
     public function __wakeup()
index dcc4067..ae2ee81 100644 (file)
@@ -112,7 +112,7 @@ class DownloadController extends AbstractController
     }
 
     /**
-     *
+     * Defines which view object should be used for the installFromTer action
      */
     protected function initializeInstallFromTerAction()
     {
index 82387e4..a71ba87 100644 (file)
@@ -25,6 +25,7 @@ class ClickMenuOnIconViewHelper extends \TYPO3\CMS\Fluid\Core\ViewHelper\Abstrac
     protected $tagName = 'a';
 
     /**
+     * Defines additional arguments that are allowed for this view helper.
      * @return void
      */
     public function initializeArguments()
index a551f4d..24c14fb 100644 (file)
@@ -55,6 +55,8 @@ class PaginateController extends \TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetCont
     protected $numberOfObjects = 0;
 
     /**
+     * Initializes necessary variables for all actions.
+     *
      * @return void
      */
     public function initializeAction()
index 035f37e..4cbd2c0 100644 (file)
@@ -38,6 +38,7 @@ class RenderViewHelper extends AbstractViewHelper
     protected $escapeOutput = false;
 
     /**
+     * Initializes additional arguments available for this view helper.
      * @return void
      */
     public function initializeArguments()
index 1b2c605..e6f6938 100644 (file)
@@ -28,6 +28,7 @@ class OptgroupViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormF
     protected $tagName = 'optgroup';
 
     /**
+     * Initialize additional arguments available for this tag view helper.
      * @return void
      */
     public function initializeArguments()
index d09a5df..37ac254 100644 (file)
@@ -28,6 +28,7 @@ class OptionViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFie
     protected $tagName = 'option';
 
     /**
+     * Initialize additional arguments available for this tag view helper.
      * @return void
      */
     public function initializeArguments()
index 17d516d..a8c5583 100644 (file)
@@ -20,6 +20,8 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Widget\Controller;
 class AutocompleteController extends \TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetController
 {
     /**
+     * Simply assigns the ID of the widget.
+     *
      * @return void
      */
     public function indexAction()
index 5560359..26f558a 100644 (file)
@@ -66,6 +66,7 @@ class PaginateController extends AbstractWidgetController
     protected $displayRangeEnd = null;
 
     /**
+     * Initializes the current information on which page the visitor is.
      * @return void
      */
     public function initializeAction()
index 3dc273c..ebf32ae 100644 (file)
@@ -26,6 +26,7 @@ class DatePicker extends AbstractFormElement
 {
 
     /**
+     * Initializes the Form Element by setting the data type to "DateTime"
      * @return void
      * @internal
      */
index f5885e3..480118f 100644 (file)
@@ -26,6 +26,7 @@ class FileUpload extends AbstractFormElement
 {
 
     /**
+     * Initializes the Form Element by setting the data type to a Extbase File Reference
      * @return void
      * @internal
      */
index cd7a6a3..501d547 100644 (file)
@@ -187,6 +187,7 @@ class FormRuntime implements RootRenderableInterface, \ArrayAccess
     }
 
     /**
+     * Initializes the current state of the form, based on the request
      * @return void
      */
     protected function initializeFormStateFromRequest()
@@ -201,6 +202,7 @@ class FormRuntime implements RootRenderableInterface, \ArrayAccess
     }
 
     /**
+     * Initializes the current page data based on the current request, also modifiable by a hook
      * @return void
      */
     protected function initializeCurrentPageFromRequest()
@@ -261,6 +263,8 @@ class FormRuntime implements RootRenderableInterface, \ArrayAccess
     }
 
     /**
+     * Checks if the honey pot is active, and adds a validator if so.
+     *
      * @return void
      */
     protected function initializeHoneypotFromRequest()
@@ -288,6 +292,8 @@ class FormRuntime implements RootRenderableInterface, \ArrayAccess
     }
 
     /**
+     * Renders a hidden field if the honey pot is active.
+     *
      * @return void
      */
     protected function renderHoneypot()
@@ -396,6 +402,7 @@ class FormRuntime implements RootRenderableInterface, \ArrayAccess
     }
 
     /**
+     * Runs throuh all validations
      * @return void
      */
     protected function processSubmittedFormValues()
index f133202..d95596a 100644 (file)
@@ -292,6 +292,7 @@ class MenuProcessor implements DataProcessorInterface
     }
 
     /**
+     * Prepare configuration for a certain menu level in the hierarchy
      * @return void
      */
     public function prepareLevelConfiguration()
@@ -307,6 +308,7 @@ class MenuProcessor implements DataProcessorInterface
     }
 
     /**
+     * Prepare the configuration when rendering a language menu
      * @return void
      */
     public function prepareLevelLanguageConfiguration()
@@ -338,6 +340,8 @@ class MenuProcessor implements DataProcessorInterface
     }
 
     /**
+     * Build the menu configuration so it can be treated by HMENU cObject
+     *
      * @return void
      */
     public function buildConfiguration()
index 888bd1f..b3f8e67 100644 (file)
@@ -156,6 +156,8 @@ class ImportExportController extends BaseScriptClass
     }
 
     /**
+     * Initializes the module and defining necessary variables for this module to run.
+     *
      * @return void
      */
     public function init()
index a48216c..d036aed 100644 (file)
@@ -26,6 +26,7 @@ class FlagValueViewHelper extends AbstractViewHelper
     use CompileWithRenderStatic;
 
     /**
+     * Sets up the needed arguments for this View Helper.
      * @return void
      */
     public function initializeArguments()
index d745366..7403dcc 100644 (file)
@@ -63,6 +63,8 @@ abstract class AbstractStepAction extends \TYPO3\CMS\Install\Controller\Action\A
     }
 
     /**
+     * Define the steps to the view.
+     *
      * @return void
      */
     protected function assignSteps()
index 72cd58a..67c9ec9 100644 (file)
@@ -158,6 +158,7 @@ class DatabaseBrowser extends AbstractElementBrowser implements ElementBrowserIn
     }
 
     /**
+     * If the current Backend User has set a temporary DB mount, it is stored to her/his UC.
      * @return void
      */
     protected function setTemporaryDbMounts()
index 472e87e..6c86654 100644 (file)
@@ -67,6 +67,7 @@ class FileBrowser extends AbstractElementBrowser implements ElementBrowserInterf
     protected $fileRepository;
 
     /**
+     * Loads additional JavaScript
      * @return void
      */
     protected function initialize()
@@ -77,6 +78,7 @@ class FileBrowser extends AbstractElementBrowser implements ElementBrowserInterf
     }
 
     /**
+     * Checks additional GET/POST requests
      * @return void
      */
     protected function initVariables()
index 304af25..07f70ba 100644 (file)
@@ -38,6 +38,7 @@ class FolderBrowser extends AbstractElementBrowser implements ElementBrowserInte
     protected $expandFolder;
 
     /**
+     * Adds additional JavaScript modules
      * @return void
      */
     protected function initialize()
@@ -51,6 +52,7 @@ class FolderBrowser extends AbstractElementBrowser implements ElementBrowserInte
     }
 
     /**
+     * Checks for an additional request parameter
      * @return void
      */
     protected function initVariables()
index af52262..e7735ac 100644 (file)
@@ -113,6 +113,7 @@ abstract class AbstractLinkHandler
     }
 
     /**
+     * Sets a DB mount and stores it in the currently defined backend user in her/his uc
      * @return void
      */
     protected function setTemporaryDbMounts()
index 7f9231c..3156158 100644 (file)
@@ -223,6 +223,7 @@ class PageLinkHandler extends AbstractLinkHandler implements LinkHandlerInterfac
     }
 
     /**
+     * Sets a DB mount and stores it in the currently defined backend user in her/his uc
      * @return void
      */
     protected function setTemporaryDbMounts()
index 38c312d..d946177 100644 (file)
@@ -68,6 +68,8 @@ class ParseHtmlController
     }
 
     /**
+     * Initializes necessary parameters before calling the actual main action.
+     *
      * @return void
      */
     public function init()
index 32b82b2..c0f606d 100644 (file)
@@ -63,6 +63,7 @@ class UserElementsController
     }
 
     /**
+     * Initializes necessary parameters before calling the actual main action.
      * @return void
      */
     public function init()