Skip to content

Commit 2130c94

Browse files
authored
readme: simplify intro (#143)
* readme: simplify intro * Update README.md
1 parent 240e2c3 commit 2130c94

File tree

1 file changed

+6
-22
lines changed

1 file changed

+6
-22
lines changed

README.md

Lines changed: 6 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,12 @@
44
With this information at hand `phpstan-dba` is able to detect type inconsistencies between your domain model and database-schema.
55
Additionally errors in code handling the results of sql queries can be detected.
66

7-
This extension provides following features:
8-
9-
* the array shape of results can be inferred for `Doctrine\DBAL\Result`, `PDOStatement` and `mysqli_result`
10-
* .. when the query string can be resolved at analysis time. This is even possible for queries containing php-variables, as long as their typ is known in most cases.
11-
* builtin we support
12-
* `Doctrine\DBAL\Connection->query()`
13-
* `Doctrine\DBAL\Result->fetchNumeric()`
14-
* `Doctrine\DBAL\Result->fetchAssociative()`
15-
* `Doctrine\DBAL\Result->fetchAllNumeric()`
16-
* `Doctrine\DBAL\Result->fetchAllAssociative()`
17-
* `Doctrine\DBAL\Result->columnCount()`
18-
* `mysqli->query`
19-
* `PDOStatement->fetch`
20-
* `PDOStatement->fetchAll`
21-
* `PDOStatement->execute`
22-
* `PDO->query`
23-
* `PDO->prepare`
24-
* `SyntaxErrorInPreparedStatementMethodRule` can inspect prepared sql queries and detect syntax errors
25-
* `SyntaxErrorInQueryMethodRule` can inspect sql queries and detect syntax errors - `SyntaxErrorInQueryFunctionRule` can do the same for functions
26-
* builtin is query syntax error detection for `mysqli_query`, `mysqli->query`, `PDO->query` and `PDO->prepare`
27-
* `mysqli_real_escape_string` and `mysqli->real_escape_string` dynamic return type extensions
28-
* `pdo->quote` dynamic return type extension
7+
This extension provides the following features:
8+
9+
* inspect sql queries, detect syntax errors and placeholder/bound value mismatches
10+
* type-inferrence for `Doctrine\DBAL\Result`, `PDOStatement` and `mysqli_result`
11+
* builtin support for `doctrine/dbal`, `mysqli`, and `PDO`
12+
* API to built the same features for your custom sql based database access layer
2913

3014
[see the unit-testsuite](https://github.com/staabm/phpstan-dba/tree/main/tests/data) to get a feeling about the current featureset.
3115

0 commit comments

Comments
 (0)