[TASK] Streamline PHPDoc comment matches function/method signature 29/58129/4
authorWouter Wolters <typo3@wouterwolters.nl>
Sun, 2 Sep 2018 16:03:56 +0000 (18:03 +0200)
committerAnja Leichsenring <aleichsenring@ab-softlab.de>
Mon, 3 Sep 2018 08:59:08 +0000 (10:59 +0200)
Resolves: #86088
Releases: master
Change-Id: Ia011b8ca85b8665edd80a093844b5a60a5fe2e29
Reviewed-on: https://review.typo3.org/58129
Tested-by: TYPO3com <no-reply@typo3.com>
Reviewed-by: Christian Kuhn <lolli@schwarzbu.ch>
Tested-by: Christian Kuhn <lolli@schwarzbu.ch>
Reviewed-by: Anja Leichsenring <aleichsenring@ab-softlab.de>
Tested-by: Anja Leichsenring <aleichsenring@ab-softlab.de>
59 files changed:
typo3/sysext/adminpanel/Classes/Middleware/AdminPanelDataPersister.php
typo3/sysext/adminpanel/Classes/Middleware/AdminPanelRenderer.php
typo3/sysext/adminpanel/Classes/Middleware/SqlLogging.php
typo3/sysext/backend/Classes/Controller/File/RenameFileController.php
typo3/sysext/backend/Classes/Controller/OnlineMediaController.php
typo3/sysext/backend/Classes/Controller/Wizard/EditController.php
typo3/sysext/backend/Classes/Form/Container/AbstractContainer.php
typo3/sysext/backend/Classes/Provider/PageTsBackendLayoutDataProvider.php
typo3/sysext/backend/Classes/Toolbar/ClearCacheActionsHookInterface.php
typo3/sysext/backend/Classes/Tree/Renderer/UnorderedListTreeRenderer.php
typo3/sysext/backend/Classes/Tree/TreeNodeCollection.php
typo3/sysext/backend/Classes/Tree/View/AbstractTreeView.php
typo3/sysext/beuser/Classes/Controller/BackendUserController.php
typo3/sysext/core/Classes/Authentication/AuthenticationService.php
typo3/sysext/core/Classes/DataHandling/DataHandler.php
typo3/sysext/core/Classes/Database/Connection.php
typo3/sysext/core/Classes/Error/Http/StatusException.php
typo3/sysext/core/Classes/Imaging/ImageManipulation/CropVariantCollection.php
typo3/sysext/core/Classes/Log/Processor/IntrospectionProcessor.php
typo3/sysext/core/Classes/Log/Writer/FileWriter.php
typo3/sysext/core/Classes/Page/PageRenderer.php
typo3/sysext/core/Classes/Resource/FileReference.php
typo3/sysext/core/Classes/Resource/InaccessibleFolder.php
typo3/sysext/core/Classes/Resource/ProcessedFile.php
typo3/sysext/core/Classes/Resource/Processing/ImageCropScaleMaskTask.php
typo3/sysext/core/Classes/Resource/Processing/ImagePreviewTask.php
typo3/sysext/core/Classes/Resource/ResourceStorage.php
typo3/sysext/core/Classes/Tree/TableConfiguration/DatabaseTreeDataProvider.php
typo3/sysext/extbase/Classes/Mvc/Controller/ControllerContext.php
typo3/sysext/extbase/Classes/Persistence/Generic/Mapper/ColumnMap.php
typo3/sysext/extbase/Classes/Persistence/Generic/PersistenceManager.php
typo3/sysext/extbase/Classes/Persistence/Generic/Query.php
typo3/sysext/extbase/Classes/Property/TypeConverter/DateTimeConverter.php
typo3/sysext/extbase/Classes/Scheduler/FieldProvider.php
typo3/sysext/extensionmanager/Classes/Report/ExtensionStatus.php
typo3/sysext/filelist/Classes/Controller/FileListController.php
typo3/sysext/fluid/Classes/ViewHelpers/FormViewHelper.php
typo3/sysext/form/Classes/Domain/Configuration/ConfigurationService.php
typo3/sysext/form/Classes/Domain/Configuration/FormDefinitionConversionService.php
typo3/sysext/form/Classes/Domain/Configuration/FrameworkConfiguration/Extractors/ExtractorDto.php
typo3/sysext/form/Classes/Domain/Finishers/SaveToDatabaseFinisher.php
typo3/sysext/form/Classes/ViewHelpers/RenderAllFormValuesViewHelper.php
typo3/sysext/frontend/Classes/ContentObject/FilesContentObject.php
typo3/sysext/frontend/Classes/ContentObject/Menu/CategoryMenuUtility.php
typo3/sysext/frontend/Classes/Middleware/EidHandler.php
typo3/sysext/frontend/Classes/Page/PageGenerator.php
typo3/sysext/impexp/Classes/Controller/ImportExportController.php
typo3/sysext/indexed_search/Classes/Domain/Repository/IndexSearchRepository.php
typo3/sysext/indexed_search/Classes/Example/PluginHook.php
typo3/sysext/install/Classes/Command/UpgradeWizardCommand.php
typo3/sysext/install/Classes/Controller/EnvironmentController.php
typo3/sysext/install/Classes/Http/RequestHandler.php
typo3/sysext/install/Classes/UpgradeAnalysis/DocumentationFile.php
typo3/sysext/linkvalidator/Classes/Report/LinkValidatorReport.php
typo3/sysext/opendocs/Classes/Service/OpenDocumentService.php
typo3/sysext/rsaauth/Classes/Controller/RsaPublicKeyGenerationController.php
typo3/sysext/seo/Classes/XmlSitemap/RecordsXmlSitemapDataProvider.php
typo3/sysext/sys_action/Classes/ActionTask.php
typo3/sysext/workspaces/Classes/Hook/DataHandlerHook.php

index 24fb844..8b02ec8 100644 (file)
@@ -35,6 +35,9 @@ class AdminPanelDataPersister implements MiddlewareInterface
 {
     /**
      * Render the admin panel if activated
+     * @param ServerRequestInterface $request
+     * @param RequestHandlerInterface $handler
+     * @return ResponseInterface
      */
     public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
     {
index 628f2a0..5c0847e 100644 (file)
@@ -37,6 +37,9 @@ class AdminPanelRenderer implements MiddlewareInterface
 
     /**
      * Render the admin panel if activated
+     * @param ServerRequestInterface $request
+     * @param RequestHandlerInterface $handler
+     * @return ResponseInterface
      */
     public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
     {
index 720d7c8..f2909f0 100644 (file)
@@ -35,6 +35,9 @@ class SqlLogging implements MiddlewareInterface
 
     /**
      * Enable SQL Logging as early as possible to catch all queries if the admin panel is active
+     * @param ServerRequestInterface $request
+     * @param RequestHandlerInterface $handler
+     * @return ResponseInterface
      */
     public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
     {
index 92f29e1..4eb02de 100644 (file)
@@ -106,6 +106,7 @@ class RenameFileController
     /**
      * Processes the request, currently everything is handled and put together via "renderContent()"
      *
+     * @param ServerRequestInterface $request
      * @return ResponseInterface the response with the content
      */
     public function mainAction(ServerRequestInterface $request): ResponseInterface
index 2cb512c..c8a00fa 100644 (file)
@@ -34,6 +34,7 @@ class OnlineMediaController
     /**
      * AJAX endpoint for storing the URL as a sys_file record
      *
+     * @param ServerRequestInterface $request
      * @return ResponseInterface
      */
     public function createAction(ServerRequestInterface $request): ResponseInterface
index a44bb86..e9d6582 100644 (file)
@@ -87,7 +87,7 @@ class EditController extends AbstractWizardController
     /**
      * Initialization of the script
      *
-     * @param  ServerRequestInterface
+     * @param ServerRequestInterface $request
      */
     protected function init(ServerRequestInterface $request)
     {
index 968c96b..db42092 100644 (file)
@@ -105,6 +105,7 @@ abstract class AbstractContainer extends AbstractNode
      *
      * @param array $menuItems Tab elements, each element is an array with "label" and "content"
      * @param string $domId DOM id attribute, will be appended with an iteration number per tab.
+     * @param int $defaultTabIndex
      * @return string
      */
     protected function renderTabMenu(array $menuItems, $domId, $defaultTabIndex = 1)
index 8458828..e071072 100644 (file)
@@ -164,6 +164,8 @@ class PageTsBackendLayoutDataProvider implements DataProviderInterface
     /**
      * Generates a Backend Layout from PageTsConfig array
      *
+     * @param string $identifier
+     * @param array $data
      * @return mixed
      */
     protected function generateBackendLayoutFromTsConfig($identifier, $data)
index 5cabc95..a86d900 100644 (file)
@@ -24,7 +24,6 @@ interface ClearCacheActionsHookInterface
      *
      * @param array $cacheActions Array of CacheMenuItems
      * @param array $optionValues Array of AccessConfigurations-identifiers (typically used by userTS with options.clearCache.identifier)
-     * @return
      */
     public function manipulateCacheActions(&$cacheActions, &$optionValues);
 }
index 7e0976d..37e8524 100644 (file)
@@ -48,7 +48,7 @@ class UnorderedListTreeRenderer extends \TYPO3\CMS\Backend\Tree\Renderer\Abstrac
     /**
      * Renders a node collection recursive or just a single instance
      *
-     * @param \TYPO3\CMS\Backend\Tree\TreeNodeCollection $node
+     * @param \TYPO3\CMS\Backend\Tree\AbstractTree $tree
      * @param bool $recursive
      * @return string
      */
index cf439d3..a20c956 100644 (file)
@@ -48,6 +48,9 @@ class TreeNodeCollection extends \ArrayObject
      *
      * @see \TYPO3\CMS\Backend\Tree\TreeNode::compareTo
      * @internal
+     * @param TreeNode $node
+     * @param TreeNode $otherNode
+     * @return int
      */
     public function nodeCompare(\TYPO3\CMS\Backend\Tree\TreeNode $node, \TYPO3\CMS\Backend\Tree\TreeNode $otherNode)
     {
index 6a508cd..5e2a373 100644 (file)
@@ -967,7 +967,7 @@ abstract class AbstractTreeView
      *
      * @param mixed $res Data handle
      *
-     * @return array item data array OR FALSE if end of elements.
+     * @return array|bool item data array OR FALSE if end of elements.
      * @access private
      * @see getDataInit()
      */
index 2a84890..019996c 100644 (file)
@@ -111,6 +111,7 @@ class BackendUserController extends ActionController
 
     /**
      * Assign default variables to view
+     * @param ViewInterface $view
      */
     public function initializeView(ViewInterface $view)
     {
index 8ff05b4..a9a3239 100644 (file)
@@ -298,7 +298,6 @@ class AuthenticationService extends AbstractAuthenticationService
      * @param string $grList Commalist of fe_groups uid numbers
      * @param string $idList List of already processed fe_groups-uids so the function will not fall into an eternal recursion.
      * @param array $groups
-     * @return array
      * @access private
      */
     public function getSubGroups($grList, $idList = '', &$groups)
@@ -350,14 +349,11 @@ class AuthenticationService extends AbstractAuthenticationService
             // Get row:
             $row = $groupRows[$uid];
             // Must be an array and $uid should not be in the idList, because then it is somewhere previously in the grouplist
-            if (is_array($row) && !GeneralUtility::inList($idList, $uid)) {
-                // Include sub groups
-                if (trim($row['subgroup'])) {
-                    // Make integer list
-                    $theList = implode(',', GeneralUtility::intExplode(',', $row['subgroup']));
-                    // Call recursively, pass along list of already processed groups so they are not processed again.
-                    $this->getSubGroups($theList, $idList . ',' . $uid, $groups);
-                }
+            if (is_array($row) && !GeneralUtility::inList($idList, $uid) && trim($row['subgroup'])) {
+                // Make integer list
+                $theList = implode(',', GeneralUtility::intExplode(',', $row['subgroup']));
+                // Call recursively, pass along list of already processed groups so they are not processed again.
+                $this->getSubGroups($theList, $idList . ',' . $uid, $groups);
             }
         }
     }
index 1900599..b344306 100644 (file)
@@ -1309,9 +1309,8 @@ class DataHandler implements LoggerAwareInterface
 
     /**
      * @param string $table
-     * @param string $row
-     * @param string $key
-     *
+     * @param string $value
+     * @param string $dbType
      * @return string
      */
     protected function normalizeTimeFormat(string $table, string $value, string $dbType): string
@@ -2639,7 +2638,6 @@ class DataHandler implements LoggerAwareInterface
      * @param array $PP Additional parameters in a numeric array: $table,$id,$curValue,$status,$realPid,$recFID
      * @param string $field Field name
      * @param array $additionalData Additional data to be forwarded to sub-processors
-     * @return array Modified $res array
      */
     public function checkValue_inline($res, $value, $tcaFieldConf, $PP, $field, array $additionalData = null)
     {
@@ -5935,7 +5933,6 @@ class DataHandler implements LoggerAwareInterface
      * @param string $dataValue_ext1 Not used.
      * @param string $dataValue_ext2 Not used.
      * @param string $path Path in flexforms
-     * @return array Result array with key "value" containing the value of the processing.
      * @see version_remapMMForVersionSwap(), checkValue_flex_procInData_travDS()
      */
     public function version_remapMMForVersionSwap_flexFormCallBack($pParams, $dsConf, $dataValue, $dataValue_ext1, $dataValue_ext2, $path)
index 2c239f9..436314b 100644 (file)
@@ -93,7 +93,7 @@ class Connection extends \Doctrine\DBAL\Connection implements LoggerAwareInterfa
     /**
      * Gets the DatabasePlatform for the connection and initializes custom types and event listeners.
      *
-     * @return \Doctrine\DBAL\Platforms\AbstractPlatform
+     * @return bool
      */
     public function connect(): bool
     {
index 4ddde79..702f8f0 100644 (file)
@@ -71,7 +71,7 @@ class StatusException extends \TYPO3\CMS\Core\Error\Exception
     /**
      * Getter for the Status Header.
      *
-     * @return string
+     * @return array
      */
     public function getStatusHeaders()
     {
index ae95370..4981213 100644 (file)
@@ -154,7 +154,7 @@ class CropVariantCollection
     }
 
     /**
-     * @param CropVariant[] ...$cropVariants
+     * @param CropVariant[] $cropVariants
      * @throws \TYPO3\CMS\Core\Imaging\ImageManipulation\InvalidConfigurationException
      */
     protected function setCropVariants(CropVariant ...$cropVariants)
index 71864de..31bb290 100644 (file)
@@ -54,7 +54,7 @@ class IntrospectionProcessor extends AbstractProcessor
      * Set the number of levels to be shift from the backtrace
      *
      * @param int $shiftBackTraceLevel Numbers of levels to shift
-     * @return \TYPO3\CMS\Core\Log\Writer\AbstractWriter
+     * @return IntrospectionProcessor
      */
     public function setShiftBackTraceLevel($shiftBackTraceLevel)
     {
@@ -66,7 +66,7 @@ class IntrospectionProcessor extends AbstractProcessor
      * Set if the full backtrace should be added to the log or just the last item
      *
      * @param bool $appendFullBackTrace If the full backtrace should be added
-     * @return \TYPO3\CMS\Core\Log\Writer\AbstractWriter
+     * @return IntrospectionProcessor
      */
     public function setAppendFullBackTrace($appendFullBackTrace)
     {
index 7f43ed5..b068d82 100644 (file)
@@ -73,7 +73,6 @@ class FileWriter extends AbstractWriter
      * Constructor, opens the log file handle
      *
      * @param array $options
-     * @return FileWriter
      */
     public function __construct(array $options = [])
     {
index 0cda976..4019235 100644 (file)
@@ -1187,7 +1187,7 @@ class PageRenderer implements \TYPO3\CMS\Core\SingletonInterface
      * @param string $splitChar The char used to split the allWrap value, default is "|"
      * @param bool $async Flag if property 'async="async"' should be added to JavaScript tags
      * @param string $integrity Subresource Integrity (SRI)
-     * @param string $defer Flag if property 'defer="defer"' should be added to JavaScript tags
+     * @param bool $defer Flag if property 'defer="defer"' should be added to JavaScript tags
      * @param string $crossorigin CORS settings attribute
      */
     public function addJsFooterFile($file, $type = 'text/javascript', $compress = true, $forceOnTop = false, $allWrap = '', $excludeFromConcatenation = false, $splitChar = '|', $async = false, $integrity = '', $defer = false, $crossorigin = '')
index 4c10cde..fd03bfa 100644 (file)
@@ -409,7 +409,6 @@ class FileReference implements FileInterface
      * (database table sys_file_reference) but leaves the original file untouched.
      *
      * @throws \BadMethodCallException
-     * @return bool TRUE if deletion succeeded
      */
     public function delete()
     {
@@ -424,7 +423,6 @@ class FileReference implements FileInterface
      *
      * @param string $newName The new name
      * @param string $conflictMode
-     * @return FileReference
      */
     public function rename($newName, $conflictMode = DuplicationBehavior::RENAME)
     {
index d90878c..25cca23 100644 (file)
@@ -76,7 +76,7 @@ class InaccessibleFolder extends Folder
      * @param bool $recursive
      * @param string $sort
      * @param bool $sortRev
-     * @return File[]
+     * @throws Exception\InsufficientFolderReadPermissionsException
      */
     public function getFiles($start = 0, $numberOfItems = 0, $filterMode = self::FILTER_MODE_USE_OWN_AND_STORAGE_FILTERS, $recursive = false, $sort = '', $sortRev = false)
     {
@@ -89,8 +89,7 @@ class InaccessibleFolder extends Folder
      *
      * @param array $filterMethods
      * @param bool $recursive
-     *
-     * @return int
+     * @throws Exception\InsufficientFolderReadPermissionsException
      */
     public function getFileCount(array $filterMethods = [], $recursive = false)
     {
@@ -101,9 +100,7 @@ class InaccessibleFolder extends Folder
      * Returns the object for a subfolder of the current folder, if it exists.
      *
      * @param string $name Name of the subfolder
-     *
-     * @throws \InvalidArgumentException
-     * @return Folder
+     * @throws Exception\InsufficientFolderReadPermissionsException
      */
     public function getSubfolder($name)
     {
@@ -117,7 +114,7 @@ class InaccessibleFolder extends Folder
      * @param int $numberOfItems The number of items to return
      * @param int $filterMode The filter mode to use for the filelist.
      * @param bool $recursive
-     * @return Folder[]
+     * @throws Exception\InsufficientFolderReadPermissionsException
      */
     public function getSubfolders($start = 0, $numberOfItems = 0, $filterMode = self::FILTER_MODE_USE_OWN_AND_STORAGE_FILTERS, $recursive = false)
     {
@@ -131,7 +128,7 @@ class InaccessibleFolder extends Folder
      * @param string $localFilePath
      * @param string $fileName
      * @param string $conflictMode a value of the DuplicationBehavior enumeration
-     * @return File The file object
+     * @throws Exception\InsufficientFolderReadPermissionsException
      */
     public function addFile($localFilePath, $fileName = null, $conflictMode = DuplicationBehavior::CANCEL)
     {
@@ -143,7 +140,7 @@ class InaccessibleFolder extends Folder
      *
      * @param array $uploadedFileData contains information about the uploaded file given by $_FILES['file1']
      * @param string $conflictMode a value of the DuplicationBehavior enumeration
-     * @return File The file object
+     * @throws Exception\InsufficientFolderReadPermissionsException
      */
     public function addUploadedFile(array $uploadedFileData, $conflictMode = DuplicationBehavior::CANCEL)
     {
@@ -154,7 +151,7 @@ class InaccessibleFolder extends Folder
      * Renames this folder.
      *
      * @param string $newName
-     * @return Folder
+     * @throws Exception\InsufficientFolderReadPermissionsException
      */
     public function rename($newName)
     {
@@ -165,7 +162,7 @@ class InaccessibleFolder extends Folder
      * Deletes this folder from its storage. This also means that this object becomes useless.
      *
      * @param bool $deleteRecursively
-     * @return bool TRUE if deletion succeeded
+     * @throws Exception\InsufficientFolderReadPermissionsException
      */
     public function delete($deleteRecursively = true)
     {
@@ -176,7 +173,7 @@ class InaccessibleFolder extends Folder
      * Creates a new blank file
      *
      * @param string $fileName
-     * @return File The new file object
+     * @throws Exception\InsufficientFolderReadPermissionsException
      */
     public function createFile($fileName)
     {
@@ -187,7 +184,7 @@ class InaccessibleFolder extends Folder
      * Creates a new folder
      *
      * @param string $folderName
-     * @return Folder The new folder object
+     * @throws Exception\InsufficientFolderReadPermissionsException
      */
     public function createFolder($folderName)
     {
@@ -200,7 +197,7 @@ class InaccessibleFolder extends Folder
      * @param Folder $targetFolder Target folder to copy to.
      * @param string $targetFolderName an optional destination fileName
      * @param string $conflictMode a value of the DuplicationBehavior enumeration
-     * @return Folder New (copied) folder object.
+     * @throws Exception\InsufficientFolderReadPermissionsException
      */
     public function copyTo(Folder $targetFolder, $targetFolderName = null, $conflictMode = DuplicationBehavior::RENAME)
     {
@@ -213,7 +210,7 @@ class InaccessibleFolder extends Folder
      * @param Folder $targetFolder Target folder to move to.
      * @param string $targetFolderName an optional destination fileName
      * @param string $conflictMode a value of the DuplicationBehavior enumeration
-     * @return Folder New (copied) folder object.
+     * @throws Exception\InsufficientFolderReadPermissionsException
      */
     public function moveTo(Folder $targetFolder, $targetFolderName = null, $conflictMode = DuplicationBehavior::RENAME)
     {
@@ -224,7 +221,7 @@ class InaccessibleFolder extends Folder
      * Checks if a file exists in this folder
      *
      * @param string $name
-     * @return bool
+     * @throws Exception\InsufficientFolderReadPermissionsException
      */
     public function hasFile($name)
     {
@@ -235,7 +232,7 @@ class InaccessibleFolder extends Folder
      * Checks if a folder exists in this folder.
      *
      * @param string $name
-     * @return bool
+     * @throws Exception\InsufficientFolderReadPermissionsException
      */
     public function hasFolder($name)
     {
index 7119620..44d69e5 100644 (file)
@@ -167,7 +167,6 @@ class ProcessedFile extends AbstractFile
      * Replace the current file contents with the given string
      *
      * @param string $contents The contents to write to the file.
-     * @return File The file object (allows chaining).
      * @throws \BadMethodCallException
      */
     public function setContents($contents)
index 72e3c3d..95839be 100644 (file)
@@ -42,7 +42,6 @@ class ImageCropScaleMaskTask extends AbstractGraphicalTask
      * are given, within the boundaries and don't conflict with each other.
      *
      * @param array $configuration
-     * @return bool
      */
     protected function isValidConfiguration(array $configuration)
     {
index 379917b..715f806 100644 (file)
@@ -44,7 +44,6 @@ class ImagePreviewTask extends AbstractGraphicalTask
      * are given, within the boundaries and don't conflict with each other.
      *
      * @param array $configuration
-     * @return bool
      */
     protected function isValidConfiguration(array $configuration)
     {
@@ -60,8 +59,6 @@ class ImagePreviewTask extends AbstractGraphicalTask
      * Note: This does not indicate if the concrete ProcessedFile attached to this task has to be (re)processed.
      * This check is done in ProcessedFile::isOutdated().
      * @todo isOutdated()/needsReprocessing()?
-     *
-     * @return bool
      */
     public function fileNeedsProcessing()
     {
index d50733f..e057944 100644 (file)
@@ -2062,8 +2062,6 @@ class ResourceStorage implements ResourceStorageInterface
      * @param Folder $folderToMove
      * @param Folder $targetParentFolder
      * @param string $newFolderName
-     *
-     * @return bool
      * @throws NotImplementedMethodException
      */
     protected function moveFolderBetweenStorages(Folder $folderToMove, Folder $targetParentFolder, $newFolderName)
@@ -2119,8 +2117,6 @@ class ResourceStorage implements ResourceStorageInterface
      * @param Folder $folderToCopy
      * @param Folder $targetParentFolder
      * @param string $newFolderName
-     *
-     * @return bool
      * @throws NotImplementedMethodException
      */
     protected function copyFolderBetweenStorages(Folder $folderToCopy, Folder $targetParentFolder, $newFolderName)
index 83a54c1..ca2464f 100644 (file)
@@ -180,7 +180,6 @@ class DatabaseTreeDataProvider extends AbstractTableConfigurationTreeDataProvide
      * Gets the nodes
      *
      * @param \TYPO3\CMS\Backend\Tree\TreeNode $node
-     * @return \TYPO3\CMS\Backend\Tree\TreeNodeCollection
      */
     public function getNodes(\TYPO3\CMS\Backend\Tree\TreeNode $node)
     {
index cd3f96c..e33be31 100644 (file)
@@ -107,7 +107,7 @@ class ControllerContext
     /**
      * Get the response of the controller
      *
-     * @return \TYPO3\CMS\Extbase\Mvc\Request
+     * @return \TYPO3\CMS\Extbase\Mvc\Response
      * @api
      */
     public function getResponse()
index bebdb03..0f54e8d 100644 (file)
@@ -172,7 +172,6 @@ class ColumnMap
      *
      * @param string $columnName The column name
      * @param string $propertyName The property name
-     * @return \TYPO3\CMS\Extbase\Persistence\Generic\Mapper\ColumnMap
      */
     public function __construct($columnName, $propertyName)
     {
index 29145b7..e969893 100644 (file)
@@ -308,9 +308,8 @@ class PersistenceManager implements \TYPO3\CMS\Extbase\Persistence\PersistenceMa
     /**
      * Converts the given object into an array containing the identity of the domain object.
      *
-     * @throws \TYPO3\CMS\Extbase\Persistence\Generic\Exception\NotImplementedException
      * @param object $object The object to be converted
-     * @return array
+     * @throws Exception\NotImplementedException
      * @api
      */
     public function convertObjectToIdentityArray($object)
@@ -324,7 +323,6 @@ class PersistenceManager implements \TYPO3\CMS\Extbase\Persistence\PersistenceMa
      *
      * @throws \TYPO3\CMS\Extbase\Persistence\Generic\Exception\NotImplementedException
      * @param array $array The array to be iterated over
-     * @return array
      * @api
      * @see convertObjectToIdentityArray()
      */
index 78fb142..3b839be 100644 (file)
@@ -263,7 +263,7 @@ class Query implements QueryInterface
      * 'bar' => \TYPO3\CMS\Extbase\Persistence\QueryInterface::ORDER_DESCENDING
      * )
      *
-     * @return array
+     * @return int
      * @api
      */
     public function getOrderings()
@@ -637,8 +637,7 @@ class Query implements QueryInterface
      * It matches if the multivalued property contains no values or is NULL.
      *
      * @param string $propertyName The name of the multivalued property to compare against
-     * @throws \TYPO3\CMS\Extbase\Persistence\Generic\Exception\NotImplementedException
-     * @return bool
+     * @throws Exception\NotImplementedException
      * @api
      */
     public function isEmpty($propertyName)
index 37375ab..fd60126 100644 (file)
@@ -118,7 +118,7 @@ class DateTimeConverter extends \TYPO3\CMS\Extbase\Property\TypeConverter\Abstra
      * @param string $targetType must be "DateTime"
      * @param array $convertedChildProperties not used currently
      * @param \TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationInterface $configuration
-     * @return \DateTime
+     * @return \DateTime|\TYPO3\CMS\Extbase\Error\Error
      * @throws \TYPO3\CMS\Extbase\Property\Exception\TypeConverterException
      */
     public function convertFrom($source, $targetType, array $convertedChildProperties = [], \TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationInterface $configuration = null)
index e20963b..e8fcd54 100644 (file)
@@ -115,7 +115,7 @@ class FieldProvider implements AdditionalFieldProviderInterface
     /**
      * Get description of selected command
      *
-     * @return string
+     * @return array
      */
     protected function getCommandControllerActionDescriptionField()
     {
index effbde7..d59c563 100644 (file)
@@ -88,7 +88,7 @@ class ExtensionStatus implements \TYPO3\CMS\Reports\StatusProviderInterface
     /**
      * Check main repository status: existence, has extensions, last update younger than 7 days
      *
-     * @return \TYPO3\CMS\Reports\Report\Status\Status
+     * @return \TYPO3\CMS\Reports\Status
      */
     protected function getMainRepositoryStatus()
     {
index 1c7e874..69aa26a 100644 (file)
@@ -584,8 +584,6 @@ class FileListController extends ActionController
 
     /**
      * Create the panel of buttons for submitting the form or otherwise perform operations.
-     *
-     * @return array All available buttons as an assoc. array
      */
     protected function registerButtons()
     {
index a51b3ad..c32d984 100644 (file)
@@ -394,6 +394,10 @@ class FormViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormViewH
 
     /**
      * Add the URI arguments after postprocessing to the request hash as well.
+     * @param array $arguments
+     * @param array $results
+     * @param string $currentPrefix
+     * @param int $level
      */
     protected function postProcessUriArgumentsForRequestHash($arguments, &$results, $currentPrefix = '', $level = 0)
     {
index 20ea290..7dc9379 100644 (file)
@@ -627,7 +627,7 @@ class ConfigurationService implements SingletonInterface
 
     /**
      * @param array $prototypeConfiguration
-     * @param array $configuration
+     * @param array $formElements
      * @return array
      */
     protected function translatePredefinedDefaults(array $prototypeConfiguration, array $formElements): array
index 2054070..36b4f8b 100644 (file)
@@ -92,6 +92,7 @@ class FormDefinitionConversionService implements SingletonInterface
     }
 
     /**
+     * @param string $sessionToken
      */
     protected function persistSessionToken(string $sessionToken)
     {
index 9049de2..d727503 100644 (file)
@@ -40,7 +40,7 @@ class ExtractorDto
     }
 
     /**
-     * @return string
+     * @return array
      */
     public function getPrototypeConfiguration(): array
     {
@@ -48,7 +48,7 @@ class ExtractorDto
     }
 
     /**
-     * @return string
+     * @return array
      */
     public function getResult(): array
     {
@@ -56,7 +56,7 @@ class ExtractorDto
     }
 
     /**
-     * @return string
+     * @param array $result
      * @return ExtractorDto
      */
     public function setResult(array $result): ExtractorDto
index 1840754..858d8f6 100644 (file)
@@ -297,7 +297,7 @@ class SaveToDatabaseFinisher extends AbstractFinisher
      * Save or insert the values from
      * $databaseData into the table $table
      *
-     * @param [] $databaseData
+     * @param array $databaseData
      * @param string $table
      * @param int $iterationCount
      */
@@ -348,7 +348,7 @@ class SaveToDatabaseFinisher extends AbstractFinisher
     /**
      * Returns the values of the submitted form
      *
-     * @return []
+     * @return array
      */
     protected function getFormValues(): array
     {
index 5ad12f4..f2f27eb 100644 (file)
@@ -229,6 +229,7 @@ class RenderAllFormValuesViewHelper extends AbstractViewHelper
     }
 
     /**
+     * @param RenderableInterface $renderable
      * @return bool
      */
     public static function hasDisabledParent(RenderableInterface $renderable): bool
index 0772bb7..fa76520 100644 (file)
@@ -163,7 +163,6 @@ class FilesContentObject extends AbstractContentObject
      * @param array $configuration TypoScript configuration
      * @param array $element The parent element referencing to files
      * @param FileCollector $fileCollector
-     * @return array
      */
     protected function addFileReferences(array $configuration, array $element, FileCollector $fileCollector)
     {
index 5b283de..7bba222 100644 (file)
@@ -36,7 +36,7 @@ class CategoryMenuUtility
      * @param string $selectedCategories Comma-separated list of system categories primary keys
      * @param array $configuration TypoScript configuration for the "special." keyword
      * @param \TYPO3\CMS\Frontend\ContentObject\Menu\AbstractMenuContentObject $parentObject Back-reference to the calling object
-     * @return string List of selected pages
+     * @return array List of selected pages
      */
     public function collectPages($selectedCategories, $configuration, $parentObject)
     {
index cf4db88..6532db1 100644 (file)
@@ -35,6 +35,7 @@ class EidHandler implements MiddlewareInterface
      * Dispatches the request to the corresponding eID class or eID script
      *
      * @param ServerRequestInterface $request
+     * @param RequestHandlerInterface $handler
      * @return ResponseInterface
      * @throws Exception
      */
index 81b55c3..390f9bc 100644 (file)
@@ -943,7 +943,6 @@ class PageGenerator
      * Generate meta tags from meta tag TypoScript
      *
      * @param array $metaTagTypoScript TypoScript configuration for meta tags (e.g. $GLOBALS['TSFE']->pSetup['meta.'])
-     * @param bool $xhtml Whether xhtml tag-style should be used. (e.g. pass $GLOBALS['TSFE']->xhtmlVersion here)
      * @param ContentObjectRenderer $cObj
      */
     protected static function generateMetaTagHtml(array $metaTagTypoScript, ContentObjectRenderer $cObj)
index 138122b..b983864 100644 (file)
@@ -306,8 +306,6 @@ class ImportExportController extends BaseScriptClass
 
     /**
      * Create the panel of buttons for submitting the form or otherwise perform operations.
-     *
-     * @return array all available buttons as an associated array
      */
     protected function getButtons()
     {
index 01a0b4b..5f62afd 100644 (file)
@@ -360,7 +360,7 @@ class IndexSearchRepository
      * mysql fulltext specific helper method
      *
      * @param array $searchWordArray Search word array
-     * @return string Search string
+     * @return array Search string
      */
     protected function getSearchString($searchWordArray)
     {
index 4a9c4b5..da0f381 100644 (file)
@@ -66,7 +66,6 @@ class PluginHook
      * Providing an alternative search algorithm!
      *
      * @param array $sWArr Array of search words
-     * @return array Array of first row, result rows, count
      */
     public function getResultRows($sWArr)
     {
index 5690e30..4e01867 100644 (file)
@@ -65,9 +65,6 @@ class UpgradeWizardCommand extends Command
      *
      * @param InputInterface $input
      * @param OutputInterface $output
-     * @throws \InvalidArgumentException
-     * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
-     * @return int
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
@@ -114,7 +111,7 @@ class UpgradeWizardCommand extends Command
     /**
      * @param \Symfony\Component\Console\Input\InputInterface $input
      * @param \Symfony\Component\Console\Output\OutputInterface $output
-     * @param $wizardToExecute
+     * @param UpgradeWizardInterface $instance
      * @return int
      */
     protected function runSingleWizard(
@@ -153,6 +150,8 @@ class UpgradeWizardCommand extends Command
     /**
      * Get list of registered upgrade wizards.
      *
+     * @param InputInterface $input
+     * @param OutputInterface $output
      * @return array List of upgrade wizards in correct order with detail information
      */
     public function runAllWizards(InputInterface $input, OutputInterface $output): array
index 152935d..cbe45b8 100644 (file)
@@ -204,6 +204,7 @@ class EnvironmentController extends AbstractController
     /**
      *  Send a test mail
      *
+     * @param ServerRequestInterface $request
      * @return ResponseInterface
      */
     public function mailTestAction(ServerRequestInterface $request): ResponseInterface
index 17cdc30..cab7932 100644 (file)
@@ -253,9 +253,9 @@ class RequestHandler implements RequestHandlerInterface
     /**
      * Use form protection API to find out if protected POST forms are ok.
      *
+     * @param ServerRequestInterface $request
      * @param SessionService $session
      * @return bool
-     * @throws \RuntimeException
      */
     protected function checkSessionToken(ServerRequestInterface $request, SessionService $session): bool
     {
index 044633e..9cd387b 100644 (file)
@@ -47,6 +47,7 @@ class DocumentationFile
     /**
      * DocumentationFile constructor.
      * @param Registry|null $registry
+     * @param string $changelogDir
      */
     public function __construct(Registry $registry = null, $changelogDir = '')
     {
index 493b056..d2a0607 100644 (file)
@@ -530,7 +530,7 @@ class LinkValidatorReport extends \TYPO3\CMS\Backend\Module\AbstractFunctionModu
     /**
      * Displays the table header of the table with the broken links
      *
-     * @return string Code of content
+     * @return array Code of content
      */
     protected function startTable()
     {
index 2dafd26..8cc708e 100644 (file)
@@ -29,6 +29,7 @@ class OpenDocumentService
 
     /**
      * Constructor
+     * @param BackendUserAuthentication|null $backendUser
      */
     public function __construct(BackendUserAuthentication $backendUser = null)
     {
index 5bc9338..076f1dc 100644 (file)
@@ -33,6 +33,7 @@ class RsaPublicKeyGenerationController
 
     /**
      * Set up dependencies
+     * @param RsaEncryptionEncoder|null $encoder
      */
     public function __construct(RsaEncryptionEncoder $encoder = null)
     {
index 0d9b06e..5e0bf0a 100644 (file)
@@ -14,6 +14,7 @@ use TYPO3\CMS\Seo\XmlSitemap\Exception\MissingConfigurationException;
 class RecordsXmlSitemapDataProvider extends AbstractXmlSitemapDataProvider
 {
     /**
+     * @param ServerRequestInterface $request
      * @param string $key
      * @param array $config
      * @param ContentObjectRenderer|null $cObj
index 3c08d4d..ea6f150 100644 (file)
@@ -60,6 +60,7 @@ class ActionTask implements \TYPO3\CMS\Taskcenter\TaskInterface
 
     /**
      * Constructor
+     * @param \TYPO3\CMS\Taskcenter\Controller\TaskModuleController $taskObject
      */
     public function __construct(\TYPO3\CMS\Taskcenter\Controller\TaskModuleController $taskObject)
     {
index c4f7062..3d800ae 100644 (file)
@@ -720,7 +720,7 @@ class DataHandlerHook
      * Setting stage of record
      *
      * @param string $table Table name
-     * @param int $integer Record UID
+     * @param int $id
      * @param int $stageId Stage ID to set
      * @param string $comment Comment that goes into log
      * @param bool $notificationEmailInfo Accumulate state changes in memory for compiled notification email?