[TASK] Clean up code with CS fixer

cobwebch · Dec 6, 2024 · 23e3c1e · 23e3c1e
1 parent 26b1905
commit 23e3c1e
Show file tree

Hide file tree

Showing 5 changed files with 33 additions and 40 deletions.
diff --git a/ChangeLog b/ChangeLog
@@ -1,3 +1,7 @@
+2024-12-06 Francois Suter (Idéative)  <[email protected]>
+
+    * Automate documentation and code linting
+
 2024-12-02 Francois Suter (Idéative)  <[email protected]>
 
     * Clean up and improve documentation

diff --git a/Classes/Database/DoctrineDbalConnection.php b/Classes/Database/DoctrineDbalConnection.php
@@ -35,15 +35,14 @@ class DoctrineDbalConnection
      *
      * @param array $parameters Parameters needed to connect to the database
      * @throws DatabaseConnectionException
-     * @return void
      * @throws QueryErrorException
      */
     public function connect(array $parameters = []): void
     {
         $configuration = new Configuration();
         if (array_key_exists('uri', $parameters)) {
             $connectionParameters = [
-                'url' => $parameters['uri']
+                'url' => $parameters['uri'],
             ];
         } else {
             $connectionParameters = [
@@ -52,37 +51,36 @@ public function connect(array $parameters = []): void
                 'password' => $parameters['password'],
                 'host' => $parameters['server'],
                 'driver' => $parameters['driver'] ?? null,
-                'driverClass' => $parameters['driverClass'] ?? null
+                'driverClass' => $parameters['driverClass'] ?? null,
             ];
         }
         try {
             $this->connection = DriverManager::getConnection(
-                    $connectionParameters,
-                    $configuration
+                $connectionParameters,
+                $configuration
             );
         } catch (\Exception $e) {
             // Throw unified exception
             throw new DatabaseConnectionException(
-                    sprintf(
-                            'Database connection failed (%s)',
-                            $e->getMessage()
-                    ),
-                    1491062456
+                sprintf(
+                    'Database connection failed (%s)',
+                    $e->getMessage()
+                ),
+                1491062456
             );
         }
 
         // Execute connection initialization if defined
         if (!empty($parameters['init'])) {
             try {
                 $this->connection->executeQuery($parameters['init']);
-            }
-            catch (\Throwable $e) {
+            } catch (\Throwable $e) {
                 throw new QueryErrorException(
-                        sprintf(
-                            'Failled executing "init" statement (%s)',
-                            $e->getMessage()
-                        ),
-                        1491379532
+                    sprintf(
+                        'Failled executing "init" statement (%s)',
+                        $e->getMessage()
+                    ),
+                    1491379532
                 );
             }
         }
@@ -101,14 +99,13 @@ public function query(string $sql, int $fetchMode = \PDO::FETCH_ASSOC): array
     {
         try {
             $result = $this->connection->executeQuery($sql);
-        }
-        catch (\Exception $e) {
+        } catch (\Exception $e) {
             throw new QueryErrorException(
-                    sprintf(
-                        'Failled executing query (%s)',
-                        $e->getMessage()
-                    ),
-                    1491379701
+                sprintf(
+                    'Failled executing query (%s)',
+                    $e->getMessage()
+                ),
+                1491379701
             );
         }
 
@@ -118,4 +115,4 @@ public function query(string $sql, int $fetchMode = \PDO::FETCH_ASSOC): array
             default => $result->fetchAllAssociative(),
         };
     }
-}
+}
diff --git a/Classes/Exception/DatabaseConnectionException.php b/Classes/Exception/DatabaseConnectionException.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace Cobweb\SvconnectorSql\Exception;
 
 /*
@@ -18,10 +19,5 @@
 
 /**
  * Exception to be thrown when failing to connect to a DBMS.
- *
- * @package Cobweb\SvconnectorSql\Exception
  */
-class DatabaseConnectionException extends SourceErrorException
-{
-
-}
+class DatabaseConnectionException extends SourceErrorException {}
diff --git a/Classes/Exception/QueryErrorException.php b/Classes/Exception/QueryErrorException.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace Cobweb\SvconnectorSql\Exception;
 
 /*
@@ -18,10 +19,5 @@
 
 /**
  * Exception to be thrown when a SQL query fails.
- *
- * @package Cobweb\SvconnectorSql\Exception
  */
-class QueryErrorException extends SourceErrorException
-{
-
-}
+class QueryErrorException extends SourceErrorException {}
diff --git a/Classes/Service/ConnectorSql.php b/Classes/Service/ConnectorSql.php
@@ -22,10 +22,10 @@
 use Cobweb\Svconnector\Event\ProcessRawDataEvent;
 use Cobweb\Svconnector\Event\ProcessResponseEvent;
 use Cobweb\Svconnector\Event\ProcessXmlDataEvent;
-use Cobweb\SvconnectorSql\Exception\DatabaseConnectionException;
-use Cobweb\SvconnectorSql\Exception\QueryErrorException;
 use Cobweb\Svconnector\Service\ConnectorBase;
 use Cobweb\SvconnectorSql\Database\DoctrineDbalConnection;
+use Cobweb\SvconnectorSql\Exception\DatabaseConnectionException;
+use Cobweb\SvconnectorSql\Exception\QueryErrorException;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
@@ -39,7 +39,7 @@ class ConnectorSql extends ConnectorBase
     /**
      * Verifies that the connection is functional
      * In this case it always is, as the connection can really be tested only for specific configurations
-     * @return boolean TRUE if the service is available
+     * @return bool TRUE if the service is available
      */
     public function isAvailable(): bool
     {