blob: 7ff7e9cd01032f1911d5476904fcc320c508eb92 (
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
|
<?php
declare(strict_types = 1);
namespace Williamdes\MariaDBMySQLKBS;
use \stdClass;
use \JsonSerializable;
class KBEntry extends stdClass implements JsonSerializable
{
/**
* The name of the variable
*
* @var string
*/
private $name;
/**
* Type of variable
*
* @var string
*/
private $type = null;
/**
* Is dynamic ?
*
* @var bool
*/
private $dynamic = null;
/**
* Documentations
*
* @var KBDocumentation[]
*/
private $docs = null;
/**
* Create a KBEntry object
*
* @param string $name The name of the variable
* @param string|null $type Type of variable
* @param bool|null $dynamic Is dynamic ?
*/
public function __construct(string $name, ?string $type, ?bool $dynamic)
{
$this->name = $name;
if ($type !== null) {
$this->type = $type;
}
if ($dynamic !== null) {
$this->dynamic = $dynamic;
}
}
/**
* Get the variable name
*
* @return string
*/
public function getName(): string
{
return $this->name;
}
/**
* Is the variable dynamic
*
* @return bool|null
*/
public function isDynamic(): ?bool
{
return $this->dynamic;
}
/**
* Get the variable type
*
* @return string|null
*/
public function getType(): ?string
{
return $this->type;
}
/**
* Variable has documentations
*
* @return bool
*/
public function hasDocumentations(): bool
{
if ($this->docs === null) {
return false;
} else {
return count($this->docs) > 0;
}
}
/**
* Get all documentations
*
* @return KBDocumentation[]
*/
public function getDocumentations(): array
{
return $this->docs;
}
/**
* Add documentation link
*
* @param string $url The URL
* @param string|null $anchor The anchor
* @return KBDocumentation
*/
public function addDocumentation(string $url, ?string $anchor = null ): KBDocumentation
{
$this->url = $url;
if ($this->docs === null) {
$this->docs = array();
}
$kbd = new KBDocumentation($url, $anchor);
$this->docs[] = $kbd;
return $kbd;
}
/**
* Used for json_encode function
* This can seem useless, do not remove it.
*
* @return array
*/
public function jsonSerialize(): array
{
$outObj = array();
$outObj['name'] = $this->name;
if ($this->type !== null) {
$outObj['type'] = $this->type;
}
if ($this->dynamic !== null) {
$outObj['dynamic'] = $this->dynamic;
}
if ($this->docs !== null) {
$outObj['docs'] = $this->docs;
}
return $outObj;
}
}
|
