src/IndexColumn.php

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