silverstripe / silverstripe-fulltextsearch

tests/SolrIndexSubsitesTest.php

Doc Comments +3 added lines

@@ -65,6 +65,9 @@
         parent::tearDown();
     }
 
+    /**
+     * @return \SilverStripe\FullTextSearch\Solr\Services\SolrService
+     */
     protected function getServiceMock()
     {
         return \Phockito::mock('Solr4Service');

src/Search/Variants/SearchVariantSubsites.php

Doc Comments +4 added lines, -1 removed lines

@@ -19,6 +19,9 @@ 
         return class_exists('Subsite');
     }
 
+    /**
+     * @param boolean $includeSubclasses
+     */
     public function appliesTo($class, $includeSubclasses)
     {
         // Include all DataExtensions that contain a SubsiteID.
@@ -135,7 +138,7 @@ 
     /**
      * Determine if a field with a certain name is filtered by the search query or on the index
      * This is the equivalent of saying "show me the results that do ONLY contain this value"
-     * @param $field string name of the field being filtered
+     * @param string $field string name of the field being filtered
      * @param $query SearchQuery currently being executed
      * @param $index SearchIndex which specifies a filter field
      * @return bool true if $field is being filtered, false if it is not being filtered

src/Search/Variants/SearchVariantVersioned.php

Doc Comments +3 added lines

@@ -10,6 +10,9 @@
 
 class SearchVariantVersioned extends SearchVariant
 {
+    /**
+     * @param boolean $includeSubclasses
+     */
     public function appliesTo($class, $includeSubclasses)
     {
         return SearchIntrospection::has_extension($class, Versioned::class, $includeSubclasses);

src/Utils/WebDAV.php

Doc Comments +9 added lines

@@ -3,6 +3,9 @@ 
 
 class WebDAV
 {
+    /**
+     * @param string $method
+     */
     public static function curl_init($url, $method)
     {
         $ch = curl_init($url);
@@ -46,6 +49,9 @@ 
         return $code == 201;
     }
 
+    /**
+     * @param resource $handle
+     */
     public static function put($handle, $url)
     {
         $ch = curl_init($url);
@@ -70,6 +76,9 @@ 
         return self::put($fh, $url);
     }
 
+    /**
+     * @param string $url
+     */
     public static function upload_from_file($string, $url)
     {
         return self::put(fopen($string, 'rb'), $url);

src/Solr/SolrIndex.php

Doc Comments +10 added lines, -1 removed lines

@@ -289,7 +289,7 @@ 
      * @param string $forceType The type to force this field as (required in some cases, when not
      * detectable from metadata)
      * @param array $extraOptions Dependent on search implementation
-     * @param float $boost Numeric boosting value (defaults to 2)
+     * @param integer $boost Numeric boosting value (defaults to 2)
      */
     public function addBoostedField($field, $forceType = null, $extraOptions = array(), $boost = 2)
     {
@@ -298,6 +298,9 @@ 
     }
 
 
+    /**
+     * @param string $field
+     */
     public function fieldData($field, $forceType = null, $extraOptions = array())
     {
         // Ensure that 'boost' is recorded here without being captured by solr
@@ -508,6 +511,9 @@ 
         return $class === $base || is_subclass_of($class, $base);
     }
 
+    /**
+     * @param \Apache_Solr_Document $doc
+     */
     protected function _addField($doc, $object, $field)
     {
         $class = get_class($object);
@@ -557,6 +563,9 @@ 
         }
     }
 
+    /**
+     * @param string $base
+     */
     protected function _addAs($object, $base, $options)
     {
         $includeSubs = $options['include_children'];

tests/SolrIndexVersionedTest.php

Doc Comments +1 added lines, -1 removed lines

@@ -94,7 +94,7 @@
      * @param DataObject $object Item being added
      * @param string $value Value for class
      * @param string $stage Stage updated
-     * @return Apache_Solr_Document
+     * @return \Apache_Solr_Document
      */
     protected function getSolrDocument($class, $object, $value, $stage)
     {

src/Search/Variants/SearchVariant.php

Doc Comments +3 added lines, -1 removed lines

@@ -151,6 +151,7 @@ 
      * A shortcut to with when calling without passing in a class,
      *
      * SearchVariant::call(...) ==== SearchVariant::with()->call(...);
+     * @param string $method
      */
 
     public static function call($method, &...$args)
@@ -161,6 +162,7 @@ 
     /**
      * Get the current state of every variant
      * @static
+     * @param string $class
      * @return array
      */
     public static function current_state($class = null, $includeSubclasses = true)
@@ -194,7 +196,7 @@ 
      * @static
      * @param string $class - The class name to get variants for
      * @param bool $includeSubclasses - True if variants should be included if they apply to at least one subclass of $class
-     * @return SearchVariant_ReindexStateIteratorRet - The iterator to foreach loop over
+     * @return \Traversable - The iterator to foreach loop over
      */
     public static function reindex_states($class = null, $includeSubclasses = true)
     {