neomerx / json-api

src/Exceptions/JsonApiException.php

Doc Comments +1 added lines, -1 removed lines

@@ -54,7 +54,7 @@
     private $httpCode;
 
     /**
-     * @param ErrorInterface|iterable $errors
+     * @param ErrorInterface $errors
      * @param int                     $httpCode
      * @param Exception|null          $previous
      *

src/Representation/FieldSetFilter.php

Doc Comments +1 added lines, -1 removed lines

@@ -117,7 +117,7 @@
      * @param string   $type
      * @param iterable $fields
      *
-     * @return iterable
+     * @return \Generator
      */
     protected function filterFields(string $type, iterable $fields): iterable
     {

src/Representation/ErrorWriter.php

Indentation +1 added lines, -1 removed lines

@@ -51,7 +51,7 @@
             DocumentInterface::KEYWORD_ERRORS_TITLE  => $error->getTitle(),
             DocumentInterface::KEYWORD_ERRORS_DETAIL => $error->getDetail(),
             DocumentInterface::KEYWORD_ERRORS_SOURCE => $error->getSource(),
-         ]);
+            ]);
 
         if ($error->hasMeta() === true) {
             $representation[DocumentInterface::KEYWORD_ERRORS_META] = $error->getMeta();

src/Parser/RelationshipData/ParseRelationshipLinksTrait.php

Doc Comments +1 added lines, -1 removed lines

@@ -84,7 +84,7 @@
      * @param bool            $addSelfLink
      * @param bool            $addRelatedLink
      *
-     * @return iterable
+     * @return \Generator
      */
     private function parseLinks(
         SchemaInterface $parentSchema,

src/Parser/Parser.php

Doc Comments +3 added lines, -3 removed lines

@@ -188,7 +188,7 @@ 
      * @see ResourceInterface
      * @see IdentifierInterface
      *
-     * @return iterable
+     * @return \Generator
      */
     private function parseAsResourcesOrIdentifiers(
         PositionInterface $position,
@@ -212,7 +212,7 @@ 
      *
      * @see ResourceInterface
      *
-     * @return iterable
+     * @return \Generator
      *
      */
     private function parseAsResource(
@@ -233,7 +233,7 @@ 
     /**
      * @param ResourceInterface $resource
      *
-     * @return iterable
+     * @return \Generator
      *
      * @SuppressWarnings(PHPMD.CyclomaticComplexity)
      */

src/Http/Query/BaseQueryParserTrait.php

Doc Comments +9 added lines, -9 removed lines

@@ -32,7 +32,7 @@ 
      * @param array  $parameters
      * @param string $errorTitle
      *
-     * @return iterable
+     * @return \Generator
      */
     protected function getIncludes(array $parameters, string $errorTitle): iterable
     {
@@ -49,7 +49,7 @@ 
      * @param array  $parameters
      * @param string $errorTitle
      *
-     * @return iterable
+     * @return \Generator
      */
     protected function getIncludePaths(array $parameters, string $errorTitle): iterable
     {
@@ -64,7 +64,7 @@ 
      * @param array  $parameters
      * @param string $errorTitle
      *
-     * @return iterable
+     * @return \Generator
      */
     protected function getFields(array $parameters, string $errorTitle): iterable
     {
@@ -84,7 +84,7 @@ 
      * @param array  $parameters
      * @param string $errorTitle
      *
-     * @return iterable
+     * @return \Generator
      */
     protected function getSorts(array $parameters, string $errorTitle): iterable
     {
@@ -116,7 +116,7 @@ 
      * @param array  $parameters
      * @param string $errorTitle
      *
-     * @return iterable
+     * @return \Generator
      */
     protected function getProfileUrls(array $parameters, string $errorTitle): iterable
     {
@@ -136,7 +136,7 @@ 
      * @param string|mixed $shouldBeString
      * @param string       $errorTitle
      *
-     * @return iterable
+     * @return \Generator
      */
     private function splitCommaSeparatedStringAndCheckNoEmpties(
         string $paramName,
@@ -148,10 +148,10 @@ 
 
     /**
      * @param string       $paramName
-     * @param string|mixed $shouldBeString
+     * @param string $shouldBeString
      * @param string       $errorTitle
      *
-     * @return iterable
+     * @return \Generator
      */
     private function splitSpaceSeparatedStringAndCheckNoEmpties(
         string $paramName,
@@ -167,7 +167,7 @@ 
      * @param string       $separator
      * @param string       $errorTitle
      *
-     * @return iterable
+     * @return \Generator
      *
      * @SuppressWarnings(PHPMD.IfStatementAssignment)
      */