limoncello-php-dist / flute

src/Contracts/Http/Query/ParametersMapperInterface.php

Doc Comments +3 added lines, -3 removed lines

@@ -52,17 +52,17 @@
     public function withIncludes(iterable $includes): self;
 
     /**
-     * @return iterable
+     * @return \Generator
      */
     public function getMappedFilters(): iterable;
 
     /**
-     * @return iterable
+     * @return \Generator
      */
     public function getMappedSorts(): iterable;
 
     /**
-     * @return iterable
+     * @return \Generator
      */
     public function getMappedIncludes(): iterable;
 

src/Adapters/ModelQueryBuilder.php

Doc Comments +8 added lines, -8 removed lines

@@ -171,7 +171,7 @@ 
     }
 
     /**
-     * @param iterable $attributes
+     * @param \Generator $attributes
      *
      * @return self
      *
@@ -193,7 +193,7 @@ 
     }
 
     /**
-     * @param iterable $attributes
+     * @param \Generator $attributes
      *
      * @return self
      *
@@ -216,7 +216,7 @@ 
      * @param string   $modelClass
      * @param iterable $attributes
      *
-     * @return iterable
+     * @return \Generator
      *
      * @SuppressWarnings(PHPMD.StaticAccess)
      *
@@ -315,7 +315,7 @@ 
     }
 
     /**
-     * @param iterable $filters
+     * @param \Limoncello\Flute\Api\iterable|null $filters
      *
      * @return self
      *
@@ -331,7 +331,7 @@ 
     }
 
     /**
-     * @param iterable $filters
+     * @param \Limoncello\Flute\Api\iterable|null $filters
      *
      * @return self
      *
@@ -347,7 +347,7 @@ 
     }
 
     /**
-     * @param iterable $filters
+     * @param \Limoncello\Flute\Api\iterable|null $filters
      *
      * @return self
      *
@@ -391,7 +391,7 @@ 
 
     /**
      * @param string        $relationshipName
-     * @param iterable      $relationshipFilters
+     * @param \Limoncello\Flute\Api\iterable|null      $relationshipFilters
      * @param iterable|null $relationshipSorts
      *
      * @return self
@@ -417,7 +417,7 @@ 
     }
 
     /**
-     * @param iterable $sortParameters
+     * @param \Limoncello\Flute\Api\iterable|null $sortParameters
      *
      * @return self
      */

src/Api/Crud.php

Doc Comments +7 added lines, -7 removed lines

@@ -756,9 +756,9 @@ 
     }
 
     /**
-     * @param iterable $paths (string[])
+     * @param iterable|null $paths (string[])
      *
-     * @return iterable
+     * @return Generator
      */
     private static function getPaths(iterable $paths): iterable
     {
@@ -1399,7 +1399,7 @@ 
      * @param string       $modelClass
      * @param string       $keyColumnName
      *
-     * @return iterable
+     * @return Generator
      *
      * @throws DBALException
      *
@@ -1503,7 +1503,7 @@ 
      * @param null|string $index
      * @param iterable    $attributes
      *
-     * @return iterable
+     * @return Generator
      */
     protected function filterAttributesOnCreate(?string $index, iterable $attributes): iterable
     {
@@ -1523,7 +1523,7 @@ 
     /**
      * @param iterable $attributes
      *
-     * @return iterable
+     * @return Generator
      */
     protected function filterAttributesOnUpdate(iterable $attributes): iterable
     {
@@ -1722,10 +1722,10 @@ 
 
     /**
      * @param iterable         $attributes
-     * @param array            $typeNames
+     * @param Type[]            $typeNames
      * @param AbstractPlatform $platform
      *
-     * @return iterable
+     * @return Generator
      *
      * @throws DBALException
      */

src/Http/Query/ParametersMapper.php

Doc Comments +1 added lines, -1 removed lines

@@ -409,7 +409,7 @@
      * @param string   $parameterName
      * @param iterable $value
      *
-     * @return iterable
+     * @return Generator
      *
      * @SuppressWarnings(PHPMD.CyclomaticComplexity)
      */

src/Validation/JsonApi/QueryParser.php

Doc Comments +12 added lines, -12 removed lines

@@ -379,7 +379,7 @@ 
     }
 
     /**
-     * @return iterable
+     * @return Generator
      *
      * @SuppressWarnings(PHPMD.ElseExpression)
      */
@@ -421,9 +421,9 @@ 
     }
 
     /**
-     * @param iterable $fieldsFromParent
+     * @param Generator $fieldsFromParent
      *
-     * @return iterable
+     * @return Generator
      *
      * @SuppressWarnings(PHPMD.StaticAccess)
      * @SuppressWarnings(PHPMD.ElseExpression)
@@ -456,9 +456,9 @@ 
     }
 
     /**
-     * @param iterable $sortsFromParent
+     * @param Generator $sortsFromParent
      *
-     * @return iterable
+     * @return Generator
      *
      * @SuppressWarnings(PHPMD.StaticAccess)
      * @SuppressWarnings(PHPMD.ElseExpression)
@@ -488,9 +488,9 @@ 
     }
 
     /**
-     * @param iterable $includesFromParent
+     * @param Generator $includesFromParent
      *
-     * @return iterable
+     * @return Generator
      *
      * @SuppressWarnings(PHPMD.StaticAccess)
      * @SuppressWarnings(PHPMD.ElseExpression)
@@ -520,7 +520,7 @@ 
     }
 
     /**
-     * @param iterable $iterable
+     * @param Generator $iterable
      *
      * @return array
      */
@@ -683,7 +683,7 @@ 
      * @param int      $ruleIndex
      * @param iterable $values
      *
-     * @return iterable
+     * @return Generator
      */
     private function validateValues(int $ruleIndex, iterable $values): iterable
     {
@@ -698,9 +698,9 @@ 
 
     /**
      * @param int      $ruleIndex
-     * @param iterable $opsAndArgs
+     * @param Generator $opsAndArgs
      *
-     * @return iterable
+     * @return Generator
      */
     private function validateFilterArguments(int $ruleIndex, iterable $opsAndArgs): iterable
     {
@@ -858,7 +858,7 @@ 
      * @param string $parameterName
      * @param array  $value
      *
-     * @return iterable
+     * @return Generator
      *
      * @SuppressWarnings(PHPMD.ElseExpression)
      */

src/Contracts/Models/TagStorageInterface.php

Indentation +14 added lines, -14 removed lines

@@ -1,20 +1,20 @@
 <?php namespace Limoncello\Flute\Contracts\Models;
 
     /**
- * Copyright 2015-2018 info@neomerx.com
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
+     * Copyright 2015-2018 info@neomerx.com
+     *
+     * Licensed under the Apache License, Version 2.0 (the "License");
+     * you may not use this file except in compliance with the License.
+     * You may obtain a copy of the License at
+     *
+     * http://www.apache.org/licenses/LICENSE-2.0
+     *
+     * Unless required by applicable law or agreed to in writing, software
+     * distributed under the License is distributed on an "AS IS" BASIS,
+     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+     * See the License for the specific language governing permissions and
+     * limitations under the License.
+     */
 
 /**
  * @package Limoncello\Flute

src/Contracts/Models/PaginatedDataInterface.php

Indentation +14 added lines, -14 removed lines

@@ -1,20 +1,20 @@
 <?php namespace Limoncello\Flute\Contracts\Models;
 
     /**
- * Copyright 2015-2018 info@neomerx.com
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
+     * Copyright 2015-2018 info@neomerx.com
+     *
+     * Licensed under the Apache License, Version 2.0 (the "License");
+     * you may not use this file except in compliance with the License.
+     * You may obtain a copy of the License at
+     *
+     * http://www.apache.org/licenses/LICENSE-2.0
+     *
+     * Unless required by applicable law or agreed to in writing, software
+     * distributed under the License is distributed on an "AS IS" BASIS,
+     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+     * See the License for the specific language governing permissions and
+     * limitations under the License.
+     */
 
 /**
  * @package Limoncello\Flute

src/Contracts/Models/ModelStorageInterface.php

Indentation +14 added lines, -14 removed lines

@@ -1,20 +1,20 @@
 <?php namespace Limoncello\Flute\Contracts\Models;
 
     /**
- * Copyright 2015-2018 info@neomerx.com
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
+     * Copyright 2015-2018 info@neomerx.com
+     *
+     * Licensed under the Apache License, Version 2.0 (the "License");
+     * you may not use this file except in compliance with the License.
+     * You may obtain a copy of the License at
+     *
+     * http://www.apache.org/licenses/LICENSE-2.0
+     *
+     * Unless required by applicable law or agreed to in writing, software
+     * distributed under the License is distributed on an "AS IS" BASIS,
+     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+     * See the License for the specific language governing permissions and
+     * limitations under the License.
+     */
 
 /**
  * @package Limoncello\Flute

src/Contracts/Api/CrudInterface.php

Doc Comments +2 added lines, -2 removed lines

@@ -120,7 +120,7 @@ 
     public function fetchResources(QueryBuilder $builder, string $modelClass): PaginatedDataInterface;
 
     /**
-     * @param QueryBuilder|null $builder
+     * @param QueryBuilder $builder
      * @param string|null       $modelClass
      *
      * @return mixed|null
@@ -140,7 +140,7 @@ 
      * @param string       $modelClass
      * @param string       $columnName
      *
-     * @return iterable
+     * @return \Generator
      */
     public function fetchColumn(QueryBuilder $builder, string $modelClass, string $columnName): iterable;