forrest79/phpgsql-phpstan

PhPgSql class reflection extension and settings for PHPStan.

v1.9.0 2025-03-11 22:17 UTC

Requires

• php: ^8.0
• phpstan/phpstan: ^2.0

Requires (Dev)

• dg/bypass-finals: ^1.5
• forrest79/phpcs: ^1.7
• forrest79/phpcs-ignores: ^0.5
• forrest79/phpgsql: ^1.4
• phpstan/phpstan-strict-rules: ^2.0

BSD-3-Clause

• Jakub Trmota

• PHPStan
• phpgsql

README

• PHPStan
• PhPgSql

Introduction

This extension defines dynamic methods and other PHPStan setting for Forrest79\PhPgSql.

Installation

To use this extension, require it in Composer:

composer require --dev forrest79/phpgsql-phpstan

Using

Include extension.neon in your project's PHPStan config:

includes:
    - vendor/forrest79/phpgsql-phpstan/extension.neon

If you're using your own Forrest79\PhPgSql\Db\Row or Forrest79\PhPgSql\Fluen\Query, you can set it likes this:

parameters:
    forrest79:
        phpgsql:
            dbRowClass: MyOwn\PhPgSql\Db\RowXyz
            fluentQueryClass: MyOwn\PhPgSql\Fluent\QueryXyz

Or you can set just one extension:

• for PhPgSql\Db\Result (for fetching the correct Row object from fetch methods - unfortunately Row iteration must be typed right in your code for now):

services:
    Forrest79PhPgSqlPHPStanReflectionDbResultDynamicMethodReturnTypeExtension:
        arguments:
            dbRowClass: MyOwn\PhPgSql\Db\RowXyz

• for PhPgSql\Fluent\QueryExecute (for fetching the correct Row object from fetch methods - unfortunately Row iteration must be typed right in your code for now):

services:
    Forrest79PhPgSqlPHPStanReflectionFluentQueryExecuteDynamicMethodReturnTypeExtension:
        arguments:
            dbRowClass: MyOwn\PhPgSql\Db\RowXyz

• for PhPgSql\Fluent\Complex (to return right Query in query() method):

services:
    Forrest79PhPgSqlPHPStanReflectionFluentComplexDynamicMethodReturnTypeExtension:
        arguments:
            fluentQueryClass: MyOwn\PhPgSql\Fluent\QueryXyz

You can use simple DbRow annotation to narrow the Row object.

foreach ($someQuery as $row) {
    // here is $row as Forrest79\PhPgSql\Db\Row for PHPStan
    /** @var DbRow $row */
    // here is as your custom row object
}

Use DbRow pseudo-type whenever you want, params, returns, vars...

To set only this extension use:

services:
    Forrest79PhPgSqlPHPStanPhpDocDbRowTypeNodeResolverExtension:
        arguments:
            dbRowClass: MyOwn\PhPgSql\Db\RowXyz