@@ -70,7 +70,7 @@ discard block |
||
| 70 | 70 | * |
| 71 | 71 | * If not connected yet, connect first. |
| 72 | 72 | * |
| 73 | - * @return Apache_Solr_Service|false |
|
| 73 | + * @return Apache_Solr_Service |
|
| 74 | 74 | */ |
| 75 | 75 | public function connection() { |
| 76 | 76 | return $this->connect(); |
@@ -79,7 +79,7 @@ discard block |
||
| 79 | 79 | /** |
| 80 | 80 | * Connect to the database. |
| 81 | 81 | * |
| 82 | - * @return Apache_Solr_Service|false |
|
| 82 | + * @return Apache_Solr_Service |
|
| 83 | 83 | */ |
| 84 | 84 | protected function connect() { |
| 85 | 85 | if (is_null($this->connection)) { |
@@ -8,7 +8,7 @@ discard block |
||
| 8 | 8 | * @param boolean $expungeDeletes Defaults to false, merge segments with deletes away |
| 9 | 9 | * @param boolean $waitFlush Defaults to true, block until index changes are flushed to disk |
| 10 | 10 | * @param boolean $waitSearcher Defaults to true, block until a new searcher is opened and registered as the main query searcher, making the changes visible |
| 11 | - * @param float $timeout Maximum expected duration (in seconds) of the commit operation on the server (otherwise, will throw a communication exception). Defaults to 1 hour |
|
| 11 | + * @param integer $timeout Maximum expected duration (in seconds) of the commit operation on the server (otherwise, will throw a communication exception). Defaults to 1 hour |
|
| 12 | 12 | * @param boolean $softCommit Defaults to false, perform a soft commit instead of a hard commit. |
| 13 | 13 | * @return string An XML string |
| 14 | 14 | */ |
@@ -19,7 +19,6 @@ discard block |
||
| 19 | 19 | * |
| 20 | 20 | * @param boolean $waitFlush |
| 21 | 21 | * @param boolean $waitSearcher |
| 22 | - * @param float $timeout Maximum expected duration of the commit operation on the server (otherwise, will throw a communication exception) |
|
| 23 | 22 | * @return string An XML string |
| 24 | 23 | */ |
| 25 | 24 | function createOptimizeXml($waitFlush = true, $waitSearcher = true); |
@@ -8,7 +8,7 @@ discard block |
||
| 8 | 8 | * @param boolean $expungeDeletes Defaults to false, merge segments with deletes away |
| 9 | 9 | * @param boolean $waitFlush Defaults to true, block until index changes are flushed to disk |
| 10 | 10 | * @param boolean $waitSearcher Defaults to true, block until a new searcher is opened and registered as the main query searcher, making the changes visible |
| 11 | - * @param float $timeout Maximum expected duration (in seconds) of the commit operation on the server (otherwise, will throw a communication exception). Defaults to 1 hour |
|
| 11 | + * @param integer $timeout Maximum expected duration (in seconds) of the commit operation on the server (otherwise, will throw a communication exception). Defaults to 1 hour |
|
| 12 | 12 | * @param boolean $softCommit Defaults to false, is ignored. |
| 13 | 13 | * @return string An XML string |
| 14 | 14 | */ |
@@ -28,7 +28,6 @@ discard block |
||
| 28 | 28 | * |
| 29 | 29 | * @param boolean $waitFlush |
| 30 | 30 | * @param boolean $waitSearcher |
| 31 | - * @param float $timeout Maximum expected duration of the commit operation on the server (otherwise, will throw a communication exception) |
|
| 32 | 31 | * @return string An XML string |
| 33 | 32 | */ |
| 34 | 33 | public function createOptimizeXml($waitFlush = true, $waitSearcher = true) |
@@ -10,7 +10,7 @@ discard block |
||
| 10 | 10 | * @param boolean $expungeDeletes Defaults to false, merge segments with deletes away |
| 11 | 11 | * @param boolean $waitFlush Defaults to true, is ignored. |
| 12 | 12 | * @param boolean $waitSearcher Defaults to true, block until a new searcher is opened and registered as the main query searcher, making the changes visible. |
| 13 | - * @param float $timeout Maximum expected duration (in seconds) of the commit operation on the server (otherwise, will throw a communication exception). Defaults to 1 hour |
|
| 13 | + * @param integer $timeout Maximum expected duration (in seconds) of the commit operation on the server (otherwise, will throw a communication exception). Defaults to 1 hour |
|
| 14 | 14 | * @param boolean $softCommit Defaults to false, perform a soft commit instead of a hard commit. |
| 15 | 15 | * @return string An XML string |
| 16 | 16 | */ |
@@ -30,7 +30,6 @@ discard block |
||
| 30 | 30 | * |
| 31 | 31 | * @param boolean $waitFlush Is ignored. |
| 32 | 32 | * @param boolean $waitSearcher |
| 33 | - * @param float $timeout Maximum expected duration of the commit operation on the server (otherwise, will throw a communication exception) |
|
| 34 | 33 | * @return string An XML string |
| 35 | 34 | */ |
| 36 | 35 | public function createOptimizeXml($waitFlush = true, $waitSearcher = true) |
@@ -102,7 +102,7 @@ discard block |
||
| 102 | 102 | /** |
| 103 | 103 | * Get current document boost |
| 104 | 104 | * |
| 105 | - * @return mixed will be false for default, or else a float |
|
| 105 | + * @return double will be false for default, or else a float |
|
| 106 | 106 | */ |
| 107 | 107 | public function getBoost() |
| 108 | 108 | { |
@@ -148,7 +148,7 @@ discard block |
||
| 148 | 148 | * </code> |
| 149 | 149 | * |
| 150 | 150 | * @param string $key |
| 151 | - * @param mixed $value |
|
| 151 | + * @param string $value |
|
| 152 | 152 | * @param mixed $boost Use false for default boost, else cast to float that should be > 0 or will be treated as false |
| 153 | 153 | */ |
| 154 | 154 | public function addField($key, $value, $boost = false) |
@@ -223,7 +223,7 @@ discard block |
||
| 223 | 223 | * if not specified. |
| 224 | 224 | * |
| 225 | 225 | * @param string $host |
| 226 | - * @param string $port |
|
| 226 | + * @param integer $port |
|
| 227 | 227 | * @param string $path |
| 228 | 228 | * @param Apache_Solr_HttpTransport_Interface $httpTransport |
| 229 | 229 | */ |
@@ -422,7 +422,7 @@ discard block |
||
| 422 | 422 | /** |
| 423 | 423 | * Get the set port |
| 424 | 424 | * |
| 425 | - * @return integer |
|
| 425 | + * @return string |
|
| 426 | 426 | */ |
| 427 | 427 | public function getPort() |
| 428 | 428 | { |
@@ -493,7 +493,7 @@ discard block |
||
| 493 | 493 | /** |
| 494 | 494 | * Get the current configured HTTP Transport |
| 495 | 495 | * |
| 496 | - * @return HttpTransportInterface |
|
| 496 | + * @return Apache_Solr_HttpTransport_Interface |
|
| 497 | 497 | */ |
| 498 | 498 | public function getHttpTransport() |
| 499 | 499 | { |
@@ -669,7 +669,7 @@ discard block |
||
| 669 | 669 | * Call the /admin/ping servlet, can be used to quickly tell if a connection to the |
| 670 | 670 | * server is able to be made. |
| 671 | 671 | * |
| 672 | - * @param float $timeout maximum time to wait for ping in seconds, -1 for unlimited (default is 2) |
|
| 672 | + * @param integer $timeout maximum time to wait for ping in seconds, -1 for unlimited (default is 2) |
|
| 673 | 673 | * @return float Actual time taken to ping the server, FALSE if timeout or HTTP error status occurs |
| 674 | 674 | */ |
| 675 | 675 | public function ping($timeout = 2) |
@@ -789,11 +789,11 @@ discard block |
||
| 789 | 789 | } |
| 790 | 790 | |
| 791 | 791 | /** |
| 792 | - * @param $documentsXmlFragment |
|
| 793 | - * @param $allowDups |
|
| 794 | - * @param $overwritePending |
|
| 795 | - * @param $overwriteCommitted |
|
| 796 | - * @param $commitWithin |
|
| 792 | + * @param string $documentsXmlFragment |
|
| 793 | + * @param boolean $allowDups |
|
| 794 | + * @param boolean $overwritePending |
|
| 795 | + * @param boolean $overwriteCommitted |
|
| 796 | + * @param integer $commitWithin |
|
| 797 | 797 | * @return Apache_Solr_Response |
| 798 | 798 | */ |
| 799 | 799 | private function addRawDocuments( |
@@ -910,7 +910,7 @@ discard block |
||
| 910 | 910 | * @param boolean $expungeDeletes Defaults to false, merge segments with deletes away |
| 911 | 911 | * @param boolean $waitFlush Defaults to true, block until index changes are flushed to disk |
| 912 | 912 | * @param boolean $waitSearcher Defaults to true, block until a new searcher is opened and registered as the main query searcher, making the changes visible |
| 913 | - * @param float $timeout Maximum expected duration (in seconds) of the commit operation on the server (otherwise, will throw a communication exception). Defaults to 1 hour |
|
| 913 | + * @param integer $timeout Maximum expected duration (in seconds) of the commit operation on the server (otherwise, will throw a communication exception). Defaults to 1 hour |
|
| 914 | 914 | * @param boolean $softCommit Whether to perform a soft commit instead of a hard commit. |
| 915 | 915 | * @return Apache_Solr_Response |
| 916 | 916 | * |
@@ -935,7 +935,7 @@ discard block |
||
| 935 | 935 | * @param boolean $expungeDeletes Defaults to false, merge segments with deletes away |
| 936 | 936 | * @param boolean $waitFlush Defaults to true, block until index changes are flushed to disk |
| 937 | 937 | * @param boolean $waitSearcher Defaults to true, block until a new searcher is opened and registered as the main query searcher, making the changes visible |
| 938 | - * @param float $timeout Maximum expected duration (in seconds) of the commit operation on the server (otherwise, will throw a communication exception). Defaults to 1 hour |
|
| 938 | + * @param integer $timeout Maximum expected duration (in seconds) of the commit operation on the server (otherwise, will throw a communication exception). Defaults to 1 hour |
|
| 939 | 939 | * @return Apache_Solr_Response |
| 940 | 940 | * |
| 941 | 941 | * @throws Apache_Solr_HttpTransportException If an error occurs during the service call |
@@ -950,7 +950,7 @@ discard block |
||
| 950 | 950 | * a complete and well formed "delete" xml document |
| 951 | 951 | * |
| 952 | 952 | * @param string $rawPost Expected to be utf-8 encoded xml document |
| 953 | - * @param float $timeout Maximum expected duration of the delete operation on the server (otherwise, will throw a communication exception) |
|
| 953 | + * @param integer $timeout Maximum expected duration of the delete operation on the server (otherwise, will throw a communication exception) |
|
| 954 | 954 | * @return Apache_Solr_Response |
| 955 | 955 | * |
| 956 | 956 | * @throws Apache_Solr_HttpTransportException If an error occurs during the service call |
@@ -966,7 +966,7 @@ discard block |
||
| 966 | 966 | * @param string $id Expected to be utf-8 encoded |
| 967 | 967 | * @param boolean $fromPending |
| 968 | 968 | * @param boolean $fromCommitted |
| 969 | - * @param float $timeout Maximum expected duration of the delete operation on the server (otherwise, will throw a communication exception) |
|
| 969 | + * @param integer $timeout Maximum expected duration of the delete operation on the server (otherwise, will throw a communication exception) |
|
| 970 | 970 | * @return Apache_Solr_Response |
| 971 | 971 | * |
| 972 | 972 | * @throws Apache_Solr_HttpTransportException If an error occurs during the service call |
@@ -990,7 +990,7 @@ discard block |
||
| 990 | 990 | * @param array $ids Expected to be utf-8 encoded strings |
| 991 | 991 | * @param boolean $fromPending |
| 992 | 992 | * @param boolean $fromCommitted |
| 993 | - * @param float $timeout Maximum expected duration of the delete operation on the server (otherwise, will throw a communication exception) |
|
| 993 | + * @param integer $timeout Maximum expected duration of the delete operation on the server (otherwise, will throw a communication exception) |
|
| 994 | 994 | * @return Apache_Solr_Response |
| 995 | 995 | * |
| 996 | 996 | * @throws Apache_Solr_HttpTransportException If an error occurs during the service call |
@@ -1021,7 +1021,7 @@ discard block |
||
| 1021 | 1021 | * @param string $rawQuery Expected to be utf-8 encoded |
| 1022 | 1022 | * @param boolean $fromPending |
| 1023 | 1023 | * @param boolean $fromCommitted |
| 1024 | - * @param float $timeout Maximum expected duration of the delete operation on the server (otherwise, will throw a communication exception) |
|
| 1024 | + * @param integer $timeout Maximum expected duration of the delete operation on the server (otherwise, will throw a communication exception) |
|
| 1025 | 1025 | * @return Apache_Solr_Response |
| 1026 | 1026 | * |
| 1027 | 1027 | * @throws Apache_Solr_HttpTransportException If an error occurs during the service call |
@@ -1225,7 +1225,7 @@ discard block |
||
| 1225 | 1225 | * |
| 1226 | 1226 | * @param boolean $waitFlush |
| 1227 | 1227 | * @param boolean $waitSearcher |
| 1228 | - * @param float $timeout Maximum expected duration of the commit operation on the server (otherwise, will throw a communication exception) |
|
| 1228 | + * @param integer $timeout Maximum expected duration of the commit operation on the server (otherwise, will throw a communication exception) |
|
| 1229 | 1229 | * @return Apache_Solr_Response |
| 1230 | 1230 | * |
| 1231 | 1231 | * @throws Apache_Solr_HttpTransportException If an error occurs during the service call |
@@ -615,7 +615,7 @@ discard block |
||
| 615 | 615 | * a complete and well formed "delete" xml document |
| 616 | 616 | * |
| 617 | 617 | * @param string $rawPost |
| 618 | - * @param float $timeout Maximum expected duration of the delete operation on the server (otherwise, will throw a communication exception) |
|
| 618 | + * @param integer $timeout Maximum expected duration of the delete operation on the server (otherwise, will throw a communication exception) |
|
| 619 | 619 | * @return Apache_Solr_Response |
| 620 | 620 | * |
| 621 | 621 | * @throws Apache_Solr_HttpTransportException If an error occurs during the service call |
@@ -650,7 +650,7 @@ discard block |
||
| 650 | 650 | * @param string $id |
| 651 | 651 | * @param boolean $fromPending |
| 652 | 652 | * @param boolean $fromCommitted |
| 653 | - * @param float $timeout Maximum expected duration of the delete operation on the server (otherwise, will throw a communication exception) |
|
| 653 | + * @param integer $timeout Maximum expected duration of the delete operation on the server (otherwise, will throw a communication exception) |
|
| 654 | 654 | * @return Apache_Solr_Response |
| 655 | 655 | * |
| 656 | 656 | * @throws Apache_Solr_HttpTransportException If an error occurs during the service call |
@@ -685,7 +685,7 @@ discard block |
||
| 685 | 685 | * @param array $ids Expected to be utf-8 encoded strings |
| 686 | 686 | * @param boolean $fromPending |
| 687 | 687 | * @param boolean $fromCommitted |
| 688 | - * @param float $timeout Maximum expected duration of the delete operation on the server (otherwise, will throw a communication exception) |
|
| 688 | + * @param integer $timeout Maximum expected duration of the delete operation on the server (otherwise, will throw a communication exception) |
|
| 689 | 689 | * @return Apache_Solr_Response |
| 690 | 690 | * |
| 691 | 691 | * @throws Apache_Solr_HttpTransportException If an error occurs during the service call |
@@ -720,7 +720,7 @@ discard block |
||
| 720 | 720 | * @param string $rawQuery |
| 721 | 721 | * @param boolean $fromPending |
| 722 | 722 | * @param boolean $fromCommitted |
| 723 | - * @param float $timeout Maximum expected duration of the delete operation on the server (otherwise, will throw a communication exception) |
|
| 723 | + * @param integer $timeout Maximum expected duration of the delete operation on the server (otherwise, will throw a communication exception) |
|
| 724 | 724 | * @return Apache_Solr_Response |
| 725 | 725 | * |
| 726 | 726 | * @throws Apache_Solr_HttpTransportException If an error occurs during the service call |
@@ -841,7 +841,7 @@ discard block |
||
| 841 | 841 | * |
| 842 | 842 | * @param boolean $waitFlush |
| 843 | 843 | * @param boolean $waitSearcher |
| 844 | - * @param float $timeout Maximum expected duration of the optimize operation on the server (otherwise, will throw a communication exception) |
|
| 844 | + * @param integer $timeout Maximum expected duration of the optimize operation on the server (otherwise, will throw a communication exception) |
|
| 845 | 845 | * @return Apache_Solr_Response |
| 846 | 846 | * |
| 847 | 847 | * @throws Apache_Solr_HttpTransportException If an error occurs during the service call |