From 86195ac0f9d287b0f08843435f0d97aba25981b6 Mon Sep 17 00:00:00 2001 From: rxu Date: Sat, 19 Jul 2025 15:17:18 +0700 Subject: [PATCH] [ticket/17530] Better classes naming PHPBB-17530 --- .../db/doctrine/case_insensitive_string.php | 8 ++++---- phpBB/phpbb/db/doctrine/connection_factory.php | 16 ++++++++-------- .../db/doctrine/connection_parameter_factory.php | 8 +++----- .../mysql/{phpbb_mysql_driver.php => driver.php} | 4 ++-- ...phpbb_mysql_middleware.php => middleware.php} | 5 +++-- .../{phpbb_mysql_platform.php => platform.php} | 2 +- .../{phpbb_oracle_driver.php => driver.php} | 6 +++--- ...hpbb_oracle_middleware.php => middleware.php} | 5 +++-- .../{phpbb_oracle_platform.php => platform.php} | 2 +- ...cle_schema_manager.php => schema_manager.php} | 2 +- .../{phpbb_postgresql_driver.php => driver.php} | 4 ++-- ..._postgresql_middleware.php => middleware.php} | 5 +++-- ...hpbb_postgresql_platform.php => platform.php} | 2 +- .../{phpbb_sqlsrv_driver.php => driver.php} | 4 ++-- ...hpbb_sqlsrv_middleware.php => middleware.php} | 5 +++-- .../{phpbb_sqlsrv_platform.php => platform.php} | 2 +- 16 files changed, 41 insertions(+), 39 deletions(-) rename phpBB/phpbb/db/middleware/mysql/{phpbb_mysql_driver.php => driver.php} (85%) rename phpBB/phpbb/db/middleware/mysql/{phpbb_mysql_middleware.php => middleware.php} (78%) rename phpBB/phpbb/db/middleware/mysql/{phpbb_mysql_platform.php => platform.php} (95%) rename phpBB/phpbb/db/middleware/oracle/{phpbb_oracle_driver.php => driver.php} (83%) rename phpBB/phpbb/db/middleware/oracle/{phpbb_oracle_middleware.php => middleware.php} (78%) rename phpBB/phpbb/db/middleware/oracle/{phpbb_oracle_platform.php => platform.php} (98%) rename phpBB/phpbb/db/middleware/oracle/{phpbb_oracle_schema_manager.php => schema_manager.php} (94%) rename phpBB/phpbb/db/middleware/postgresql/{phpbb_postgresql_driver.php => driver.php} (85%) rename phpBB/phpbb/db/middleware/postgresql/{phpbb_postgresql_middleware.php => middleware.php} (77%) rename phpBB/phpbb/db/middleware/postgresql/{phpbb_postgresql_platform.php => platform.php} (98%) rename phpBB/phpbb/db/middleware/sqlsrv/{phpbb_sqlsrv_driver.php => driver.php} (86%) rename phpBB/phpbb/db/middleware/sqlsrv/{phpbb_sqlsrv_middleware.php => middleware.php} (78%) rename phpBB/phpbb/db/middleware/sqlsrv/{phpbb_sqlsrv_platform.php => platform.php} (98%) diff --git a/phpBB/phpbb/db/doctrine/case_insensitive_string.php b/phpBB/phpbb/db/doctrine/case_insensitive_string.php index a8ac6e7605..e7b62f8649 100644 --- a/phpBB/phpbb/db/doctrine/case_insensitive_string.php +++ b/phpBB/phpbb/db/doctrine/case_insensitive_string.php @@ -15,8 +15,8 @@ namespace phpbb\db\doctrine; use Doctrine\DBAL\Platforms\AbstractPlatform; use Doctrine\DBAL\Types\Type; -use phpbb\db\middleware\postgresql\phpbb_postgresql_platform; -use phpbb\db\middleware\oracle\phpbb_oracle_platform; +use phpbb\db\middleware\oracle\platform as oracle_platform; +use phpbb\db\middleware\postgresql\platform as postgresql_platform; /** * Case-insensitive string type (only supported by Postgres). @@ -30,7 +30,7 @@ class case_insensitive_string extends Type */ public function getSQLDeclaration(array $column, AbstractPlatform $platform): string { - if ($platform instanceof phpbb_postgresql_platform) + if ($platform instanceof postgresql_platform) { return 'varchar_ci'; } @@ -39,7 +39,7 @@ class case_insensitive_string extends Type // we used 3 times larger capacity for strings on oracle for unicode strings // as on other platforms. This is not the case with varchar_ci, which uses // the same length as other platforms. - if ($platform instanceof phpbb_oracle_platform) + if ($platform instanceof oracle_platform) { return $platform->getAsciiStringTypeDeclarationSQL($column); } diff --git a/phpBB/phpbb/db/doctrine/connection_factory.php b/phpBB/phpbb/db/doctrine/connection_factory.php index 5ae5107da4..15a0a6416e 100644 --- a/phpBB/phpbb/db/doctrine/connection_factory.php +++ b/phpBB/phpbb/db/doctrine/connection_factory.php @@ -20,10 +20,10 @@ use Doctrine\DBAL\Exception; use Doctrine\DBAL\Types\Type; use InvalidArgumentException; use phpbb\config_php_file; -use phpbb\db\middleware\mysql\phpbb_mysql_middleware; -use phpbb\db\middleware\oracle\phpbb_oracle_middleware; -use phpbb\db\middleware\postgresql\phpbb_postgresql_middleware; -use phpbb\db\middleware\sqlsrv\phpbb_sqlsrv_middleware; +use phpbb\db\middleware\mysql\middleware as mysql_middleware; +use phpbb\db\middleware\oracle\middleware as oracle_middleware; +use phpbb\db\middleware\postgresql\middleware as postgresql_middleware; +use phpbb\db\middleware\sqlsrv\middleware as sqlsrv_middleware; use phpbb\exception\runtime_exception; /** @@ -101,10 +101,10 @@ class connection_factory $middleware = match($driver) { - 'pdo_mysql', 'mysqli' => [new phpbb_mysql_middleware()], - 'pdo_oci', 'oci8' => [new phpbb_oracle_middleware()], - 'pdo_pgsql', 'pgsql' => [new phpbb_postgresql_middleware()], - 'pdo_sqlsrv', 'sqlsrv' => [new phpbb_sqlsrv_middleware()], + 'pdo_mysql', 'mysqli' => [new mysql_middleware()], + 'pdo_oci', 'oci8' => [new oracle_middleware()], + 'pdo_pgsql', 'pgsql' => [new postgresql_middleware()], + 'pdo_sqlsrv', 'sqlsrv' => [new sqlsrv_middleware()], default => [], }; diff --git a/phpBB/phpbb/db/doctrine/connection_parameter_factory.php b/phpBB/phpbb/db/doctrine/connection_parameter_factory.php index 6e59c4a61e..ea5a929ba7 100644 --- a/phpBB/phpbb/db/doctrine/connection_parameter_factory.php +++ b/phpBB/phpbb/db/doctrine/connection_parameter_factory.php @@ -13,8 +13,6 @@ namespace phpbb\db\doctrine; -use InvalidArgumentException; - /** * Helper class to generate Doctrine DBAL configuration. */ @@ -32,7 +30,7 @@ class connection_parameter_factory * * @return array Doctrine DBAL connection parameters. * - * @throws InvalidArgumentException If a required parameter is empty or null. + * @throws \InvalidArgumentException If a required parameter is empty or null. */ public static function get_configuration( string $driver, @@ -68,7 +66,7 @@ class connection_parameter_factory * * @return array Doctrine's DBAL configuration for SQLite. * - * @throws InvalidArgumentException If a required parameter is empty or null. + * @throws \InvalidArgumentException If a required parameter is empty or null. */ private static function build_connection_parameters( array $params, @@ -87,7 +85,7 @@ class connection_parameter_factory if (empty($user) || empty($name)) { - throw new InvalidArgumentException('Required database parameter is not set.'); + throw new \InvalidArgumentException('Required database parameter is not set.'); } $params = array_merge($params, [ diff --git a/phpBB/phpbb/db/middleware/mysql/phpbb_mysql_driver.php b/phpBB/phpbb/db/middleware/mysql/driver.php similarity index 85% rename from phpBB/phpbb/db/middleware/mysql/phpbb_mysql_driver.php rename to phpBB/phpbb/db/middleware/mysql/driver.php index 651a979765..306cadb72d 100644 --- a/phpBB/phpbb/db/middleware/mysql/phpbb_mysql_driver.php +++ b/phpBB/phpbb/db/middleware/mysql/driver.php @@ -19,13 +19,13 @@ use Doctrine\DBAL\Driver\Middleware\AbstractDriverMiddleware; * MySQL Doctrine driver middleware. * Makes use of phpBB's MySQL specific platform. */ -class phpbb_mysql_driver extends AbstractDriverMiddleware +class driver extends AbstractDriverMiddleware { /** * {@inheritDoc} */ public function createDatabasePlatformForVersion($version) { - return new phpbb_mysql_platform(); + return new platform(); } } diff --git a/phpBB/phpbb/db/middleware/mysql/phpbb_mysql_middleware.php b/phpBB/phpbb/db/middleware/mysql/middleware.php similarity index 78% rename from phpBB/phpbb/db/middleware/mysql/phpbb_mysql_middleware.php rename to phpBB/phpbb/db/middleware/mysql/middleware.php index 5e79142a9e..793512cfff 100644 --- a/phpBB/phpbb/db/middleware/mysql/phpbb_mysql_middleware.php +++ b/phpBB/phpbb/db/middleware/mysql/middleware.php @@ -14,15 +14,16 @@ namespace phpbb\db\middleware\mysql; use Doctrine\DBAL\Driver; +use phpbb\db\middleware\mysql\driver as mysql_driver; /** * MySQL Doctrine middleware. * Makes use of phpBB's MySQL specific platform. */ -class phpbb_mysql_middleware implements Driver\Middleware +class middleware implements Driver\Middleware { public function wrap(Driver $driver): Driver { - return new phpbb_mysql_driver($driver); + return new mysql_driver($driver); } } diff --git a/phpBB/phpbb/db/middleware/mysql/phpbb_mysql_platform.php b/phpBB/phpbb/db/middleware/mysql/platform.php similarity index 95% rename from phpBB/phpbb/db/middleware/mysql/phpbb_mysql_platform.php rename to phpBB/phpbb/db/middleware/mysql/platform.php index a64430613d..ed4cbdb1bb 100644 --- a/phpBB/phpbb/db/middleware/mysql/phpbb_mysql_platform.php +++ b/phpBB/phpbb/db/middleware/mysql/platform.php @@ -23,7 +23,7 @@ use Doctrine\DBAL\Schema\TableDiff; * If it's indexed as primary key, it should be declared as NOT NULL * because MySQL primary key columns cannot be NULL. */ -class phpbb_mysql_platform extends AbstractMySQLPlatform +class platform extends AbstractMySQLPlatform { /** * {@inheritDoc} diff --git a/phpBB/phpbb/db/middleware/oracle/phpbb_oracle_driver.php b/phpBB/phpbb/db/middleware/oracle/driver.php similarity index 83% rename from phpBB/phpbb/db/middleware/oracle/phpbb_oracle_driver.php rename to phpBB/phpbb/db/middleware/oracle/driver.php index fc341a2243..bb4172bfe0 100644 --- a/phpBB/phpbb/db/middleware/oracle/phpbb_oracle_driver.php +++ b/phpBB/phpbb/db/middleware/oracle/driver.php @@ -21,14 +21,14 @@ use Doctrine\DBAL\Platforms\AbstractPlatform; * Oracle Doctrine driver middleware. * Makes use of phpBB's Oracle specific platform. */ -class phpbb_oracle_driver extends AbstractDriverMiddleware +class driver extends AbstractDriverMiddleware { /** * {@inheritDoc} */ public function getSchemaManager(DoctrineConnection $conn, AbstractPlatform $platform) { - return new phpbb_oracle_schema_manager($conn, $platform); + return new schema_manager($conn, $platform); } /** @@ -36,6 +36,6 @@ class phpbb_oracle_driver extends AbstractDriverMiddleware */ public function createDatabasePlatformForVersion($version) { - return new phpbb_oracle_platform(); + return new platform(); } } diff --git a/phpBB/phpbb/db/middleware/oracle/phpbb_oracle_middleware.php b/phpBB/phpbb/db/middleware/oracle/middleware.php similarity index 78% rename from phpBB/phpbb/db/middleware/oracle/phpbb_oracle_middleware.php rename to phpBB/phpbb/db/middleware/oracle/middleware.php index be35ce963a..c54ca4d81d 100644 --- a/phpBB/phpbb/db/middleware/oracle/phpbb_oracle_middleware.php +++ b/phpBB/phpbb/db/middleware/oracle/middleware.php @@ -14,15 +14,16 @@ namespace phpbb\db\middleware\oracle; use Doctrine\DBAL\Driver; +use phpbb\db\middleware\oracle\driver as oracle_driver; /** * Oracle Doctrine middleware. * Makes use of phpBB's Oracle specific platform. */ -class phpbb_oracle_middleware implements Driver\Middleware +class middleware implements Driver\Middleware { public function wrap(Driver $driver): Driver { - return new phpbb_oracle_driver($driver); + return new oracle_driver($driver); } } diff --git a/phpBB/phpbb/db/middleware/oracle/phpbb_oracle_platform.php b/phpBB/phpbb/db/middleware/oracle/platform.php similarity index 98% rename from phpBB/phpbb/db/middleware/oracle/phpbb_oracle_platform.php rename to phpBB/phpbb/db/middleware/oracle/platform.php index efafcd768d..8604f50fb1 100644 --- a/phpBB/phpbb/db/middleware/oracle/phpbb_oracle_platform.php +++ b/phpBB/phpbb/db/middleware/oracle/platform.php @@ -21,7 +21,7 @@ use Doctrine\DBAL\Schema\Table; /** * Oracle specific schema restrictions for BC. */ -class phpbb_oracle_platform extends OraclePlatform +class platform extends OraclePlatform { /** * {@inheritDoc} diff --git a/phpBB/phpbb/db/middleware/oracle/phpbb_oracle_schema_manager.php b/phpBB/phpbb/db/middleware/oracle/schema_manager.php similarity index 94% rename from phpBB/phpbb/db/middleware/oracle/phpbb_oracle_schema_manager.php rename to phpBB/phpbb/db/middleware/oracle/schema_manager.php index 078630eb8a..2ec1c08df0 100644 --- a/phpBB/phpbb/db/middleware/oracle/phpbb_oracle_schema_manager.php +++ b/phpBB/phpbb/db/middleware/oracle/schema_manager.php @@ -18,7 +18,7 @@ use Doctrine\DBAL\Schema\AbstractSchemaManager; use Doctrine\DBAL\Schema\OracleSchemaManager; use Doctrine\DBAL\Schema\Table; -class phpbb_oracle_schema_manager extends OracleSchemaManager +class schema_manager extends OracleSchemaManager { /** * {@inheritdoc} diff --git a/phpBB/phpbb/db/middleware/postgresql/phpbb_postgresql_driver.php b/phpBB/phpbb/db/middleware/postgresql/driver.php similarity index 85% rename from phpBB/phpbb/db/middleware/postgresql/phpbb_postgresql_driver.php rename to phpBB/phpbb/db/middleware/postgresql/driver.php index 9464825c78..35a2de28be 100644 --- a/phpBB/phpbb/db/middleware/postgresql/phpbb_postgresql_driver.php +++ b/phpBB/phpbb/db/middleware/postgresql/driver.php @@ -19,13 +19,13 @@ use Doctrine\DBAL\Driver\Middleware\AbstractDriverMiddleware; * PostgreSQL Doctrine driver middleware. * Makes use of phpBB's PostgreSQL specific platform. */ -class phpbb_postgresql_driver extends AbstractDriverMiddleware +class driver extends AbstractDriverMiddleware { /** * {@inheritDoc} */ public function createDatabasePlatformForVersion($version) { - return new phpbb_postgresql_platform(); + return new platform(); } } diff --git a/phpBB/phpbb/db/middleware/postgresql/phpbb_postgresql_middleware.php b/phpBB/phpbb/db/middleware/postgresql/middleware.php similarity index 77% rename from phpBB/phpbb/db/middleware/postgresql/phpbb_postgresql_middleware.php rename to phpBB/phpbb/db/middleware/postgresql/middleware.php index 31d3fbcb20..defdcea6eb 100644 --- a/phpBB/phpbb/db/middleware/postgresql/phpbb_postgresql_middleware.php +++ b/phpBB/phpbb/db/middleware/postgresql/middleware.php @@ -14,15 +14,16 @@ namespace phpbb\db\middleware\postgresql; use Doctrine\DBAL\Driver; +use phpbb\db\middleware\postgresql\driver as postgresql_driver; /** * PostgreSQL Doctrine middleware. * Makes use of phpBB's PostgreSQL specific platform. */ -class phpbb_postgresql_middleware implements Driver\Middleware +class middleware implements Driver\Middleware { public function wrap(Driver $driver): Driver { - return new phpbb_postgresql_driver($driver); + return new postgresql_driver($driver); } } diff --git a/phpBB/phpbb/db/middleware/postgresql/phpbb_postgresql_platform.php b/phpBB/phpbb/db/middleware/postgresql/platform.php similarity index 98% rename from phpBB/phpbb/db/middleware/postgresql/phpbb_postgresql_platform.php rename to phpBB/phpbb/db/middleware/postgresql/platform.php index 7ed3508ba0..e5e7a9a1c6 100644 --- a/phpBB/phpbb/db/middleware/postgresql/phpbb_postgresql_platform.php +++ b/phpBB/phpbb/db/middleware/postgresql/platform.php @@ -31,7 +31,7 @@ use Doctrine\DBAL\Types\Type; * to stay compatible with the existing DB we have to change its * naming and not ours. */ -class phpbb_postgresql_platform extends PostgreSQLPlatform +class platform extends PostgreSQLPlatform { /** * {@inheritdoc} diff --git a/phpBB/phpbb/db/middleware/sqlsrv/phpbb_sqlsrv_driver.php b/phpBB/phpbb/db/middleware/sqlsrv/driver.php similarity index 86% rename from phpBB/phpbb/db/middleware/sqlsrv/phpbb_sqlsrv_driver.php rename to phpBB/phpbb/db/middleware/sqlsrv/driver.php index ba7ec877f6..4fbd9e33f0 100644 --- a/phpBB/phpbb/db/middleware/sqlsrv/phpbb_sqlsrv_driver.php +++ b/phpBB/phpbb/db/middleware/sqlsrv/driver.php @@ -19,13 +19,13 @@ use Doctrine\DBAL\Driver\Middleware\AbstractDriverMiddleware; * Microsoft SQL server Doctrine driver middleware. * Makes use of phpBB's SQL Server specific platform. */ -class phpbb_sqlsrv_driver extends AbstractDriverMiddleware +class driver extends AbstractDriverMiddleware { /** * {@inheritDoc} */ public function createDatabasePlatformForVersion($version) { - return new phpbb_sqlsrv_platform(); + return new platform(); } } diff --git a/phpBB/phpbb/db/middleware/sqlsrv/phpbb_sqlsrv_middleware.php b/phpBB/phpbb/db/middleware/sqlsrv/middleware.php similarity index 78% rename from phpBB/phpbb/db/middleware/sqlsrv/phpbb_sqlsrv_middleware.php rename to phpBB/phpbb/db/middleware/sqlsrv/middleware.php index a5603fd422..03814e8cfa 100644 --- a/phpBB/phpbb/db/middleware/sqlsrv/phpbb_sqlsrv_middleware.php +++ b/phpBB/phpbb/db/middleware/sqlsrv/middleware.php @@ -14,15 +14,16 @@ namespace phpbb\db\middleware\sqlsrv; use Doctrine\DBAL\Driver; +use phpbb\db\middleware\sqlsrv\driver as sqlsrv_driver; /** * Microsoft SQL server Doctrine middleware. * Makes use of phpBB's SQL Server specific platform. */ -class phpbb_sqlsrv_middleware implements Driver\Middleware +class middleware implements Driver\Middleware { public function wrap(Driver $driver): Driver { - return new phpbb_sqlsrv_driver($driver); + return new sqlsrv_driver($driver); } } diff --git a/phpBB/phpbb/db/middleware/sqlsrv/phpbb_sqlsrv_platform.php b/phpBB/phpbb/db/middleware/sqlsrv/platform.php similarity index 98% rename from phpBB/phpbb/db/middleware/sqlsrv/phpbb_sqlsrv_platform.php rename to phpBB/phpbb/db/middleware/sqlsrv/platform.php index 896cb72643..a7a58e3dda 100644 --- a/phpBB/phpbb/db/middleware/sqlsrv/phpbb_sqlsrv_platform.php +++ b/phpBB/phpbb/db/middleware/sqlsrv/platform.php @@ -20,7 +20,7 @@ use Doctrine\DBAL\Schema\TableDiff; /** * SQLServer specific schema restrictions for BC. */ -class phpbb_sqlsrv_platform extends SQLServerPlatform +class platform extends SQLServerPlatform { /** * {@inheritDoc}