introduce PdoMysqlQueryReflector and deprecate PdoQueryReflector (#370)

Co-authored-by: Markus Staab <[email protected]>

Author: staabm

.gitattributes

@@ -1,12 +1,12 @@
 # mark cache files as generated files, so they don't show up in Pull Requests diffs
 .phpstan-dba-mysqli.cache linguist-generated=true
-.phpstan-dba-pdo.cache linguist-generated=true
+.phpstan-dba-pdo-mysql.cache linguist-generated=true
 .phpunit-phpstan-dba-mysqli.cache linguist-generated=true
-.phpunit-phpstan-dba-pdo.cache linguist-generated=true
+.phpunit-phpstan-dba-pdo-mysql.cache linguist-generated=true
 .phpunit-phpstan-dba-pdo-pgsql.cache linguist-generated=true
 
 # Exclude non-essential files from dist
 /tests export-ignore
 .phpunit-phpstan-dba-mysqli.cache
-.phpunit-phpstan-dba-pdo.cache
+.phpunit-phpstan-dba-pdo-mysql.cache
 .phpunit-phpstan-dba-pdo-pgsql.cache

.github/workflows/phpstan.yml

@@ -18,7 +18,7 @@ jobs:
         include:
           - php-version: "8.0"
             db-image: 'mysql:8.0'
-            reflector: "pdo"
+            reflector: "pdo-mysql"
             mode: "recording"
           - php-version: "8.0"
             db-image: 'mysql:8.0'
@@ -88,7 +88,7 @@ jobs:
             reflector: "mysqli"
             mode: "replay"
           - php-version: "8.1"
-            reflector: "pdo"
+            reflector: "pdo-mysql"
             mode: "replay"
 
     env:

.github/workflows/tests.yml

@@ -18,11 +18,11 @@ jobs:
         include:
           - php-version: "7.4"
             db-image: 'mysql:8.0'
-            reflector: "pdo"
+            reflector: "pdo-mysql"
             mode: "recording"
           - php-version: "8.0"
             db-image: 'mysql:8.0'
-            reflector: "pdo"
+            reflector: "pdo-mysql"
             mode: "recording"
           - php-version: "8.0"
             db-image: 'mysql:8.0'
@@ -40,7 +40,7 @@ jobs:
 
           - php-version: "8.1"
             db-image: 'mysql:8.0'
-            reflector: "pdo"
+            reflector: "pdo-mysql"
             mode: "replay-and-recording"
 
     env:
@@ -94,7 +94,7 @@ jobs:
       matrix:
         include:
           - php-version: "8.1"
-            reflector: "pdo"
+            reflector: "pdo-mysql"
             mode: "replay"
           - php-version: "8.1"
             reflector: "mysqli"

.phpstan-dba-mysqli.cache

@@ -58,7 +58,7 @@ QueryReflection::setupReflector(
         ReflectionCache::create(
             $cacheFile
         ),
-        // XXX alternatively you can use PdoQueryReflector instead
+        // XXX alternatively you can use PdoMysqlQueryReflector instead
         new MysqliQueryReflector($mysqli),
         new SchemaHasherMysql($mysqli)
 

.phpstan-dba-pdo.cache renamed to .phpstan-dba-pdo-mysql.cache

@@ -53,7 +53,7 @@
 			"@phpunit",
 			"@phpstan",
 
-			"@putenv DBA_REFLECTOR=pdo",
+			"@putenv DBA_REFLECTOR=pdo-mysql",
 			"@phpunit",
 			"@phpstan",
 

README.md

@@ -2,7 +2,7 @@
 
 Analyzing MySQL based codebases is supported for Doctrine DBAL, PDO and mysqli.
 
-At analysis time you can pick either `MysqliQueryReflector` or `PdoQueryReflector`.
+At analysis time you can pick either `MysqliQueryReflector` or `PdoMysqlQueryReflector`.
 
 ## Configuration
 
@@ -33,7 +33,7 @@ QueryReflection::setupReflector(
         ReflectionCache::create(
             $cacheFile
         ),
-        // XXX alternatively you can use PdoQueryReflector instead
+        // XXX alternatively you can use PdoMysqlQueryReflector instead
         new MysqliQueryReflector($mysqli),
         new SchemaHasherMysql($mysqli)
 

composer.json

@@ -8,7 +8,7 @@ It is **not** mandatory to use the same database driver for phpstan-dba, as you
 | Reflector            | Key Features                                                                                                                                                 |
 |----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | MysqliQueryReflector | - limited to mysql/mariadb databases<br/>- requires a active database connection<br/>- most feature complete reflector                                       |
-| PdoQueryReflector    | - connects to a mysql/mariadb database<br/>- requires a active database connection |
+| PdoMysqlQueryReflector    | - connects to a mysql/mariadb database<br/>- requires a active database connection |
 | PdoPgSqlQueryReflector    | - connects to a PGSQL database<br/>- requires a active database connection |
 
 

docs/mysql.md

@@ -18,7 +18,7 @@
 /**
  * @phpstan-type ColumnMeta array{name: string, table: string, native_type: string, len: int, flags: array<int, string>, precision: int<0, max>, pdo_type: PDO::PARAM_* }
  */
-abstract class BasePdoQueryReflector
+abstract class BasePdoQueryReflector implements QueryReflector
 {
     private const PSQL_INVALID_TEXT_REPRESENTATION = '22P02';
     private const PSQL_UNDEFINED_COLUMN = '42703';