*NEW*

ChangeLog

@@ -8,6 +8,7 @@ $Source$
 2006-02-21 Sebastian Mendel <cybot_tm@users.sourceforge.net>
     * libraries/common.lib.php PMA_getUvaCondition():
       do not test for isset but strlen on orgname of table
+    * libraries/Tabel.class.php: *NEW*
 
 2006-02-20 Marc Delisle  <lem9@users.sourceforge.net>
     ### 2.8.0-rc1 released

libraries/Table.class.php

@@ -0,0 +1,262 @@
+<?php
+
+
+class PMA_Table {
+
+    /**
+     * @var string  table name
+     */
+    var $name = '';
+
+    /**
+     * @var string  database name
+     */
+    var $db_name = '';
+
+    /**
+     * @var string  engine (innodb, myisam, bdb, ...)
+     */
+    var $engine = '';
+
+    /**
+     * @var string  type (view, base table, system view)
+     */
+    var $type = '';
+
+    /**
+     * @var array   settings
+     */
+    var $settings = array();
+
+    /**
+     * Constructor
+     *
+     * @param   string  $table_name table name
+     * @param   string  $db_name    database name
+     */
+    function __construct($table_name, $db_name)
+    {
+        $this->setName($table_name);
+        $this->setDbName($db_name);
+    }
+
+    /**
+     * @see PMA_Table::getName()
+     */
+    function __toString()
+    {
+        return $this->getName();
+    }
+
+    /**
+     * sets table anme
+     *
+     * @uses    $this->name to set it
+     * @param   string  $table_name new table name
+     */
+    function setName($table_name)
+    {
+        $this->name = $table_name;
+    }
+
+    /**
+     * returns table name
+     *
+     * @uses    $this->name as return value
+     * @param   boolean wether to quote name with backticks ``
+     * @return  string  table name
+     */
+    function getName($quoted = false)
+    {
+        if ( $quoted ) {
+            return PMA_backquote($this->name);
+        }
+        return $this->name;
+    }
+
+    /**
+     * sets database name for this table
+     *
+     * @uses    $this->db_name  to set it
+     * @param   string  $db_name
+     */
+    function setDbName($db_name)
+    {
+        $this->db_name = $db_name;
+    }
+
+    /**
+     * returns database name for this table
+     *
+     * @uses    $this->db_name  as return value
+     * @param   boolean wether to quote name with backticks ``
+     * @return  string  database name for this table
+     */
+    function getDbName($quoted = false)
+    {
+        if ( $quoted ) {
+            return PMA_backquote($this->db_name);
+        }
+        return $this->db_name;
+    }
+
+    /**
+     * returns full name for table, including database name
+     *
+     * @param   boolean wether to quote name with backticks ``
+     */
+    function getFullName($quoted = false)
+    {
+        return $this->getDbName($quoted) . '.' . $this->getName($quoted);
+    }
+
+    function isView()
+    {
+        if ( strpos($this->get('TABLE TYPE'), 'VIEW') ) {
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * sets given $value for given $param
+     *
+     * @uses    $this->settings to add or change value
+     * @param   string  param name
+     * @param   mixed   param value
+     */
+    function set($param, $value)
+    {
+        $this->settings[$param] = $value;
+    }
+
+    /**
+     * returns value for given setting/param
+     *
+     * @uses    $this->settings to return value
+     * @param   string  name for value to return
+     * @return  mixed   value for $param
+     */
+    function get($param)
+    {
+        if ( isset( $this->settings[$param]) ) {
+            return $this->settings[$param];
+        }
+
+        return null;
+    }
+
+    /**
+     * loads structure data
+     */
+    function loadStructure()
+    {
+        $table_info = PMA_DBI_get_tables_full($this->getDbName(), $this->getName());
+
+        if ( false === $table_info ) {
+            return false;
+        }
+
+        $this->settings = $table_info;
+
+        if ( $this->get('TABLE_ROWS') === null ) {
+            $this->set('TABLE_ROWS', PMA_countRecords($this->getDbName(),
+                $this->getName(), true, true));
+        }
+
+        $create_options = explode(' ', $this->get('TABLE_ROWS'));
+
+        // export create options by its name as variables into gloabel namespace
+        // f.e. pack_keys=1 becomes available as $pack_keys with value of '1'
+        foreach ( $create_options as $each_create_option ) {
+            $each_create_option = explode('=', $each_create_option);
+            if ( isset( $each_create_option[1] ) ) {
+                $this->set($$each_create_option[0], $each_create_option[1]);
+            }
+        }
+    }
+
+    /**
+     * old PHP 4style constructor
+     *
+     * @see     PMA_Table::__construct()
+     */
+    function PMA_Table()
+    {
+        $this->__construct();
+    }
+
+    /**
+     * @TODO    add documentation
+     *
+     * @static
+     */
+    function generateFieldSpec($name, $type, $length, $attribute,
+        $collation, $null, $default, $default_current_timestamp, $extra,
+        $comment='', &$field_primary, $index, $default_orig = false)
+    {
+
+        // $default_current_timestamp has priority over $default
+        // TODO: on the interface, some js to clear the default value
+        // when the default current_timestamp is checked
+
+        $query = PMA_backquote($name) . ' ' . $type;
+
+        if ($length != ''
+            && !preg_match('@^(DATE|DATETIME|TIME|TINYBLOB|TINYTEXT|BLOB|TEXT|MEDIUMBLOB|MEDIUMTEXT|LONGBLOB|LONGTEXT)$@i', $type)) {
+            $query .= '(' . $length . ')';
+        }
+
+        if ($attribute != '') {
+            $query .= ' ' . $attribute;
+        }
+
+        if (PMA_MYSQL_INT_VERSION >= 40100 && !empty($collation)
+          && $collation != 'NULL'
+          && preg_match('@^(TINYTEXT|TEXT|MEDIUMTEXT|LONGTEXT|VARCHAR|CHAR|ENUM|SET)$@i', $type)) {
+            $query .= PMA_generateCharsetQueryPart($collation);
+        }
+
+        if (!($null === false)) {
+            if (!empty($null)) {
+                $query .= ' NOT NULL';
+            } else {
+                $query .= ' NULL';
+            }
+        }
+
+        if ($default_current_timestamp && strpos(' ' . strtoupper($type), 'TIMESTAMP') == 1) {
+            $query .= ' DEFAULT CURRENT_TIMESTAMP';
+            // 0 is empty in PHP
+            // auto_increment field cannot have a default value
+        } elseif ($extra !== 'AUTO_INCREMENT' && (!empty($default) || $default == '0' || $default != $default_orig)) {
+            if (strtoupper($default) == 'NULL') {
+                $query .= ' DEFAULT NULL';
+            } else {
+                $query .= ' DEFAULT \'' . PMA_sqlAddslashes($default) . '\'';
+            }
+        }
+
+        if (!empty($extra)) {
+            $query .= ' ' . $extra;
+            // An auto_increment field must be use as a primary key
+            if ($extra == 'AUTO_INCREMENT' && isset($field_primary)) {
+                $primary_cnt = count($field_primary);
+                for ($j = 0; $j < $primary_cnt && $field_primary[$j] != $index; $j++) {
+                    // void
+                } // end for
+                if (isset($field_primary[$j]) && $field_primary[$j] == $index) {
+                    $query .= ' PRIMARY KEY';
+                    unset($field_primary[$j]);
+                } // end if
+            } // end if (auto_increment)
+        }
+        if (PMA_MYSQL_INT_VERSION >= 40100 && !empty($comment)) {
+            $query .= " COMMENT '" . PMA_sqlAddslashes($comment) . "'";
+        }
+        return $query;
+    } // end function
+
+}
+?>