phpstandba: PHPStan based SQL static analysis and type inference for the database access layer
phpstan-dba makes your phpstan static code analysis jobs aware of datatypes within your database.
With this information at hand we are able to detect type inconsistencies between your domain model and database-schema.
Additionally errors in code handling the results of sql queries can be detected.
This extension provides the following features, as long as you stick to the rules:
- result set type-inference
- detect errors in sql queries
- detect placeholder/bound value mismatches
- query plan analysis to detect performance issues
- builtin support for
doctrine/dbal,mysqli, andPDO - API to configure the same features for your custom sql based database access layer
- Opt-In analysis of write queries (since version 0.2.55+)
In case you are using Doctrine ORM, you might use phpstan-dba in tandem with phpstan-doctrine.
Note: At the moment only MySQL/MariaDB and PGSQL databases are supported. Technically it's not a big problem to support other databases though.
Talks
phpstan-dba - check your sql queries like a boss May 2023, at PHP Usergroup in Frankfurt Main (Germany).
DEMO
see the 'Files Changed' tab of the DEMO-PR for a quick glance.
💌 Support phpstan-dba
Consider supporting the project, so we can make this tool even better even faster for everyone.
Installation
First, use composer to install:
composer require --dev staabm/phpstan-dbaSecond, create a phpstan-dba-bootstrap.php file, which allows to you to configure phpstan-dba (this optionally includes database connection details, to introspect the database; if you would rather not do this see Record and Replay:
<?php // phpstan-dba-bootstrap.php
use staabm\PHPStanDba\DbSchema\SchemaHasherMysql;
use staabm\PHPStanDba\QueryReflection\RuntimeConfiguration;
use staabm\PHPStanDba\QueryReflection\MysqliQueryReflector;
use staabm\PHPStanDba\QueryReflection\QueryReflection;
use staabm\PHPStanDba\QueryReflection\ReplayAndRecordingQueryReflector;
use staabm\PHPStanDba\QueryReflection\ReplayQueryReflector;
use staabm\PHPStanDba\QueryReflection\ReflectionCache;
require_once __DIR__ . '/vendor/autoload.php';
$cacheFile = __DIR__.'/.phpstan-dba.cache';
$config = new RuntimeConfiguration();
// $config->debugMode(true);
// $config->stringifyTypes(true);
// $config->analyzeQueryPlans(true);
// $config->utilizeSqlAst(true);
// TODO: Put your database credentials here
$mysqli = new mysqli('hostname', 'username', 'password', 'database');
QueryReflection::setupReflector(
new ReplayAndRecordingQueryReflector(
ReflectionCache::create(
$cacheFile
),
// XXX alternatively you can use PdoMysqlQueryReflector instead
new MysqliQueryReflector($mysqli),
new SchemaHasherMysql($mysqli)
),
$config
);Note: Configuration for PGSQL is pretty similar
Third, create or update your phpstan.neon file so bootstrapFiles includes phpstan-dba-bootstrap.php.
If you are not using phpstan/extension-installer, you will also need to include dba.neon.
Your phpstan.neon might look something like:
parameters:
level: 8
paths:
- src/
bootstrapFiles:
- phpstan-dba-bootstrap.php
includes:
- ./vendor/staabm/phpstan-dba/config/dba.neonFinally, run phpstan, e.g.
./vendor/bin/phpstan analyse -c phpstan.neon