Skip to content

Commit 583a080

Browse files
kenjiskenjis
committed
feat: add TableName class
1 parent 0572f98 commit 583a080

File tree

2 files changed

+240
-0
lines changed

2 files changed

+240
-0
lines changed

‎system/Database/TableName.php‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
/**
6+
* This file is part of CodeIgniter 4 framework.
7+
*
8+
* (c) CodeIgniter Foundation <[email protected]>
9+
*
10+
* For the full copyright and license information, please view
11+
* the LICENSE file that was distributed with this source code.
12+
*/
13+
14+
namespace CodeIgniter\Database;
15+
16+
/**
17+
* Represents a table name in SQL.
18+
*
19+
* @see \CodeIgniter\Database\TableNameTest
20+
*/
21+
class TableName
22+
{
23+
/**
24+
* @param string $actualTable Actual table name
25+
* @param string $logicalTable Logical table name (w/o DB prefix)
26+
* @param string $schema Schema name
27+
* @param string $database Database name
28+
* @param string $alias Alias name
29+
*/
30+
protected function __construct(
31+
private readonly string $actualTable,
32+
private readonly string $logicalTable = '',
33+
private readonly string $schema = '',
34+
private readonly string $database = '',
35+
private readonly string $alias = ''
36+
) {
37+
}
38+
39+
/**
40+
* Creates a new instance.
41+
*
42+
* @param string $table Table name (w/o DB prefix)
43+
* @param string $alias Alias name
44+
*/
45+
public static function create(BaseConnection $db, string $table, string $alias = ''): self
46+
{
47+
return new self(
48+
$db->DBPrefix . $table,
49+
$table,
50+
'',
51+
'',
52+
$alias
53+
);
54+
}
55+
56+
/**
57+
* Creates a new instance from an actual table name.
58+
*
59+
* @param string $actualTable Actual table name with DB prefix
60+
* @param string $alias Alias name
61+
*/
62+
public static function fromActualName(BaseConnection $db, string $actualTable, string $alias = ''): self
63+
{
64+
$prefix = $db->DBPrefix;
65+
$logicalTable = '';
66+
67+
if (str_starts_with($actualTable, $prefix)) {
68+
$logicalTable = substr($actualTable, strlen($prefix));
69+
}
70+
71+
return new self(
72+
$actualTable,
73+
$logicalTable,
74+
'',
75+
$alias
76+
);
77+
}
78+
79+
/**
80+
* Creates a new instance from full name.
81+
*
82+
* @param string $table Table name (w/o DB prefix)
83+
* @param string $schema Schema name
84+
* @param string $database Database name
85+
* @param string $alias Alias name
86+
*/
87+
public static function fromFullName(
88+
BaseConnection $db,
89+
string $table,
90+
string $schema = '',
91+
string $database = '',
92+
string $alias = ''
93+
): self {
94+
return new self(
95+
$db->DBPrefix . $table,
96+
$table,
97+
$schema,
98+
$database,
99+
$alias
100+
);
101+
}
102+
103+
/**
104+
* Returns the single segment table name w/o DB prefix.
105+
*/
106+
public function getTableName(): string
107+
{
108+
return $this->logicalTable;
109+
}
110+
111+
/**
112+
* Returns the actual single segment table name w/z DB prefix.
113+
*/
114+
public function getActualTableName(): string
115+
{
116+
return $this->actualTable;
117+
}
118+
119+
public function getAlias(): string
120+
{
121+
return $this->alias;
122+
}
123+
124+
public function getSchema(): string
125+
{
126+
return $this->schema;
127+
}
128+
129+
public function getDatabase(): string
130+
{
131+
return $this->database;
132+
}
133+
}

‎tests/system/Database/TableNameTest.php‎

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
/**
6+
* This file is part of CodeIgniter 4 framework.
7+
*
8+
* (c) CodeIgniter Foundation <[email protected]>
9+
*
10+
* For the full copyright and license information, please view
11+
* the LICENSE file that was distributed with this source code.
12+
*/
13+
14+
namespace CodeIgniter\Database;
15+
16+
use CodeIgniter\Test\CIUnitTestCase;
17+
use CodeIgniter\Test\Mock\MockConnection;
18+
19+
/**
20+
* @internal
21+
*
22+
* @group Others
23+
*/
24+
final class TableNameTest extends CIUnitTestCase
25+
{
26+
protected function setUp(): void
27+
{
28+
parent::setUp();
29+
30+
$this->db = new MockConnection([
31+
'database' => 'test',
32+
'DBPrefix' => 'db_',
33+
'schema' => 'dbo',
34+
]);
35+
}
36+
37+
public function testInstantiate(): void
38+
{
39+
$table = 'table';
40+
41+
$tableName = TableName::create($this->db, $table);
42+
43+
$this->assertInstanceOf(TableName::class, $tableName);
44+
}
45+
46+
public function testCreateAndTableName(): void
47+
{
48+
$table = 'table';
49+
50+
$tableName = TableName::create($this->db, $table);
51+
52+
$this->assertSame($table, $tableName->getTableName());
53+
$this->assertSame('db_table', $tableName->getActualTableName());
54+
}
55+
56+
public function testFromActualNameAndTableNameWithPrefix(): void
57+
{
58+
$actualTable = 'db_table';
59+
60+
$tableName = TableName::fromActualName($this->db, $actualTable);
61+
62+
$this->assertSame('table', $tableName->getTableName());
63+
$this->assertSame($actualTable, $tableName->getActualTableName());
64+
}
65+
66+
public function testFromActualNameAndTableNameWithoutPrefix(): void
67+
{
68+
$actualTable = 'table';
69+
70+
$tableName = TableName::fromActualName($this->db, $actualTable);
71+
72+
$this->assertSame('', $tableName->getTableName());
73+
$this->assertSame($actualTable, $tableName->getActualTableName());
74+
}
75+
76+
public function testGetAlias(): void
77+
{
78+
$table = 'table';
79+
$alias = 't';
80+
81+
$tableName = TableName::create($this->db, $table, $alias);
82+
83+
$this->assertSame($alias, $tableName->getAlias());
84+
}
85+
86+
public function testGetSchema(): void
87+
{
88+
$table = 'table';
89+
$schema = 'dbo';
90+
$database = 'test';
91+
92+
$tableName = TableName::fromFullName($this->db, $table, $schema, $database);
93+
94+
$this->assertSame($schema, $tableName->getSchema());
95+
}
96+
97+
public function testGetDatabase(): void
98+
{
99+
$table = 'table';
100+
$schema = 'dbo';
101+
$database = 'test';
102+
103+
$tableName = TableName::fromFullName($this->db, $table, $schema, $database);
104+
105+
$this->assertSame($database, $tableName->getDatabase());
106+
}
107+
}

0 commit comments

Comments
 (0)