Added warning to escape on $selectClause argument

Author: samuelgfeller

src/Trait/DatabaseTableExtensionTestTrait.php

@@ -15,7 +15,9 @@ trait DatabaseTableExtensionTestTrait
      * @param string $table Table name
      * @param string $whereColumn The column name of the select query
      * @param mixed $whereValue The value that will be searched for
-     * @param string|array $selectClause Fields array or string after SELECT and before FROM like 'id, name'
+     * @param string|array $selectClause Fields array or string after "SELECT" and before "FROM" like 'id, `name`'
+     * WARNING: the column names passed as array or string must be escaped with ` if they match a reserved word
+     * Example: ['`column_name`', '`column_name_2`'] or '`column_name`, `column_name_2`'
      *
      * @return array[] array or rows
      */
@@ -40,7 +42,9 @@ protected function findTableRowsByColumn(
      *
      * @param string $table Table name
      * @param string $whereString
-     * @param string|array $selectClause Fields array or string after SELECT and before FROM like 'id, name'
+     * @param string|array $selectClause Fields array or string after "SELECT" and before "FROM" like 'id, `name`'
+     * WARNING: the column names passed as array or string must be escaped with ` if they match a reserved word
+     * Example: ['`column_name`', '`column_name_2`'] or '`column_name`, `column_name_2`'
      * @param string $joinString
      *
      * @return array[] array or rows
@@ -84,7 +88,9 @@ protected function findLastInsertedTableRow(string $table): array
      * @param string $table Table to look into
      * @param string $whereColumn The column of the search query
      * @param mixed $whereValue The value that will be searched for
-     * @param string|array|null $selectClause Fields array or string after SELECT and before FROM like 'id, name'
+     * @param string|array|null $selectClause Fields array or string after "SELECT" and before "FROM" like 'id, `name`'
+     * WARNING: the column names passed as array or string must be escaped with ` if they match a reserved word
+     * Example: ['`column_name`', '`column_name_2`'] or '`column_name`, `column_name_2`'
      * @param string $message Optional message
      *
      * @return void
@@ -101,7 +107,7 @@ protected function assertTableRowsByColumn(
             $table,
             $whereColumn,
             $whereValue,
-            $selectClause ?: array_keys($expectedRow)
+            $selectClause ?: array_map(fn ($key) => "`$key`", array_keys($expectedRow))
         );
         foreach ($rows as $row) {
             $this->assertSame(

src/Trait/DatabaseTableTestTrait.php

@@ -16,7 +16,9 @@ trait DatabaseTableTestTrait
      * @param array $expectedRow Row expected to find
      * @param string $table Table to look into
      * @param int $id The primary key
-     * @param string|array|null $selectClause Fields array or string after SELECT and before FROM like 'id, name'
+     * @param string|array|null $selectClause Fields array or string after "SELECT" and before "FROM" like 'id, `name`'
+     * WARNING: the column names passed as array or string must be escaped with ` if they match a reserved word
+     * Example: ['`column_name`', '`column_name_2`'] or '`column_name`, `column_name_2`'
      * @param string $message Optional message
      *
      * @return void
@@ -30,7 +32,11 @@ protected function assertTableRow(
     ): void {
         $this->assertSame(
             $expectedRow,
-            $this->getTableRowById($table, $id, $selectClause ?: array_keys($expectedRow)),
+            $this->getTableRowById(
+                $table,
+                $id,
+                $selectClause ?: array_map(fn ($key) => "`$key`", array_keys($expectedRow))
+            ),
             $message
         );
     }
@@ -40,7 +46,9 @@ protected function assertTableRow(
      *
      * @param string $table Table name
      * @param int $id The primary key value
-     * @param string|array $selectClause Fields string after SELECT and before FROM like 'id, name'
+     * @param string|array $selectClause Fields array or string after "SELECT" and before "FROM" like 'id, `name`'
+     * WARNING: the column names passed as array or string must be escaped with ` if they match a reserved word
+     * Example: ['`column_name`', '`column_name_2`'] or '`column_name`, `column_name_2`'
      *
      * @throws DomainException
      *
@@ -71,7 +79,9 @@ protected function getTableRowById(string $table, int $id, string|array $selectC
      * @param array $expectedRow Row expected to find
      * @param string $table Table to look into
      * @param int $id The primary key
-     * @param string|array|null $selectClause Fields array or string after SELECT and before FROM like 'id, name'
+     * @param string|array|null $selectClause Fields array or string after "SELECT" and before "FROM" like 'id, `name`'
+     * WARNING: the column names passed as array or string must be escaped with ` if they match a reserved word
+     * Example: ['`column_name`', '`column_name_2`'] or '`column_name`, `column_name_2`'
      * @param string $message Optional message
      *
      * @return void
@@ -85,7 +95,11 @@ protected function assertTableRowEquals(
     ): void {
         $this->assertEquals(
             $expectedRow,
-            $this->getTableRowById($table, $id, $selectClause ?: array_keys($expectedRow)),
+            $this->getTableRowById(
+                $table,
+                $id,
+                $selectClause ?: array_map(fn ($key) => "`$key`", array_keys($expectedRow))
+            ),
             $message
         );
     }