groupby / api-php

src/API/AbstractBridge.php

Doc Comments +5 added lines, -1 removed lines

@@ -147,7 +147,7 @@ 
   /**
    * @param Response $response
    *
-   * @return bool|string
+   * @return string|false
    */
   private function getContentEncoding($response)
   {
@@ -161,6 +161,10 @@ 
     return false;
   }
 
+  /**
+   * @param string $json
+   * @param string $class
+   */
   private function deserialize($json, $class)
   {
     $object = null;

src/API/Url/UrlBeautifier.php

Doc Comments +6 added lines

@@ -342,6 +342,9 @@ 
     return $lastSegment;
   }
 
+  /**
+   * @param string $pathSegmentLookup
+   */
   private function removeUnusedPathSegments(array &$pathSegments, $pathSegmentLookup)
   {
     while (count($pathSegments) > strlen($pathSegmentLookup)) {
@@ -389,6 +392,9 @@ 
     }
   }
 
+  /**
+   * @param string $token
+   */
   private function getFieldName($token)
   {
     $mapping = $this->tokenToName[$token];

src/API/Url/UrlReplacement.php

Doc Comments +1 added lines, -1 removed lines

@@ -149,7 +149,7 @@
 
   /**
    * @param UrlReplacement[] $replacements
-   * @return string
+   * @return StringBuilder
    */
   public static function buildQueryString(array $replacements)
   {

src/API/Util/StringBuilder.php

Doc Comments +4 added lines

@@ -71,6 +71,10 @@
     $this->string = $front . $back;
   }
 
+  /**
+   * @param integer $index
+   * @param integer $length
+   */
   public function delete($index, $length = null)
   {
     if ($length != null) {

tests/API/Url/UrlBeautifierTest.php

Doc Comments +18 added lines

@@ -18,6 +18,9 @@ 
         $this->beautifier->clearSavedFields();
     }
 
+    /**
+     * @param string $identifier
+     */
     private function getBeautifier($identifier)
     {
         $beautifiers = UrlBeautifier::getUrlBeautifiers();
@@ -203,6 +206,10 @@ 
         $this->assertNavigation("height", "=20in", $navigations[1]);
     }
 
+    /**
+     * @param string $expectedNavName
+     * @param string $expectedValue
+     */
     public function assertNavigation($expectedNavName, $expectedValue, Navigation $navigation)
     {
         $this->assertEquals($expectedNavName, $navigation->getName());
@@ -284,6 +291,10 @@ 
         $this->assertFromUrl("/aoeu/laptop/MAGNOLIA+HOME+THEATRE/qd/index.html", null, "MAGNOLIA HOME THEATRE");
     }
 
+    /**
+     * @param string $url
+     * @param null|string $searchString
+     */
     private function assertFromUrl($url, $searchString)
     {
         $query = $this->beautifier->fromUrl($url);
@@ -324,6 +335,10 @@ 
             ->setAppend("/index.html");
     }
 
+    /**
+     * @param string|null $searchString
+     * @param null|string $refinementString
+     */
     private function assertToAndFromUrl($searchString, $refinementString)
     {
         $url = $this->beautifier->toUrl($searchString, $refinementString);
@@ -377,6 +392,9 @@ 
         $this->assertFailingQuery("/black+decker/q/index.html?z=2-B--");
     }
 
+    /**
+     * @param string $uri
+     */
     private function assertFailingQuery($uri)
     {
         try {

tests/API/Url/UrlReplacementTest.php

Doc Comments +10 added lines

@@ -121,6 +121,9 @@ 
         $this->assertBadApply("abc12", new UrlReplacement(6, "3", OperationType::Insert));
     }
 
+    /**
+     * @param string $input
+     */
     private function assertBadApply($input, UrlReplacement $replacement)
     {
         $builder = new StringBuilder($input);
@@ -128,6 +131,10 @@ 
         $this->assertEquals($input, $builder);
     }
 
+    /**
+     * @param string $input
+     * @param string $expected
+     */
     private function assertApply($input, $expected, UrlReplacement $replacement)
     {
         $builder = new StringBuilder($input);
@@ -156,6 +163,9 @@ 
         }
     }
 
+    /**
+     * @param string $replacementString
+     */
     private function assertToAndFromString($replacementString)
     {
         $replacement1 = UrlReplacement::fromString($replacementString);

src/API/Model/ResultsMetadata.php

Doc Comments +2 added lines, -2 removed lines

@@ -24,7 +24,7 @@ 
 
   /**
    * @param recordLimitReached    Whether the total record count is actually greater than the returned record count
-   * @return                      This ResultsMetadata object
+   * @return                      ResultsMetadata ResultsMetadata object
    */
   public function setRecordLimitReached($recordLimitReached)
   {
@@ -42,7 +42,7 @@ 
 
   /**
    * @param totalTime    The total time spent in milliseconds to generate results
-   * @return             This ResultsMetadata object
+   * @return             ResultsMetadata ResultsMetadata object
    */
   public function setTotalTime($totalTime)
   {

src/API/Model/NumericBoost.php

Doc Comments +6 added lines, -5 removed lines

@@ -30,8 +30,8 @@ 
   /**
    * Set the name of this Numeric Boost
    *
-   * @param name    The string to be the name of this Numeric Boost
-   * @return        This Numeric Boost
+   * @param name    string string to be the name of this Numeric Boost
+   * @return        NumericBoost Numeric Boost
    */
   public function setName($name)
   {
@@ -50,8 +50,8 @@ 
   /**
    * Set this Numeric Boost to inverted
    *
-   * @param inverted    True if this is to be an iverted Numeric Boost, false otherwise
-   * @return            This Numeric Boost
+   * @param inverted    boolean if this is to be an iverted Numeric Boost, false otherwise
+   * @return            NumericBoost Numeric Boost
    */
   public function setInverted($inverted)
   {
@@ -71,7 +71,8 @@ 
    * Set the strength of this Numeric Boost
    *
    * @param double  The value to be the strength of this Numeric Boost
-   * @return        This Numeric Boost
+   * @param double $strength
+   * @return        NumericBoost Numeric Boost
    */
   public function setStrength($strength)
   {

src/API/Query.php

Doc Comments +3 added lines

@@ -430,6 +430,9 @@
     array_push($this->customUrlParams, $param);
   }
 
+  /**
+   * @param string|null $refinementString
+   */
   public function splitRefinements($refinementString)
   {
     if (StringUtils::isNotBlank($refinementString)) {