|
1
|
|
|
<?php |
|
2
|
|
|
/** |
|
3
|
|
|
* @author: Viskov Sergey |
|
4
|
|
|
* @date: 3/17/16 |
|
5
|
|
|
* @time: 2:32 PM |
|
6
|
|
|
*/ |
|
7
|
|
|
|
|
8
|
|
|
namespace LTDBeget\sphinx\informer; |
|
9
|
|
|
|
|
10
|
|
|
|
|
11
|
|
|
use LTDBeget\sphinx\enums\base\eOption; |
|
12
|
|
|
use LTDBeget\sphinx\enums\eSection; |
|
13
|
|
|
use LTDBeget\sphinx\enums\eVersion; |
|
14
|
|
|
|
|
15
|
|
|
/** |
|
16
|
|
|
* Class OptionInfo |
|
17
|
|
|
* structure class for storing option info |
|
18
|
|
|
* @package LTDBeget\sphinx\informer |
|
19
|
|
|
*/ |
|
20
|
|
|
final class OptionInfo |
|
21
|
|
|
{ |
|
22
|
|
|
/** |
|
23
|
|
|
* OptionInfo constructor. |
|
24
|
|
|
* @param eOption $name |
|
25
|
|
|
* @param eSection $section |
|
26
|
|
|
* @param eVersion $version |
|
27
|
|
|
* @param string $description |
|
28
|
|
|
* @param bool $isMultiValue |
|
29
|
|
|
* @param string $docLink |
|
30
|
|
|
*/ |
|
31
|
3 |
|
public function __construct( |
|
32
|
|
|
eOption $name, |
|
33
|
|
|
eSection $section, |
|
34
|
|
|
eVersion $version, |
|
35
|
|
|
string $description, |
|
36
|
|
|
bool $isMultiValue, |
|
37
|
|
|
string $docLink |
|
38
|
|
|
) |
|
39
|
|
|
{ |
|
40
|
3 |
|
$this->name = $name; |
|
41
|
3 |
|
$this->section = $section; |
|
42
|
3 |
|
$this->version = $version; |
|
43
|
3 |
|
$this->description = $description; |
|
44
|
3 |
|
$this->isMultiValue = $isMultiValue; |
|
45
|
3 |
|
$this->docLink = $docLink; |
|
46
|
|
|
|
|
47
|
3 |
|
} |
|
48
|
|
|
|
|
49
|
|
|
/** |
|
50
|
|
|
* name of option |
|
51
|
|
|
* @return eOption |
|
52
|
|
|
*/ |
|
53
|
1 |
|
public function getName() : eOption |
|
54
|
|
|
{ |
|
55
|
1 |
|
return $this->name; |
|
56
|
|
|
} |
|
57
|
|
|
|
|
58
|
|
|
/** |
|
59
|
|
|
* in what section option store |
|
60
|
|
|
* @return eSection |
|
61
|
|
|
*/ |
|
62
|
1 |
|
public function getSection() : eSection |
|
63
|
|
|
{ |
|
64
|
1 |
|
return $this->section; |
|
65
|
|
|
} |
|
66
|
|
|
|
|
67
|
|
|
/** |
|
68
|
|
|
* Version of documentation info |
|
69
|
|
|
* @return eVersion |
|
70
|
|
|
*/ |
|
71
|
1 |
|
public function getVersion() : eVersion |
|
72
|
|
|
{ |
|
73
|
1 |
|
return $this->version; |
|
74
|
|
|
} |
|
75
|
|
|
|
|
76
|
|
|
/** |
|
77
|
|
|
* is Multi-value option (MVA) |
|
78
|
|
|
* @return boolean |
|
79
|
|
|
*/ |
|
80
|
5 |
|
public function isIsMultiValue() : bool |
|
81
|
|
|
{ |
|
82
|
5 |
|
return $this->isMultiValue; |
|
83
|
|
|
} |
|
84
|
|
|
|
|
85
|
|
|
/** |
|
86
|
|
|
* Get description for option |
|
87
|
|
|
* @return string |
|
88
|
|
|
*/ |
|
89
|
1 |
|
public function getDescription() : string |
|
90
|
|
|
{ |
|
91
|
1 |
|
return $this->description; |
|
92
|
|
|
} |
|
93
|
|
|
|
|
94
|
|
|
/** |
|
95
|
|
|
* Get link on original documentation of option |
|
96
|
|
|
* @return string |
|
97
|
|
|
*/ |
|
98
|
1 |
|
public function getDocLink() : string |
|
99
|
|
|
{ |
|
100
|
1 |
|
return $this->docLink; |
|
101
|
|
|
} |
|
102
|
|
|
|
|
103
|
|
|
/** |
|
104
|
|
|
* @var eOption |
|
105
|
|
|
*/ |
|
106
|
|
|
private $name; |
|
107
|
|
|
|
|
108
|
|
|
/** |
|
109
|
|
|
* @var eSection |
|
110
|
|
|
*/ |
|
111
|
|
|
private $section; |
|
112
|
|
|
|
|
113
|
|
|
/** |
|
114
|
|
|
* @var eVersion |
|
115
|
|
|
*/ |
|
116
|
|
|
private $version; |
|
117
|
|
|
|
|
118
|
|
|
/** |
|
119
|
|
|
* @var bool |
|
120
|
|
|
*/ |
|
121
|
|
|
private $isMultiValue; |
|
122
|
|
|
|
|
123
|
|
|
/** |
|
124
|
|
|
* @var string |
|
125
|
|
|
*/ |
|
126
|
|
|
private $description; |
|
127
|
|
|
|
|
128
|
|
|
/** |
|
129
|
|
|
* @var string |
|
130
|
|
|
*/ |
|
131
|
|
|
private $docLink; |
|
132
|
|
|
} |
LTD-Beget /
sphinx-configurator
