phpmyadmin/libraries/classes/Database/Designer/DesignerTable.php
Maurício Meneghini Fauth f80d3e3bd4 Remove unnecessary annotations
@package, @subpackage and others.

Signed-off-by: Maurício Meneghini Fauth <mauricio@fauth.dev>
2020-01-20 17:35:56 -03:00

100 lines
2.0 KiB
PHP

<?php
/**
* Holds the PhpMyAdmin\Database\Designer\DesignerTable class
*/
namespace PhpMyAdmin\Database\Designer;
use PhpMyAdmin\Util;
/**
* Common functions for Designer
*/
class DesignerTable
{
private $tableName;
private $databaseName;
private $tableEngine;
private $displayField;
/**
* Create a new DesignerTable
*
* @param string $databaseName The database name
* @param string $tableName The table name
* @param string $tableEngine The table engine
* @param string|null $displayField The display field if available
*/
public function __construct(
string $databaseName,
string $tableName,
string $tableEngine,
?string $displayField
) {
$this->databaseName = $databaseName;
$this->tableName = $tableName;
$this->tableEngine = $tableEngine;
$this->displayField = $displayField;
}
/**
* The table engine supports or not foreign keys
*
* @return bool
*/
public function supportsForeignkeys(): bool
{
return Util::isForeignKeySupported($this->tableEngine);
}
/**
* Get the database name
*
* @return string
*/
public function getDatabaseName(): string
{
return $this->databaseName;
}
/**
* Get the table name
*
* @return string
*/
public function getTableName(): string
{
return $this->tableName;
}
/**
* Get the table engine
*
* @return string
*/
public function getTableEngine(): string
{
return $this->tableEngine;
}
/**
* Get the displayed field
*
* @return string
*/
public function getDisplayField()
{
return $this->displayField;
}
/**
* Get the db and table separated with a dot
*
* @return string
*/
public function getDbTableString(): string
{
return $this->databaseName . '.' . $this->tableName;
}
}