limoncello-php-dist / flute

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/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/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/Http/BaseController.php

Spacing +2 added lines, -2 removed lines

@@ -208,7 +208,7 @@ 
         static::assertClassValueDefined(static::SCHEMA_CLASS);
 
         $api     = static::createApi($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::createApi($container, static::API_CLASS);
-        $handler = function () use ($api, $index, $modelRelName) {
+        $handler = function() use ($api, $index, $modelRelName) {
             return $api->readRelationship($index, $modelRelName);
         };
 

src/Http/Traits/DefaultControllerMethodsTrait.php

Spacing +4 added lines, -4 removed lines

@@ -166,7 +166,7 @@ 
             $queryParser->hasIncludes() === true ? array_keys($queryParser->getIncludes()) : null,
             $queryParser->hasFields() === true ? $queryParser->getFields() : null
         );
-        $responses      = static::createResponses($requestUri, $provider, $jsonSchemes, $encoder, $encodingParams);
+        $responses = static::createResponses($requestUri, $provider, $jsonSchemes, $encoder, $encodingParams);
 
         $noData   = $relData === null || ($relData instanceof PaginatedDataInterface && $relData->getData() === null);
         $response = $noData === true ? $responses->getCodeResponse(404) : $responses->getContentResponse($relData);
@@ -207,7 +207,7 @@ 
             $queryParser->hasIncludes() === true ? array_keys($queryParser->getIncludes()) : null,
             $queryParser->hasFields() === true ? $queryParser->getFields() : null
         );
-        $responses      = static::createResponses($requestUri, $provider, $jsonSchemes, $encoder, $encodingParams);
+        $responses = static::createResponses($requestUri, $provider, $jsonSchemes, $encoder, $encodingParams);
 
         $noData   = $relData === null || ($relData instanceof PaginatedDataInterface && $relData->getData() === null);
         $response = $noData === true ? $responses->getCodeResponse(404) : $responses->getIdentifiersResponse($relData);
@@ -665,7 +665,7 @@ 
      */
     protected 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.'`.');
     }
 
     /**
@@ -678,7 +678,7 @@ 
     {
         assert(
             array_key_exists($interface, class_implements($class)) === true,
-            "Class `$class` should implement `" . $interface . '` interface.'
+            "Class `$class` should implement `".$interface.'` interface.'
         );
     }
 }

src/Package/FluteContainerConfigurator.php

Spacing +7 added lines, -7 removed lines

@@ -50,18 +50,18 @@ 
 
         $container[FactoryInterface::class] = $factory;
 
-        $container[JsonSchemesInterface::class] = function (PsrContainerInterface $container) use ($factory) {
+        $container[JsonSchemesInterface::class] = function(PsrContainerInterface $container) use ($factory) {
             $settings     = $container->get(SettingsProviderInterface::class)->get(FluteSettings::class);
             $modelSchemes = $container->get(ModelSchemeInfoInterface::class);
 
             return $factory->createJsonSchemes($settings[FluteSettings::KEY_MODEL_TO_SCHEME_MAP], $modelSchemes);
         };
 
-        $container[ParametersMapperInterface::class] = function (PsrContainerInterface $container) {
+        $container[ParametersMapperInterface::class] = function(PsrContainerInterface $container) {
             return new ParametersMapper($container->get(JsonSchemesInterface::class));
         };
 
-        $container[EncoderInterface::class] = function (PsrContainerInterface $container) use ($factory) {
+        $container[EncoderInterface::class] = function(PsrContainerInterface $container) use ($factory) {
             /** @var JsonSchemesInterface $jsonSchemes */
             $jsonSchemes = $container->get(JsonSchemesInterface::class);
             $settings    = $container->get(SettingsProviderInterface::class)->get(FluteSettings::class);
@@ -76,19 +76,19 @@ 
             return $encoder;
         };
 
-        $container[RelationshipPaginationStrategyInterface::class] = function (PsrContainerInterface $container) {
+        $container[RelationshipPaginationStrategyInterface::class] = function(PsrContainerInterface $container) {
             $settings = $container->get(SettingsProviderInterface::class)->get(FluteSettings::class);
 
             return new BasicRelationshipPaginationStrategy($settings[FluteSettings::KEY_DEFAULT_PAGING_SIZE]);
         };
 
-        $container[JsonApiParserFactoryInterface::class] = function (PsrContainerInterface $container) {
+        $container[JsonApiParserFactoryInterface::class] = function(PsrContainerInterface $container) {
             $factory = new JsonApiParserFactory($container);
 
             return $factory;
         };
 
-        $container[FormValidatorFactoryInterface::class] = function (PsrContainerInterface $container) {
+        $container[FormValidatorFactoryInterface::class] = function(PsrContainerInterface $container) {
             $factory = new FormValidatorFactory($container);
 
             return $factory;
@@ -116,7 +116,7 @@ 
      */
     public static function configureExceptionHandler(LimoncelloContainerInterface $container)
     {
-        $container[ThrowableHandlerInterface::class] = function (PsrContainerInterface $container) {
+        $container[ThrowableHandlerInterface::class] = function(PsrContainerInterface $container) {
             /** @var CacheSettingsProviderInterface $provider */
             $provider      = $container->get(CacheSettingsProviderInterface::class);
             $appConfig     = $provider->getApplicationConfiguration();

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`.");
 
-        $schemesPath         = $schemesFolder . DIRECTORY_SEPARATOR . $schemesFileMask;
-        $jsonDataValPath     = $jsonDataValFolder . DIRECTORY_SEPARATOR . $jsonDataValFileMask;
-        $formsValidatorsPath = $formsValFolder . DIRECTORY_SEPARATOR . $formsValFileMask;
-        $jsonQueryValPath    = $jsonQueryValFolder . DIRECTORY_SEPARATOR . $jsonQueryValFileMask;
+        $schemesPath         = $schemesFolder.DIRECTORY_SEPARATOR.$schemesFileMask;
+        $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/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/Api/Crud.php

Spacing +18 added lines, -19 removed lines

@@ -688,7 +688,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,
@@ -776,7 +776,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++;
             }
@@ -933,7 +933,7 @@ 
     ): ModelQueryBuilder {
         assert(
             $this->getModelSchemes()->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
@@ -952,8 +952,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) {
@@ -981,7 +980,7 @@ 
     ) {
         assert(
             $this->getModelSchemes()->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
@@ -1008,7 +1007,7 @@ 
     ): array {
         assert(
             $this->getModelSchemes()->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
@@ -1082,7 +1081,7 @@ 
 
         $this->clearFetchParameters();
 
-        return (int)$deleted;
+        return (int) $deleted;
     }
 
     /**
@@ -1096,7 +1095,7 @@ 
 
         $this->clearFetchParameters();
 
-        return (int)$deleted > 0;
+        return (int) $deleted > 0;
     }
 
     /**
@@ -1117,7 +1116,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
@@ -1133,7 +1132,7 @@ 
                         ->prepareCreateInToManyRelationship($relationshipName, $index, $secondaryIdBindName)
                 );
                 foreach ($secondaryIds as $secondaryId) {
-                    $inserted += (int)$saveToMany->setParameter($secondaryIdBindName, $secondaryId)->execute();
+                    $inserted += (int) $saveToMany->setParameter($secondaryIdBindName, $secondaryId)->execute();
                 }
             }
         });
@@ -1162,12 +1161,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) {
@@ -1187,12 +1186,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;
     }
 
     /**
@@ -1343,7 +1342,7 @@ 
     {
         $countBuilder = $this->getConnection()->createQueryBuilder();
         $countBuilder->setParameters($builder->getParameters());
-        $countBuilder->select('COUNT(*)')->from('(' . $builder->getSQL() . ') AS RESULT');
+        $countBuilder->select('COUNT(*)')->from('('.$builder->getSQL().') AS RESULT');
 
         return $countBuilder;
     }
@@ -1554,7 +1553,7 @@ 
 
         $pkName = $this->getModelSchemes()->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,
@@ -1566,7 +1565,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->getModelSchemes()->getRelationshipType($parentClass, $name);
             list ($targetModelClass, $reverseRelName) =
@@ -1616,7 +1615,7 @@ 
                             [$pkName => [FilterParameterInterface::OPERATION_EQUALS => [$parent->{$pkName}]]],
                             []
                         );
-                        $children      = $this->fetchPaginatedResourcesWithoutRelationships(
+                        $children = $this->fetchPaginatedResourcesWithoutRelationships(
                             $clonedBuilder,
                             $clonedBuilder->getModelClass()
                         );