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