Move and deprecate Schema methods

CHANGELOG.md

@@ -18,6 +18,11 @@
 - Enh #789: Remove unnecessary type casting to array in `AbstractDMLQueryBuilder::getTableUniqueColumnNames()` (@Tigrov)
 - Enh #795: Allow to use `DMLQueryBuilderInterface::batchInsert()` method with empty columns (@Tigrov)
 - Enh #794: Add message type to log context (@darkdef)
+- Enh #801: Deprecate `AbstractSchema::normalizeRowKeyCase()` method (@Tigrov)
+- Enh #801: Deprecate `SchemaInterface::getRawTableName()` and add `QuoterInterface::getRawTableName()` method (@Tigrov)
+- Enh #801: Deprecate `SchemaInterface::isReadQuery()` and add `DbStringHelper::isReadQuery()` method (@Tigrov)
+- Enh #801: Remove unnecessary symbol `\\` from `rtrim()` function inside `DbStringHelper::baseName()` method (@Tigrov)
+- Bug #801: Fix bug with `Quoter::$tablePrefix` when change `AbstractConnection::$tablePrefix` property (@Tigrov)
 
 ## 1.2.0 November 12, 2023
 

src/Driver/Pdo/AbstractPdoConnection.php

@@ -198,6 +198,12 @@
         $this->emulatePrepare = $value;
     }
 
+    public function setTablePrefix(string $value): void
+    {
+        parent::setTablePrefix($value);
+        $this->quoter?->setTablePrefix($value);
+    }
+
     /**
      * Initializes the DB connection.
      *

src/Helper/DbStringHelper.php

@@ -9,6 +9,7 @@
 use function mb_strrpos;
 use function mb_strtolower;
 use function mb_substr;
+use function preg_match;
 use function preg_replace;
 use function rtrim;
 use function str_replace;
@@ -38,7 +39,7 @@ final class DbStringHelper
      */
     public static function baseName(string $path): string
     {
-        $path = rtrim(str_replace('\\', '/', $path), '/\\');
+        $path = rtrim(str_replace('\\', '/', $path), '/');
         $position = mb_strrpos($path, '/');
 
         if ($position !== false) {
@@ -48,6 +49,20 @@ public static function baseName(string $path): string
         return $path;
     }
 
+    /**
+     * Returns a value indicating whether an SQL statement is for read purpose.
+     *
+     * @param string $sql The SQL statement.
+     *
+     * @return bool Whether an SQL statement is for read purpose.
+     */
+    public static function isReadQuery(string $sql): bool
+    {
+        $pattern = '/^\s*(SELECT|SHOW|DESCRIBE)\b/i';
+
+        return preg_match($pattern, $sql) === 1;
+    }
+
     /**
      * Returns string representation of a number value without a thousand separators and with dot as decimal separator.
      *

src/Schema/AbstractSchema.php

@@ -144,6 +144,7 @@ public function getDataType(mixed $data): int
         };
     }
 
+    /** @deprecated Use {@see QuoterInterface::getRawTableName()}. Will be removed in version 2.0.0. */
     public function getRawTableName(string $name): string
     {
         if (str_contains($name, '{{')) {
@@ -315,6 +316,7 @@ public function getTableUniques(string $name, bool $refresh = false): array
         return is_array($tableUniques) ? $tableUniques : [];
     }
 
+    /** @deprecated Use {@see DbStringHelper::isReadQuery()}. Will be removed in version 2.0.0. */
     public function isReadQuery(string $sql): bool
     {
         $pattern = '/^\s*(SELECT|SHOW|DESCRIBE)\b/i';
@@ -340,7 +342,7 @@ public function refresh(): void
      */
     public function refreshTableSchema(string $name): void
     {
-        $rawName = $this->getRawTableName($name);
+        $rawName = $this->db->getQuoter()->getRawTableName($name);
 
         unset($this->tableMetadata[$rawName]);
 
@@ -470,7 +472,7 @@ protected function getSchemaMetadata(string $schema, string $type, bool $refresh
      */
     protected function getTableMetadata(string $name, string $type, bool $refresh = false): mixed
     {
-        $rawName = $this->getRawTableName($name);
+        $rawName = $this->db->getQuoter()->getRawTableName($name);
 
         if (!isset($this->tableMetadata[$rawName])) {
             $this->loadTableMetadataFromCache($rawName);
@@ -532,6 +534,9 @@ protected function getTableTypeMetadata(
      * @param bool $multiple Whether many rows or a single row passed.
      *
      * @return array The normalized row or rows.
+     *
+     * @deprecated Use `array_change_key_case($row)` or `array_map('array_change_key_case', $row)`.
+     * Will be removed in version 2.0.0.
      */
     protected function normalizeRowKeyCase(array $row, bool $multiple): array
     {
@@ -568,7 +573,7 @@ protected function resolveTableName(string $name): TableSchemaInterface
     protected function setTableMetadata(string $name, string $type, mixed $data): void
     {
         /** @psalm-suppress MixedArrayAssignment  */
-        $this->tableMetadata[$this->getRawTableName($name)][$type] = $data;
+        $this->tableMetadata[$this->db->getQuoter()->getRawTableName($name)][$type] = $data;
     }
 
     /**

src/Schema/Quoter.php

@@ -83,6 +83,17 @@ public function cleanUpTableNames(array $tableNames): array
         return $cleanedUpTableNames;
     }
 
+    public function getRawTableName(string $name): string
+    {
+        if (str_contains($name, '{{')) {
+            $name = preg_replace('/{{(.*?)}}/', '\1', $name);
+
+            return str_replace('%', $this->tablePrefix, $name);
+        }
+
+        return $name;
+    }
+
     public function getTableNameParts(string $name, bool $withColumn = false): array
     {
         $parts = array_slice(explode('.', $name), -2, 2);
@@ -204,6 +215,11 @@ public function quoteValue(mixed $value): mixed
         return "'" . str_replace("'", "''", addcslashes($value, "\000\032")) . "'";
     }
 
+    public function setTablePrefix(string $value): void
+    {
+        $this->tablePrefix = $value;
+    }
+
     public function unquoteSimpleColumnName(string $name): string
     {
         if (is_string($this->columnQuoteCharacter)) {

src/Schema/QuoterInterface.php

@@ -26,6 +26,18 @@ interface QuoterInterface
      */
     public function cleanUpTableNames(array $tableNames): array;
 
+    /**
+     * Returns the actual name of a given table name.
+     *
+     * This method will strip off curly brackets from the given table name and replace the percentage character '%' with
+     * {@see ConnectionInterface::tablePrefix}.
+     *
+     * @param string $name The table name to convert.
+     *
+     * @return string The real name of the given table name.
+     */
+    public function getRawTableName(string $name): string;
+
     /**
      * Splits full table name into parts.
      *

src/Schema/SchemaInterface.php

@@ -284,6 +284,8 @@ public function getDataType(mixed $data): int;
      * @param string $name The table name to convert.
      *
      * @return string The real name of the given table name.
+     *
+     * @deprecated Use {@see QuoterInterface::getRawTableName()}. Will be removed in version 2.0.0.
      */
     public function getRawTableName(string $name): string;
 
@@ -367,6 +369,8 @@ public function getTableSchemas(string $schema = '', bool $refresh = false): arr
      * @param string $sql The SQL statement.
      *
      * @return bool Whether an SQL statement is for read purpose.
+     *
+     * @deprecated Use {@see DbStringHelper::isReadQuery()}. Will be removed in version 2.0.0.
      */
     public function isReadQuery(string $sql): bool;
 

tests/AbstractQuoterTest.php

@@ -31,6 +31,18 @@ public function testEnsureNameQuoted(string $name, string $expected): void
         $this->assertSame($expected, $db->getQuoter()->ensureNameQuoted($name));
     }
 
+    /**
+     * @dataProvider \Yiisoft\Db\Tests\Provider\QuoterProvider::rawTableNames
+     */
+    public function testGetRawTableName(string $tableName, string $expected, string $tablePrefix = ''): void
+    {
+        $db = $this->getConnection();
+
+        $db->setTablePrefix($tablePrefix);
+
+        $this->assertSame($expected, $db->getQuoter()->getRawTableName($tableName));
+    }
+
     /**
      * @dataProvider \Yiisoft\Db\Tests\Provider\QuoterProvider::tableNameParts
      */

tests/AbstractSchemaTest.php

@@ -6,6 +6,7 @@
 
 use PHPUnit\Framework\TestCase;
 use Yiisoft\Db\Command\DataType;
+use Yiisoft\Db\Helper\DbStringHelper;
 use Yiisoft\Db\Schema\Builder\ColumnInterface;
 use Yiisoft\Db\Schema\SchemaInterface;
 use Yiisoft\Db\Tests\Support\Assert;
@@ -76,14 +77,10 @@ public function testGetDataType(): void
 
     public function testIsReadQuery(): void
     {
-        $db = $this->getConnection();
-
-        $schema = $db->getSchema();
-
-        $this->assertTrue($schema->isReadQuery('SELECT * FROM tbl'));
-        $this->assertTrue($schema->isReadQuery('SELECT * FROM tbl WHERE id=1'));
-        $this->assertTrue($schema->isReadQuery('SELECT * FROM tbl WHERE id=1 LIMIT 1'));
-        $this->assertTrue($schema->isReadQuery('SELECT * FROM tbl WHERE id=1 LIMIT 1 OFFSET 1'));
+        $this->assertTrue(DbStringHelper::isReadQuery('SELECT * FROM tbl'));
+        $this->assertTrue(DbStringHelper::isReadQuery('SELECT * FROM tbl WHERE id=1'));
+        $this->assertTrue(DbStringHelper::isReadQuery('SELECT * FROM tbl WHERE id=1 LIMIT 1'));
+        $this->assertTrue(DbStringHelper::isReadQuery('SELECT * FROM tbl WHERE id=1 LIMIT 1 OFFSET 1'));
     }
 
     public function testRefresh(): void

tests/Provider/QuoterProvider.php

@@ -75,6 +75,22 @@ public static function simpleTableNames(): array
         ];
     }
 
+    /**
+     * @return string[][]
+     */
+    public static function rawTableNames(): array
+    {
+        return [
+            ['table', 'table'],
+            ['"table"', '"table"'],
+            ['public.table', 'public.table'],
+            ['{{table}}', 'table'],
+            ['{{public}}.{{table}}', 'public.table'],
+            ['{{%table}}', 'yii_table', 'yii_'],
+            ['{{public}}.{{%table}}', 'public.yii_table', 'yii_'],
+        ];
+    }
+
     /**
      * @return string[][]
      */