From a71692354e6bd2709a8f13f05107628c9eb7bb0d Mon Sep 17 00:00:00 2001
From: Benni Mack <benni@typo3.org>
Date: Mon, 27 Mar 2017 22:58:56 +0200
Subject: [PATCH] [TASK] Add proper comments to PHP code
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>
---
.../Functional/Framework/Frontend/RequestBootstrap.php | 6 +++++-
.../Fluid/Unit/ViewHelpers/ViewHelperBaseTestcase.php | 1 +
.../ContentElement/ElementInformationController.php | 3 ++-
.../Classes/Controller/FormInlineAjaxController.php | 2 +-
.../Classes/Form/Container/PaletteAndSingleContainer.php | 2 +-
typo3/sysext/core/Classes/DataHandling/DataHandler.php | 2 +-
typo3/sysext/core/Classes/Messaging/FlashMessageQueue.php | 1 +
.../sysext/core/Classes/Resource/Driver/DriverRegistry.php | 5 ++++-
typo3/sysext/core/Classes/Resource/ProcessedFile.php | 2 ++
.../Backend/Formhandler/ElementsBasicInputDateCest.php | 2 +-
.../extbase/Classes/Command/HelpCommandController.php | 2 ++
.../extbase/Classes/Persistence/Generic/QueryResult.php | 2 ++
.../Classes/Controller/DownloadController.php | 2 +-
.../Classes/ViewHelpers/Link/ClickMenuOnIconViewHelper.php | 1 +
.../Be/Widget/Controller/PaginateController.php | 2 ++
.../fluid/Classes/ViewHelpers/Debug/RenderViewHelper.php | 1 +
.../Classes/ViewHelpers/Form/Select/OptgroupViewHelper.php | 1 +
.../Classes/ViewHelpers/Form/Select/OptionViewHelper.php | 1 +
.../Widget/Controller/AutocompleteController.php | 2 ++
.../ViewHelpers/Widget/Controller/PaginateController.php | 1 +
.../form/Classes/Domain/Model/FormElements/DatePicker.php | 1 +
.../form/Classes/Domain/Model/FormElements/FileUpload.php | 1 +
typo3/sysext/form/Classes/Domain/Runtime/FormRuntime.php | 7 +++++++
.../frontend/Classes/DataProcessing/MenuProcessor.php | 4 ++++
.../impexp/Classes/Controller/ImportExportController.php | 2 ++
.../Classes/ViewHelpers/Format/FlagValueViewHelper.php | 1 +
.../Classes/Controller/Action/Step/AbstractStepAction.php | 2 ++
.../sysext/recordlist/Classes/Browser/DatabaseBrowser.php | 1 +
typo3/sysext/recordlist/Classes/Browser/FileBrowser.php | 2 ++
typo3/sysext/recordlist/Classes/Browser/FolderBrowser.php | 2 ++
.../recordlist/Classes/LinkHandler/AbstractLinkHandler.php | 1 +
.../recordlist/Classes/LinkHandler/PageLinkHandler.php | 1 +
.../rtehtmlarea/Classes/Controller/ParseHtmlController.php | 2 ++
.../Classes/Controller/UserElementsController.php | 1 +
34 files changed, 61 insertions(+), 8 deletions(-)
diff --git a/components/testing_framework/Classes/Core/Functional/Framework/Frontend/RequestBootstrap.php b/components/testing_framework/Classes/Core/Functional/Framework/Frontend/RequestBootstrap.php
index 8f7babbac1a5..683c0ab6d915 100644
--- a/components/testing_framework/Classes/Core/Functional/Framework/Frontend/RequestBootstrap.php
+++ b/components/testing_framework/Classes/Core/Functional/Framework/Frontend/RequestBootstrap.php
@@ -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()
{
diff --git a/components/testing_framework/Classes/Fluid/Unit/ViewHelpers/ViewHelperBaseTestcase.php b/components/testing_framework/Classes/Fluid/Unit/ViewHelpers/ViewHelperBaseTestcase.php
index ee9fec9d60ab..7a0611849a84 100644
--- a/components/testing_framework/Classes/Fluid/Unit/ViewHelpers/ViewHelperBaseTestcase.php
+++ b/components/testing_framework/Classes/Fluid/Unit/ViewHelpers/ViewHelperBaseTestcase.php
@@ -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()
diff --git a/typo3/sysext/backend/Classes/Controller/ContentElement/ElementInformationController.php b/typo3/sysext/backend/Classes/Controller/ContentElement/ElementInformationController.php
index 7641696cb81f..a8c301743d0b 100644
--- a/typo3/sysext/backend/Classes/Controller/ContentElement/ElementInformationController.php
+++ b/typo3/sysext/backend/Classes/Controller/ContentElement/ElementInformationController.php
@@ -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()
{
diff --git a/typo3/sysext/backend/Classes/Controller/FormInlineAjaxController.php b/typo3/sysext/backend/Classes/Controller/FormInlineAjaxController.php
index 97a8e4463e62..2a2884e3e0ee 100644
--- a/typo3/sysext/backend/Classes/Controller/FormInlineAjaxController.php
+++ b/typo3/sysext/backend/Classes/Controller/FormInlineAjaxController.php
@@ -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'];
diff --git a/typo3/sysext/backend/Classes/Form/Container/PaletteAndSingleContainer.php b/typo3/sysext/backend/Classes/Form/Container/PaletteAndSingleContainer.php
index daa4ab37b19d..73c8b8d84b33 100644
--- a/typo3/sysext/backend/Classes/Form/Container/PaletteAndSingleContainer.php
+++ b/typo3/sysext/backend/Classes/Form/Container/PaletteAndSingleContainer.php
@@ -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
diff --git a/typo3/sysext/core/Classes/DataHandling/DataHandler.php b/typo3/sysext/core/Classes/DataHandling/DataHandler.php
index 16811a8904b5..0d611578a927 100644
--- a/typo3/sysext/core/Classes/DataHandling/DataHandler.php
+++ b/typo3/sysext/core/Classes/DataHandling/DataHandler.php
@@ -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()
{
diff --git a/typo3/sysext/core/Classes/Messaging/FlashMessageQueue.php b/typo3/sysext/core/Classes/Messaging/FlashMessageQueue.php
index cac6dde4a841..7500df42c5ed 100644
--- a/typo3/sysext/core/Classes/Messaging/FlashMessageQueue.php
+++ b/typo3/sysext/core/Classes/Messaging/FlashMessageQueue.php
@@ -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()
diff --git a/typo3/sysext/core/Classes/Resource/Driver/DriverRegistry.php b/typo3/sysext/core/Classes/Resource/Driver/DriverRegistry.php
index ec56dfc1a15e..5143b780314f 100644
--- a/typo3/sysext/core/Classes/Resource/Driver/DriverRegistry.php
+++ b/typo3/sysext/core/Classes/Resource/Driver/DriverRegistry.php
@@ -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()
diff --git a/typo3/sysext/core/Classes/Resource/ProcessedFile.php b/typo3/sysext/core/Classes/Resource/ProcessedFile.php
index 808abc73f04f..1ba8b0f9c266 100644
--- a/typo3/sysext/core/Classes/Resource/ProcessedFile.php
+++ b/typo3/sysext/core/Classes/Resource/ProcessedFile.php
@@ -388,6 +388,8 @@ class ProcessedFile extends AbstractFile
}
/**
+ * Defines that the original file should be used.
+ *
* @return void
*/
public function setUsesOriginalFile()
diff --git a/typo3/sysext/core/Tests/Acceptance/Backend/Formhandler/ElementsBasicInputDateCest.php b/typo3/sysext/core/Tests/Acceptance/Backend/Formhandler/ElementsBasicInputDateCest.php
index ecd424c12632..5a212c171a93 100644
--- a/typo3/sysext/core/Tests/Acceptance/Backend/Formhandler/ElementsBasicInputDateCest.php
+++ b/typo3/sysext/core/Tests/Acceptance/Backend/Formhandler/ElementsBasicInputDateCest.php
@@ -179,7 +179,7 @@ class ElementsBasicInputDateCest extends AbstractElementsBasicCest
/**
* @param Admin $I
*/
- /**
+ /*
public function checkThatValidationWorks_EvalDateTime_DbTypeDateTime(Admin $I)
{
// @todo fix these unstable test
diff --git a/typo3/sysext/extbase/Classes/Command/HelpCommandController.php b/typo3/sysext/extbase/Classes/Command/HelpCommandController.php
index 0f20eb7637ad..8886577a8412 100644
--- a/typo3/sysext/extbase/Classes/Command/HelpCommandController.php
+++ b/typo3/sysext/extbase/Classes/Command/HelpCommandController.php
@@ -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()
diff --git a/typo3/sysext/extbase/Classes/Persistence/Generic/QueryResult.php b/typo3/sysext/extbase/Classes/Persistence/Generic/QueryResult.php
index aa18658a8478..382a5d628659 100644
--- a/typo3/sysext/extbase/Classes/Persistence/Generic/QueryResult.php
+++ b/typo3/sysext/extbase/Classes/Persistence/Generic/QueryResult.php
@@ -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()
diff --git a/typo3/sysext/extensionmanager/Classes/Controller/DownloadController.php b/typo3/sysext/extensionmanager/Classes/Controller/DownloadController.php
index dcc40671b0a9..ae2ee81955fc 100644
--- a/typo3/sysext/extensionmanager/Classes/Controller/DownloadController.php
+++ b/typo3/sysext/extensionmanager/Classes/Controller/DownloadController.php
@@ -112,7 +112,7 @@ class DownloadController extends AbstractController
}
/**
- *
+ * Defines which view object should be used for the installFromTer action
*/
protected function initializeInstallFromTerAction()
{
diff --git a/typo3/sysext/filelist/Classes/ViewHelpers/Link/ClickMenuOnIconViewHelper.php b/typo3/sysext/filelist/Classes/ViewHelpers/Link/ClickMenuOnIconViewHelper.php
index 82387e486b6a..a71ba87c842d 100644
--- a/typo3/sysext/filelist/Classes/ViewHelpers/Link/ClickMenuOnIconViewHelper.php
+++ b/typo3/sysext/filelist/Classes/ViewHelpers/Link/ClickMenuOnIconViewHelper.php
@@ -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()
diff --git a/typo3/sysext/fluid/Classes/ViewHelpers/Be/Widget/Controller/PaginateController.php b/typo3/sysext/fluid/Classes/ViewHelpers/Be/Widget/Controller/PaginateController.php
index a551f4d94cb2..24c14fbe02dc 100644
--- a/typo3/sysext/fluid/Classes/ViewHelpers/Be/Widget/Controller/PaginateController.php
+++ b/typo3/sysext/fluid/Classes/ViewHelpers/Be/Widget/Controller/PaginateController.php
@@ -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()
diff --git a/typo3/sysext/fluid/Classes/ViewHelpers/Debug/RenderViewHelper.php b/typo3/sysext/fluid/Classes/ViewHelpers/Debug/RenderViewHelper.php
index 035f37ef9bf4..4cbd2c089c10 100644
--- a/typo3/sysext/fluid/Classes/ViewHelpers/Debug/RenderViewHelper.php
+++ b/typo3/sysext/fluid/Classes/ViewHelpers/Debug/RenderViewHelper.php
@@ -38,6 +38,7 @@ class RenderViewHelper extends AbstractViewHelper
protected $escapeOutput = false;
/**
+ * Initializes additional arguments available for this view helper.
* @return void
*/
public function initializeArguments()
diff --git a/typo3/sysext/fluid/Classes/ViewHelpers/Form/Select/OptgroupViewHelper.php b/typo3/sysext/fluid/Classes/ViewHelpers/Form/Select/OptgroupViewHelper.php
index 1b2c60521dda..e6f6938dc788 100644
--- a/typo3/sysext/fluid/Classes/ViewHelpers/Form/Select/OptgroupViewHelper.php
+++ b/typo3/sysext/fluid/Classes/ViewHelpers/Form/Select/OptgroupViewHelper.php
@@ -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()
diff --git a/typo3/sysext/fluid/Classes/ViewHelpers/Form/Select/OptionViewHelper.php b/typo3/sysext/fluid/Classes/ViewHelpers/Form/Select/OptionViewHelper.php
index d09a5df85ae6..37ac254a7689 100644
--- a/typo3/sysext/fluid/Classes/ViewHelpers/Form/Select/OptionViewHelper.php
+++ b/typo3/sysext/fluid/Classes/ViewHelpers/Form/Select/OptionViewHelper.php
@@ -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()
diff --git a/typo3/sysext/fluid/Classes/ViewHelpers/Widget/Controller/AutocompleteController.php b/typo3/sysext/fluid/Classes/ViewHelpers/Widget/Controller/AutocompleteController.php
index 17d516d6c7e9..a8c558389c34 100644
--- a/typo3/sysext/fluid/Classes/ViewHelpers/Widget/Controller/AutocompleteController.php
+++ b/typo3/sysext/fluid/Classes/ViewHelpers/Widget/Controller/AutocompleteController.php
@@ -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()
diff --git a/typo3/sysext/fluid/Classes/ViewHelpers/Widget/Controller/PaginateController.php b/typo3/sysext/fluid/Classes/ViewHelpers/Widget/Controller/PaginateController.php
index 556035930183..26f558a8e980 100644
--- a/typo3/sysext/fluid/Classes/ViewHelpers/Widget/Controller/PaginateController.php
+++ b/typo3/sysext/fluid/Classes/ViewHelpers/Widget/Controller/PaginateController.php
@@ -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()
diff --git a/typo3/sysext/form/Classes/Domain/Model/FormElements/DatePicker.php b/typo3/sysext/form/Classes/Domain/Model/FormElements/DatePicker.php
index 3dc273c82dbb..ebf32ae10797 100644
--- a/typo3/sysext/form/Classes/Domain/Model/FormElements/DatePicker.php
+++ b/typo3/sysext/form/Classes/Domain/Model/FormElements/DatePicker.php
@@ -26,6 +26,7 @@ class DatePicker extends AbstractFormElement
{
/**
+ * Initializes the Form Element by setting the data type to "DateTime"
* @return void
* @internal
*/
diff --git a/typo3/sysext/form/Classes/Domain/Model/FormElements/FileUpload.php b/typo3/sysext/form/Classes/Domain/Model/FormElements/FileUpload.php
index f5885e3e28b0..480118fc177a 100644
--- a/typo3/sysext/form/Classes/Domain/Model/FormElements/FileUpload.php
+++ b/typo3/sysext/form/Classes/Domain/Model/FormElements/FileUpload.php
@@ -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
*/
diff --git a/typo3/sysext/form/Classes/Domain/Runtime/FormRuntime.php b/typo3/sysext/form/Classes/Domain/Runtime/FormRuntime.php
index cd7a6a3db35e..501d5474315b 100644
--- a/typo3/sysext/form/Classes/Domain/Runtime/FormRuntime.php
+++ b/typo3/sysext/form/Classes/Domain/Runtime/FormRuntime.php
@@ -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()
diff --git a/typo3/sysext/frontend/Classes/DataProcessing/MenuProcessor.php b/typo3/sysext/frontend/Classes/DataProcessing/MenuProcessor.php
index f13320278ee4..d95596a04b65 100644
--- a/typo3/sysext/frontend/Classes/DataProcessing/MenuProcessor.php
+++ b/typo3/sysext/frontend/Classes/DataProcessing/MenuProcessor.php
@@ -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()
diff --git a/typo3/sysext/impexp/Classes/Controller/ImportExportController.php b/typo3/sysext/impexp/Classes/Controller/ImportExportController.php
index 888bd1fbf424..b3f8e675ff3a 100644
--- a/typo3/sysext/impexp/Classes/Controller/ImportExportController.php
+++ b/typo3/sysext/impexp/Classes/Controller/ImportExportController.php
@@ -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()
diff --git a/typo3/sysext/indexed_search/Classes/ViewHelpers/Format/FlagValueViewHelper.php b/typo3/sysext/indexed_search/Classes/ViewHelpers/Format/FlagValueViewHelper.php
index a48216cc19cf..d036aed591e6 100644
--- a/typo3/sysext/indexed_search/Classes/ViewHelpers/Format/FlagValueViewHelper.php
+++ b/typo3/sysext/indexed_search/Classes/ViewHelpers/Format/FlagValueViewHelper.php
@@ -26,6 +26,7 @@ class FlagValueViewHelper extends AbstractViewHelper
use CompileWithRenderStatic;
/**
+ * Sets up the needed arguments for this View Helper.
* @return void
*/
public function initializeArguments()
diff --git a/typo3/sysext/install/Classes/Controller/Action/Step/AbstractStepAction.php b/typo3/sysext/install/Classes/Controller/Action/Step/AbstractStepAction.php
index d745366236b1..7403dcc7ed6f 100644
--- a/typo3/sysext/install/Classes/Controller/Action/Step/AbstractStepAction.php
+++ b/typo3/sysext/install/Classes/Controller/Action/Step/AbstractStepAction.php
@@ -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()
diff --git a/typo3/sysext/recordlist/Classes/Browser/DatabaseBrowser.php b/typo3/sysext/recordlist/Classes/Browser/DatabaseBrowser.php
index 72cd58aba875..67c9ec91f61c 100644
--- a/typo3/sysext/recordlist/Classes/Browser/DatabaseBrowser.php
+++ b/typo3/sysext/recordlist/Classes/Browser/DatabaseBrowser.php
@@ -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()
diff --git a/typo3/sysext/recordlist/Classes/Browser/FileBrowser.php b/typo3/sysext/recordlist/Classes/Browser/FileBrowser.php
index 472e87e8cc17..6c866546222c 100644
--- a/typo3/sysext/recordlist/Classes/Browser/FileBrowser.php
+++ b/typo3/sysext/recordlist/Classes/Browser/FileBrowser.php
@@ -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()
diff --git a/typo3/sysext/recordlist/Classes/Browser/FolderBrowser.php b/typo3/sysext/recordlist/Classes/Browser/FolderBrowser.php
index 304af25b211d..07f70baf7946 100644
--- a/typo3/sysext/recordlist/Classes/Browser/FolderBrowser.php
+++ b/typo3/sysext/recordlist/Classes/Browser/FolderBrowser.php
@@ -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()
diff --git a/typo3/sysext/recordlist/Classes/LinkHandler/AbstractLinkHandler.php b/typo3/sysext/recordlist/Classes/LinkHandler/AbstractLinkHandler.php
index af52262f2cc3..e7735acfd1d3 100644
--- a/typo3/sysext/recordlist/Classes/LinkHandler/AbstractLinkHandler.php
+++ b/typo3/sysext/recordlist/Classes/LinkHandler/AbstractLinkHandler.php
@@ -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()
diff --git a/typo3/sysext/recordlist/Classes/LinkHandler/PageLinkHandler.php b/typo3/sysext/recordlist/Classes/LinkHandler/PageLinkHandler.php
index 7f9231cdad0a..31561585cdcd 100644
--- a/typo3/sysext/recordlist/Classes/LinkHandler/PageLinkHandler.php
+++ b/typo3/sysext/recordlist/Classes/LinkHandler/PageLinkHandler.php
@@ -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()
diff --git a/typo3/sysext/rtehtmlarea/Classes/Controller/ParseHtmlController.php b/typo3/sysext/rtehtmlarea/Classes/Controller/ParseHtmlController.php
index 38c312d09565..d9461775a920 100644
--- a/typo3/sysext/rtehtmlarea/Classes/Controller/ParseHtmlController.php
+++ b/typo3/sysext/rtehtmlarea/Classes/Controller/ParseHtmlController.php
@@ -68,6 +68,8 @@ class ParseHtmlController
}
/**
+ * Initializes necessary parameters before calling the actual main action.
+ *
* @return void
*/
public function init()
diff --git a/typo3/sysext/rtehtmlarea/Classes/Controller/UserElementsController.php b/typo3/sysext/rtehtmlarea/Classes/Controller/UserElementsController.php
index 32b82b21c9a6..c0f606d8bc6a 100644
--- a/typo3/sysext/rtehtmlarea/Classes/Controller/UserElementsController.php
+++ b/typo3/sysext/rtehtmlarea/Classes/Controller/UserElementsController.php
@@ -63,6 +63,7 @@ class UserElementsController
}
/**
+ * Initializes necessary parameters before calling the actual main action.
* @return void
*/
public function init()
--
GitLab