Commit 119d6732 authored by Wouter Wolters's avatar Wouter Wolters Committed by Anja Leichsenring
Browse files

[TASK] Streamline PHPDoc comment matches function/method signature

Resolves: #86088
Releases: master
Change-Id: Ia011b8ca85b8665edd80a093844b5a60a5fe2e29
Reviewed-on: https://review.typo3.org/58129


Tested-by: default avatarTYPO3com <no-reply@typo3.com>
Reviewed-by: Christian Kuhn's avatarChristian Kuhn <lolli@schwarzbu.ch>
Tested-by: Christian Kuhn's avatarChristian Kuhn <lolli@schwarzbu.ch>
Reviewed-by: Anja Leichsenring's avatarAnja Leichsenring <aleichsenring@ab-softlab.de>
Tested-by: Anja Leichsenring's avatarAnja Leichsenring <aleichsenring@ab-softlab.de>
parent 0f583937
......@@ -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
{
......
......@@ -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
{
......
......@@ -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
{
......
......@@ -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
......
......@@ -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
......
......@@ -87,7 +87,7 @@ class EditController extends AbstractWizardController
/**
* Initialization of the script
*
* @param ServerRequestInterface
* @param ServerRequestInterface $request
*/
protected function init(ServerRequestInterface $request)
{
......
......@@ -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)
......
......@@ -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)
......
......@@ -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);
}
......@@ -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
*/
......
......@@ -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)
{
......
......@@ -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()
*/
......
......@@ -111,6 +111,7 @@ class BackendUserController extends ActionController
/**
* Assign default variables to view
* @param ViewInterface $view
*/
public function initializeView(ViewInterface $view)
{
......
......@@ -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);
}
}
}
......
......@@ -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)
......
......@@ -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
{
......
......@@ -71,7 +71,7 @@ class StatusException extends \TYPO3\CMS\Core\Error\Exception
/**
* Getter for the Status Header.
*
* @return string
* @return array
*/
public function getStatusHeaders()
{
......
......@@ -154,7 +154,7 @@ class CropVariantCollection
}
/**
* @param CropVariant[] ...$cropVariants
* @param CropVariant[] $cropVariants
* @throws \TYPO3\CMS\Core\Imaging\ImageManipulation\InvalidConfigurationException
*/
protected function setCropVariants(CropVariant ...$cropVariants)
......
......@@ -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)
{
......
......@@ -73,7 +73,6 @@ class FileWriter extends AbstractWriter
* Constructor, opens the log file handle
*
* @param array $options
* @return FileWriter
*/
public function __construct(array $options = [])
{
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment