aboutsummaryrefslogtreecommitdiff
path: root/srcs/phpmyadmin/libraries/classes/Server/Plugin.php
blob: 9b45297a7e651aafbf6d3fdb6364866a3097d133 (plain)
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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
<?php
/**
 * Server Plugin value object
 * @package PhpMyAdmin\Server
 */
declare(strict_types=1);

namespace PhpMyAdmin\Server;

/**
 * Server Plugin value object
 * @package PhpMyAdmin\Server
 */
final class Plugin
{
    /**
     * @var string
     */
    private $name;

    /**
     * @var string|null
     */
    private $version;

    /**
     * @var string
     */
    private $status;

    /**
     * @var string
     */
    private $type;

    /**
     * @var string|null
     */
    private $typeVersion;

    /**
     * @var string|null
     */
    private $library;

    /**
     * @var string|null
     */
    private $libraryVersion;

    /**
     * @var string|null
     */
    private $author;

    /**
     * @var string|null
     */
    private $description;

    /**
     * @var string
     */
    private $license;

    /**
     * @var string|null
     */
    private $loadOption;

    /**
     * @var string|null
     */
    private $maturity;

    /**
     * @var string|null
     */
    private $authVersion;

    /**
     * @param string      $name           Name of the plugin
     * @param string|null $version        Version from the plugin's general type descriptor
     * @param string      $status         Plugin status
     * @param string      $type           Type of plugin
     * @param string|null $typeVersion    Version from the plugin's type-specific descriptor
     * @param string|null $library        Plugin's shared object file name
     * @param string|null $libraryVersion Version from the plugin's API interface
     * @param string|null $author         Author of the plugin
     * @param string|null $description    Description
     * @param string      $license        Plugin's licence
     * @param string|null $loadOption     How the plugin was loaded
     * @param string|null $maturity       Plugin's maturity level
     * @param string|null $authVersion    Plugin's version as determined by the plugin author
     */
    private function __construct(
        string $name,
        ?string $version,
        string $status,
        string $type,
        ?string $typeVersion,
        ?string $library,
        ?string $libraryVersion,
        ?string $author,
        ?string $description,
        string $license,
        ?string $loadOption,
        ?string $maturity,
        ?string $authVersion
    ) {
        $this->name = $name;
        $this->version = $version;
        $this->status = $status;
        $this->type = $type;
        $this->typeVersion = $typeVersion;
        $this->library = $library;
        $this->libraryVersion = $libraryVersion;
        $this->author = $author;
        $this->description = $description;
        $this->license = $license;
        $this->loadOption = $loadOption;
        $this->maturity = $maturity;
        $this->authVersion = $authVersion;
    }

    /**
     * @param array $state array with the properties
     * @return self
     */
    public static function fromState(array $state): self
    {
        return new self(
            $state['name'] ?? '',
            $state['version'] ?? null,
            $state['status'] ?? '',
            $state['type'] ?? '',
            $state['typeVersion'] ?? null,
            $state['library'] ?? null,
            $state['libraryVersion'] ?? null,
            $state['author'] ?? null,
            $state['description'] ?? null,
            $state['license'] ?? '',
            $state['loadOption'] ?? null,
            $state['maturity'] ?? null,
            $state['authVersion'] ?? null
        );
    }

    /**
     * @return array
     */
    public function toArray(): array
    {
        return [
            'name' => $this->getName(),
            'version' => $this->getVersion(),
            'status' => $this->getStatus(),
            'type' => $this->getType(),
            'type_version' => $this->getTypeVersion(),
            'library' => $this->getLibrary(),
            'library_version' => $this->getLibraryVersion(),
            'author' => $this->getAuthor(),
            'description' => $this->getDescription(),
            'license' => $this->getLicense(),
            'load_option' => $this->getLoadOption(),
            'maturity' => $this->getMaturity(),
            'auth_version' => $this->getAuthVersion(),
        ];
    }

    /**
     * @return string
     */
    public function getName(): string
    {
        return $this->name;
    }

    /**
     * @return string|null
     */
    public function getVersion(): ?string
    {
        return $this->version;
    }

    /**
     * @return string
     */
    public function getStatus(): string
    {
        return $this->status;
    }

    /**
     * @return string
     */
    public function getType(): string
    {
        return $this->type;
    }

    /**
     * @return string|null
     */
    public function getTypeVersion(): ?string
    {
        return $this->typeVersion;
    }

    /**
     * @return string|null
     */
    public function getLibrary(): ?string
    {
        return $this->library;
    }

    /**
     * @return string|null
     */
    public function getLibraryVersion(): ?string
    {
        return $this->libraryVersion;
    }

    /**
     * @return string|null
     */
    public function getAuthor(): ?string
    {
        return $this->author;
    }

    /**
     * @return string|null
     */
    public function getDescription(): ?string
    {
        return $this->description;
    }

    /**
     * @return string
     */
    public function getLicense(): string
    {
        return $this->license;
    }

    /**
     * @return string|null
     */
    public function getLoadOption(): ?string
    {
        return $this->loadOption;
    }

    /**
     * @return string|null
     */
    public function getMaturity(): ?string
    {
        return $this->maturity;
    }

    /**
     * @return string|null
     */
    public function getAuthVersion(): ?string
    {
        return $this->authVersion;
    }
}