limoncello-php-dist / flute

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
      */

Spacing +3 added lines, -3 removed lines

@@ -639,7 +639,7 @@ 
         string $targetColumn
     ): string {
         $targetAlias   = $this->createAlias($targetTable);
-        $joinCondition = $this->buildColumnName($fromAlias, $fromColumn) . '=' .
+        $joinCondition = $this->buildColumnName($fromAlias, $fromColumn).'='.
             $this->buildColumnName($targetAlias, $targetColumn);
 
         $this->innerJoin(
@@ -685,7 +685,7 @@ 
      */
     private function createAlias(string $tableName): string
     {
-        $alias                          = $tableName . (++$this->aliasIdCounter);
+        $alias                          = $tableName.(++$this->aliasIdCounter);
         $this->knownAliases[$tableName] = $alias;
 
         return $alias;
@@ -850,7 +850,7 @@ 
         } else {
             assert(
                 $value !== null,
-                'It seems you are trying to use `null` with =, >, <, or etc operator. ' .
+                'It seems you are trying to use `null` with =, >, <, or etc operator. '.
                 'Use `is null` or `not null` instead.'
             );
             assert(is_string($value), "Only strings, booleans and integers are supported.");

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
      */

Spacing +18 added lines, -19 removed lines

@@ -689,7 +689,7 @@ 
             $classAtPath = new ArrayObject();
             $idsAtPath   = new ArrayObject();
 
-            $registerModelAtRoot = function ($model) use ($modelStorage, $modelsAtPath, $idsAtPath): void {
+            $registerModelAtRoot = function($model) use ($modelStorage, $modelsAtPath, $idsAtPath): void {
                 self::registerModelAtPath(
                     $model,
                     static::ROOT_PATH,
@@ -777,7 +777,7 @@ 
                 assert(is_string($pathPiece));
                 $parent                    = $tmpPath;
                 $tmpPath                   = empty($tmpPath) === true ?
-                    $pathPiece : $tmpPath . static::PATH_SEPARATOR . $pathPiece;
+                    $pathPiece : $tmpPath.static::PATH_SEPARATOR.$pathPiece;
                 $normalizedPaths[$tmpPath] = [$parent, $pathPiece];
                 $pathsDepths[$parent]      = $parentDepth++;
             }
@@ -934,7 +934,7 @@ 
     ): ModelQueryBuilder {
         assert(
             $this->getModelSchemas()->hasRelationship($this->getModelClass(), $relationshipName),
-            "Relationship `$relationshipName` do not exist in model `" . $this->getModelClass() . '`'
+            "Relationship `$relationshipName` do not exist in model `".$this->getModelClass().'`'
         );
 
         // as we read data from a relationship our main table and model would be the table/model in the relationship
@@ -953,8 +953,7 @@ 
             $filters = $this->getFilters();
             $sorts   = $this->getSorts();
             $this->areFiltersWithAnd() ?
-                $builder->addRelationshipFiltersAndSortsWithAnd($reverseRelName, $filters, $sorts) :
-                $builder->addRelationshipFiltersAndSortsWithOr($reverseRelName, $filters, $sorts);
+                $builder->addRelationshipFiltersAndSortsWithAnd($reverseRelName, $filters, $sorts) : $builder->addRelationshipFiltersAndSortsWithOr($reverseRelName, $filters, $sorts);
         }
         // ... and the input filters to actual data we select
         if ($relationshipFilters !== null) {
@@ -982,7 +981,7 @@ 
     ) {
         assert(
             $this->getModelSchemas()->hasRelationship($this->getModelClass(), $name),
-            "Relationship `$name` do not exist in model `" . $this->getModelClass() . '`'
+            "Relationship `$name` do not exist in model `".$this->getModelClass().'`'
         );
 
         // depending on the relationship type we expect the result to be either single resource or a collection
@@ -1009,7 +1008,7 @@ 
     ): array {
         assert(
             $this->getModelSchemas()->hasRelationship($this->getModelClass(), $name),
-            "Relationship `$name` do not exist in model `" . $this->getModelClass() . '`'
+            "Relationship `$name` do not exist in model `".$this->getModelClass().'`'
         );
 
         // depending on the relationship type we expect the result to be either single resource or a collection
@@ -1083,7 +1082,7 @@ 
 
         $this->clearFetchParameters();
 
-        return (int)$deleted;
+        return (int) $deleted;
     }
 
     /**
@@ -1097,7 +1096,7 @@ 
 
         $this->clearFetchParameters();
 
-        return (int)$deleted > 0;
+        return (int) $deleted > 0;
     }
 
     /**
@@ -1118,7 +1117,7 @@ 
 
         $this->clearBuilderParameters()->clearFetchParameters();
 
-        $this->inTransaction(function () use ($saveMain, $toMany, &$index) {
+        $this->inTransaction(function() use ($saveMain, $toMany, &$index) {
             $saveMain->execute();
 
             // if no index given will use last insert ID as index
@@ -1134,7 +1133,7 @@ 
                         ->prepareCreateInToManyRelationship($relationshipName, $index, $secondaryIdBindName)
                 );
                 foreach ($secondaryIds as $secondaryId) {
-                    $inserted += (int)$saveToMany->setParameter($secondaryIdBindName, $secondaryId)->execute();
+                    $inserted += (int) $saveToMany->setParameter($secondaryIdBindName, $secondaryId)->execute();
                 }
             }
         });
@@ -1163,12 +1162,12 @@ 
             ->createBuilder($this->getModelClass())
             ->updateModels($allowedChanges)
             ->addFiltersWithAndToTable($filters);
-        $saveMain       = $this->builderSaveResourceOnUpdate($saveMain);
+        $saveMain = $this->builderSaveResourceOnUpdate($saveMain);
         $saveMain->getSQL(); // prepare
 
         $this->clearBuilderParameters()->clearFetchParameters();
 
-        $this->inTransaction(function () use ($saveMain, $toMany, $index, &$updated) {
+        $this->inTransaction(function() use ($saveMain, $toMany, $index, &$updated) {
             $updated = $saveMain->execute();
 
             foreach ($toMany as $relationshipName => $secondaryIds) {
@@ -1188,12 +1187,12 @@ 
                         ->prepareCreateInToManyRelationship($relationshipName, $index, $secondaryIdBindName)
                 );
                 foreach ($secondaryIds as $secondaryId) {
-                    $updated += (int)$saveToMany->setParameter($secondaryIdBindName, $secondaryId)->execute();
+                    $updated += (int) $saveToMany->setParameter($secondaryIdBindName, $secondaryId)->execute();
                 }
             }
         });
 
-        return (int)$updated;
+        return (int) $updated;
     }
 
     /**
@@ -1344,7 +1343,7 @@ 
     {
         $countBuilder = $this->createBuilder($this->getModelClass());
         $countBuilder->setParameters($builder->getParameters());
-        $countBuilder->select('COUNT(*)')->from('(' . $builder->getSQL() . ') AS RESULT');
+        $countBuilder->select('COUNT(*)')->from('('.$builder->getSQL().') AS RESULT');
 
         return $countBuilder;
     }
@@ -1555,7 +1554,7 @@ 
 
         $pkName = $this->getModelSchemas()->getPrimaryKey($parentClass);
 
-        $registerModelAtPath = function ($model, string $path) use ($deDup, $modelsAtPath, $idsAtPath) {
+        $registerModelAtPath = function($model, string $path) use ($deDup, $modelsAtPath, $idsAtPath) {
             return self::registerModelAtPath(
                 $model,
                 $path,
@@ -1567,7 +1566,7 @@ 
         };
 
         foreach ($childRelationships as $name) {
-            $childrenPath = $parentsPath !== static::ROOT_PATH ? $parentsPath . static::PATH_SEPARATOR . $name : $name;
+            $childrenPath = $parentsPath !== static::ROOT_PATH ? $parentsPath.static::PATH_SEPARATOR.$name : $name;
 
             $relationshipType = $this->getModelSchemas()->getRelationshipType($parentClass, $name);
             list ($targetModelClass, $reverseRelName) =
@@ -1617,7 +1616,7 @@ 
                             [$pkName => [FilterParameterInterface::OPERATION_EQUALS => [$parent->{$pkName}]]],
                             []
                         );
-                        $children      = $this->fetchPaginatedResourcesWithoutRelationships(
+                        $children = $this->fetchPaginatedResourcesWithoutRelationships(
                             $clonedBuilder,
                             $clonedBuilder->getModelClass()
                         );

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)
      */

Spacing +3 added lines, -3 removed lines

@@ -246,7 +246,7 @@ 
     public function getMappedIncludes(): iterable
     {
         $fromSchema        = $this->getRootSchema();
-        $getMappedRelLinks = function (iterable $links) use ($fromSchema) : iterable {
+        $getMappedRelLinks = function(iterable $links) use ($fromSchema) : iterable {
             foreach ($links as $link) {
                 assert(is_string($link));
                 $fromSchemaClass = get_class($fromSchema);
@@ -296,14 +296,14 @@ 
         //     ['rel2_name1', ],
         //     ['rel3_name1', 'rel3_name2', 'rel3_name3', ],
         // ]
-        $includeAsModelNames = function (iterable $relationships): iterable {
+        $includeAsModelNames = function(iterable $relationships): iterable {
             foreach ($relationships as $relationship) {
                 assert($relationship instanceof RelationshipInterface);
                 yield $relationship->getNameInModel();
             }
         };
         $mappedIncludes      = $this->getMappedIncludes();
-        $getIncludes         = function () use ($mappedIncludes, $includeAsModelNames) : iterable {
+        $getIncludes         = function() use ($mappedIncludes, $includeAsModelNames) : iterable {
             foreach ($mappedIncludes as $relationships) {
                 yield $includeAsModelNames($relationships);
             }

src/Contracts/Api/CrudInterface.php

Doc Comments +4 added lines, -4 removed lines

@@ -108,7 +108,7 @@ 
     public function fetchResources(QueryBuilder $builder, string $modelClass): PaginatedDataInterface;
 
     /**
-     * @param QueryBuilder|null $builder
+     * @param QueryBuilder $builder
      * @param string|null       $modelClass
      *
      * @return mixed|null
@@ -128,7 +128,7 @@ 
      * @param string       $modelClass
      * @param string       $columnName
      *
-     * @return iterable
+     * @return \Generator
      */
     public function fetchColumn(QueryBuilder $builder, string $modelClass, string $columnName): iterable;
 
@@ -226,9 +226,9 @@ 
     );
 
     /**
-     * @param int|string $parentId
+     * @param string $parentId
      * @param string     $name
-     * @param int|string $childId
+     * @param string $childId
      *
      * @return bool
      */

src/Contracts/Validation/JsonApiQueryRulesSerializerInterface.php

Doc Comments +2 added lines, -2 removed lines

@@ -168,7 +168,7 @@ 
      *
      * @param array $ruleIndexes
      *
-     * @return array
+     * @return integer[]
      */
     public static function readRuleStartIndexes(array $ruleIndexes): array;
 
@@ -177,7 +177,7 @@ 
      *
      * @param array $ruleIndexes
      *
-     * @return array
+     * @return integer[]
      */
     public static function readRuleEndIndexes(array $ruleIndexes): array;
 }

src/Encoder/Encoder.php

Spacing +2 added lines, -2 removed lines

@@ -125,7 +125,7 @@ 
 
         parse_str($this->getOriginalUri()->getQuery(), $queryParams);
 
-        return function ($offset) use ($pageSize, $queryParams) {
+        return function($offset) use ($pageSize, $queryParams) {
             $paramsWithPaging = array_merge($queryParams, [
                 BaseQueryParserInterface::PARAM_PAGE => [
                     JsonApiQueryValidatingParserInterface::PARAM_PAGING_OFFSET => $offset,
@@ -133,7 +133,7 @@ 
                 ],
             ]);
             $newUri           = $this->getOriginalUri()->withQuery(http_build_query($paramsWithPaging));
-            $fullUrl          = (string)$newUri;
+            $fullUrl          = (string) $newUri;
             $link             = $this->getFactory()->createLink($fullUrl, null, true);
 
             return $link;

src/Validation/JsonApi/QueryParser.php

Spacing +3 added lines, -3 removed lines

@@ -155,7 +155,7 @@ 
     ) {
         assert(
             in_array(JsonApiQueryRulesSerializerInterface::class, class_implements($serializerClass)),
-            "`$serializerClass` should implement interface `" . JsonApiQueryRulesSerializerInterface::class . '`.'
+            "`$serializerClass` should implement interface `".JsonApiQueryRulesSerializerInterface::class.'`.'
         );
 
         $parameters = [];
@@ -571,7 +571,7 @@ 
     {
         // no validation rule means we should accept any input value
         if ($ruleIndexes === null) {
-            return is_numeric($value) === true ? (int)$value : 0;
+            return is_numeric($value) === true ? (int) $value : 0;
         }
 
         $ruleIndex = $this->serializerClass::readRuleMainIndex($ruleIndexes);
@@ -582,7 +582,7 @@ 
 
         $validatedValue = $this->readSingleCapturedValue();
 
-        return (int)$validatedValue;
+        return (int) $validatedValue;
     }
 
     /**

Doc Comments +9 added lines, -9 removed lines

@@ -448,7 +448,7 @@ 
     }
 
     /**
-     * @return iterable
+     * @return Generator
      *
      * @SuppressWarnings(PHPMD.ElseExpression)
      */
@@ -495,7 +495,7 @@ 
     /**
      * @param iterable $fieldsFromParent
      *
-     * @return iterable
+     * @return Generator
      *
      * @SuppressWarnings(PHPMD.StaticAccess)
      * @SuppressWarnings(PHPMD.ElseExpression)
@@ -530,7 +530,7 @@ 
     /**
      * @param iterable $sortsFromParent
      *
-     * @return iterable
+     * @return Generator
      *
      * @SuppressWarnings(PHPMD.StaticAccess)
      * @SuppressWarnings(PHPMD.ElseExpression)
@@ -562,7 +562,7 @@ 
     /**
      * @param iterable $includesFromParent
      *
-     * @return iterable
+     * @return Generator
      *
      * @SuppressWarnings(PHPMD.StaticAccess)
      * @SuppressWarnings(PHPMD.ElseExpression)
@@ -592,7 +592,7 @@ 
     }
 
     /**
-     * @param iterable $iterable
+     * @param Generator $iterable
      *
      * @return array
      */
@@ -755,7 +755,7 @@ 
      * @param int      $ruleIndex
      * @param iterable $values
      *
-     * @return iterable
+     * @return Generator
      */
     private function validateValues(int $ruleIndex, iterable $values): iterable
     {
@@ -770,9 +770,9 @@ 
 
     /**
      * @param int      $ruleIndex
-     * @param iterable $opsAndArgs
+     * @param Generator $opsAndArgs
      *
-     * @return iterable
+     * @return Generator
      */
     private function validateFilterArguments(int $ruleIndex, iterable $opsAndArgs): iterable
     {
@@ -936,7 +936,7 @@ 
      * @param string $parameterName
      * @param array  $value
      *
-     * @return iterable
+     * @return Generator
      *
      * @SuppressWarnings(PHPMD.ElseExpression)
      */

src/Schema/Schema.php

Spacing +2 added lines, -2 removed lines

@@ -212,12 +212,12 @@
             return [static::DATA => $data->getData()];
         }
 
-        $buildUrl = function ($offset) use ($data, $uri) {
+        $buildUrl = function($offset) use ($data, $uri) {
             $paramsWithPaging = [
                 JsonApiQueryValidatingParserInterface::PARAM_PAGING_OFFSET => $offset,
                 JsonApiQueryValidatingParserInterface::PARAM_PAGING_LIMIT  => $data->getLimit(),
             ];
-            $fullUrl          = $uri . '?' . http_build_query($paramsWithPaging);
+            $fullUrl = $uri.'?'.http_build_query($paramsWithPaging);
 
             return $fullUrl;
         };

src/Http/Traits/DefaultControllerMethodsTrait.php

Doc Comments +1 added lines, -1 removed lines

@@ -269,7 +269,7 @@
      * @param FactoryInterface                     $errorFactory
      * @param FormatterFactoryInterface            $formatterFactory
      *
-     * @return ResponseInterface
+     * @return string
      */
     protected static function defaultCreate(
         string $requestBody,

Spacing +2 added lines, -2 removed lines

@@ -792,7 +792,7 @@ 
      */
     private static function assertClassValueDefined(?string $value): void
     {
-        assert(empty($value) === false, 'Value should be defined in `' . static::class . '`.');
+        assert(empty($value) === false, 'Value should be defined in `'.static::class.'`.');
     }
 
     /**
@@ -805,7 +805,7 @@ 
     {
         assert(
             array_key_exists($interface, class_implements($class)) === true,
-            "Class `$class` should implement `" . $interface . '` interface.'
+            "Class `$class` should implement `".$interface.'` interface.'
         );
     }
 }