|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
/** |
|
4
|
|
|
* Created by PhpStorm. |
|
5
|
|
|
* Project: json-rpc-server |
|
6
|
|
|
* User: sv |
|
7
|
|
|
* Date: 06.02.2021 |
|
8
|
|
|
* Time: 10:48 |
|
9
|
|
|
*/ |
|
10
|
|
|
|
|
11
|
|
|
declare(strict_types=1); |
|
12
|
|
|
|
|
13
|
|
|
namespace Onnov\JsonRpcServer\Definition; |
|
14
|
|
|
|
|
15
|
|
|
use stdClass; |
|
16
|
|
|
|
|
17
|
|
|
/** |
|
18
|
|
|
* Class RpcProcedureDefinition |
|
19
|
|
|
* |
|
20
|
|
|
* @package Onnov\JsonRpcServer\Definition |
|
21
|
|
|
*/ |
|
22
|
|
|
class RpcProcedureDefinition |
|
23
|
|
|
{ |
|
24
|
|
|
use CastableToArray; |
|
25
|
|
|
|
|
26
|
|
|
/** |
|
27
|
|
|
* Short summary of what the procedure does. |
|
28
|
|
|
* |
|
29
|
|
|
* @var string |
|
30
|
|
|
*/ |
|
31
|
|
|
private $summary; |
|
32
|
|
|
|
|
33
|
|
|
/** |
|
34
|
|
|
* Longer description of what the procedure does. |
|
35
|
|
|
* |
|
36
|
|
|
* @var string|string[]|null |
|
37
|
|
|
*/ |
|
38
|
|
|
private $description = null; |
|
39
|
|
|
|
|
40
|
|
|
/** |
|
41
|
|
|
* Tags for grouping similar procedures. |
|
42
|
|
|
* |
|
43
|
|
|
* @var string[]|null |
|
44
|
|
|
*/ |
|
45
|
|
|
private $tags = null; |
|
46
|
|
|
|
|
47
|
|
|
/** |
|
48
|
|
|
* JSON-Schema of the procedure params. |
|
49
|
|
|
* |
|
50
|
|
|
* @var stdClass|null |
|
51
|
|
|
*/ |
|
52
|
|
|
private $params = null; |
|
53
|
|
|
|
|
54
|
|
|
/** |
|
55
|
|
|
* php object for mapping request params |
|
56
|
|
|
* or null if not required |
|
57
|
|
|
* |
|
58
|
|
|
* @var object|null |
|
59
|
|
|
*/ |
|
60
|
|
|
private $paramsObject = null; |
|
61
|
|
|
/** |
|
62
|
|
|
* JSON-Schema of the procedure result. |
|
63
|
|
|
* |
|
64
|
|
|
* @var stdClass|null |
|
65
|
|
|
*/ |
|
66
|
|
|
private $result = null; |
|
67
|
|
|
|
|
68
|
|
|
/** |
|
69
|
|
|
* Definition of possible error responses. |
|
70
|
|
|
* |
|
71
|
|
|
* @var RpcErrorDefinition[]|null |
|
72
|
|
|
*/ |
|
73
|
|
|
private $errors = null; |
|
74
|
|
|
|
|
75
|
|
|
/** |
|
76
|
|
|
* @return string |
|
77
|
|
|
*/ |
|
78
|
|
|
public function getSummary(): string |
|
79
|
|
|
{ |
|
80
|
|
|
return $this->summary; |
|
81
|
|
|
} |
|
82
|
|
|
|
|
83
|
|
|
/** |
|
84
|
|
|
* @param string $summary |
|
85
|
|
|
* @return RpcProcedureDefinition |
|
86
|
|
|
*/ |
|
87
|
|
|
public function setSummary(string $summary): self |
|
88
|
|
|
{ |
|
89
|
|
|
$this->summary = $summary; |
|
90
|
|
|
|
|
91
|
|
|
return $this; |
|
92
|
|
|
} |
|
93
|
|
|
|
|
94
|
|
|
/** |
|
95
|
|
|
* @return string|string[]|null |
|
96
|
|
|
*/ |
|
97
|
|
|
public function getDescription() |
|
98
|
|
|
{ |
|
99
|
|
|
return $this->description; |
|
100
|
|
|
} |
|
101
|
|
|
|
|
102
|
|
|
/** |
|
103
|
|
|
* @param string|string[]|null $description |
|
104
|
|
|
* @return RpcProcedureDefinition |
|
105
|
|
|
*/ |
|
106
|
|
|
public function setDescription($description): self |
|
107
|
|
|
{ |
|
108
|
|
|
$this->description = $description; |
|
109
|
|
|
|
|
110
|
|
|
return $this; |
|
111
|
|
|
} |
|
112
|
|
|
|
|
113
|
|
|
/** |
|
114
|
|
|
* @return string[]|null |
|
115
|
|
|
*/ |
|
116
|
|
|
public function getTags(): ?array |
|
117
|
|
|
{ |
|
118
|
|
|
return $this->tags; |
|
119
|
|
|
} |
|
120
|
|
|
|
|
121
|
|
|
/** |
|
122
|
|
|
* @param string[]|null $tags |
|
123
|
|
|
* @return RpcProcedureDefinition |
|
124
|
|
|
*/ |
|
125
|
|
|
public function setTags(?array $tags): self |
|
126
|
|
|
{ |
|
127
|
|
|
$this->tags = $tags; |
|
128
|
|
|
|
|
129
|
|
|
return $this; |
|
130
|
|
|
} |
|
131
|
|
|
|
|
132
|
|
|
/** |
|
133
|
|
|
* @return stdClass|null |
|
134
|
|
|
*/ |
|
135
|
|
|
public function getParams(): ?stdClass |
|
136
|
|
|
{ |
|
137
|
|
|
return $this->params; |
|
138
|
|
|
} |
|
139
|
|
|
|
|
140
|
|
|
/** |
|
141
|
|
|
* @param stdClass|null $params |
|
142
|
|
|
* @return RpcProcedureDefinition |
|
143
|
|
|
*/ |
|
144
|
|
|
public function setParams(?stdClass $params): self |
|
145
|
|
|
{ |
|
146
|
|
|
$this->params = $params; |
|
147
|
|
|
|
|
148
|
|
|
return $this; |
|
149
|
|
|
} |
|
150
|
|
|
|
|
151
|
|
|
/** |
|
152
|
|
|
* @return object|null |
|
153
|
|
|
*/ |
|
154
|
|
|
public function getParamsObject(): ?object |
|
155
|
|
|
{ |
|
156
|
|
|
return $this->paramsObject; |
|
157
|
|
|
} |
|
158
|
|
|
|
|
159
|
|
|
/** |
|
160
|
|
|
* @param object|null $paramsObject |
|
161
|
|
|
* @return RpcProcedureDefinition |
|
162
|
|
|
*/ |
|
163
|
|
|
public function setParamsObject(?object $paramsObject): self |
|
164
|
|
|
{ |
|
165
|
|
|
$this->paramsObject = $paramsObject; |
|
166
|
|
|
|
|
167
|
|
|
return $this; |
|
168
|
|
|
} |
|
169
|
|
|
|
|
170
|
|
|
/** |
|
171
|
|
|
* @return stdClass|null |
|
172
|
|
|
*/ |
|
173
|
|
|
public function getResult(): ?stdClass |
|
174
|
|
|
{ |
|
175
|
|
|
return $this->result; |
|
176
|
|
|
} |
|
177
|
|
|
|
|
178
|
|
|
/** |
|
179
|
|
|
* @param stdClass|null $result |
|
180
|
|
|
* @return RpcProcedureDefinition |
|
181
|
|
|
*/ |
|
182
|
|
|
public function setResult(?stdClass $result): self |
|
183
|
|
|
{ |
|
184
|
|
|
$this->result = $result; |
|
185
|
|
|
|
|
186
|
|
|
return $this; |
|
187
|
|
|
} |
|
188
|
|
|
|
|
189
|
|
|
/** |
|
190
|
|
|
* @return RpcErrorDefinition[]|null |
|
191
|
|
|
*/ |
|
192
|
|
|
public function getErrors(): ?array |
|
193
|
|
|
{ |
|
194
|
|
|
return $this->errors; |
|
195
|
|
|
} |
|
196
|
|
|
|
|
197
|
|
|
/** |
|
198
|
|
|
* @param RpcErrorDefinition[]|null $errors |
|
199
|
|
|
* @return RpcProcedureDefinition |
|
200
|
|
|
*/ |
|
201
|
|
|
public function setErrors(?array $errors): self |
|
202
|
|
|
{ |
|
203
|
|
|
$this->errors = $errors; |
|
204
|
|
|
|
|
205
|
|
|
return $this; |
|
206
|
|
|
} |
|
207
|
|
|
} |
|
208
|
|
|
|
onnov /
json-rpc-server
