TYPO3-Solr / ext-solr

Classes/IndexQueue/Queue.php

Doc Comments +1 added lines, -1 removed lines

@@ -856,7 +856,7 @@
      * Marks an item as failed and causes the indexer to skip the item in the
      * next run.
      *
-     * @param int|Item $item Either the item's Index Queue
+     * @param Item $item Either the item's Index Queue
      *      uid or the complete item
      * @param string $errorMessage Error message
      */

Classes/Plugin/PluginBase.php

Doc Comments +1 added lines, -1 removed lines

@@ -438,7 +438,7 @@
      * This method executes the requested commands and applies the changes to
      * the template.
      *
-     * @param $actionResult
+     * @param string $actionResult
      * @return string Rendered plugin content
      */
     abstract protected function render($actionResult);

Classes/Plugin/Results/NoResultsCommand.php

Doc Comments +1 added lines, -1 removed lines

@@ -80,7 +80,7 @@
     /**
      * Constructs label markers.
      *
-     * @return array Array of label markers.
+     * @return string Array of label markers.
      */
     protected function getLabelMarkers()
     {

Spacing +1 added lines, -1 removed lines

@@ -64,7 +64,7 @@
         $markers = $this->getLabelMarkers();
 
         if ($this->parentPlugin->typoScriptConfiguration->getSearchSpellcheckingSearchUsingSpellCheckerSuggestion()) {
-            $suggestionResults =  $this->getSuggestionResults();
+            $suggestionResults = $this->getSuggestionResults();
             $markers['suggestion_results'] = $suggestionResults;
             $markers['has_suggestion_results'] = trim($suggestionResults) !== '';
         }

Classes/Query.php

Doc Comments +1 added lines, -1 removed lines

@@ -941,7 +941,7 @@
     /**
      * Sets the fields to return by a query.
      *
-     * @param array|string $fieldList an array or comma-separated list of field names
+     * @param string $fieldList an array or comma-separated list of field names
      * @throws \UnexpectedValueException on parameters other than comma-separated lists and arrays
      */
     public function setFieldList($fieldList = array('*', 'score'))

Spacing +1 added lines, -1 removed lines

@@ -157,7 +157,7 @@
      */
     public function __construct($keywords, $solrConfiguration = null)
     {
-        $keywords = (string) $keywords;
+        $keywords = (string)$keywords;
         if ($solrConfiguration == null) {
             $this->solrConfiguration = Util::getSolrConfiguration();
         } else {

Classes/Query/FilterEncoder/DateRange.php

Doc Comments -1 removed lines

@@ -48,7 +48,6 @@
      * Parses the given date range from a GET parameter and returns a Solr
      * date range filter.
      *
-     * @param string $rangeFilter The range filter query string from the query URL
      * @param array $configuration Facet configuration
      * @return string Lucene query language filter to be used for querying Solr
      */

Classes/System/Configuration/ConfigurationManager.php

Doc Comments +1 added lines, -1 removed lines

@@ -58,7 +58,7 @@
      * path that is used in in the current context.
      *
      * @param array $configurationArray
-     * @param null $contextPageId
+     * @param integer $contextPageId
      * @param int $contextLanguageId
      * @param string $contextTypoScriptPath
      * @return TypoScriptConfiguration

Spacing +1 added lines, -1 removed lines

@@ -71,7 +71,7 @@
             }
         }
 
-        if (! is_array($configurationArray)) {
+        if (!is_array($configurationArray)) {
             $configurationArray = array();
         }
 

Classes/System/Configuration/TypoScriptConfiguration.php

Doc Comments +3 added lines, -3 removed lines

@@ -544,7 +544,7 @@ 
      *
      * @param string $configurationName
      * @param string $defaultIfEmpty
-     * @return mixed
+     * @return string
      */
     public function getIndexQueueInitializerClassByConfigurationName($configurationName, $defaultIfEmpty = 'ApacheSolrForTypo3\\Solr\\IndexQueue\\Initializer\\Record')
     {
@@ -1237,7 +1237,7 @@ 
      * plugin.tx_solr.search.query.allowEmptyQuery
      *
      * @param string $defaultIfEmpty
-     * @return string
+     * @return boolean
      */
     public function getSearchQueryAllowEmptyQuery($defaultIfEmpty = '')
     {
@@ -1299,7 +1299,7 @@ 
      *
      * plugin.tx_solr.search.query.returnFields
      *
-     * @param array $defaultIfEmpty
+     * @param string[] $defaultIfEmpty
      * @return array
      */
     public function getSearchQueryReturnFieldsAsArray($defaultIfEmpty = array())

Indentation -3 removed lines

@@ -767,7 +767,6 @@ 
      * Returns if a log message should be written when a page was indexed.
      *
      * plugin.tx_solr.logging.indexing.pageIndexed
-
      * @param bool $defaultIfEmpty
      * @return bool
      */
@@ -781,7 +780,6 @@ 
      * Returns if a log message should be written when the TYPO3 search markers are missing in the page.
      *
      * plugin.tx_solr.logging.indexing.missingTypo3SearchMarkers
-
      * @param bool $defaultIfEmpty
      * @return bool
      */
@@ -809,7 +807,6 @@ 
      * Indicates if the debug mode is enabled or not.
      *
      * plugin.tx_solr.enableDebugMode
-
      * @param bool $defaultIfEmpty
      * @return bool
      */

Spacing +34 added lines, -34 removed lines

@@ -255,8 +255,8 @@ 
      */
     public function getCssFileByFileKey($fileKey, $defaultIfEmpty = '')
     {
-        $cssFileName =  $this->getValueByPathOrDefaultValue('plugin.tx_solr.cssFiles.' . $fileKey, $defaultIfEmpty);
-        return (string) $cssFileName;
+        $cssFileName = $this->getValueByPathOrDefaultValue('plugin.tx_solr.cssFiles.' . $fileKey, $defaultIfEmpty);
+        return (string)$cssFileName;
     }
 
     /**
@@ -565,8 +565,8 @@ 
      */
     public function getJavaScriptFileByFileKey($fileKey, $defaultIfEmpty = '')
     {
-        $javaScriptFileName =  $this->getValueByPathOrDefaultValue('plugin.tx_solr.javascriptFiles.' . $fileKey, $defaultIfEmpty);
-        return (string) $javaScriptFileName;
+        $javaScriptFileName = $this->getValueByPathOrDefaultValue('plugin.tx_solr.javascriptFiles.' . $fileKey, $defaultIfEmpty);
+        return (string)$javaScriptFileName;
     }
 
     /**
@@ -579,8 +579,8 @@ 
      */
     public function getJavaScriptLoadIn($defaultIfEmpty = 'footer')
     {
-        $loadIn =  $this->getValueByPathOrDefaultValue('plugin.tx_solr.javascriptFiles.loadIn', $defaultIfEmpty);
-        return (string) $loadIn;
+        $loadIn = $this->getValueByPathOrDefaultValue('plugin.tx_solr.javascriptFiles.loadIn', $defaultIfEmpty);
+        return (string)$loadIn;
     }
 
     /**
@@ -927,7 +927,7 @@ 
     public function getSearchVariantsLimit($defaultIfEmpty = 10)
     {
         $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.variants.limit', $defaultIfEmpty);
-        return (int) $result;
+        return (int)$result;
     }
 
     /**
@@ -969,7 +969,7 @@ 
     public function getSearchFrequentSearchesMinSize($defaultIfEmpty = 14)
     {
         $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.frequentSearches.minSize', $defaultIfEmpty);
-        return (int) $result;
+        return (int)$result;
     }
 
     /**
@@ -983,7 +983,7 @@ 
     public function getSearchFrequentSearchesMaxSize($defaultIfEmpty = 32)
     {
         $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.frequentSearches.maxSize', $defaultIfEmpty);
-        return (int) $result;
+        return (int)$result;
     }
 
     /**
@@ -1025,7 +1025,7 @@ 
     public function getSearchInitializeWithQuery($defaultIfEmpty = '')
     {
         $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.initializeWithQuery', $defaultIfEmpty);
-        return (string) $result;
+        return (string)$result;
     }
 
     /**
@@ -1053,7 +1053,7 @@ 
     public function getSearchLastSearchesMode($defaultIfEmpty = 'user')
     {
         $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.lastSearches.mode', $defaultIfEmpty);
-        return (string) $result;
+        return (string)$result;
     }
 
     /**
@@ -1067,7 +1067,7 @@ 
     public function getSearchLastSearchesLimit($defaultIfEmpty = 10)
     {
         $result = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.lastSearches.limit', $defaultIfEmpty);
-        return (int) $result;
+        return (int)$result;
     }
 
     /**
@@ -1321,7 +1321,7 @@ 
      */
     public function getSearchTargetPage()
     {
-        $targetPage = (int) $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.targetPage', 0);
+        $targetPage = (int)$this->getValueByPathOrDefaultValue('plugin.tx_solr.search.targetPage', 0);
         if ($targetPage === 0) {
             // when no specific page was configured we use the contextPageId (which is usual $GLOBALS['TSFE']->id)
             $targetPage = $this->contextPageId;
@@ -1414,7 +1414,7 @@ 
      */
     public function getSearchResultsPerPage($defaultIfEmpty = 10)
     {
-        return (int) $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.results.resultsPerPage', $defaultIfEmpty);
+        return (int)$this->getValueByPathOrDefaultValue('plugin.tx_solr.search.results.resultsPerPage', $defaultIfEmpty);
     }
 
     /**
@@ -1459,7 +1459,7 @@ 
      */
     public function getSearchSpellchecking($defaultIfEmpty = false)
     {
-        $isFacetingEnabled =  $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.spellchecking', $defaultIfEmpty);
+        $isFacetingEnabled = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.spellchecking', $defaultIfEmpty);
         return $this->getBool($isFacetingEnabled);
     }
 
@@ -1473,7 +1473,7 @@ 
      */
     public function getSearchSpellcheckingWrap($defaultIfEmpty = '')
     {
-        return (string) $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.spellchecking.wrap', $defaultIfEmpty);
+        return (string)$this->getValueByPathOrDefaultValue('plugin.tx_solr.search.spellchecking.wrap', $defaultIfEmpty);
     }
 
     /**
@@ -1486,7 +1486,7 @@ 
      */
     public function getSearchSpellcheckingNumberOfSuggestionsToTry($defaultIfEmpty = 0)
     {
-        return (int) $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.spellchecking.numberOfSuggestionsToTry', $defaultIfEmpty);
+        return (int)$this->getValueByPathOrDefaultValue('plugin.tx_solr.search.spellchecking.numberOfSuggestionsToTry', $defaultIfEmpty);
     }
 
     /**
@@ -1513,7 +1513,7 @@ 
      */
     public function getSearchFaceting($defaultIfEmpty = false)
     {
-        $isFacetingEnabled =  $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.faceting', $defaultIfEmpty);
+        $isFacetingEnabled = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.faceting', $defaultIfEmpty);
         return $this->getBool($isFacetingEnabled);
     }
 
@@ -1559,7 +1559,7 @@ 
      */
     public function getSearchFacetingRemoveFacetLinkText($defaultIfEmpty = '@facetLabel: @facetText')
     {
-        return (string) $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.faceting.removeFacetLinkText', $defaultIfEmpty);
+        return (string)$this->getValueByPathOrDefaultValue('plugin.tx_solr.search.faceting.removeFacetLinkText', $defaultIfEmpty);
     }
 
     /**
@@ -1603,7 +1603,7 @@ 
      */
     public function getSearchFacetingShowAllLinkWrap($defaultIfEmpty = '')
     {
-        return (string) $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.faceting.showAllLink.wrap', $defaultIfEmpty);
+        return (string)$this->getValueByPathOrDefaultValue('plugin.tx_solr.search.faceting.showAllLink.wrap', $defaultIfEmpty);
     }
 
     /**
@@ -1631,7 +1631,7 @@ 
      */
     public function getSearchFacetingFacetLinkUrlParametersUseForFacetResetLinkUrl($defaultIfEmpty = true)
     {
-        $useForFacetResetLinkUrl =  $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.faceting.facetLinkUrlParameters.useForFacetResetLinkUrl', $defaultIfEmpty);
+        $useForFacetResetLinkUrl = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.faceting.facetLinkUrlParameters.useForFacetResetLinkUrl', $defaultIfEmpty);
         return $this->getBool($useForFacetResetLinkUrl);
     }
 
@@ -1663,7 +1663,7 @@ 
      */
     public function getSearchFacetingMinimumCount($defaultIfEmpty = 1)
     {
-        return (int) $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.faceting.minimumCount', $defaultIfEmpty);
+        return (int)$this->getValueByPathOrDefaultValue('plugin.tx_solr.search.faceting.minimumCount', $defaultIfEmpty);
     }
 
     /**
@@ -1676,7 +1676,7 @@ 
      */
     public function getSearchFacetingLimit($defaultIfEmpty = 10)
     {
-        return (int) $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.faceting.limit', $defaultIfEmpty);
+        return (int)$this->getValueByPathOrDefaultValue('plugin.tx_solr.search.faceting.limit', $defaultIfEmpty);
     }
 
     /**
@@ -1689,7 +1689,7 @@ 
      */
     public function getSearchFacetingSingleFacetMode($defaultIfEmpty = false)
     {
-        $singleFacetMode =  $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.faceting.singleFacetMode', $defaultIfEmpty);
+        $singleFacetMode = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.faceting.singleFacetMode', $defaultIfEmpty);
         return $this->getBool($singleFacetMode);
     }
 
@@ -1719,7 +1719,7 @@ 
      */
     public function getSearchFacetingKeepAllFacetsOnSelection($defaultIfEmpty = false)
     {
-        $keepAllOptionsOnSelection =  $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.faceting.keepAllFacetsOnSelection', $defaultIfEmpty);
+        $keepAllOptionsOnSelection = $this->getValueByPathOrDefaultValue('plugin.tx_solr.search.faceting.keepAllFacetsOnSelection', $defaultIfEmpty);
         return $this->getBool($keepAllOptionsOnSelection);
     }
 
@@ -1761,7 +1761,7 @@ 
      */
     public function getStatistics($defaultIfEmpty = false)
     {
-        $isFacetingEnabled =  $this->getValueByPathOrDefaultValue('plugin.tx_solr.statistics', $defaultIfEmpty);
+        $isFacetingEnabled = $this->getValueByPathOrDefaultValue('plugin.tx_solr.statistics', $defaultIfEmpty);
         return $this->getBool($isFacetingEnabled);
     }
 
@@ -1777,8 +1777,8 @@ 
      */
     public function getStatisticsAnonymizeIP($defaultIfEmpty = 0)
     {
-        $anomizeToLength =  $this->getValueByPathOrDefaultValue('plugin.tx_solr.statistics.anonymizeIP', $defaultIfEmpty);
-        return (int) $anomizeToLength;
+        $anomizeToLength = $this->getValueByPathOrDefaultValue('plugin.tx_solr.statistics.anonymizeIP', $defaultIfEmpty);
+        return (int)$anomizeToLength;
     }
 
     /**
@@ -1791,7 +1791,7 @@ 
      */
     public function getSuggest($defaultIfEmpty = false)
     {
-        $isSuggestionEnabled =  $this->getValueByPathOrDefaultValue('plugin.tx_solr.suggest', $defaultIfEmpty);
+        $isSuggestionEnabled = $this->getValueByPathOrDefaultValue('plugin.tx_solr.suggest', $defaultIfEmpty);
         return $this->getBool($isSuggestionEnabled);
     }
 
@@ -1805,7 +1805,7 @@ 
      */
     public function getSuggestForceHttps($defaultIfEmpty = false)
     {
-        $isHttpsForced =  $this->getValueByPathOrDefaultValue('plugin.tx_solr.suggest.forceHttps', $defaultIfEmpty);
+        $isHttpsForced = $this->getValueByPathOrDefaultValue('plugin.tx_solr.suggest.forceHttps', $defaultIfEmpty);
         return $this->getBool($isHttpsForced);
     }
 
@@ -1821,8 +1821,8 @@ 
      */
     public function getTemplateByFileKey($fileKey, $defaultIfEmpty = '')
     {
-        $templateFileName =  $this->getValueByPathOrDefaultValue('plugin.tx_solr.templateFiles.' . $fileKey, $defaultIfEmpty);
-        return (string) $templateFileName;
+        $templateFileName = $this->getValueByPathOrDefaultValue('plugin.tx_solr.templateFiles.' . $fileKey, $defaultIfEmpty);
+        return (string)$templateFileName;
     }
 
     /**
@@ -1835,7 +1835,7 @@ 
      */
     public function getViewHelpersCropConfiguration(array $defaultIfEmpty = array())
     {
-        $cropViewHelperConfiguration =  $this->getObjectByPathOrDefault('plugin.tx_solr.viewHelpers.crop.', $defaultIfEmpty);
+        $cropViewHelperConfiguration = $this->getObjectByPathOrDefault('plugin.tx_solr.viewHelpers.crop.', $defaultIfEmpty);
         return $cropViewHelperConfiguration;
     }
 
@@ -1849,7 +1849,7 @@ 
      */
     public function getViewHelpersSortIndicatorConfiguration(array $defaultIfEmpty = array())
     {
-        $sortingViewHelperConfiguration =  $this->getObjectByPathOrDefault('plugin.tx_solr.viewHelpers.sortIndicator.', $defaultIfEmpty);
+        $sortingViewHelperConfiguration = $this->getObjectByPathOrDefault('plugin.tx_solr.viewHelpers.sortIndicator.', $defaultIfEmpty);
         return $sortingViewHelperConfiguration;
     }
 }

Classes/Task/IndexQueueWorkerTask.php

Doc Comments +1 added lines, -1 removed lines

@@ -186,7 +186,7 @@
     }
 
     /**
-     * @return mixed
+     * @return integer
      */
     public function getDocumentsToIndexLimit()
     {

Spacing +1 added lines, -1 removed lines

@@ -145,7 +145,7 @@
             $message .= ' Failures: ' . $failedItemsCount;
         }
 
-        $message .=  ' / Using webroot: ' . htmlspecialchars($this->getWebRoot());
+        $message .= ' / Using webroot: ' . htmlspecialchars($this->getWebRoot());
 
         return $message;
     }

Classes/Template.php

Doc Comments +2 added lines, -1 removed lines

@@ -130,6 +130,7 @@ 
     /**
      * Finds the view helpers in the template and loads them.
      *
+     * @param string $content
      * @return void
      */
     protected function initializeViewHelpers($content)
@@ -1158,7 +1159,7 @@ 
     }
 
     /**
-     * @param $templateContent
+     * @param string $templateContent
      * @return mixed
      */
     public function setTemplateContent($templateContent)

Spacing +1 added lines, -1 removed lines

@@ -218,7 +218,7 @@
             $ucHelperKey = Util::underscoredToUpperCamelCase($helperKey);
             $vendorNameSpace = 'ApacheSolrForTypo3\\Solr\\';
             $possibleFilename = $ucHelperKey . '.php';
-            $possibleClassName =  $vendorNameSpace . str_replace('/', '\\',
+            $possibleClassName = $vendorNameSpace . str_replace('/', '\\',
                     $viewHelperRealPath) . '\\' . $ucHelperKey;
 
             $viewHelperIncludePath = ExtensionManagementUtility::extPath($extensionKey)