neomerx / json-api

src/Contracts/Schema/SchemaFactoryInterface.php

Doc Comments +1 added lines, -1 removed lines

@@ -48,7 +48,7 @@
      * @param SchemaInterface $schema
      * @param object          $resource
      * @param bool            $isInArray
-     * @param array<string,int>|null  $attributeKeysFilter
+     * @param array<string,int>|null  $fieldKeysFilter
      *
      * @return ResourceObjectInterface
      */

src/Schema/ResourceObject.php

Doc Comments +1 added lines, -1 removed lines

@@ -122,7 +122,7 @@
      * @param SchemaInterface $schema
      * @param object          $resource
      * @param bool            $isInArray
-     * @param array<string,int>|null  $attributeKeysFilter
+     * @param array<string,int>|null  $fieldKeysFilter
      *
      * @SuppressWarnings(PHPMD.StaticAccess)
      */

src/Encoder/Parser/Parser.php

Doc Comments +1 added lines, -1 removed lines

@@ -160,7 +160,7 @@
     }
 
     /**
-     * @return iterable
+     * @return \Generator
      *
      * @SuppressWarnings(PHPMD.ElseExpression)
      * @SuppressWarnings(PHPMD.CyclomaticComplexity)

src/Http/Query/BaseQueryParserTrait.php

Doc Comments +5 added lines, -5 removed lines

@@ -30,7 +30,7 @@ 
      * @param array  $parameters
      * @param string $errorTitle
      *
-     * @return iterable
+     * @return \Generator
      */
     protected function getIncludes(array $parameters, string $errorTitle): iterable
     {
@@ -53,7 +53,7 @@ 
      * @param array  $parameters
      * @param string $errorTitle
      *
-     * @return iterable
+     * @return \Generator
      */
     protected function getFields(array $parameters, string $errorTitle): iterable
     {
@@ -73,7 +73,7 @@ 
      * @param array  $parameters
      * @param string $errorTitle
      *
-     * @return iterable
+     * @return \Generator
      */
     protected function getSorts(array $parameters, string $errorTitle): iterable
     {
@@ -106,7 +106,7 @@ 
      * @param string|mixed $shouldBeString
      * @param string       $errorTitle
      *
-     * @return iterable
+     * @return \Generator
      */
     private function splitCommaSeparatedStringAndCheckNoEmpties(
         string $paramName,
@@ -122,7 +122,7 @@ 
      * @param string       $separator
      * @param string       $errorTitle
      *
-     * @return iterable
+     * @return \Generator
      */
     private function splitStringAndCheckNoEmpties(
         string $paramName,

src/Contracts/Encoder/EncoderInterface.php

Doc Comments +1 added lines, -1 removed lines

@@ -132,7 +132,7 @@
     /**
      * Encode errors as JSON API string.
      *
-     * @param ErrorInterface[]|ErrorCollection|iterable $errors
+     * @param ErrorInterface[] $errors
      *
      * @return string
      */