libraries/classes/IndexColumn.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * holds the database index columns class
   5  *
   6  * @package PhpMyAdmin
   7  */
   8 namespace PhpMyAdmin;
   9
  10 /**
  11  * Index column wrapper
  12  *
  13  * @package PhpMyAdmin
  14  */
  15 class IndexColumn
  16 {
  17     /**
  18      * @var string The column name
  19      */
  20     private $_name = '';
  21
  22     /**
  23      * @var integer The column sequence number in the index, starting with 1.
  24      */
  25     private $_seq_in_index = 1;
  26
  27     /**
  28      * @var string How the column is sorted in the index. “A” (Ascending) or
  29      * NULL (Not sorted)
  30      */
  31     private $_collation = null;
  32
  33     /**
  34      * The number of indexed characters if the column is only partly indexed,
  35      * NULL if the entire column is indexed.
  36      *
  37      * @var integer
  38      */
  39     private $_sub_part = null;
  40
  41     /**
  42      * Contains YES if the column may contain NULL.
  43      * If not, the column contains NO.
  44      *
  45      * @var string
  46      */
  47     private $_null = '';
  48
  49     /**
  50      * An estimate of the number of unique values in the index. This is updated
  51      * by running ANALYZE TABLE or myisamchk -a. Cardinality is counted based on
  52      * statistics stored as integers, so the value is not necessarily exact even
  53      * for small tables. The higher the cardinality, the greater the chance that
  54      * MySQL uses the index when doing joins.
  55      *
  56      * @var integer
  57      */
  58     private $_cardinality = null;
  59
  60     /**
  61      * Constructor
  62      *
  63      * @param array $params an array containing the parameters of the index column
  64      */
  65     public function __construct(array $params = array())
  66     {
  67         $this->set($params);
  68     }
  69
  70     /**
  71      * Sets parameters of the index column
  72      *
  73      * @param array $params an array containing the parameters of the index column
  74      *
  75      * @return void
  76      */
  77     public function set(array $params)
  78     {
  79         if (isset($params['Column_name'])) {
  80             $this->_name = $params['Column_name'];
  81         }
  82         if (isset($params['Seq_in_index'])) {
  83             $this->_seq_in_index = $params['Seq_in_index'];
  84         }
  85         if (isset($params['Collation'])) {
  86             $this->_collation = $params['Collation'];
  87         }
  88         if (isset($params['Cardinality'])) {
  89             $this->_cardinality = $params['Cardinality'];
  90         }
  91         if (isset($params['Sub_part'])) {
  92             $this->_sub_part = $params['Sub_part'];
  93         }
  94         if (isset($params['Null'])) {
  95             $this->_null = $params['Null'];
  96         }
  97     }
  98
  99     /**
 100      * Returns the column name
 101      *
 102      * @return string column name
 103      */
 104     public function getName()
 105     {
 106         return $this->_name;
 107     }
 108
 109     /**
 110      * Return the column collation
 111      *
 112      * @return string column collation
 113      */
 114     public function getCollation()
 115     {
 116         return $this->_collation;
 117     }
 118
 119     /**
 120      * Returns the cardinality of the column
 121      *
 122      * @return int cardinality of the column
 123      */
 124     public function getCardinality()
 125     {
 126         return $this->_cardinality;
 127     }
 128
 129     /**
 130      * Returns whether the column is nullable
 131      *
 132      * @param boolean $as_text whether to returned the string representation
 133      *
 134      * @return mixed nullability of the column. True/false or Yes/No depending
 135      *               on the value of the $as_text parameter
 136      */
 137     public function getNull($as_text = false)
 138     {
 139         if ($as_text) {
 140             if (!$this->_null || $this->_null == 'NO') {
 141                 return __('No');
 142             }
 143
 144             return __('Yes');
 145         }
 146
 147         return $this->_null;
 148     }
 149
 150     /**
 151      * Returns the sequence number of the column in the index
 152      *
 153      * @return int sequence number of the column in the index
 154      */
 155     public function getSeqInIndex()
 156     {
 157         return $this->_seq_in_index;
 158     }
 159
 160     /**
 161      * Returns the number of indexed characters if the column is only
 162      * partly indexed
 163      *
 164      * @return int the number of indexed characters
 165      */
 166     public function getSubPart()
 167     {
 168         return $this->_sub_part;
 169     }
 170
 171     /**
 172      * Gets the properties in an array for comparison purposes
 173      *
 174      * @return array an array containing the properties of the index column
 175      */
 176     public function getCompareData()
 177     {
 178         return array(
 179             'Column_name'   => $this->_name,
 180             'Seq_in_index'  => $this->_seq_in_index,
 181             'Collation'     => $this->_collation,
 182             'Sub_part'      => $this->_sub_part,
 183             'Null'          => $this->_null,
 184         );
 185     }
 186 }