TYPO3-Solr / ext-solr

Classes/Domain/Search/Statistics/StatisticsRepository.php

Doc Comments +1 added lines

@@ -201,6 +201,7 @@
      *
      * @param array $mergedRow
      * @param array $statisticsRow
+     * @param string $fieldName
      * @return float|int
      */
     protected function getAverageFromField(array &$mergedRow, array $statisticsRow,  $fieldName)

Spacing +9 added lines, -9 removed lines

@@ -46,9 +46,9 @@ 
     public function getSearchStatistics($rootPageId, $days = 30, $limit = 10)
     {
         $now = time();
-        $timeStart = (int) ($now - 86400 * intval($days)); // 86400 seconds/day
-        $rootPageId = (int) $rootPageId;
-        $limit = (int) $limit;
+        $timeStart = (int)($now - 86400 * intval($days)); // 86400 seconds/day
+        $rootPageId = (int)$rootPageId;
+        $limit = (int)$limit;
 
         $statisticsRows = $this->getDatabase()->exec_SELECTgetRows(
             'keywords, count(keywords) as count, num_found as hits',
@@ -66,7 +66,7 @@ 
             $sumCount += $statisticsRow['count'];
         }
 
-        $statisticsRows = array_map(function ($row) use ($sumCount) {
+        $statisticsRows = array_map(function($row) use ($sumCount) {
             $row['percent'] = $row['count'] * 100 / $sumCount;
 
             return $row;
@@ -112,9 +112,9 @@ 
      */
     protected function getTopKeyWordsWithOrWithoutHits($rootPageId, $days = 30, $limit, $withoutHits)
     {
-        $rootPageId = (int) $rootPageId;
-        $limit = (int) $limit;
-        $withoutHits = (bool) $withoutHits;
+        $rootPageId = (int)$rootPageId;
+        $limit = (int)$limit;
+        $withoutHits = (bool)$withoutHits;
 
         $now = time();
         $timeStart = $now - 86400 * intval($days); // 86400 seconds/day
@@ -159,7 +159,7 @@ 
 
                 // for the hits we need to take the average
             $avgHits = $this->getAverageFromField($mergedRow, $statisticsRow, 'hits');
-            $mergedRow['hits'] = (int) $avgHits;
+            $mergedRow['hits'] = (int)$avgHits;
 
                 // for the count we need to take the sum, because it's the sum of searches
             $mergedRow['count'] = $mergedRow['count'] + $statisticsRow['count'];
@@ -203,7 +203,7 @@ 
      * @param array $statisticsRow
      * @return float|int
      */
-    protected function getAverageFromField(array &$mergedRow, array $statisticsRow,  $fieldName)
+    protected function getAverageFromField(array &$mergedRow, array $statisticsRow, $fieldName)
     {
         // when this is the first row we can take it.
         if ($mergedRow['mergedrows'] === 1) {

Classes/IndexQueue/PageIndexerRequest.php

Doc Comments +2 added lines, -2 removed lines

@@ -204,7 +204,7 @@ 
     /**
      * Generates the headers to be send with the request.
      *
-     * @return array Array of HTTP headers.
+     * @return string[] Array of HTTP headers.
      */
     public function getHeaders()
     {
@@ -324,7 +324,7 @@ 
      * Sets a request's parameter and its value.
      *
      * @param string $parameter Parameter name
-     * @param mixed $value Parameter value.
+     * @param string $value Parameter value.
      */
     public function setParameter($parameter, $value)
     {

Classes/SuggestQuery.php

Indentation +3 added lines, -3 removed lines

@@ -39,9 +39,9 @@
      */
     protected $configuration;
 
-     /**
-     * @var string
-     */
+        /**
+         * @var string
+         */
     protected $prefix;
 
     /**

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

Unused Use Statements -1 removed lines

@@ -29,7 +29,6 @@
 use ApacheSolrForTypo3\Solr\Domain\Search\SearchRequest;
 use ApacheSolrForTypo3\Solr\Plugin\CommandPluginBase;
 use ApacheSolrForTypo3\Solr\Plugin\PluginCommand;
-use ApacheSolrForTypo3\Solr\Query;
 use ApacheSolrForTypo3\Solr\System\Configuration\TypoScriptConfiguration;
 use ApacheSolrForTypo3\Solr\Template;
 use TYPO3\CMS\Core\Utility\GeneralUtility;

Classes/Site.php

Doc Comments +1 added lines, -1 removed lines

@@ -274,7 +274,7 @@
      * Generates a list of page IDs in this site. Attention, this includes
      * all page types! Deleted pages are not included.
      *
-     * @param int|string $rootPageId Page ID from where to start collection sub pages
+     * @param integer $rootPageId Page ID from where to start collection sub pages
      * @param int $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

@@ -128,7 +128,7 @@ 
     /**
      * Returns the current time in milliseconds.
      *
-     * @return int
+     * @return double
      */
     protected function getMilliseconds()
     {
@@ -174,7 +174,7 @@ 
      *
      * Also does not report the time, see https://forge.typo3.org/issues/64551
      *
-     * @param float|int $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)
@@ -186,8 +186,8 @@ 
     /**
      * Call the /admin/ping servlet, can be used to get the runtime of a ping request.
      *
-     * @param float|int $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)
@@ -581,7 +581,7 @@ 
      * a complete and well formed "delete" xml document
      *
      * @param string $rawPost Expected to be utf-8 encoded xml document
-     * @param float|int $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)
@@ -678,7 +678,7 @@ 
     /**
      * Add list of synonyms for base word to managed synonyms map
      *
-     * @param $baseWord
+     * @param string $baseWord
      * @param array $synonyms
      *
      * @return \Apache_Solr_Response
@@ -699,7 +699,7 @@ 
     /**
      * Remove a synonym from the synonyms map
      *
-     * @param $baseWord
+     * @param string $baseWord
      * @return \Apache_Solr_Response
      * @throws \Apache_Solr_InvalidArgumentException
      */
@@ -715,7 +715,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
      */

Classes/Util.php

Doc Comments +4 added lines, -4 removed lines

@@ -236,7 +236,7 @@ 
      * @param int $pageId Id of the (root) page to get the Solr configuration from.
      * @param string $path The TypoScript configuration path to retrieve.
      * @param bool $initializeTsfe Optionally initializes a full TSFE to get the configuration, defaults to FALSE
-     * @param int|bool $language System language uid or FALSE to disable language usage, optional, defaults to 0
+     * @param integer $language System language uid or FALSE to disable language usage, optional, defaults to 0
      * @return TypoScriptConfiguration The Solr configuration for the requested tree.
      */
     public static function getConfigurationFromPageId(
@@ -311,9 +311,9 @@ 
 
     /**
      * This function is used to retrieve the configuration from an existing TSFE instance
-     * @param $pageId
-     * @param $path
-     * @param $language
+     * @param integer $pageId
+     * @param string $path
+     * @param integer $language
      * @return mixed
      */
     private static function getConfigurationFromExistingTSFE($pageId, $path, $language)

Classes/Search.php

Spacing +1 added lines, -1 removed lines

@@ -526,7 +526,7 @@
             $spellcheckingSuggestions = $suggestions;
 
             if (isset($this->response->spellcheck->collations)) {
-                $collections = (array) $this->response->spellcheck->collations;
+                $collections = (array)$this->response->spellcheck->collations;
                 $spellcheckingSuggestions['collation'] = $collections['collation'];
             }
         }

Classes/Domain/Search/ResultSet/SearchResultSetService.php

Spacing +3 added lines, -3 removed lines

@@ -286,7 +286,7 @@ 
      * @param Query $query The query that has been searched for.
      * @param \Apache_Solr_Response $response The search's response.
      */
-    protected function processResponse($rawQuery, Query $query, \Apache_Solr_Response &$response)
+    protected function processResponse($rawQuery, Query $query, \Apache_Solr_Response & $response)
     {
         if ($this->shouldHideResultsFromInitialSearch($rawQuery)) {
             // explicitly set number of results to 0 as we just wanted
@@ -314,7 +314,7 @@ 
      *
      * @param \Apache_Solr_Response $response
      */
-    protected function addExpandedDocumentsFromVariants(\Apache_Solr_Response &$response)
+    protected function addExpandedDocumentsFromVariants(\Apache_Solr_Response & $response)
     {
         if (!is_array($response->response->docs)) {
             return;
@@ -366,7 +366,7 @@ 
      * @param \Apache_Solr_Response $response
      * @throws \InvalidArgumentException
      */
-    protected function wrapResultDocumentInResultObject(\Apache_Solr_Response &$response)
+    protected function wrapResultDocumentInResultObject(\Apache_Solr_Response & $response)
     {
         if (!is_array($response->response->docs)) {
             return;