groupby / api-php

src/API/AbstractBridge.php

Doc Comments +5 added lines, -1 removed lines

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

Unused Use Statements -1 removed lines

@@ -4,7 +4,6 @@
 
 use Exception;
 use GroupByInc\API\Util\SerializerFactory;
-use GroupByInc\API\Util\UriBuilder;
 use Httpful\Mime;
 use Httpful\Request;
 use Httpful\Response;

src/API/Query.php

Doc Comments +3 added lines

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

Unused Use Statements -1 removed lines

@@ -16,7 +16,6 @@
 use GroupByInc\API\Request\RefinementsRequest;
 use GroupByInc\API\Request\Request;
 use GroupByInc\API\Request\RestrictNavigation;
-use GroupByInc\API\Request\SelectedRefinement;
 use GroupByInc\API\Request\SelectedRefinementRange;
 use GroupByInc\API\Request\SelectedRefinementValue;
 use GroupByInc\API\Request\Sort as RSort;

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];

Unused Use Statements -1 removed lines

@@ -4,7 +4,6 @@
 
 use GroupByInc\API\Model\Navigation;
 use GroupByInc\API\Model\Refinement\Type;
-use GroupByInc\API\Model\SelectedRefinement;
 use GroupByInc\API\Model\SelectedRefinementValue;
 use GroupByInc\API\Query;
 use GroupByInc\API\Symbol;

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/Url/UrlReplacementRule.php

Unused Use Statements -1 removed lines

@@ -3,7 +3,6 @@
 namespace GroupByInc\API\Url;
 
 use GroupByInc\API\Util\StringBuilder;
-use GroupByInc\API\Model\SelectedRefinement;
 
 class UrlReplacementRule
 {

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) {