Commit 38f46fdb authored by Wouter Wolters's avatar Wouter Wolters Committed by Christian Kuhn
Browse files

[TASK] Streamline phpDoc order of @param and @var

Resolves: #86084
Releases: master
Change-Id: I6ebbe0756d799a3c04386c854f6e5e385eeac54f
Reviewed-on: https://review.typo3.org/58124


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>
parent db81f3aa
......@@ -139,7 +139,7 @@ class BackendUserConfiguration
/**
* Computes the subarray from dotted notation
*
* @param $key string Dotted notation of subkeys like moduleData.module1.general.checked
* @param string $key Dotted notation of subkeys like moduleData.module1.general.checked
* @return mixed value of the settings
*/
protected function getFromDottedNotation(string $key)
......
......@@ -110,7 +110,7 @@ class TsConfigParser extends \TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser
*/
protected function parseWithConditions($TSconfig)
{
/** @var $matchObj \TYPO3\CMS\Backend\Configuration\TypoScript\ConditionMatching\ConditionMatcher */
/** @var \TYPO3\CMS\Backend\Configuration\TypoScript\ConditionMatching\ConditionMatcher $matchObj */
$matchObj = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(\TYPO3\CMS\Backend\Configuration\TypoScript\ConditionMatching\ConditionMatcher::class);
$matchObj->setRootline($this->rootLine);
$matchObj->setPageId($this->id);
......@@ -131,7 +131,7 @@ class TsConfigParser extends \TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser
protected function matching(array $cc)
{
if (is_array($cc['sections'])) {
/** @var $matchObj \TYPO3\CMS\Backend\Configuration\TypoScript\ConditionMatching\ConditionMatcher */
/** @var \TYPO3\CMS\Backend\Configuration\TypoScript\ConditionMatching\ConditionMatcher $matchObj */
$matchObj = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(\TYPO3\CMS\Backend\Configuration\TypoScript\ConditionMatching\ConditionMatcher::class);
$matchObj->setRootline($this->rootLine);
$matchObj->setPageId($this->id);
......
......@@ -44,7 +44,7 @@ class ContextMenu
$items = [];
$itemsProviders = $this->getAvailableProviders($table, $identifier, $context);
/** @var $provider \TYPO3\CMS\Backend\ContextMenu\ItemProviders\ProviderInterface */
/** @var \TYPO3\CMS\Backend\ContextMenu\ItemProviders\ProviderInterface $provider */
foreach ($itemsProviders as $provider) {
$items = $provider->addItems($items);
}
......
......@@ -98,7 +98,7 @@ abstract class AbstractFormEngineAjaxController
*/
protected function getLabelsFromLocalizationFile($file)
{
/** @var $languageFactory LocalizationFactory */
/** @var LocalizationFactory $languageFactory */
$languageFactory = GeneralUtility::makeInstance(LocalizationFactory::class);
$language = $GLOBALS['LANG']->lang;
$localizationArray = $languageFactory->getParsedData($file, $language);
......
......@@ -585,7 +585,7 @@ class ElementInformationController
$selectTable = $table;
$selectUid = $ref;
}
/** @var $queryBuilder \TYPO3\CMS\Core\Database\Query\QueryBuilder */
/** @var \TYPO3\CMS\Core\Database\Query\QueryBuilder $queryBuilder */
$queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
->getQueryBuilderForTable('sys_refindex');
$rows = $queryBuilder
......@@ -667,7 +667,7 @@ class ElementInformationController
$refFromLines = [];
$lang = $this->getLanguageService();
/** @var $queryBuilder \TYPO3\CMS\Core\Database\Query\QueryBuilder */
/** @var \TYPO3\CMS\Core\Database\Query\QueryBuilder $queryBuilder */
$queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
->getQueryBuilderForTable('sys_refindex');
$rows = $queryBuilder
......@@ -729,7 +729,7 @@ class ElementInformationController
*/
protected function transformFileReferenceToRecordReference(array $referenceRecord)
{
/** @var $queryBuilder \TYPO3\CMS\Core\Database\Query\QueryBuilder */
/** @var \TYPO3\CMS\Core\Database\Query\QueryBuilder $queryBuilder */
$queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
->getQueryBuilderForTable('sys_file_reference');
$queryBuilder->getRestrictions()->removeAll();
......
......@@ -637,7 +637,7 @@ class EditDocumentController
/**
* Do processing of data, submitting it to DataHandler. May return a RedirectResponse
*
* @param $request ServerRequestInterface
* @param ServerRequestInterface $request
* @return ResponseInterface|null
*/
public function processData(ServerRequestInterface $request = null): ?ResponseInterface
......@@ -828,7 +828,7 @@ class EditDocumentController
$relatedPageId = -$nRec['t3ver_oid'];
}
/** @var $duplicateTce \TYPO3\CMS\Core\DataHandling\DataHandler */
/** @var \TYPO3\CMS\Core\DataHandling\DataHandler $duplicateTce */
$duplicateTce = GeneralUtility::makeInstance(DataHandler::class);
$duplicateCmd = [
......@@ -897,7 +897,7 @@ class EditDocumentController
/**
* Initialize the view part of the controller logic.
*
* @param $request ServerRequestInterface
* @param ServerRequestInterface $request
*/
public function init(ServerRequestInterface $request = null): void
{
......@@ -1156,7 +1156,7 @@ class EditDocumentController
/**
* Main module operation
*
* @param $request ServerRequestInterface
* @param ServerRequestInterface $request
*/
public function main(ServerRequestInterface $request = null): void
{
......@@ -1391,7 +1391,7 @@ class EditDocumentController
/**
* Create the panel of buttons for submitting the form or otherwise perform operations.
*
* @param $request ServerRequestInterface
* @param ServerRequestInterface $request
*/
protected function getButtons(ServerRequestInterface $request): void
{
......@@ -2624,7 +2624,7 @@ class EditDocumentController
* - other values will call setDocument with ->retUrl
*
* @param int $mode the close mode: one of self::DOCUMENT_CLOSE_MODE_*
* @param $request ServerRequestInterface Incoming request
* @param ServerRequestInterface $request Incoming request
* @return ResponseInterface|null Redirect response if needed
*/
public function closeDocument($mode = self::DOCUMENT_CLOSE_MODE_DEFAULT, ServerRequestInterface $request = null): ?ResponseInterface
......
......@@ -330,7 +330,7 @@ class FormInlineAjaxController extends AbstractFormEngineAjaxController
];
}
/** @var $tce DataHandler */
/** @var DataHandler $tce */
$tce = GeneralUtility::makeInstance(DataHandler::class);
$tce->start([], $cmd);
$tce->process_cmdmap();
......
......@@ -192,7 +192,7 @@ class LoginController implements LoggerAwareInterface
*/
protected function createLoginLogoutForm(ServerRequestInterface $request): string
{
/** @var $pageRenderer PageRenderer */
/** @var PageRenderer $pageRenderer */
$pageRenderer = GeneralUtility::makeInstance(PageRenderer::class);
$pageRenderer->loadRequireJsModule('TYPO3/CMS/Backend/Login');
......
......@@ -558,7 +558,7 @@ class NewRecordController
if ($numberOfPages > 0) {
$this->code .= '<h3>' . htmlspecialchars($this->getLanguageService()->getLL('selectPosition')) . ':</h3>';
/** @var $positionMap \TYPO3\CMS\Backend\Tree\View\PagePositionMap */
/** @var \TYPO3\CMS\Backend\Tree\View\PagePositionMap $positionMap */
$positionMap = GeneralUtility::makeInstance(PagePositionMap::class, NewRecordPageTreeView::class);
$this->code .= $positionMap->positionTree(
$this->id,
......
......@@ -136,10 +136,10 @@ class OnlineMediaController
*/
protected function addFlashMessage(FlashMessage $flashMessage)
{
/** @var $flashMessageService FlashMessageService */
/** @var FlashMessageService $flashMessageService */
$flashMessageService = GeneralUtility::makeInstance(FlashMessageService::class);
/** @var $defaultFlashMessageQueue \TYPO3\CMS\Core\Messaging\FlashMessageQueue */
/** @var \TYPO3\CMS\Core\Messaging\FlashMessageQueue $defaultFlashMessageQueue */
$defaultFlashMessageQueue = $flashMessageService->getMessageQueueByIdentifier();
$defaultFlashMessageQueue->enqueue($flashMessage);
}
......
......@@ -47,7 +47,7 @@ class NewMultiplePagesController
/**
* Constructor Method
*
* @var $moduleTemplate ModuleTemplate
* @var ModuleTemplate $moduleTemplate
*/
public function __construct(ModuleTemplate $moduleTemplate = null)
{
......@@ -57,7 +57,7 @@ class NewMultiplePagesController
/**
* Main function Handling input variables and rendering main view
*
* @param $request ServerRequestInterface
* @param ServerRequestInterface $request
* @return ResponseInterface Response
*/
public function mainAction(ServerRequestInterface $request): ResponseInterface
......
......@@ -46,7 +46,7 @@ class SortSubPagesController
/**
* Constructor Method
*
* @var $moduleTemplate ModuleTemplate
* @var ModuleTemplate $moduleTemplate
*/
public function __construct(ModuleTemplate $moduleTemplate = null)
{
......@@ -56,7 +56,7 @@ class SortSubPagesController
/**
* Main function Handling input variables and rendering main view
*
* @param $request ServerRequestInterface
* @param ServerRequestInterface $request
* @return ResponseInterface Response
*/
public function mainAction(ServerRequestInterface $request): ResponseInterface
......
......@@ -149,7 +149,7 @@ class BackendModuleRepository implements \TYPO3\CMS\Core\SingletonInterface
*/
protected function createEntryFromRawData(array $module)
{
/** @var $entry \TYPO3\CMS\Backend\Domain\Model\Module\BackendModule */
/** @var \TYPO3\CMS\Backend\Domain\Model\Module\BackendModule $entry */
$entry = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(\TYPO3\CMS\Backend\Domain\Model\Module\BackendModule::class);
if (!empty($module['name']) && is_string($module['name'])) {
$entry->setName($module['name']);
......
......@@ -95,7 +95,7 @@ abstract class AbstractItemProvider
FlashMessage::ERROR,
true
);
/** @var $flashMessageService \TYPO3\CMS\Core\Messaging\FlashMessageService */
/** @var \TYPO3\CMS\Core\Messaging\FlashMessageService $flashMessageService */
$flashMessageService = GeneralUtility::makeInstance(FlashMessageService::class);
$defaultFlashMessageQueue = $flashMessageService->getMessageQueueByIdentifier();
$defaultFlashMessageQueue->enqueue($flashMessage);
......@@ -465,11 +465,11 @@ abstract class AbstractItemProvider
$msg = $databaseError . '. ';
$msg .= $languageService->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:error.database_schema_mismatch');
$msgTitle = $languageService->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:error.database_schema_mismatch_title');
/** @var $flashMessage FlashMessage */
/** @var FlashMessage $flashMessage */
$flashMessage = GeneralUtility::makeInstance(FlashMessage::class, $msg, $msgTitle, FlashMessage::ERROR, true);
/** @var $flashMessageService FlashMessageService */
/** @var FlashMessageService $flashMessageService */
$flashMessageService = GeneralUtility::makeInstance(FlashMessageService::class);
/** @var $defaultFlashMessageQueue FlashMessageQueue */
/** @var FlashMessageQueue $defaultFlashMessageQueue */
$defaultFlashMessageQueue = $flashMessageService->getMessageQueueByIdentifier();
$defaultFlashMessageQueue->enqueue($flashMessage);
return $items;
......
......@@ -82,7 +82,7 @@ class DatabaseSystemLanguageRows implements FormDataProviderInterface
'',
FlashMessage::ERROR
);
/** @var $flashMessageService FlashMessageService */
/** @var FlashMessageService $flashMessageService */
$flashMessageService = GeneralUtility::makeInstance(FlashMessageService::class);
$defaultFlashMessageQueue = $flashMessageService->getMessageQueueByIdentifier();
$defaultFlashMessageQueue->enqueue($flashMessage);
......
......@@ -332,9 +332,9 @@ class BaseScriptClass
$this->getLanguageService()->getLL('title'),
FlashMessage::ERROR
);
/** @var $flashMessageService \TYPO3\CMS\Core\Messaging\FlashMessageService */
/** @var \TYPO3\CMS\Core\Messaging\FlashMessageService $flashMessageService */
$flashMessageService = GeneralUtility::makeInstance(FlashMessageService::class);
/** @var $defaultFlashMessageQueue \TYPO3\CMS\Core\Messaging\FlashMessageQueue */
/** @var \TYPO3\CMS\Core\Messaging\FlashMessageQueue $defaultFlashMessageQueue */
$defaultFlashMessageQueue = $flashMessageService->getMessageQueueByIdentifier();
$defaultFlashMessageQueue->enqueue($flashMessage);
} else {
......
......@@ -834,9 +834,9 @@ function jumpToUrl(URL) {
*/
public function getFlashMessages()
{
/** @var $flashMessageService \TYPO3\CMS\Core\Messaging\FlashMessageService */
/** @var \TYPO3\CMS\Core\Messaging\FlashMessageService $flashMessageService */
$flashMessageService = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Messaging\FlashMessageService::class);
/** @var $defaultFlashMessageQueue \TYPO3\CMS\Core\Messaging\FlashMessageQueue */
/** @var \TYPO3\CMS\Core\Messaging\FlashMessageQueue $defaultFlashMessageQueue */
$defaultFlashMessageQueue = $flashMessageService->getMessageQueueByIdentifier();
return $defaultFlashMessageQueue->renderFlashMessages();
}
......
......@@ -301,7 +301,7 @@ class FolderTreeView extends AbstractTreeView
$this->reset();
// Go through all "root level folders" of this tree (can be the rootlevel folder or any file mount points)
foreach ($rootLevelFolders as $rootLevelFolderInfo) {
/** @var $rootLevelFolder Folder */
/** @var Folder $rootLevelFolder */
$rootLevelFolder = $rootLevelFolderInfo['folder'];
$rootLevelFolderName = $rootLevelFolderInfo['name'];
$folderHashSpecUID = GeneralUtility::md5int($rootLevelFolder->getCombinedIdentifier());
......@@ -459,9 +459,9 @@ class FolderTreeView extends AbstractTreeView
$this->getLanguageService()->sL('LLL:EXT:backend/Resources/Private/Language/locallang.xlf:foldertreeview.noFolders.title'),
FlashMessage::INFO
);
/** @var $flashMessageService \TYPO3\CMS\Core\Messaging\FlashMessageService */
/** @var \TYPO3\CMS\Core\Messaging\FlashMessageService $flashMessageService */
$flashMessageService = GeneralUtility::makeInstance(FlashMessageService::class);
/** @var $defaultFlashMessageQueue \TYPO3\CMS\Core\Messaging\FlashMessageQueue */
/** @var \TYPO3\CMS\Core\Messaging\FlashMessageQueue $defaultFlashMessageQueue */
$defaultFlashMessageQueue = $flashMessageService->getMessageQueueByIdentifier();
$defaultFlashMessageQueue->enqueue($message);
return $defaultFlashMessageQueue->renderFlashMessages();
......@@ -483,7 +483,7 @@ class FolderTreeView extends AbstractTreeView
// so we know how many we have to close when all children are done rendering
$closeDepth = [];
foreach ($treeItems as $treeItem) {
/** @var $folderObject Folder */
/** @var Folder $folderObject */
$folderObject = $treeItem['row']['folder'];
$classAttr = $treeItem['row']['_CSSCLASS'] ?? '';
$folderIdentifier = $folderObject->getCombinedIdentifier();
......
......@@ -871,7 +871,7 @@ class BackendUtility
}
// Parsing the page TS-Config
$pageTs = implode(LF . '[GLOBAL]' . LF, $TSdataArray);
/* @var $parseObj \TYPO3\CMS\Backend\Configuration\TsConfigParser */
/* @var \TYPO3\CMS\Backend\Configuration\TsConfigParser $parseObj */
$parseObj = GeneralUtility::makeInstance(\TYPO3\CMS\Backend\Configuration\TsConfigParser::class);
$res = $parseObj->parseTSconfig($pageTs, 'PAGES', $id, $rootLine);
if ($res) {
......@@ -1256,7 +1256,7 @@ class BackendUtility
}
$fileReferences = [];
/** @var $relationHandler RelationHandler */
/** @var RelationHandler $relationHandler */
$relationHandler = GeneralUtility::makeInstance(RelationHandler::class);
if ($workspaceId !== null) {
$relationHandler->setWorkspaceId($workspaceId);
......@@ -1957,7 +1957,7 @@ class BackendUtility
}
}
}
/** @var $dbGroup RelationHandler */
/** @var RelationHandler $dbGroup */
$dbGroup = GeneralUtility::makeInstance(RelationHandler::class);
$dbGroup->start(
$value,
......@@ -2114,7 +2114,7 @@ class BackendUtility
}
}
}
/** @var $dbGroup RelationHandler */
/** @var RelationHandler $dbGroup */
$dbGroup = GeneralUtility::makeInstance(RelationHandler::class);
$dbGroup->start(
$value,
......
......@@ -53,7 +53,7 @@ class BackendLayoutView implements \TYPO3\CMS\Core\SingletonInterface
*/
protected function initializeDataProviderCollection()
{
/** @var $dataProviderCollection BackendLayout\DataProviderCollection */
/** @var BackendLayout\DataProviderCollection $dataProviderCollection */
$dataProviderCollection = GeneralUtility::makeInstance(
BackendLayout\DataProviderCollection::class
);
......@@ -353,7 +353,7 @@ class BackendLayoutView implements \TYPO3\CMS\Core\SingletonInterface
}
if (!empty($backendLayout)) {
/** @var $parser TypoScriptParser */
/** @var TypoScriptParser $parser */
$parser = GeneralUtility::makeInstance(TypoScriptParser::class);
/** @var \TYPO3\CMS\Backend\Configuration\TypoScript\ConditionMatching\ConditionMatcher $conditionMatcher */
$conditionMatcher = GeneralUtility::makeInstance(\TYPO3\CMS\Backend\Configuration\TypoScript\ConditionMatching\ConditionMatcher::class);
......
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