timohund / ext-solr

Classes/SolrService.php

Doc Comments +8 added lines, -8 removed lines

@@ -129,7 +129,7 @@ 
     /**
      * Returns the current time in milliseconds.
      *
-     * @return int
+     * @return double
      */
     protected function getMilliseconds()
     {
@@ -175,7 +175,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)
@@ -187,8 +187,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)
@@ -582,7 +582,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)
@@ -679,7 +679,7 @@ 
     /**
      * Add list of synonyms for base word to managed synonyms map
      *
-     * @param $baseWord
+     * @param string $baseWord
      * @param array $synonyms
      *
      * @return \Apache_Solr_Response
@@ -700,7 +700,7 @@ 
     /**
      * Remove a synonym from the synonyms map
      *
-     * @param $baseWord
+     * @param string $baseWord
      * @return \Apache_Solr_Response
      * @throws \Apache_Solr_InvalidArgumentException
      */
@@ -716,7 +716,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/System/Configuration/TypoScriptConfiguration.php

Doc Comments +3 added lines, -3 removed lines

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

Classes/Task/IndexQueueWorkerTask.php

Doc Comments +1 added lines, -1 removed lines

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

Classes/Template.php

Doc Comments +2 added lines, -1 removed lines

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

Classes/Typo3PageIndexer.php

Doc Comments +1 added lines, -1 removed lines

@@ -437,7 +437,7 @@
      * should be indexed for the current page.
      *
      * @param \Apache_Solr_Document $pageDocument The main document representing this page.
-     * @param array $existingDocuments An array of documents already created for this page.
+     * @param \Apache_Solr_Document[] $existingDocuments An array of documents already created for this page.
      * @return array An array of additional \Apache_Solr_Document objects to index
      */
     protected function getAdditionalDocuments(

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/ViewHelper/CurrentResultNumber.php

Doc Comments +1 added lines, -1 removed lines

@@ -60,7 +60,7 @@
      * number counting from zero of the total number of results.
      *
      * @param array $arguments
-     * @return string
+     * @return integer
      */
     public function execute(array $arguments = array())
     {

Classes/GarbageCollector.php

Doc Comments +1 added lines, -1 removed lines

@@ -168,7 +168,7 @@
     }
 
     /**
-     * @param $table
+     * @param string $table
      * @param $uid
      * @param $changedFields
      * @param $indexQueue

Classes/Query.php

Doc Comments +3 added lines, -3 removed lines

@@ -193,7 +193,7 @@ 
      *
      * @param string $msg
      * @param int $severity
-     * @param mixed $dataVar
+     * @param string[] $dataVar
      */
     protected function writeDevLog($msg, $severity = 0, $dataVar = false)
     {
@@ -1004,7 +1004,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'))
@@ -1080,7 +1080,7 @@ 
      *
      * This query supports the complete Lucene Query Language.
      *
-     * @param mixed $alternativeQuery String alternative query or boolean FALSE to disable / reset the q.alt parameter.
+     * @param string $alternativeQuery String alternative query or boolean FALSE to disable / reset the q.alt parameter.
      * @see http://wiki.apache.org/solr/DisMaxQParserPlugin#q.alt
      */
     public function setAlternativeQuery($alternativeQuery)