TYPO3-Solr / ext-solr

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/Plugin/Results/Results.php

Unused Use Statements -6 removed lines

@@ -26,17 +26,11 @@
 
 use ApacheSolrForTypo3\Solr\CommandResolver;
 use ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\SearchResultSet;
-use ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\SearchResultSetService;
 use ApacheSolrForTypo3\Solr\Domain\Search\SearchRequest;
 use ApacheSolrForTypo3\Solr\Plugin\CommandPluginBase;
-use ApacheSolrForTypo3\Solr\Plugin\PluginAware;
 use ApacheSolrForTypo3\Solr\Plugin\PluginCommand;
-use ApacheSolrForTypo3\Solr\Query;
-use ApacheSolrForTypo3\Solr\Response\Processor\ResponseProcessor;
-use ApacheSolrForTypo3\Solr\Search\QueryAware;
 use ApacheSolrForTypo3\Solr\System\Configuration\TypoScriptConfiguration;
 use ApacheSolrForTypo3\Solr\Template;
-use ApacheSolrForTypo3\Solr\Util;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**

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'))

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/Search.php

Doc Comments +9 added lines

@@ -445,6 +445,9 @@ 
         return $facetCounts;
     }
 
+    /**
+     * @param string $facetField
+     */
     public function getFacetFieldOptions($facetField)
     {
         $facetOptions = null;
@@ -457,6 +460,9 @@ 
         return $facetOptions;
     }
 
+    /**
+     * @param string $facetField
+     */
     public function getFacetQueryOptions($facetField)
     {
         $options = array();
@@ -479,6 +485,9 @@ 
         return $options;
     }
 
+    /**
+     * @param string $rangeFacetField
+     */
     public function getFacetRangeOptions($rangeFacetField)
     {
         return get_object_vars($this->getFacetCounts()->facet_ranges->$rangeFacetField);

Classes/Site.php

Doc Comments +1 added lines, -1 removed lines

@@ -276,7 +276,7 @@
      * Generates a list of page IDs in this site. Attention, this includes
      * all page types! Deleted pages are not included.
      *
-     * @param integer|string $rootPageId Page ID from where to start collection sub pages
+     * @param integer $rootPageId Page ID from where to start collection sub pages
      * @param integer $maxDepth Maximum depth to decend into the site tree
      * @return array Array of pages (IDs) in this site
      */

Classes/SolrService.php

Doc Comments +8 added lines, -8 removed lines

@@ -134,7 +134,7 @@ 
     /**
      * Returns the current time in milliseconds.
      *
-     * @return integer
+     * @return double
      */
     protected function getMilliseconds()
     {
@@ -180,7 +180,7 @@ 
      *
      * Also does not report the time, see https://forge.typo3.org/issues/64551
      *
-     * @param float|integer $timeout maximum time to wait for ping in seconds, -1 for unlimited (default is 2)
+     * @param integer $timeout maximum time to wait for ping in seconds, -1 for unlimited (default is 2)
      * @return bool TRUE if Solr can be reached, FALSE if not
      */
     public function ping($timeout = 2)
@@ -192,8 +192,8 @@ 
     /**
      * Call the /admin/ping servlet, can be used to get the runtime of a ping request.
      *
-     * @param float|integer $timeout maximum time to wait for ping in seconds, -1 for unlimited (default is 2)
-     * @return int runtime in milliseconds
+     * @param integer $timeout maximum time to wait for ping in seconds, -1 for unlimited (default is 2)
+     * @return double runtime in milliseconds
      * @throws \ApacheSolrForTypo3\Solr\PingFailedException
      */
     public function getPingRoundTripRuntime($timeout = 2)
@@ -587,7 +587,7 @@ 
      * a complete and well formed "delete" xml document
      *
      * @param string $rawPost Expected to be utf-8 encoded xml document
-     * @param float|integer $timeout Maximum expected duration of the delete operation on the server (otherwise, will throw a communication exception)
+     * @param integer $timeout Maximum expected duration of the delete operation on the server (otherwise, will throw a communication exception)
      * @return \Apache_Solr_Response
      */
     public function delete($rawPost, $timeout = 3600)
@@ -684,7 +684,7 @@ 
     /**
      * Add list of synonyms for base word to managed synonyms map
      *
-     * @param $baseWord
+     * @param string $baseWord
      * @param array $synonyms
      *
      * @return \Apache_Solr_Response
@@ -705,7 +705,7 @@ 
     /**
      * Remove a synonym from the synonyms map
      *
-     * @param $baseWord
+     * @param string $baseWord
      * @return \Apache_Solr_Response
      * @throws \Apache_Solr_InvalidArgumentException
      */
@@ -721,7 +721,7 @@ 
     /**
      * Central method for making a HTTP DELETE operation against the Solr server
      *
-     * @param $url
+     * @param string $url
      * @param bool|float $timeout Read timeout in seconds
      * @return \Apache_Solr_Response
      */

Spacing +1 added lines, -1 removed lines

@@ -544,7 +544,7 @@
 
             $solrconfigXml = simplexml_load_file($solrconfigXmlUrl);
             if ($solrconfigXml === false) {
-                throw new \InvalidArgumentException('No valid xml response from schema file: '.$solrconfigXmlUrl);
+                throw new \InvalidArgumentException('No valid xml response from schema file: ' . $solrconfigXmlUrl);
             }
             $this->solrconfigName = (string)$solrconfigXml->attributes()->name;
         }

Classes/System/Cache/TwoLevelCache.php

Doc Comments +1 added lines, -1 removed lines

@@ -113,7 +113,7 @@
      * Write a value to the first and second level cache.
      *
      * @param string $cacheId
-     * @param mixed $value
+     * @param string $value
      */
     public function set($cacheId, $value)
     {

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();
         }