DesignerTable.php 1.84 KB
Newer Older
Hamza Arfaoui's avatar
Hamza Arfaoui committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
<?php
/* vim: set expandtab sw=4 ts=4 sts=4: */
/**
 * Holds the PhpMyAdmin\Database\Designer\DesignerTable class
 *
 * @package PhpMyAdmin-Designer
 */
namespace PhpMyAdmin\Database\Designer;

use PhpMyAdmin\Util;

/**
 * Common functions for Designer
 *
 * @package PhpMyAdmin-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(
        $databaseName,
        $tableName,
        $tableEngine,
        $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() {
        return Util::isForeignKeySupported($this->tableEngine);
    }

    /**
     * Get the database name
     *
     * @return string
     */
    public function getDatabaseName() {
        return $this->databaseName;
    }

    /**
     * Get the table name
     *
     * @return string
     */
    public function getTableName() {
        return $this->tableName;
    }

    /**
     * Get the table engine
     *
     * @return string
     */
    public function getTableEngine() {
        return $this->tableEngine;
    }

    /**
     * Get the db and table speparated with a dot
     *
     * @return string
     */
    public function getDbTableString() {
        return $this->databaseName . '.' . $this->tableName;
    }
}