CoreLibs/development
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Ignore errors in DB\SQL\PgSQL for phpstan

Browse Source 
phpstan will throw an error because pg_* methods have changed from
resource to object in php 8.1
So current var has object|resource dual type and this will fail
Added ignore for phpstan in the config file.
Also added conditional config file for phpstan where we can set based on
current active PHP version
baseline file created with --generate-baseline is added for error check
This commit is contained in:
Clemens Schwaighofer
2022-01-20 13:09:02 +09:00
parent 2a697817fd
commit 6a139d3b7c
5 changed files with 63 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
phpstan-baseline.neon Normal file
View File

@@ -0,0 +1,7 @@
parameters:
ignoreErrors:
-
message: "#^Parameter \\#1 \\$result of function pg_result_error expects resource, object\\|resource\\|true given\\.$#"
count: 1
path: www/lib/CoreLibs/DB/SQL/PgSQL.php

21
phpstan-conditional.php Normal file
View File

@@ -0,0 +1,21 @@
<?php
// conditional formats for PHP versions
declare(strict_types=1);
$config = [];
if (PHP_VERSION_ID >= 8_00_00) {
// Change of signature in PHP 8.1
/* $config['parameters']['ignoreErrors'][] = [
'message' => '~Parameter #1 \$(result|connection) of function pg_\w+ '
. 'expects resource(\|null)?, object\|resource given\.~',
'path' => 'www/lib/CoreLibs/DB/SQL/PgSQL.php',
// 'count' => 1,
]; */
}
return $config;
// __END_

6
phpstan.neon
View File

@@ -1,5 +1,6 @@
# PHP Stan Config # PHP Stan Config
includes:
- phpstan-conditional.php
parameters: parameters:
tmpDir: /tmp/phpstan-corelibs tmpDir: /tmp/phpstan-corelibs
level: 8 # max is now 9 level: 8 # max is now 9
@@ -48,6 +49,9 @@ parameters:
- www/admin/class_test.smarty4.php - www/admin/class_test.smarty4.php
# ignore errores with # ignore errores with
ignoreErrors: ignoreErrors:
- # this error is ignore because of the PHP 8.0 to 8.1 change for pg_*
message: "#^Parameter \\#1 \\$(result|connection) of function pg_\\w+ expects resource(\\|null)?, object\\|resource(\\|bool)? given\\.$#"
path: %currentWorkingDirectory%/www/lib/CoreLibs/DB/SQL/PgSQL.php
# this is ignored for now # this is ignored for now
# - '#Expression in empty\(\) is always falsy.#' # - '#Expression in empty\(\) is always falsy.#'
# - # -

3
www/lib/CoreLibs/DB/IO.php
View File

@@ -252,7 +252,8 @@ declare(strict_types=1);
namespace CoreLibs\DB; namespace CoreLibs\DB;
// this is for running in php 8.0 phan // below no ignore is needed if we want to use PgSql interface checks with PHP 8.0
// as main system. Currently all @var sets are written as object
/** @#phan-file-suppress PhanUndeclaredTypeProperty,PhanUndeclaredTypeParameter,PhanUndeclaredTypeReturnType */ /** @#phan-file-suppress PhanUndeclaredTypeProperty,PhanUndeclaredTypeParameter,PhanUndeclaredTypeReturnType */
class IO class IO

51
www/lib/CoreLibs/DB/SQL/PgSQL.php
View File

@@ -47,6 +47,8 @@ declare(strict_types=1);
namespace CoreLibs\DB\SQL; namespace CoreLibs\DB\SQL;
// below no ignore is needed if we want to use PgSql interface checks with PHP 8.0
// as main system. Currently all @var sets are written as object
/** @#phan-file-suppress PhanUndeclaredTypeProperty,PhanUndeclaredTypeParameter,PhanUndeclaredTypeReturnType */ /** @#phan-file-suppress PhanUndeclaredTypeProperty,PhanUndeclaredTypeParameter,PhanUndeclaredTypeReturnType */
class PgSQL class PgSQL
@@ -85,7 +87,7 @@ class PgSQL
public function __dbQuery(string $query) public function __dbQuery(string $query)
{ {
$this->last_error_query = ''; $this->last_error_query = '';
if ($this->dbh === false) { if ($this->dbh === false || is_bool($this->dbh)) {
return false; return false;
} }
// read out the query status and save the query if needed // read out the query status and save the query if needed
@@ -103,7 +105,7 @@ class PgSQL
*/ */
public function __dbSendQuery(string $query): bool public function __dbSendQuery(string $query): bool
{ {
if ($this->dbh === false) { if ($this->dbh === false || is_bool($this->dbh)) {
return false; return false;
} }
$result = pg_send_query($this->dbh, $query); $result = pg_send_query($this->dbh, $query);
@@ -117,7 +119,7 @@ class PgSQL
public function __dbGetResult() public function __dbGetResult()
{ {
$this->last_error_query = ''; $this->last_error_query = '';
if ($this->dbh === false) { if ($this->dbh === false || is_bool($this->dbh)) {
return false; return false;
} }
$result = pg_get_result($this->dbh); $result = pg_get_result($this->dbh);
@@ -136,7 +138,7 @@ class PgSQL
*/ */
public function __dbClose(): void public function __dbClose(): void
{ {
if ($this->dbh === false) { if ($this->dbh === false || is_bool($this->dbh)) {
return; return;
} }
if (pg_connection_status($this->dbh) === PGSQL_CONNECTION_OK) { if (pg_connection_status($this->dbh) === PGSQL_CONNECTION_OK) {
@@ -153,7 +155,7 @@ class PgSQL
*/ */
public function __dbPrepare(string $name, string $query) public function __dbPrepare(string $name, string $query)
{ {
if ($this->dbh === false) { if ($this->dbh === false || is_bool($this->dbh)) {
return false; return false;
} }
$result = pg_prepare($this->dbh, $name, $query); $result = pg_prepare($this->dbh, $name, $query);
@@ -171,7 +173,7 @@ class PgSQL
*/ */
public function __dbExecute(string $name, array $data) public function __dbExecute(string $name, array $data)
{ {
if ($this->dbh === false) { if ($this->dbh === false || is_bool($this->dbh)) {
return false; return false;
} }
$result = pg_execute($this->dbh, $name, $data); $result = pg_execute($this->dbh, $name, $data);
@@ -188,7 +190,7 @@ class PgSQL
*/ */
public function __dbNumRows($cursor): int public function __dbNumRows($cursor): int
{ {
if (!$cursor) { if ($cursor === false || is_bool($cursor)) {
return -1; return -1;
} }
return pg_num_rows($cursor); return pg_num_rows($cursor);
@@ -201,7 +203,7 @@ class PgSQL
*/ */
public function __dbNumFields($cursor): int public function __dbNumFields($cursor): int
{ {
if (!$cursor) { if ($cursor === false || is_bool($cursor)) {
return -1; return -1;
} }
return pg_num_fields($cursor); return pg_num_fields($cursor);
@@ -215,7 +217,7 @@ class PgSQL
*/ */
public function __dbFieldName($cursor, $i) public function __dbFieldName($cursor, $i)
{ {
if (!$cursor) { if ($cursor === false || is_bool($cursor)) {
return false; return false;
} }
return pg_field_name($cursor, $i); return pg_field_name($cursor, $i);
@@ -230,7 +232,7 @@ class PgSQL
*/ */
public function __dbFetchArray($cursor, int $result_type = PGSQL_BOTH) public function __dbFetchArray($cursor, int $result_type = PGSQL_BOTH)
{ {
if (!$cursor) { if ($cursor === false || is_bool($cursor)) {
return false; return false;
} }
// result type is passed on as is [should be checked] // result type is passed on as is [should be checked]
@@ -258,7 +260,7 @@ class PgSQL
*/ */
public function __dbFetchAll($cursor) public function __dbFetchAll($cursor)
{ {
if (!$cursor) { if ($cursor === false || is_bool($cursor)) {
return false; return false;
} }
return pg_fetch_all($cursor); return pg_fetch_all($cursor);
@@ -271,7 +273,7 @@ class PgSQL
*/ */
public function __dbAffectedRows($cursor): int public function __dbAffectedRows($cursor): int
{ {
if (!$cursor) { if ($cursor === false || is_bool($cursor)) {
return -1; return -1;
} }
return pg_affected_rows($cursor); return pg_affected_rows($cursor);
@@ -426,17 +428,18 @@ class PgSQL
*/ */
public function __dbPrintError($cursor = false): string public function __dbPrintError($cursor = false): string
{ {
if ($this->dbh === false) { if ($this->dbh === false || is_bool($this->dbh)) {
return ''; return '';
} }
// run the query again for the error result here // run the query again for the error result here
if (!$cursor && $this->last_error_query) { if (($cursor === false || is_bool($cursor)) && $this->last_error_query) {
pg_send_query($this->dbh, $this->last_error_query); pg_send_query($this->dbh, $this->last_error_query);
$this->last_error_query = ''; $this->last_error_query = '';
$cursor = pg_get_result($this->dbh); $cursor = pg_get_result($this->dbh);
} }
if ($cursor && pg_result_error($cursor)) { if ($cursor && !is_bool($cursor) && $error_str = pg_result_error($cursor)) {
return "<span style=\"color: red;\"><b>-PostgreSQL-Error-></b> " . pg_result_error($cursor) . "</span><br>"; return "<span style=\"color: red;\"><b>-PostgreSQL-Error-></b> "
. $error_str . "</span><br>";
} else { } else {
return ''; return '';
} }
@@ -450,7 +453,7 @@ class PgSQL
*/ */
public function __dbMetaData(string $table, $extended = false) public function __dbMetaData(string $table, $extended = false)
{ {
if ($this->dbh === false) { if ($this->dbh === false || is_bool($this->dbh)) {
return false; return false;
} }
// needs to prefixed with @ or it throws a warning on not existing table // needs to prefixed with @ or it throws a warning on not existing table
@@ -464,7 +467,7 @@ class PgSQL
*/ */
public function __dbEscapeString($string): string public function __dbEscapeString($string): string
{ {
if ($this->dbh === false) { if ($this->dbh === false || is_bool($this->dbh)) {
return ''; return '';
} }
return pg_escape_string($this->dbh, (string)$string); return pg_escape_string($this->dbh, (string)$string);
@@ -479,7 +482,7 @@ class PgSQL
*/ */
public function __dbEscapeLiteral($string): string public function __dbEscapeLiteral($string): string
{ {
if ($this->dbh === false) { if ($this->dbh === false || is_bool($this->dbh)) {
return ''; return '';
} }
return pg_escape_string($this->dbh, (string)$string); return pg_escape_string($this->dbh, (string)$string);
@@ -492,7 +495,7 @@ class PgSQL
*/ */
public function __dbEscapeBytea($bytea): string public function __dbEscapeBytea($bytea): string
{ {
if ($this->dbh === false) { if ($this->dbh === false || is_bool($this->dbh)) {
return ''; return '';
} }
return pg_escape_bytea($this->dbh, $bytea); return pg_escape_bytea($this->dbh, $bytea);
@@ -504,7 +507,7 @@ class PgSQL
*/ */
public function __dbConnectionBusy(): bool public function __dbConnectionBusy(): bool
{ {
if ($this->dbh === false) { if ($this->dbh === false || is_bool($this->dbh)) {
return false; return false;
} }
return pg_connection_busy($this->dbh); return pg_connection_busy($this->dbh);
@@ -518,7 +521,7 @@ class PgSQL
*/ */
public function __dbVersion(): string public function __dbVersion(): string
{ {
if ($this->dbh === false) { if ($this->dbh === false || is_bool($this->dbh)) {
return ''; return '';
} }
// array has client, protocol, server // array has client, protocol, server
@@ -547,7 +550,9 @@ class PgSQL
if ('{' != $text[$offset]) { if ('{' != $text[$offset]) {
preg_match("/(\\{?\"([^\"\\\\]|\\\\.)*\"|[^,{}]+)+([,}]+)/", $text, $match, 0, $offset); preg_match("/(\\{?\"([^\"\\\\]|\\\\.)*\"|[^,{}]+)+([,}]+)/", $text, $match, 0, $offset);
$offset += strlen($match[0]); $offset += strlen($match[0]);
$output[] = ('"' != $match[1][0] ? $match[1] : stripcslashes(substr($match[1], 1, -1))); $output[] = '"' != $match[1][0] ?
$match[1] :
stripcslashes(substr($match[1], 1, -1));
if ('},' == $match[3]) { if ('},' == $match[3]) {
return $offset; return $offset;
} }