limoncello-php-dist / flute

src/Adapters/ModelQueryBuilder.php

Doc Comments +8 added lines, -8 removed lines

@@ -128,7 +128,7 @@ 
     }
 
     /**
-     * @param iterable $attributes
+     * @param Generator $attributes
      *
      * @return self
      *
@@ -148,7 +148,7 @@ 
     }
 
     /**
-     * @param iterable $attributes
+     * @param Generator $attributes
      *
      * @return self
      *
@@ -169,7 +169,7 @@ 
      * @param string   $modelClass
      * @param iterable $attributes
      *
-     * @return iterable
+     * @return Generator
      *
      * @SuppressWarnings(PHPMD.StaticAccess)
      */
@@ -249,7 +249,7 @@ 
     }
 
     /**
-     * @param iterable $filters
+     * @param \Limoncello\Flute\Api\iterable|null $filters
      *
      * @return self
      */
@@ -259,7 +259,7 @@ 
     }
 
     /**
-     * @param iterable $filters
+     * @param \Limoncello\Flute\Api\iterable|null $filters
      *
      * @return self
      */
@@ -269,7 +269,7 @@ 
     }
 
     /**
-     * @param iterable $filters
+     * @param \Limoncello\Flute\Api\iterable|null $filters
      *
      * @return self
      */
@@ -314,7 +314,7 @@ 
 
     /**
      * @param string        $relationshipName
-     * @param iterable      $relationshipFilters
+     * @param \Limoncello\Flute\Api\iterable|null      $relationshipFilters
      * @param iterable|null $relationshipSorts
      *
      * @return self
@@ -335,7 +335,7 @@ 
     }
 
     /**
-     * @param iterable $sortParameters
+     * @param \Limoncello\Flute\Api\iterable|null $sortParameters
      *
      * @return self
      */

Spacing +12 added lines, -12 removed lines

@@ -289,7 +289,7 @@ 
         string $relationshipName,
         iterable $relationshipFilters,
         ?iterable $relationshipSorts
-    ): self {
+    ) : self {
         $joinWith = $this->expr()->andX();
 
         return $this->addRelationshipFiltersAndSorts(
@@ -323,7 +323,7 @@ 
         string $relationshipName,
         iterable $relationshipFilters,
         ?iterable $relationshipSorts
-    ): self {
+    ) : self {
         $joinWith = $this->expr()->orX();
 
         return $this->addRelationshipFiltersAndSorts(
@@ -386,7 +386,7 @@ 
         CompositeExpression $filterLink,
         iterable $relationshipFilters,
         ?iterable $relationshipSorts
-    ): self {
+    ) : self {
         $relationshipType = $this->getModelSchemes()->getRelationshipType($this->getModelClass(), $relationshipName);
         switch ($relationshipType) {
             case RelationshipTypes::BELONGS_TO:
@@ -459,7 +459,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);
@@ -491,7 +491,7 @@ 
         CompositeExpression $filterLink,
         iterable $relationshipFilters,
         ?iterable $relationshipSorts
-    ): self {
+    ) : self {
         $primaryKey = $this->getModelSchemes()->getPrimaryKey($this->getModelClass());
         list($manyForeignKey, $manyTable) =
             $this->getModelSchemes()->getReverseForeignKey($this->getModelClass(), $relationshipName);
@@ -523,7 +523,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);
@@ -571,9 +571,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(
@@ -632,7 +632,7 @@ 
         ?CompositeExpression $targetFilterLink,
         ?iterable $targetFilterParams,
         ?iterable $targetSortParams
-    ): string {
+    ) : string {
         $intNoSorting = null;
         $intAlias     = $this->innerJoinOneTable(
             $fromAlias,
@@ -643,7 +643,7 @@ 
             $intFilterParams,
             $intNoSorting
         );
-        $targetAlias  = $this->innerJoinOneTable(
+        $targetAlias = $this->innerJoinOneTable(
             $intAlias,
             $intToTargetColumn,
             $targetTable,
@@ -663,7 +663,7 @@ 
      */
     private function createAlias(string $tableName): string
     {
-        $alias                          = $tableName . (++$this->aliasIdCounter);
+        $alias                          = $tableName.(++$this->aliasIdCounter);
         $this->knownAliases[$tableName] = $alias;
 
         return $alias;
@@ -827,7 +827,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 +6 added lines, -6 removed lines

@@ -616,9 +616,9 @@ 
     }
 
     /**
-     * @param iterable $paths (string[])
+     * @param iterable|null $paths (string[])
      *
-     * @return iterable
+     * @return Generator
      */
     private static function getPaths(iterable $paths): iterable
     {
@@ -1230,7 +1230,7 @@ 
      * @param null|string $index
      * @param iterable    $attributes
      *
-     * @return iterable
+     * @return Generator
      */
     protected function filterAttributesOnCreate(?string $index, iterable $attributes): iterable
     {
@@ -1250,7 +1250,7 @@ 
     /**
      * @param iterable $attributes
      *
-     * @return iterable
+     * @return Generator
      */
     protected function filterAttributesOnUpdate(iterable $attributes): iterable
     {
@@ -1422,10 +1422,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

@@ -636,7 +636,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++;
             }
@@ -804,8 +804,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) {
@@ -924,7 +923,7 @@ 
 
         $this->clearFetchParameters();
 
-        return (int)$deleted;
+        return (int) $deleted;
     }
 
     /**
@@ -953,7 +952,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
@@ -969,7 +968,7 @@ 
                         ->prepareCreateInToManyRelationship($relationshipName, $index, $secondaryIdBindName)
                 );
                 foreach ($secondaryIds as $secondaryId) {
-                    $inserted += (int)$saveToMany->setParameter($secondaryIdBindName, $secondaryId)->execute();
+                    $inserted += (int) $saveToMany->setParameter($secondaryIdBindName, $secondaryId)->execute();
                 }
             }
         });
@@ -998,12 +997,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) {
@@ -1023,12 +1022,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;
     }
 
     /**
@@ -1114,7 +1113,7 @@ 
     /**
      * @inheritdoc
      */
-    public function fetchRow(QueryBuilder $builder, string $modelClass): ?array
+    public function fetchRow(QueryBuilder $builder, string $modelClass): ? array
     {
         $statement = $builder->execute();
         $statement->setFetchMode(PDOConnection::FETCH_ASSOC);
@@ -1232,7 +1231,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());
@@ -1291,7 +1290,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) =
@@ -1312,7 +1311,7 @@ 
                             [$pkName => [FilterParameterInterface::OPERATION_EQUALS => [$parent->{$pkName}]]],
                             []
                         );
-                        $child         = $deDup->register($this->fetchResourceWithoutRelationships(
+                        $child = $deDup->register($this->fetchResourceWithoutRelationships(
                             $clonedBuilder,
                             $clonedBuilder->getModelClass()
                         ));
@@ -1333,7 +1332,7 @@ 
                             [$pkName => [FilterParameterInterface::OPERATION_EQUALS => [$parent->{$pkName}]]],
                             []
                         );
-                        $children      = $this->fetchPaginatedResourcesWithoutRelationships(
+                        $children = $this->fetchPaginatedResourcesWithoutRelationships(
                             $clonedBuilder,
                             $clonedBuilder->getModelClass()
                         );

src/Contracts/Api/CrudInterface.php

Doc Comments +3 added lines, -3 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 PaginatedDataInterface
@@ -128,7 +128,7 @@ 
      * @param string       $modelClass
      * @param string       $columnName
      *
-     * @return iterable
+     * @return \Generator
      */
     public function fetchColumn(QueryBuilder $builder, string $modelClass, string $columnName): iterable;
 
@@ -211,7 +211,7 @@ 
     ): array;
 
     /**
-     * @param int|string    $index
+     * @param string    $index
      * @param string        $name
      * @param iterable|null $relationshipFilters
      * @param iterable|null $relationshipSorts

Spacing +1 added lines, -1 removed lines

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

src/Http/BaseController.php

Spacing +5 added lines, -5 removed lines

@@ -92,7 +92,7 @@ 
     ): ResponseInterface {
         list ($index, $api) = static::createImpl($container, $request);
 
-        $data  = $api->read($index)->getData();
+        $data = $api->read($index)->getData();
 
         $response = static::createResponses($container, $request)->getCreatedResponse($data);
 
@@ -237,7 +237,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);
@@ -378,7 +378,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);
@@ -393,7 +393,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);
@@ -601,7 +601,7 @@ 
         ContainerInterface $container,
         ServerRequestInterface $request
     ): array {
-        $jsonData  = static::normalizeIndexValueOnUpdate(
+        $jsonData = static::normalizeIndexValueOnUpdate(
             $routeParams,
             $container,
             static::readJsonFromRequest($container, $request)