[TASK] Code CleanUp

Apply various inspections of PhpStorm: * Remove unneeded annotations * Add void as method return type * Replace mb_substr/mb_strpos with str_starts_with * Simplify if conditions Relates: #3376
TYPO3-Solr · May 15, 2023 · 023cc0f · 023cc0f
1 parent cfce9f1
commit 023cc0f
Show file tree

Hide file tree

Showing 74 changed files with 166 additions and 815 deletions.
diff --git a/Classes/Access/Rootline.php b/Classes/Access/Rootline.php
@@ -97,7 +97,7 @@ public function __construct(string $accessRootline = null)
      *
      * @param RootlineElement $rootlineElement Element to add.
      */
-    public function push(RootlineElement $rootlineElement)
+    public function push(RootlineElement $rootlineElement): void
     {
         $lastElementIndex = max(0, (count($this->rootlineElements) - 1));
 

diff --git a/Classes/Backend/CoreSelectorField.php b/Classes/Backend/CoreSelectorField.php
@@ -64,7 +64,7 @@ public function __construct(Site $site)
      *
      * @param string $formElementName Form element name
      */
-    public function setFormElementName(string $formElementName)
+    public function setFormElementName(string $formElementName): void
     {
         $this->formElementName = $formElementName;
     }
@@ -84,7 +84,7 @@ public function getFormElementName(): string
      *
      * @param array $selectedValues
      */
-    public function setSelectedValues(array $selectedValues)
+    public function setSelectedValues(array $selectedValues): void
     {
         $this->selectedValues = $selectedValues;
     }

diff --git a/Classes/Backend/IndexingConfigurationSelectorField.php b/Classes/Backend/IndexingConfigurationSelectorField.php
@@ -66,7 +66,7 @@ public function __construct(Site $site)
      *
      * @param string $formElementName Form element name
      */
-    public function setFormElementName(string $formElementName)
+    public function setFormElementName(string $formElementName): void
     {
         $this->formElementName = $formElementName;
     }

diff --git a/Classes/Backend/SettingsPreviewOnPlugins.php b/Classes/Backend/SettingsPreviewOnPlugins.php
@@ -32,7 +32,6 @@ class SettingsPreviewOnPlugins
 {
     protected array $pluginsTtContentRecord;
     private array $flexformData;
-
     protected array $settings = [];
 
     public function __construct(
@@ -102,10 +101,6 @@ protected function addTargetPage(): void
         }
     }
 
-    /**
-     * @param string $settingName
-     * @param string $flexFormField
-     */
     protected function addSettingFromFlexForm(string $settingName, string $flexFormField): void
     {
         $value = $this->getFieldFromFlexform($flexFormField);
@@ -117,10 +112,6 @@ protected function addSettingFromFlexForm(string $settingName, string $flexFormF
         $this->addSettingIfNotEmpty($settingName, (string)$value);
     }
 
-    /**
-     * @param string $settingName
-     * @param array $values
-     */
     protected function addSettingFromFlexFormArray(string $settingName, array $values): void
     {
         foreach ($values as $item) {
@@ -136,10 +127,6 @@ protected function addSettingFromFlexFormArray(string $settingName, array $value
         }
     }
 
-    /**
-     * @param string $settingName
-     * @param string $value
-     */
     protected function addSettingIfNotEmpty(string $settingName, string $value): void
     {
         if (!empty($value)) {
@@ -161,8 +148,6 @@ protected function getFieldFromFlexform(string $path): mixed
 
     /**
      * Returns the plugin label
-     *
-     * @return string
      */
     protected function getPluginLabel(): string
     {
@@ -176,11 +161,6 @@ protected function getPluginLabel(): string
         return $label;
     }
 
-    /**
-     * Returns the language service
-     *
-     * @return LanguageService
-     */
     protected function getLanguageService(): LanguageService
     {
         return $GLOBALS['LANG'];

diff --git a/Classes/ConnectionManager.php b/Classes/ConnectionManager.php
@@ -103,8 +103,8 @@ public function getConnectionFromConfiguration(array $config)
      * Gets a Solr connection for a page ID.
      *
      * @param int $pageId A page ID.
-     * @param ?int $language The language ID to get the connection for as the path may differ. Optional, defaults to 0.
-     * @param ?string $mount Comma list of MountPoint parameters
+     * @param int $language The language ID to get the connection for as the path may differ. Optional, defaults to 0.
+     * @param string $mount Comma list of MountPoint parameters
      * @return SolrConnection A solr connection.
      * @throws DBALDriverException
      * @throws NoSolrConnectionFoundException

diff --git a/Classes/ContentObject/Classification.php b/Classes/ContentObject/Classification.php
@@ -91,7 +91,7 @@ protected function buildClassificationsFromConfiguration(array $configuredMapped
             // @todo deprecate patterns configuration
             $patterns = empty($class['patterns']) ? [] : GeneralUtility::trimExplode(',', $class['patterns']);
             $matchPatterns = empty($class['matchPatterns']) ? [] : GeneralUtility::trimExplode(',', $class['matchPatterns']);
-            $matchPatterns = $matchPatterns + $patterns;
+            $matchPatterns += $patterns;
             $unMatchPatters = empty($class['unmatchPatterns']) ? [] : GeneralUtility::trimExplode(',', $class['unmatchPatterns']);
 
             $className = $class['class'];

diff --git a/Classes/Controller/AbstractBaseController.php b/Classes/Controller/AbstractBaseController.php
@@ -184,7 +184,7 @@ protected function initializeSettings()
 
         // Make sure plugin.tx_solr.settings are available in the view as {settings}
         $this->settings = $typoScriptService->convertTypoScriptArrayToPlainArray(
-            $this->typoScriptConfiguration->getObjectByPathOrDefault('plugin.tx_solr.settings.', [])
+            $this->typoScriptConfiguration->getObjectByPathOrDefault('plugin.tx_solr.settings.')
         );
     }
 

diff --git a/Classes/Controller/Backend/Search/IndexAdministrationModuleController.php b/Classes/Controller/Backend/Search/IndexAdministrationModuleController.php
@@ -56,7 +56,7 @@ public function emptyIndexAction(): ResponseInterface
                 $writeService = $solrServer->getWriteService();
                 /* @var SolrConnection $solrServer */
                 $writeService->deleteByQuery('siteHash:' . $siteHash);
-                $writeService->commit(false, false, false);
+                $writeService->commit(false, false);
                 $affectedCores[] = $writeService->getPrimaryEndpoint()->getCore();
             }
             $message = LocalizationUtility::translate('solr.backend.index_administration.index_emptied_all', 'Solr', [$this->selectedSite->getLabel(), implode(', ', $affectedCores)]);

diff --git a/Classes/Controller/SearchController.php b/Classes/Controller/SearchController.php
@@ -128,10 +128,10 @@ public function resultsAction(): ResponseInterface
                 $currentPage = 1;
             }
 
-            $itemsPerPage = ($searchResultSet->getUsedResultsPerPage() ?: $this->typoScriptConfiguration->getSearchResultsPerPage(10));
+            $itemsPerPage = ($searchResultSet->getUsedResultsPerPage() ?: $this->typoScriptConfiguration->getSearchResultsPerPage());
             $paginator = GeneralUtility::makeInstance(ResultsPaginator::class, $searchResultSet, $currentPage, $itemsPerPage);
             $pagination = GeneralUtility::makeInstance(ResultsPagination::class, $paginator);
-            $pagination->setMaxPageNumbers((int)$this->typoScriptConfiguration->getMaxPaginatorLinks(0));
+            $pagination->setMaxPageNumbers($this->typoScriptConfiguration->getMaxPaginatorLinks());
 
             /* @var AfterSearchEvent $afterSearchEvent */
             $afterSearchEvent = $this->eventDispatcher->dispatch(

diff --git a/Classes/Domain/Index/Queue/GarbageRemover/StrategyFactory.php b/Classes/Domain/Index/Queue/GarbageRemover/StrategyFactory.php
@@ -25,7 +25,6 @@
 class StrategyFactory
 {
     /**
-     * @param string $table
      * @return PageStrategy|RecordStrategy
      */
     public static function getByTable(string $table): AbstractStrategy

diff --git a/Classes/Domain/Index/Queue/QueueItemRepository.php b/Classes/Domain/Index/Queue/QueueItemRepository.php
@@ -138,7 +138,7 @@ public function flushAllErrors(): int
     public function flushErrorsBySite(Site $site): int
     {
         $queryBuilder = $this->getQueryBuilder();
-        return (int)$this->getPreparedFlushErrorQuery($queryBuilder)
+        return $this->getPreparedFlushErrorQuery($queryBuilder)
             ->andWhere(
                 /** @scrutinizer ignore-type */
                 $queryBuilder->expr()->eq('root', $site->getRootPageId())
@@ -157,7 +157,7 @@ public function flushErrorsBySite(Site $site): int
     public function flushErrorByItem(Item $item): int
     {
         $queryBuilder = $this->getQueryBuilder();
-        return (int)$this->getPreparedFlushErrorQuery($queryBuilder)
+        return $this->getPreparedFlushErrorQuery($queryBuilder)
             ->andWhere(
                 /** @scrutinizer ignore-type */
                 $queryBuilder->expr()->eq('uid', $item->getIndexQueueUid())
@@ -222,7 +222,7 @@ public function updateExistingItemByItemTypeAndItemUidAndRootPageId(
             $queryBuilder->set('indexing_configuration', $indexingConfiguration);
         }
 
-        return (int)$queryBuilder->executeStatement();
+        return $queryBuilder->executeStatement();
     }
 
     /**
@@ -249,7 +249,7 @@ public function add(
         int $indexingPriority = 0
     ): int {
         $queryBuilder = $this->getQueryBuilder();
-        return (int)$queryBuilder
+        return $queryBuilder
             ->insert($this->table)
             ->values([
                 'root' => $rootPageId,
@@ -983,7 +983,7 @@ public function markItemAsFailed($item, string $errorMessage = ''): int
         $errorMessage = empty($errorMessage) ? '1' : $errorMessage;
 
         $queryBuilder = $this->getQueryBuilder();
-        return (int)$queryBuilder
+        return $queryBuilder
             ->update($this->table)
             ->set('errors', $errorMessage)
             ->where($queryBuilder->expr()->eq('uid', $itemUid))
@@ -1001,7 +1001,7 @@ public function markItemAsFailed($item, string $errorMessage = ''): int
     public function updateIndexTimeByItem(Item $item): int
     {
         $queryBuilder = $this->getQueryBuilder();
-        return (int)$queryBuilder
+        return $queryBuilder
             ->update($this->table)
             ->set('indexed', time())
             ->where($queryBuilder->expr()->eq('uid', $item->getIndexQueueUid()))
@@ -1020,7 +1020,7 @@ public function updateIndexTimeByItem(Item $item): int
     public function updateChangedTimeByItem(Item $item, int $changedTime = 0): int
     {
         $queryBuilder = $this->getQueryBuilder();
-        return (int)$queryBuilder
+        return $queryBuilder
             ->update($this->table)
             ->set('changed', $changedTime)
             ->where($queryBuilder->expr()->eq('uid', $item->getIndexQueueUid()))
@@ -1121,7 +1121,7 @@ public function findAllIndexQueueItemsByRootPidAndMountIdentifierAndMountedPids(
     public function updateHasIndexingPropertiesFlagByItemUid(int $itemUid, bool $hasIndexingPropertiesFlag): int
     {
         $queryBuilder = $this->getQueryBuilder();
-        return (int)$queryBuilder
+        return $queryBuilder
             ->update($this->table)
             ->where(
                 /** @scrutinizer ignore-type */

diff --git a/Classes/Domain/Search/ApacheSolrDocument/Builder.php b/Classes/Domain/Search/ApacheSolrDocument/Builder.php
@@ -59,7 +59,6 @@ public function __construct(IdBuilder $variantIdBuilder = null)
      * @param string $url
      * @param Rootline $pageAccessRootline
      * @param string $mountPointParameter
-     * @return Document|object
      * @throws AspectNotFoundException
      * @throws DBALDriverException
      */