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/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 +23 added lines, -23 removed lines

@@ -212,7 +212,7 @@ 
             throw new InvalidArgumentException($this->getMessage(Messages::MSG_ERR_INVALID_ARGUMENT));
         }
 
-        assert(call_user_func(function () use ($indexes) {
+        assert(call_user_func(function() use ($indexes) {
             $allOk = true;
 
             foreach ($indexes as $index) {
@@ -764,7 +764,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,
@@ -852,7 +852,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++;
             }
@@ -1021,7 +1021,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
@@ -1039,7 +1039,7 @@ 
         if ($this->hasFilters() === true) {
             $filters = $this->getFilters();
             $sorts   = $this->getSorts();
-            $joinCondition = $this->areFiltersWithAnd() === true ? ModelQueryBuilder::AND : ModelQueryBuilder::OR;
+            $joinCondition = $this->areFiltersWithAnd() === true ? ModelQueryBuilder:: AND : ModelQueryBuilder:: OR ;
             $builder->addRelationshipFiltersAndSorts($reverseRelName, $filters, $sorts, $joinCondition);
         }
         // ... and the input filters to actual data we select
@@ -1070,7 +1070,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
@@ -1099,7 +1099,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
@@ -1175,7 +1175,7 @@ 
 
         $this->clearFetchParameters();
 
-        return (int)$deleted;
+        return (int) $deleted;
     }
 
     /**
@@ -1191,7 +1191,7 @@ 
 
         $this->clearFetchParameters();
 
-        return (int)$deleted > 0;
+        return (int) $deleted > 0;
     }
 
     /**
@@ -1216,7 +1216,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
@@ -1257,12 +1257,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();
 
             $builderHook = Closure::fromCallable([$this, 'builderSaveRelationshipOnUpdate']);
@@ -1278,7 +1278,7 @@ 
                 )->execute();
 
                 // add new ones
-                $updated   += $this->addInToManyRelationship(
+                $updated += $this->addInToManyRelationship(
                     $connection,
                     $index,
                     $relationshipName,
@@ -1288,7 +1288,7 @@ 
             }
         });
 
-        return (int)$updated;
+        return (int) $updated;
     }
 
     /**
@@ -1303,9 +1303,9 @@ 
     public function createInBelongsToManyRelationship(string $parentId, string $name, iterable $childIds): int
     {
         // Check that relationship is `BelongsToMany`
-        assert(call_user_func(function () use ($name): bool {
+        assert(call_user_func(function() use ($name): bool {
             $relType = $this->getModelSchemas()->getRelationshipType($this->getModelClass(), $name);
-            $errMsg  = "Relationship `$name` of class `" . $this->getModelClass() .
+            $errMsg  = "Relationship `$name` of class `".$this->getModelClass().
                 '` either is not `belongsToMany` or do not exist in the class.';
             $isOk = $relType === RelationshipTypes::BELONGS_TO_MANY;
 
@@ -1327,9 +1327,9 @@ 
     public function removeInBelongsToManyRelationship(string $parentId, string $name, iterable $childIds): int
     {
         // Check that relationship is `BelongsToMany`
-        assert(call_user_func(function () use ($name): bool {
+        assert(call_user_func(function() use ($name): bool {
             $relType = $this->getModelSchemas()->getRelationshipType($this->getModelClass(), $name);
-            $errMsg  = "Relationship `$name` of class `" . $this->getModelClass() .
+            $errMsg  = "Relationship `$name` of class `".$this->getModelClass().
                 '` either is not `belongsToMany` or do not exist in the class.';
             $isOk = $relType === RelationshipTypes::BELONGS_TO_MANY;
 
@@ -1497,7 +1497,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;
     }
@@ -1529,7 +1529,7 @@ 
 
         foreach ($secondaryIdentities as $secondaryId) {
             try {
-                $inserted += (int)$saveToMany->setParameter($secondaryIdBindName, $secondaryId)->execute();
+                $inserted += (int) $saveToMany->setParameter($secondaryIdBindName, $secondaryId)->execute();
             } /** @noinspection PhpRedundantCatchClauseInspection */ catch (UcvException $exception) {
                 // Spec: If all of the specified resources can be added to, or are already present in,
                 // the relationship then the server MUST return a successful response.
@@ -1776,7 +1776,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,
@@ -1788,7 +1788,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) =
@@ -1843,7 +1843,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/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)
      */

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

src/Package/FluteSettings.php

Spacing +4 added lines, -4 removed lines

@@ -111,10 +111,10 @@
         );
         assert(empty($jsonQueryValFileMask) === false, "Invalid Query Validators file mask `$jsonQueryValFileMask`.");
 
-        $schemasPath         = $schemasFolder . DIRECTORY_SEPARATOR . $schemasFileMask;
-        $jsonDataValPath     = $jsonDataValFolder . DIRECTORY_SEPARATOR . $jsonDataValFileMask;
-        $formsValidatorsPath = $formsValFolder . DIRECTORY_SEPARATOR . $formsValFileMask;
-        $jsonQueryValPath    = $jsonQueryValFolder . DIRECTORY_SEPARATOR . $jsonQueryValFileMask;
+        $schemasPath         = $schemasFolder.DIRECTORY_SEPARATOR.$schemasFileMask;
+        $jsonDataValPath     = $jsonDataValFolder.DIRECTORY_SEPARATOR.$jsonDataValFileMask;
+        $formsValidatorsPath = $formsValFolder.DIRECTORY_SEPARATOR.$formsValFileMask;
+        $jsonQueryValPath    = $jsonQueryValFolder.DIRECTORY_SEPARATOR.$jsonQueryValFileMask;
 
         $requireUniqueTypes = $defaults[static::KEY_SCHEMAS_REQUIRE_UNIQUE_TYPES] ?? true;
 

src/Http/JsonApiBaseController.php

Spacing +2 added lines, -2 removed lines

@@ -208,7 +208,7 @@ 
         static::assertClassValueDefined(static::SCHEMA_CLASS);
 
         $api     = static::defaultCreateApi($container, static::API_CLASS);
-        $handler = function () use ($api, $index, $modelRelName) {
+        $handler = function() use ($api, $index, $modelRelName) {
             return $api->readRelationship($index, $modelRelName);
         };
 
@@ -248,7 +248,7 @@ 
         static::assertClassValueDefined(static::SCHEMA_CLASS);
 
         $api     = static::defaultCreateApi($container, static::API_CLASS);
-        $handler = function () use ($api, $index, $modelRelName) {
+        $handler = function() use ($api, $index, $modelRelName) {
             return $api->readRelationship($index, $modelRelName);
         };
 

src/Validation/JsonApi/Rules/ToManyRelationshipTypeCheckerRule.php

Spacing +1 added lines, -2 removed lines

@@ -71,8 +71,7 @@
         }
 
         $reply = $foundInvalidType === null ?
-            static::createSuccessReply($indexes) :
-            static::createErrorReply($context, $foundInvalidType, ErrorCodes::INVALID_RELATIONSHIP_TYPE);
+            static::createSuccessReply($indexes) : static::createErrorReply($context, $foundInvalidType, ErrorCodes::INVALID_RELATIONSHIP_TYPE);
 
         return $reply;
     }

src/Validation/JsonApi/Rules/IsReadableViaApiRule.php

Spacing +1 added lines, -2 removed lines

@@ -76,7 +76,6 @@
         $result = !empty($data);
 
         return $result === true ?
-            static::createSuccessReply($value) :
-            static::createErrorReply($context, $value, ErrorCodes::EXIST_IN_DATABASE_SINGLE);
+            static::createSuccessReply($value) : static::createErrorReply($context, $value, ErrorCodes::EXIST_IN_DATABASE_SINGLE);
     }
 }

src/Validation/JsonApi/Rules/UniqueInDbTableSingleWithDoctrineRule.php

Spacing +1 added lines, -2 removed lines

@@ -81,8 +81,7 @@
         }
 
         $reply = $count <= 0 ?
-            static::createSuccessReply($value) :
-            static::createErrorReply($context, $value, ErrorCodes::UNIQUE_IN_DATABASE_SINGLE);
+            static::createSuccessReply($value) : static::createErrorReply($context, $value, ErrorCodes::UNIQUE_IN_DATABASE_SINGLE);
 
         return $reply;
     }