feat: add TableName class

Author: kenjis

system/Database/TableName.php

@@ -0,0 +1,55 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of CodeIgniter 4 framework.
+ *
+ * (c) CodeIgniter Foundation <[email protected]>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace CodeIgniter\Database;
+
+/**
+ * Represents a single table name.
+ *
+ * @see \CodeIgniter\Database\TableNameTest
+ */
+final class TableName
+{
+    /**
+     * @param string $raw     Raw real table name
+     * @param string $escaped Escaped real table name
+     */
+    public function __construct(
+        private string $raw,
+        private string $escaped
+    ) {
+    }
+
+    /**
+     * @param string $name       A single table name w/o alias
+     * @param bool   $actualName Set true if $name is the actual table name.
+     */
+    public static function create(string $name, BaseConnection $db, bool $actualName = false): self
+    {
+        if ($actualName === false) {
+            $name = $db->DBPrefix . $name;
+        }
+
+        return new self($name, $db->escapeIdentifier($name));
+    }
+
+    public function getEscaped(): string
+    {
+        return $this->escaped;
+    }
+
+    public function __toString(): string
+    {
+        return $this->raw;
+    }
+}

tests/system/Database/TableNameTest.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of CodeIgniter 4 framework.
+ *
+ * (c) CodeIgniter Foundation <[email protected]>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace CodeIgniter\Database;
+
+use CodeIgniter\Test\CIUnitTestCase;
+
+/**
+ * @internal
+ *
+ * @group Others
+ */
+final class TableNameTest extends CIUnitTestCase
+{
+    public function testCanCreateInstance(): void
+    {
+        $name = 'table';
+
+        $tableName = TableName::create($name, db_connect(), true);
+
+        $this->assertSame($name, (string) $tableName);
+    }
+
+    public function testCanConvertToString(): void
+    {
+        $raw     = 'table';
+        $escaped = '"table"';
+
+        $tableName = new TableName($raw, $escaped);
+
+        $this->assertSame($raw, (string) $tableName);
+    }
+
+    public function testCanGetEscapedName(): void
+    {
+        $raw     = 'table';
+        $escaped = '"table"';
+
+        $tableName = new TableName($raw, $escaped);
+
+        $this->assertSame($escaped, $tableName->getEscaped());
+    }
+}