phpmyadmin/libraries/plugins/schema/TableStats.class.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Contains abstract class to hold table preferences/statistics
   5  *
   6  * @package PhpMyAdmin
   7  */
   8 if (! defined('PHPMYADMIN')) {
   9     exit;
  10 }
  11
  12 /**
  13  * Table preferences/statistics
  14  *
  15  * This class preserves the table co-ordinates,fields
  16  * and helps in drawing/generating the tables.
  17  *
  18  * @package PhpMyAdmin
  19  * @abstract
  20  */
  21 abstract class TableStats
  22 {
  23     protected $diagram;
  24     protected $db;
  25     protected $pageNumber;
  26     protected $tableName;
  27
  28     protected $showKeys;
  29     protected $tableDimension;
  30
  31     public $displayfield;
  32     public $fields = array();
  33     public $primary = array();
  34     public $x, $y;
  35
  36     public $width = 0;
  37     public $heightCell = 0;
  38
  39     protected $offline;
  40
  41     /**
  42      * Constructor
  43      *
  44      * @param object  $diagram        schema diagram
  45      * @param string  $db             current db name
  46      * @param integer $pageNumber     current page number (from the
  47      *                                $cfg['Servers'][$i]['table_coords'] table)
  48      * @param string  $tableName      table name
  49      * @param boolean $showKeys       whether to display keys or not
  50      * @param boolean $tableDimension whether to display table position or not
  51      * @param boolean $offline        whether the coordinates are sent
  52      *                                from the browser
  53      */
  54     public function __construct(
  55         $diagram, $db, $pageNumber, $tableName, $showKeys, $tableDimension, $offline
  56     ) {
  57         $this->diagram    = $diagram;
  58         $this->db         = $db;
  59         $this->pageNumber = $pageNumber;
  60         $this->tableName  = $tableName;
  61
  62         $this->showKeys   = $showKeys;
  63         $this->tableDimension   = $tableDimension;
  64
  65         $this->offline    = $offline;
  66
  67         // checks whether the table exists
  68         // and loads fields
  69         $this->validateTableAndLoadFields();
  70         // load table coordinates
  71         $this->loadCoordinates();
  72         // loads display field
  73         $this->loadDisplayField();
  74         // loads primary keys
  75         $this->loadPrimaryKey();
  76     }
  77
  78     /**
  79      * Validate whether the table exists.
  80      *
  81      * @return void
  82      */
  83     protected function validateTableAndLoadFields()
  84     {
  85         $sql = 'DESCRIBE ' . PMA_Util::backquote($this->tableName);
  86         $result = $GLOBALS['dbi']->tryQuery(
  87             $sql, null, PMA_DatabaseInterface::QUERY_STORE
  88         );
  89         if (! $result || ! $GLOBALS['dbi']->numRows($result)) {
  90             $this->showMissingTableError();
  91         }
  92
  93         if ($this->showKeys) {
  94             $indexes = PMA_Index::getFromTable($this->tableName, $this->db);
  95             $all_columns = array();
  96             foreach ($indexes as $index) {
  97                 $all_columns = array_merge(
  98                     $all_columns,
  99                     array_flip(array_keys($index->getColumns()))
 100                 );
 101             }
 102             $this->fields = array_keys($all_columns);
 103         } else {
 104             while ($row = $GLOBALS['dbi']->fetchRow($result)) {
 105                 $this->fields[] = $row[0];
 106             }
 107         }
 108     }
 109
 110     /**
 111      * Displays an error when the table cannot be found.
 112      *
 113      * @return void
 114      * @abstract
 115      */
 116     protected abstract function showMissingTableError();
 117
 118     /**
 119      * Loads coordinates of a table
 120      *
 121      * @return void
 122      */
 123     protected function loadCoordinates()
 124     {
 125         foreach ($_REQUEST['t_h'] as $key => $value) {
 126             if ($this->db . '.' . $this->tableName == $key) {
 127                 $this->x = (double) $_REQUEST['t_x'][$key];
 128                 $this->y = (double) $_REQUEST['t_y'][$key];
 129                 break;
 130             }
 131         }
 132     }
 133
 134     /**
 135      * Loads the table's display field
 136      *
 137      * @return void
 138      */
 139     protected function loadDisplayField()
 140     {
 141         $this->displayfield = PMA_getDisplayField($this->db, $this->tableName);
 142     }
 143
 144     /**
 145      * Loads the PRIMARY key.
 146      *
 147      * @return void
 148      */
 149     protected function loadPrimaryKey()
 150     {
 151         $result = $GLOBALS['dbi']->query(
 152             'SHOW INDEX FROM ' . PMA_Util::backquote($this->tableName) . ';',
 153             null, PMA_DatabaseInterface::QUERY_STORE
 154         );
 155         if ($GLOBALS['dbi']->numRows($result) > 0) {
 156             while ($row = $GLOBALS['dbi']->fetchAssoc($result)) {
 157                 if ($row['Key_name'] == 'PRIMARY') {
 158                     $this->primary[] = $row['Column_name'];
 159                 }
 160             }
 161         }
 162     }
 163
 164     /**
 165      * Returns title of the current table,
 166      * title can have the dimensions/co-ordinates of the table
 167      *
 168      * @return string title of the current table
 169      */
 170     protected function getTitle()
 171     {
 172         return ($this->tableDimension
 173             ? sprintf('%.0fx%0.f', $this->width, $this->heightCell)
 174             : ''
 175         )
 176         . ' ' . $this->tableName;
 177     }
 178 }