libraries/classes/IndexColumn.php

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