From 45aa4438527ef1ec84c1fca1355c53a5857a1e69 Mon Sep 17 00:00:00 2001
From: Vincent Langlet <vincentlanglet@hotmail.fr>
Date: Tue, 13 Feb 2024 15:06:13 +0100
Subject: [PATCH] Enforce literal string for connection execute methods

---
 extension.neon                                |  5 ++
 .../Doctrine/StubFilesExtensionLoader.php     |  1 +
 stubs/DBAL/Cache/CacheException.stub          | 10 +++
 stubs/DBAL/Cache/QueryCacheProfile.stub       |  8 +++
 stubs/DBAL/Connection.stub                    |  8 +++
 stubs/DBAL/Exception.stub                     |  8 +++
 .../UniqueConstraintViolationException.stub   |  4 +-
 stubs/DBAL/Result.stub                        |  8 +++
 stubs/DBAL/Types/Type.stub                    |  7 ++
 stubs/bleedingEdge/DBAL/Connection.stub       | 64 +++++++++++++++++++
 10 files changed, 122 insertions(+), 1 deletion(-)
 create mode 100644 stubs/DBAL/Cache/CacheException.stub
 create mode 100644 stubs/DBAL/Cache/QueryCacheProfile.stub
 create mode 100644 stubs/DBAL/Connection.stub
 create mode 100644 stubs/DBAL/Exception.stub
 create mode 100644 stubs/DBAL/Result.stub
 create mode 100644 stubs/DBAL/Types/Type.stub
 create mode 100644 stubs/bleedingEdge/DBAL/Connection.stub

diff --git a/extension.neon b/extension.neon
index c83e8c0c..01b69199 100644
--- a/extension.neon
+++ b/extension.neon
@@ -19,7 +19,12 @@ parameters:
 			- Doctrine\ORM\Tools\Pagination\Paginator
 	stubFiles:
 		- stubs/Criteria.stub
+		- stubs/DBAL/Cache/CacheException.stub
+		- stubs/DBAL/Cache/QueryCacheProfile.stub
 		- stubs/DBAL/Exception/UniqueConstraintViolationException.stub
+		- stubs/DBAL/Types/Type.stub
+		- stubs/DBAL/Exception.stub
+		- stubs/DBAL/Result.stub
 		- stubs/DocumentManager.stub
 		- stubs/DocumentRepository.stub
 		- stubs/EntityManager.stub
diff --git a/src/Stubs/Doctrine/StubFilesExtensionLoader.php b/src/Stubs/Doctrine/StubFilesExtensionLoader.php
index 1b1b4162..422f71da 100644
--- a/src/Stubs/Doctrine/StubFilesExtensionLoader.php
+++ b/src/Stubs/Doctrine/StubFilesExtensionLoader.php
@@ -35,6 +35,7 @@ public function getFiles(): array
 		}
 
 		$files = [
+			$path . '/DBAL/Connection.stub',
 			$path . '/ORM/QueryBuilder.stub',
 			$path . '/EntityRepository.stub',
 		];
diff --git a/stubs/DBAL/Cache/CacheException.stub b/stubs/DBAL/Cache/CacheException.stub
new file mode 100644
index 00000000..3c0249cd
--- /dev/null
+++ b/stubs/DBAL/Cache/CacheException.stub
@@ -0,0 +1,10 @@
+<?php
+
+namespace Doctrine\DBAL\Cache;
+
+use Doctrine\DBAL\Exception;
+
+class CacheException extends Exception
+{
+
+}
diff --git a/stubs/DBAL/Cache/QueryCacheProfile.stub b/stubs/DBAL/Cache/QueryCacheProfile.stub
new file mode 100644
index 00000000..100593a8
--- /dev/null
+++ b/stubs/DBAL/Cache/QueryCacheProfile.stub
@@ -0,0 +1,8 @@
+<?php
+
+namespace Doctrine\DBAL\Cache;
+
+class QueryCacheProfile
+{
+
+}
diff --git a/stubs/DBAL/Connection.stub b/stubs/DBAL/Connection.stub
new file mode 100644
index 00000000..8e88410a
--- /dev/null
+++ b/stubs/DBAL/Connection.stub
@@ -0,0 +1,8 @@
+<?php
+
+namespace Doctrine\DBAL;
+
+class Connection
+{
+
+}
diff --git a/stubs/DBAL/Exception.stub b/stubs/DBAL/Exception.stub
new file mode 100644
index 00000000..eef16324
--- /dev/null
+++ b/stubs/DBAL/Exception.stub
@@ -0,0 +1,8 @@
+<?php
+
+namespace Doctrine\DBAL;
+
+class Exception extends \Exception
+{
+
+}
diff --git a/stubs/DBAL/Exception/UniqueConstraintViolationException.stub b/stubs/DBAL/Exception/UniqueConstraintViolationException.stub
index aae74fc8..e10e8c58 100644
--- a/stubs/DBAL/Exception/UniqueConstraintViolationException.stub
+++ b/stubs/DBAL/Exception/UniqueConstraintViolationException.stub
@@ -2,7 +2,9 @@
 
 namespace Doctrine\DBAL\Exception;
 
-class UniqueConstraintViolationException extends \Exception
+use Doctrine\DBAL\Exception;
+
+class UniqueConstraintViolationException extends Exception
 {
 
 }
diff --git a/stubs/DBAL/Result.stub b/stubs/DBAL/Result.stub
new file mode 100644
index 00000000..2a21e2ec
--- /dev/null
+++ b/stubs/DBAL/Result.stub
@@ -0,0 +1,8 @@
+<?php
+
+namespace Doctrine\DBAL;
+
+class Result
+{
+
+}
diff --git a/stubs/DBAL/Types/Type.stub b/stubs/DBAL/Types/Type.stub
new file mode 100644
index 00000000..8cff69c9
--- /dev/null
+++ b/stubs/DBAL/Types/Type.stub
@@ -0,0 +1,7 @@
+<?php
+
+namespace Doctrine\DBAL\Types;
+
+abstract class Type
+{
+}
diff --git a/stubs/bleedingEdge/DBAL/Connection.stub b/stubs/bleedingEdge/DBAL/Connection.stub
new file mode 100644
index 00000000..6bb4a01d
--- /dev/null
+++ b/stubs/bleedingEdge/DBAL/Connection.stub
@@ -0,0 +1,64 @@
+<?php
+
+namespace Doctrine\DBAL;
+
+use Doctrine\DBAL\Cache\CacheException;
+use Doctrine\DBAL\Cache\QueryCacheProfile;
+use Doctrine\DBAL\Types\Type;
+
+class Connection
+{
+    /**
+     * Executes an SQL statement with the given parameters and returns the number of affected rows.
+     *
+     * Could be used for:
+     *  - DML statements: INSERT, UPDATE, DELETE, etc.
+     *  - DDL statements: CREATE, DROP, ALTER, etc.
+     *  - DCL statements: GRANT, REVOKE, etc.
+     *  - Session control statements: ALTER SESSION, SET, DECLARE, etc.
+     *  - Other statements that don't yield a row set.
+     *
+     * This method supports PDO binding types as well as DBAL mapping types.
+     *
+     * @param literal-string                                                       $sql    SQL statement
+     * @param list<mixed>|array<string, mixed>                                     $params Statement parameters
+     * @param array<int, int|string|Type|null>|array<string, int|string|Type|null> $types  Parameter types
+     *
+     * @return int|string The number of affected rows.
+     *
+     * @throws Exception
+     */
+    public function executeStatement($sql, array $params = [], array $types = []);
+
+    /**
+     * Executes an, optionally parameterized, SQL query.
+     *
+     * If the query is parametrized, a prepared statement is used.
+     * If an SQLLogger is configured, the execution is logged.
+     *
+     * @param literal-string                                                       $sql    SQL query
+     * @param list<mixed>|array<string, mixed>                                     $params Query parameters
+     * @param array<int, int|string|Type|null>|array<string, int|string|Type|null> $types  Parameter types
+     *
+     * @throws Exception
+     */
+    public function executeQuery(
+        string $sql,
+        array $params = [],
+        $types = [],
+        ?QueryCacheProfile $qcp = null
+    ): Result;
+
+    /**
+     * Executes a caching query.
+     *
+     * @param literal-string                                                       $sql    SQL query
+     * @param list<mixed>|array<string, mixed>                                     $params Query parameters
+     * @param array<int, int|string|Type|null>|array<string, int|string|Type|null> $types  Parameter types
+     *
+     * @throws CacheException
+     * @throws Exception
+     */
+    public function executeCacheQuery($sql, $params, $types, QueryCacheProfile $qcp): Result;
+
+}