Add conventions around PHP code in the project (#68)

* Add convention tests over packages definitions

* Add conventions around classes docblocks

* Add conventions around public method docblocks

Author: yann-eugone

composer.json

@@ -22,7 +22,10 @@
     "psr/container": "^1.0",
     "psr/event-dispatcher": "^1.0",
     "psr/log": "^1.0|^2.0|^3.0",
+    "symfony/config": "^5.0|^6.0",
     "symfony/console": "^5.0|^6.0",
+    "symfony/dependency-injection": "^5.0|^6.0",
+    "symfony/http-kernel": "^5.0|^6.0",
     "symfony/framework-bundle": "^5.0|^6.0",
     "symfony/messenger": "^5.0|^6.0",
     "symfony/serializer": "^5.0|^6.0",
@@ -45,6 +48,7 @@
     "yokai/batch-doctrine-dbal": "self.version",
     "yokai/batch-doctrine-orm": "self.version",
     "yokai/batch-doctrine-persistence": "self.version",
+    "yokai/batch-flysystem": "self.version",
     "yokai/batch-symfony-console": "self.version",
     "yokai/batch-symfony-framework": "self.version",
     "yokai/batch-symfony-messenger": "self.version",

src/batch-box-spout/src/Reader/HeaderStrategy.php

@@ -75,6 +75,8 @@ public function setHeaders(array $headers): bool
     }
 
     /**
+     * Build the associative item, a combination of headers and values.
+     *
      * @throws InvalidRowSizeException
      *
      * @phpstan-param array<int, string> $row

src/batch-box-spout/src/Reader/Options/SheetFilter.php

@@ -55,6 +55,8 @@ public static function nameIs(string $name, string ...$names): self
     }
 
     /**
+     * Iterate over valid sheets for the provided filter.
+     *
      * @return Generator&SheetInterface[]
      * @phpstan-return Generator<SheetInterface>
      * @internal

src/batch-box-spout/src/Writer/WriteToSheetItem.php

@@ -21,13 +21,18 @@ private function __construct(
     }
 
     /**
+     * Static constructor from array data.
+     *
      * @param array<int|string, mixed> $item
      */
     public static function array(string $sheet, array $item, Style $style = null): self
     {
         return new self($sheet, WriterEntityFactory::createRowFromArray($item, $style));
     }
 
+    /**
+     * Static constructor from {@see Row} object.
+     */
     public static function row(string $sheet, Row $item): self
     {
         return new self($sheet, $item);

src/batch-doctrine-dbal/composer.json

@@ -14,6 +14,7 @@
         "php": "^8.0",
         "ext-json": "*",
         "doctrine/dbal": "^2.11",
+        "doctrine/persistence": "^2.0",
         "yokai/batch": "^0.4.0"
     },
     "autoload": {

src/batch-doctrine-dbal/src/DoctrineDBALJobExecutionStorage.php

@@ -17,9 +17,14 @@
 use Yokai\Batch\Exception\JobExecutionNotFoundException;
 use Yokai\Batch\Exception\RuntimeException;
 use Yokai\Batch\JobExecution;
+use Yokai\Batch\Storage\JobExecutionStorageInterface;
 use Yokai\Batch\Storage\Query;
 use Yokai\Batch\Storage\QueryableJobExecutionStorageInterface;
 
+/**
+ * This {@see JobExecutionStorageInterface} will store
+ * {@see JobExecution} in an SQL database using doctrine/dbal.
+ */
 final class DoctrineDBALJobExecutionStorage implements QueryableJobExecutionStorageInterface
 {
     private const DEFAULT_OPTIONS = [
@@ -46,6 +51,9 @@ public function __construct(ConnectionRegistry $doctrine, array $options)
         $this->connection = $connection;
     }
 
+    /**
+     * Create required table for this storage.
+     */
     public function createSchema(): void
     {
         $assetFilter = $this->connection->getConfiguration()->getSchemaAssetsFilter();

src/batch-doctrine-dbal/src/JobExecutionRowNormalizer.php

@@ -27,6 +27,8 @@ public function __construct(
     }
 
     /**
+     * Convert a {@see JobExecution} object to a row data array.
+     *
      * @phpstan-return array<string, mixed>
      */
     public function toRow(JobExecution $jobExecution): array
@@ -47,6 +49,8 @@ public function toRow(JobExecution $jobExecution): array
     }
 
     /**
+     * Convert a row data array to a {@see JobExecution} object.
+     *
      * @phpstan-param array<string, mixed> $data
      */
     public function fromRow(array $data, JobExecution $parent = null): JobExecution
@@ -97,7 +101,7 @@ public function fromRow(array $data, JobExecution $parent = null): JobExecution
     /**
      * @phpstan-return array<string, mixed>
      */
-    public function toChildRow(JobExecution $jobExecution): array
+    private function toChildRow(JobExecution $jobExecution): array
     {
         return [
             'job_name' => $jobExecution->getJobName(),

src/batch-doctrine-orm/composer.json

@@ -13,6 +13,7 @@
     "require": {
         "php": "^8.0",
         "doctrine/orm": "^2.8",
+        "doctrine/persistence": "^2.0",
         "yokai/batch": "^0.4.0"
     },
     "autoload": {

src/batch-symfony-console/src/CommandRunner.php

@@ -7,6 +7,9 @@
 use Symfony\Component\Console\Input\ArrayInput;
 use Symfony\Component\Process\PhpExecutableFinder;
 
+/**
+ * Utility class that knows how to run command asynchronously.
+ */
 class CommandRunner
 {
     private string $consolePath;
@@ -25,6 +28,8 @@ public function __construct(
     }
 
     /**
+     * Run a command asynchronously.
+     *
      * @phpstan-param array<string, mixed> $arguments
      */
     public function runAsync(string $commandName, string $logFilename, array $arguments = []): void

src/batch-symfony-console/src/RunCommandJobLauncher.php

@@ -13,7 +13,7 @@
 /**
  * This {@see JobLauncherInterface} will execute job via an asynchronous symfony command.
  *
- * Example, if you call {@see RunCommandJobLauncher::launch('import', ['foo'=>'bar'])},
+ * Example, if you call RunCommandJobLauncher::launch('import', ['foo'=>'bar']),
  * this command will run (with absolute pathes) :
  *
  *      php bin/console yokai:batch:run import '{"foo":"bar"}' >> var/log/batch_execute.log 2>&1 &