limoncello-php-dist / flute

src/Adapters/ModelQueryBuilder.php

Doc Comments +7 added lines, -7 removed lines

@@ -123,7 +123,7 @@ 
     }
 
     /**
-     * @param iterable $attributes
+     * @param Generator $attributes
      *
      * @return self
      *
@@ -152,7 +152,7 @@ 
     }
 
     /**
-     * @param iterable $attributes
+     * @param Generator $attributes
      *
      * @return self
      *
@@ -234,7 +234,7 @@ 
     }
 
     /**
-     * @param iterable $filters
+     * @param \Limoncello\Flute\Api\iterable|null $filters
      *
      * @return self
      */
@@ -244,7 +244,7 @@ 
     }
 
     /**
-     * @param iterable $filters
+     * @param \Limoncello\Flute\Api\iterable|null $filters
      *
      * @return self
      */
@@ -254,7 +254,7 @@ 
     }
 
     /**
-     * @param iterable $filters
+     * @param \Limoncello\Flute\Api\iterable|null $filters
      *
      * @return self
      */
@@ -299,7 +299,7 @@ 
 
     /**
      * @param string        $relationshipName
-     * @param iterable      $relationshipFilters
+     * @param \Limoncello\Flute\Api\iterable|null      $relationshipFilters
      * @param iterable|null $relationshipSorts
      *
      * @return self
@@ -320,7 +320,7 @@ 
     }
 
     /**
-     * @param iterable $sortParameters
+     * @param \Limoncello\Flute\Api\iterable|null $sortParameters
      *
      * @return self
      */

Spacing +11 added lines, -11 removed lines

@@ -274,7 +274,7 @@ 
         string $relationshipName,
         iterable $relationshipFilters,
         ?iterable $relationshipSorts
-    ): self {
+    ) : self {
         $joinWith = $this->expr()->andX();
 
         return $this->addRelationshipFiltersAndSorts(
@@ -308,7 +308,7 @@ 
         string $relationshipName,
         iterable $relationshipFilters,
         ?iterable $relationshipSorts
-    ): self {
+    ) : self {
         $joinWith = $this->expr()->orX();
 
         return $this->addRelationshipFiltersAndSorts(
@@ -371,7 +371,7 @@ 
         CompositeExpression $filterLink,
         iterable $relationshipFilters,
         ?iterable $relationshipSorts
-    ): self {
+    ) : self {
         $relationshipType = $this->getModelSchemes()->getRelationshipType($this->getModelClass(), $relationshipName);
         switch ($relationshipType) {
             case RelationshipTypes::BELONGS_TO:
@@ -444,7 +444,7 @@ 
         CompositeExpression $filterLink,
         iterable $relationshipFilters,
         ?iterable $relationshipSorts
-    ): self {
+    ) : self {
         $foreignKey = $this->getModelSchemes()->getForeignKey($this->getModelClass(), $relationshipName);
         list($onePrimaryKey, $oneTable) =
             $this->getModelSchemes()->getReversePrimaryKey($this->getModelClass(), $relationshipName);
@@ -476,7 +476,7 @@ 
         CompositeExpression $filterLink,
         iterable $relationshipFilters,
         ?iterable $relationshipSorts
-    ): self {
+    ) : self {
         $primaryKey = $this->getModelSchemes()->getPrimaryKey($this->getModelClass());
         list($manyForeignKey, $manyTable) =
             $this->getModelSchemes()->getReverseForeignKey($this->getModelClass(), $relationshipName);
@@ -508,7 +508,7 @@ 
         CompositeExpression $targetFilterLink,
         iterable $relationshipFilters,
         ?iterable $relationshipSorts
-    ): self {
+    ) : self {
         $primaryKey = $this->getModelSchemes()->getPrimaryKey($this->getModelClass());
         list ($intermediateTable, $intermediatePk, $intermediateFk) =
             $this->getModelSchemes()->getBelongsToManyRelationship($this->getModelClass(), $relationshipName);
@@ -556,9 +556,9 @@ 
         ?CompositeExpression $targetFilterLink,
         ?iterable $targetFilterParams,
         ?iterable $relationshipSorts
-    ): string {
+    ) : string {
         $targetAlias   = $this->createAlias($targetTable);
-        $joinCondition = $this->buildColumnName($fromAlias, $fromColumn) . '=' .
+        $joinCondition = $this->buildColumnName($fromAlias, $fromColumn).'='.
             $this->buildColumnName($targetAlias, $targetColumn);
 
         $this->innerJoin(
@@ -617,7 +617,7 @@ 
         ?CompositeExpression $targetFilterLink,
         ?iterable $targetFilterParams,
         ?iterable $targetSortParams
-    ): string {
+    ) : string {
         $intNoSorting = null;
         $intAlias     = $this->innerJoinOneTable(
             $fromAlias,
@@ -628,7 +628,7 @@ 
             $intFilterParams,
             $intNoSorting
         );
-        $targetAlias  = $this->innerJoinOneTable(
+        $targetAlias = $this->innerJoinOneTable(
             $intAlias,
             $intToTargetColumn,
             $targetTable,
@@ -648,7 +648,7 @@ 
      */
     private function createAlias(string $tableName): string
     {
-        $alias                          = $tableName . (++$this->aliasIdCounter);
+        $alias                          = $tableName.(++$this->aliasIdCounter);
         $this->knownAliases[$tableName] = $alias;
 
         return $alias;

src/Api/Crud.php

Doc Comments +6 added lines, -6 removed lines

@@ -615,9 +615,9 @@ 
     }
 
     /**
-     * @param iterable $paths (string[])
+     * @param iterable|null $paths (string[])
      *
-     * @return iterable
+     * @return \Generator
      */
     private static function getPaths(iterable $paths): iterable
     {
@@ -1149,7 +1149,7 @@ 
      * @param null|string $index
      * @param iterable    $attributes
      *
-     * @return iterable
+     * @return \Generator
      */
     protected function filterAttributesOnCreate(?string $index, iterable $attributes): iterable
     {
@@ -1169,7 +1169,7 @@ 
     /**
      * @param iterable $attributes
      *
-     * @return iterable
+     * @return \Generator
      */
     protected function filterAttributesOnUpdate(iterable $attributes): iterable
     {
@@ -1341,10 +1341,10 @@ 
 
     /**
      * @param iterable         $attributes
-     * @param array            $typeNames
+     * @param Type[]            $typeNames
      * @param AbstractPlatform $platform
      *
-     * @return iterable
+     * @return \Generator
      */
     private function readTypedAttributes(iterable $attributes, array $typeNames, AbstractPlatform $platform): iterable
     {

Spacing +14 added lines, -15 removed lines

@@ -635,7 +635,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++;
             }
@@ -772,8 +772,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) {
@@ -851,7 +850,7 @@ 
 
         $this->clearFetchParameters();
 
-        return (int)$deleted;
+        return (int) $deleted;
     }
 
     /**
@@ -872,7 +871,7 @@ 
 
         $this->clearBuilderParameters()->clearFetchParameters();
 
-        $this->inTransaction($saveMain->getConnection(), function () use ($saveMain, $toMany, &$index) {
+        $this->inTransaction($saveMain->getConnection(), function() use ($saveMain, $toMany, &$index) {
             $saveMain->execute();
 
             // if no index given will use last insert ID as index
@@ -888,7 +887,7 @@ 
                         ->prepareCreateInToManyRelationship($relationshipName, $index, $secondaryIdBindName)
                 );
                 foreach ($secondaryIds as $secondaryId) {
-                    $inserted += (int)$saveToMany->setParameter($secondaryIdBindName, $secondaryId)->execute();
+                    $inserted += (int) $saveToMany->setParameter($secondaryIdBindName, $secondaryId)->execute();
                 }
             }
         });
@@ -917,12 +916,12 @@ 
             ->createBuilder($this->getModelClass())
             ->updateModels($allowedChanges)
             ->addFiltersWithAndToTable($filters);
-        $saveMain       = $this->builderSaveResourceOnUpdate($saveMain);
+        $saveMain = $this->builderSaveResourceOnUpdate($saveMain);
         $saveMain->getSQL(); // prepare
 
         $this->clearBuilderParameters()->clearFetchParameters();
 
-        $this->inTransaction($saveMain->getConnection(), function () use ($saveMain, $toMany, $index, &$updated) {
+        $this->inTransaction($saveMain->getConnection(), function() use ($saveMain, $toMany, $index, &$updated) {
             $updated = $saveMain->execute();
 
             foreach ($toMany as $relationshipName => $secondaryIds) {
@@ -942,12 +941,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;
     }
 
     /**
@@ -1050,7 +1049,7 @@ 
     public function fetchRow(
         QueryBuilder $builder = null,
         string $modelClass = null
-    ): ?array {
+    ): ? array {
         if ($builder === null && $modelClass === null) {
             $builder    = $this->getIndexModelBuilder();
             $modelClass = $builder->getModelClass();
@@ -1151,7 +1150,7 @@ 
      *
      * @return iterable
      */
-    protected function filterAttributesOnCreate(?string $index, iterable $attributes): iterable
+    protected function filterAttributesOnCreate(?string $index, iterable $attributes) : iterable
     {
         if ($index !== null) {
             $pkName = $this->getModelSchemes()->getPrimaryKey($this->getModelClass());
@@ -1210,7 +1209,7 @@ 
         $pkName = $this->getModelSchemes()->getPrimaryKey($parentClass);
 
         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) =
@@ -1231,7 +1230,7 @@ 
                             [$pkName => [FilterParameterInterface::OPERATION_EQUALS => [$parent->{$pkName}]]],
                             []
                         );
-                        $child         = $deDup->register($this->fetchResourceWithoutRelationships(
+                        $child = $deDup->register($this->fetchResourceWithoutRelationships(
                             $clonedBuilder,
                             $clonedBuilder->getModelClass()
                         ));
@@ -1252,7 +1251,7 @@ 
                             [$pkName => [FilterParameterInterface::OPERATION_EQUALS => [$parent->{$pkName}]]],
                             []
                         );
-                        $children      = $this->fetchPaginatedResourcesWithoutRelationships(
+                        $children = $this->fetchPaginatedResourcesWithoutRelationships(
                             $clonedBuilder,
                             $clonedBuilder->getModelClass()
                         );

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/Contracts/Http/Query/QueryParserInterface.php

Doc Comments +1 added lines, -1 removed lines

@@ -42,7 +42,7 @@
     public function areFiltersWithAnd(): bool;
 
     /**
-     * @return iterable
+     * @return \Generator
      */
     public function getFilters(): iterable;
 

src/Http/Query/BaseQueryParser.php

Doc Comments +3 added lines, -3 removed lines

@@ -132,7 +132,7 @@ 
      * @param string|mixed $shouldBeString
      * @param string       $separator
      *
-     * @return iterable
+     * @return \Generator
      */
     protected function splitString(string $paramName, $shouldBeString, string $separator): iterable
     {
@@ -150,7 +150,7 @@ 
      * @param string|mixed $shouldBeString
      * @param string       $separator
      *
-     * @return iterable
+     * @return \Generator
      */
     protected function splitStringAndCheckNoEmpties(string $paramName, $shouldBeString, string $separator): iterable
     {
@@ -168,7 +168,7 @@ 
      * @param string       $paramName
      * @param string|mixed $shouldBeString
      *
-     * @return iterable
+     * @return \Generator
      */
     protected function splitCommaSeparatedStringAndCheckNoEmpties(string $paramName, $shouldBeString): iterable
     {

Spacing +3 added lines, -3 removed lines

@@ -48,7 +48,7 @@ 
     public function __construct(array $parameters = [], array $messages = null)
     {
         $this->setParameters($parameters);
-        $this->messages   = $messages;
+        $this->messages = $messages;
     }
 
     /**
@@ -69,13 +69,13 @@ 
     public function getIncludes(): iterable
     {
         if (array_key_exists(static::PARAM_INCLUDE, $this->getParameters()) === true) {
-            $splitByDot = function (string $path): iterable {
+            $splitByDot = function(string $path): iterable {
                 foreach ($this->splitStringAndCheckNoEmpties(static::PARAM_INCLUDE, $path, '.') as $link) {
                     yield $link;
                 }
             };
 
-            $includes   = $this->getParameters()[static::PARAM_INCLUDE];
+            $includes = $this->getParameters()[static::PARAM_INCLUDE];
             foreach ($this->splitCommaSeparatedStringAndCheckNoEmpties(static::PARAM_INCLUDE, $includes) as $path) {
                 yield $path => $splitByDot($path);
             }

src/Http/Query/ParametersMapper.php

Doc Comments +1 added lines, -1 removed lines

@@ -408,7 +408,7 @@
      * @param string   $parameterName
      * @param iterable $value
      *
-     * @return iterable
+     * @return Generator
      */
     private function parseOperationsAndArguments(string $parameterName, iterable $value): iterable
     {

Spacing +4 added lines, -4 removed lines

@@ -245,7 +245,7 @@ 
     public function getMappedIncludes(): iterable
     {
         $fromScheme        = $this->getRootScheme();
-        $getMappedRelLinks = function (iterable $links) use ($fromScheme) : iterable {
+        $getMappedRelLinks = function(iterable $links) use ($fromScheme) : iterable {
             foreach ($links as $link) {
                 assert(is_string($link));
                 $fromSchemaClass = get_class($fromScheme);
@@ -289,14 +289,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 {
+        $mappedIncludes = $this->getMappedIncludes();
+        $getIncludes = function() use ($mappedIncludes, $includeAsModelNames) : iterable {
             foreach ($mappedIncludes as $relationships) {
                 yield $includeAsModelNames($relationships);
             }

src/Http/Query/QueryParser.php

Doc Comments +1 added lines, -1 removed lines

@@ -264,7 +264,7 @@
      * @param string $parameterName
      * @param array  $value
      *
-     * @return iterable
+     * @return Generator
      */
     private function parseOperationsAndArguments(string $parameterName, array $value): iterable
     {

src/Http/BaseController.php

Spacing +5 added lines, -5 removed lines

@@ -138,7 +138,7 @@ 
         ContainerInterface $container,
         ServerRequestInterface $request
     ): ResponseInterface {
-        $jsonData  = static::normalizeIndexValueOnUpdate(
+        $jsonData = static::normalizeIndexValueOnUpdate(
             $routeParams,
             $container,
             static::readJsonFromRequest($container, $request)
@@ -235,7 +235,7 @@ 
      */
     protected static function readJsonFromRequest(ContainerInterface $container, ServerRequestInterface $request): array
     {
-        $body = (string)$request->getBody();
+        $body = (string) $request->getBody();
         if (empty($body) === true || ($json = json_decode($body, true)) === null) {
             /** @var FactoryInterface $factory */
             $factory = $container->get(FactoryInterface::class);
@@ -365,7 +365,7 @@ 
     {
         assert(
             empty(static::ON_CREATE_VALIDATION_RULES_SET_CLASS) === false,
-            'Validation rules set should be defined for class ' . static::class . '.'
+            'Validation rules set should be defined for class '.static::class.'.'
         );
 
         return static::createJsonApiValidator($container, static::ON_CREATE_VALIDATION_RULES_SET_CLASS);
@@ -380,7 +380,7 @@ 
     {
         assert(
             empty(static::ON_UPDATE_VALIDATION_RULES_SET_CLASS) === false,
-            'Validation rules set should be defined for class ' . static::class . '.'
+            'Validation rules set should be defined for class '.static::class.'.'
         );
 
         return static::createJsonApiValidator($container, static::ON_UPDATE_VALIDATION_RULES_SET_CLASS);
@@ -519,7 +519,7 @@ 
         $mapper = static::createParameterMapper($container);
         $api    = static::createApi($container);
 
-        $relData    = $mapper->applyQueryParameters($parser, $api)
+        $relData = $mapper->applyQueryParameters($parser, $api)
             ->withFilters([$modelClass::FIELD_ID => [FilterParameterInterface::OPERATION_EQUALS => [$index]]])
             ->readRelationship($relationshipName);
 

src/Contracts/Api/CrudInterface.php

Spacing +1 added lines, -1 removed lines

@@ -118,7 +118,7 @@
      *
      * @return array|null
      */
-    public function fetchRow(QueryBuilder $builder = null, string $modelClass = null): ?array;
+    public function fetchRow(QueryBuilder $builder = null, string $modelClass = null): ? array;
 
     /**
      * @return PaginatedDataInterface