Skip to content

PHPStan level 9 #286

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jul 24, 2025
Merged

PHPStan level 9 #286

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b5df0f3
PHPStan level 9
swissspidy Jul 1, 2025
8f60a27
Update phpstan.neon.dist
swissspidy Jul 1, 2025
e847909
Update dependencies
swissspidy Jul 3, 2025
fac34b3
Remaining type fixes
swissspidy Jul 3, 2025
14895b3
Update PHPCS config
swissspidy Jul 3, 2025
d09bb14
Update src/DB_Command.php
swissspidy Jul 7, 2025
16e7c12
Update src/DB_Command.php
swissspidy Jul 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,15 @@
},
"require-dev": {
"wp-cli/entity-command": "^1.3 || ^2",
"wp-cli/wp-cli-tests": "^4"
"wp-cli/wp-cli-tests": "dev-add/phpstan-enhancements"
},
"config": {
"process-timeout": 7200,
"sort-packages": true,
"allow-plugins": {
"dealerdirect/phpcodesniffer-composer-installer": true,
"johnpbloch/wordpress-core-installer": true
"johnpbloch/wordpress-core-installer": true,
"phpstan/extension-installer": true
},
"lock": false
},
Expand Down Expand Up @@ -67,6 +68,7 @@
"behat-rerun": "rerun-behat-tests",
"lint": "run-linter-tests",
"phpcs": "run-phpcs-tests",
"phpstan": "run-phpstan-tests",
"phpcbf": "run-phpcbf-cleanup",
"phpunit": "run-php-unit-tests",
"prepare-tests": "install-package-tests",
Expand Down
23 changes: 23 additions & 0 deletions phpstan.neon.dist
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
parameters:
level: 9
paths:
- src
- db-command.php
scanDirectories:
- vendor/wp-cli/wp-cli/php
- vendor/wp-cli/wp-cli-tests
scanFiles:
- vendor/php-stubs/wordpress-stubs/wordpress-stubs.php
- tests/phpstan/scan-files.php
treatPhpDocTypesAsCertain: false
dynamicConstantNames:
- DB_HOST
- DB_NAME
- DB_USER
- DB_PASSWORD
- DB_CHARSET
- DB_COLLATE
ignoreErrors:
- identifier: missingType.iterableValue
- identifier: missingType.parameter
- identifier: missingType.return
40 changes: 22 additions & 18 deletions src/DB_Command.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@

$tables = Utils\wp_get_table_names(
[],
[ 'all-tables-with-prefix' => true ]

Check failure on line 202 in src/DB_Command.php

View workflow job for this annotation

GitHub Actions / code-quality / PHPStan 

Parameter #2 $assoc_args of function WP_CLI\Utils\wp_get_table_names expects array<string, string>, array<string, true> given.
);

foreach ( $tables as $table ) {
Expand Down Expand Up @@ -260,7 +260,7 @@

$assoc_args['check'] = true;
self::run(
Utils\esc_cmd( $command, DB_NAME ),

Check failure on line 263 in src/DB_Command.php

View workflow job for this annotation

GitHub Actions / code-quality / PHPStan 

Parameter #1 $cmd of function WP_CLI\Utils\esc_cmd expects array<string>, string given.
$assoc_args
);

Expand Down Expand Up @@ -308,7 +308,7 @@

$assoc_args['optimize'] = true;
self::run(
Utils\esc_cmd( $command, DB_NAME ),

Check failure on line 311 in src/DB_Command.php

View workflow job for this annotation

GitHub Actions / code-quality / PHPStan 

Parameter #1 $cmd of function WP_CLI\Utils\esc_cmd expects array<string>, string given.
$assoc_args
);

Expand Down Expand Up @@ -356,7 +356,7 @@

$assoc_args['repair'] = true;
self::run(
Utils\esc_cmd( $command, DB_NAME ),

Check failure on line 359 in src/DB_Command.php

View workflow job for this annotation

GitHub Actions / code-quality / PHPStan 

Parameter #1 $cmd of function WP_CLI\Utils\esc_cmd expects array<string>, string given.
$assoc_args
);

Expand Down Expand Up @@ -409,7 +409,7 @@
}

WP_CLI::debug( 'Associative arguments: ' . json_encode( $assoc_args ), 'db' );
self::run( $command, $assoc_args, null, true );
self::run( $command, $assoc_args, false, true );
}

/**
Expand Down Expand Up @@ -634,7 +634,7 @@
$result_file = $args[0];
} else {
// phpcs:ignore WordPress.WP.AlternativeFunctions.rand_mt_rand -- WordPress is not loaded.
$hash = substr( md5( mt_rand() ), 0, 7 );
$hash = substr( md5( (string) mt_rand() ), 0, 7 );
$result_file = sprintf( '%s-%s-%s.sql', DB_NAME, date( 'Y-m-d' ), $hash ); // phpcs:ignore WordPress.DateTime.RestrictedFunctions.date_date

}
Expand Down Expand Up @@ -709,7 +709,7 @@
}
}

$escaped_command = call_user_func_array( '\WP_CLI\Utils\esc_cmd', array_merge( [ $command ], $command_esc_args ) );
$escaped_command = \WP_CLI\Utils\esc_cmd( $command, $command_esc_args );

Check failure on line 712 in src/DB_Command.php

View workflow job for this annotation

GitHub Actions / code-quality / PHPStan 

Parameter #1 $cmd of function WP_CLI\Utils\esc_cmd expects array<string>, string given.

// Remove parameters not needed for SQL run.
unset( $assoc_args['porcelain'] );
Expand All @@ -727,7 +727,7 @@
/**
* Get the current character set of the posts table.
*
* @param array Associative array of associative arguments.
* @param array $assoc_args Associative arguments.
* @return string Posts table character set.
*/
private function get_posts_table_charset( $assoc_args ) {
Expand Down Expand Up @@ -891,6 +891,9 @@
* Success: Exported to wordpress_dbase.sql
*
* @when after_wp_load
*
* @param array<string> $args Positional arguments.
* @param array{scope?: string, network?: bool, 'all-tables-with-prefix'?: bool, 'all-tables'?: bool, format: string} $assoc_args Associative arguments.
*/
public function tables( $args, $assoc_args ) {

Expand All @@ -901,7 +904,7 @@
$assoc_args['scope'] = 'all';
}

$tables = Utils\wp_get_table_names( $args, $assoc_args );

Check failure on line 907 in src/DB_Command.php

View workflow job for this annotation

GitHub Actions / code-quality / PHPStan 

Parameter #2 $assoc_args of function WP_CLI\Utils\wp_get_table_names expects array<string, string>, array<string, bool|string> given.

if ( 'csv' === $format ) {
WP_CLI::line( implode( ',', $tables ) );
Expand Down Expand Up @@ -1042,6 +1045,9 @@
* 6
*
* @when after_wp_load
*
* @param array $args Positional arguments. Unused.
* @param array{size_format?: string, tables?: bool, 'human-readable'?: bool, format?: string, scope?: string, network?: bool, decimals?: string, 'all-tables-with-prefix'?: bool, 'all-tables'?: bool, order: string, orderby: string} $assoc_args Associative arguments.
*/
public function size( $args, $assoc_args ) {
global $wpdb;
Expand Down Expand Up @@ -1078,7 +1084,7 @@
if ( $tables || $all_tables || $all_tables_with_prefix ) {

// Add all of the table sizes.
foreach ( Utils\wp_get_table_names( $args, $assoc_args ) as $table_name ) {

Check failure on line 1087 in src/DB_Command.php

View workflow job for this annotation

GitHub Actions / code-quality / PHPStan 

Parameter #2 $assoc_args of function WP_CLI\Utils\wp_get_table_names expects array<string, string>, array<string, bool|string> given.

// Get the table size.
$table_bytes = $wpdb->get_var(
Expand Down Expand Up @@ -1132,7 +1138,7 @@
// phpcs:enable

if ( $human_readable ) {
$size_key = floor( log( $row['Size'] ) / log( 1000 ) );
$size_key = floor( log( (float) $row['Size'] ) / log( 1000 ) );
$sizes = [ 'B', 'KB', 'MB', 'GB', 'TB' ];

$size_format = isset( $sizes[ $size_key ] ) ? $sizes[ $size_key ] : $sizes[0];
Expand Down Expand Up @@ -1184,20 +1190,20 @@
}
$size_format_display = preg_replace( '/IB$/u', 'iB', strtoupper( $size_format ) );

$decimals = Utils\get_flag_value( $assoc_args, 'decimals', 0 );
$decimals = (int) Utils\get_flag_value( $assoc_args, 'decimals', 0 );
$rows[ $index ]['Size'] = round( (int) $row['Bytes'] / $divisor, $decimals ) . ' ' . $size_format_display;
}
}

if ( ! empty( $size_format ) && ! $tables && ! $format && ! $human_readable && true !== $all_tables && true !== $all_tables_with_prefix ) {
WP_CLI::line( str_replace( " {$size_format_display}", '', $rows[0]['Size'] ) );

Check failure on line 1199 in src/DB_Command.php

View workflow job for this annotation

GitHub Actions / code-quality / PHPStan 

Variable $size_format_display might not be defined.
} else {

// Sort the rows by user input
if ( $orderby ) {
usort(
$rows,
function ( $a, $b ) use ( $order, $orderby ) {

Check failure on line 1206 in src/DB_Command.php

View workflow job for this annotation

GitHub Actions / code-quality / PHPStan 

Parameter #2 $callback of function usort expects callable(array{Name: string, Size: string, Bytes: string}, array{Name: string, Size: string, Bytes: string}): int, Closure(mixed, mixed): (bool|int<-1, 1>) given.

$orderby_array = 'asc' === $order ? array( $a, $b ) : array( $b, $a );
list( $first, $second ) = $orderby_array;
Expand Down Expand Up @@ -1428,6 +1434,10 @@
$after_context = Utils\get_flag_value( $assoc_args, 'after_context', 40 );
$after_context = '' === $after_context ? $after_context : (int) $after_context;

$default_regex_delimiter = false;
$regex_flags = false;
$regex_delimiter = '';

$regex = Utils\get_flag_value( $assoc_args, 'regex', false );
if ( false !== $regex ) {
$regex_flags = Utils\get_flag_value( $assoc_args, 'regex-flags', false );
Expand Down Expand Up @@ -1557,7 +1567,7 @@

// Offsets are in bytes, so need to use `strlen()` and `substr()` before using `safe_substr()`.
if ( $before_context && $offset && ! $append_next ) {
$before = \cli\safe_substr( substr( $col_val, $last_offset, $offset - $last_offset ), -$before_context, null /*length*/, false /*is_width*/, $col_encoding );

Check failure on line 1570 in src/DB_Command.php

View workflow job for this annotation

GitHub Actions / code-quality / PHPStan 

Parameter #5 $encoding of function cli\safe_substr expects bool|string, string|false|null given.
}
if ( $after_context ) {
$end_offset = $offset + strlen( $match );
Expand Down Expand Up @@ -1857,7 +1867,7 @@
* Gets the column names of a db table differentiated into key columns and text columns and all columns.
*
* @param string $table The table name.
* @return array A 3 element array consisting of an array of primary key column names, an array of text column names, and an array containing all column names.
* @return array{0: string[], 1: string[], 2: string[]} A 3 element array consisting of an array of primary key column names, an array of text column names, and an array containing all column names.
*/
private static function get_columns( $table ) {
global $wpdb;
Expand Down Expand Up @@ -1890,7 +1900,7 @@
/**
* Determines whether a column is considered text or not.
*
* @param string Column type.
* @param string $type Column type.
* @return bool True if text column, false otherwise.
*/
private static function is_text_col( $type ) {
Expand All @@ -1909,6 +1919,8 @@
*
* @param string|array $idents A single identifier or an array of identifiers.
* @return string|array An escaped string if given a string, or an array of escaped strings if given an array of strings.
*
* @phpstan-return ($idents is string ? string : array)
*/
private static function esc_sql_ident( $idents ) {
$backtick = static function ( $v ) {
Expand Down Expand Up @@ -2155,11 +2167,6 @@
// Make sure the provided arguments don't interfere with the expected
// output here.
$args = [];
foreach ( [] as $arg ) {
if ( isset( $assoc_args[ $arg ] ) ) {
$args[ $arg ] = $assoc_args[ $arg ];
}
}
Comment on lines -2158 to -2162
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looping through an empty array does nothing


if ( null === $modes ) {
$modes = [];
Expand All @@ -2183,17 +2190,14 @@
}

if ( ! empty( $stdout ) ) {
$lines = preg_split( "/\r\n|\n|\r|,/", $stdout );
$modes = array_filter(
array_map(
'trim',
preg_split( "/\r\n|\n|\r|,/", $stdout )
$lines ? $lines : []
)
);
}

if ( false === $modes ) {
$modes = [];
}
Comment on lines -2194 to -2196
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was never false

}

return $modes;
Expand Down
10 changes: 10 additions & 0 deletions tests/phpstan/scan-files.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<?php

namespace {

Check failure on line 3 in tests/phpstan/scan-files.php

View workflow job for this annotation

GitHub Actions / code-quality / PHPCS 

Namespace declarations without a namespace name are not allowed.

Check failure on line 3 in tests/phpstan/scan-files.php

View workflow job for this annotation

GitHub Actions / code-quality / PHPCS 

Namespace declarations using the curly brace syntax are not allowed.
define( 'DB_HOST', '' );

Check failure on line 4 in tests/phpstan/scan-files.php

View workflow job for this annotation

GitHub Actions / code-quality / PHPCS 

Global constants defined by a theme/plugin should start with the theme/plugin prefix. Found: "DB_HOST".
define( 'DB_NAME', '' );

Check failure on line 5 in tests/phpstan/scan-files.php

View workflow job for this annotation

GitHub Actions / code-quality / PHPCS 

Global constants defined by a theme/plugin should start with the theme/plugin prefix. Found: "DB_NAME".
define( 'DB_USER', '' );

Check failure on line 6 in tests/phpstan/scan-files.php

View workflow job for this annotation

GitHub Actions / code-quality / PHPCS 

Global constants defined by a theme/plugin should start with the theme/plugin prefix. Found: "DB_USER".
define( 'DB_PASSWORD', '' );

Check failure on line 7 in tests/phpstan/scan-files.php

View workflow job for this annotation

GitHub Actions / code-quality / PHPCS 

Global constants defined by a theme/plugin should start with the theme/plugin prefix. Found: "DB_PASSWORD".
define( 'DB_CHARSET', '' );

Check failure on line 8 in tests/phpstan/scan-files.php

View workflow job for this annotation

GitHub Actions / code-quality / PHPCS 

Global constants defined by a theme/plugin should start with the theme/plugin prefix. Found: "DB_CHARSET".
define( 'DB_COLLATE', '' );

Check failure on line 9 in tests/phpstan/scan-files.php

View workflow job for this annotation

GitHub Actions / code-quality / PHPCS 

Global constants defined by a theme/plugin should start with the theme/plugin prefix. Found: "DB_COLLATE".
}
Loading