FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
php-openapi/src/spec/Paths.php at master · php-openapi/php-openapi · GitHub
Uh oh!
There was an error while loading.
Please reload this page
.
php-openapi
/
php-openapi
Public
forked from
cebe/php-openapi
Notifications
You must be signed in to change notification settings
Fork
0
Star
5
Code
Pull requests
0
Discussions
Actions
Projects
Security and quality
0
Insights
Additional navigation options
Code
Pull requests
Discussions
Actions
Projects
Security and quality
Insights
Expand file tree
Breadcrumbs
php-openapi
/
src
/
spec
/
Paths.php
Copy path
More file actions
More file actions
Latest commit
History
History
History
309 lines (282 loc) · 8.68 KB
Breadcrumbs
php-openapi
/
src
/
spec
/
Paths.php
Copy path
File metadata and controls
309 lines (282 loc) · 8.68 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
<?php
/**
* @copyright Copyright (c) 2018 Carsten Brandt <mail@cebe.cc> and contributors
* @license https://github.com/cebe/php-openapi/blob/master/LICENSE
*/
namespace
cebe
\
openapi
\
spec
;
use
ArrayAccess
;
use
ArrayIterator
;
use
cebe
\
openapi
\
DocumentContextInterface
;
use
cebe
\
openapi
\
exceptions
\
TypeErrorException
;
use
cebe
\
openapi
\
exceptions
\
UnresolvableReferenceException
;
use
cebe
\
openapi
\
json
\
JsonPointer
;
use
cebe
\
openapi
\
ReferenceContext
;
use
cebe
\
openapi
\
SpecObjectInterface
;
use
Countable
;
use
IteratorAggregate
;
use
Traversable
;
/**
* Holds the relative paths to the individual endpoints and their operations.
*
* The path is appended to the URL from the Server Object in order to construct the full URL.
* The Paths MAY be empty, due to ACL constraints.
*
* @link https://github.com/OAI/OpenAPI-Specification/blob/3.0.2/versions/3.0.2.md#pathsObject
*
*/
class
Paths
implements
SpecObjectInterface, DocumentContextInterface, ArrayAccess, Countable, IteratorAggregate
{
/**
* @var (PathItem|null)[]
*/
private
$
_paths
= [];
/**
* @var array
*/
private
$
_errors
= [];
/**
* @var SpecObjectInterface|null
*/
private
$
_baseDocument
;
/**
* @var JsonPointer|null
*/
private
$
_jsonPointer
;
/**
* Create an object from spec data.
* @param (PathItem|array|null)[] $data spec data read from YAML or JSON
* @throws TypeErrorException in case invalid data is supplied.
*/
public
function
__construct
(
array
$
data
)
{
foreach
(
$
data
as
$
path
=>
$
object
) {
if
(
$
object
===
null
) {
$
this
->
_paths
[
$
path
] =
null
;
}
elseif
(
is_array
(
$
object
)) {
$
this
->
_paths
[
$
path
] =
new
PathItem
(
$
object
);
}
elseif
(
$
object
instanceof
PathItem) {
$
this
->
_paths
[
$
path
] =
$
object
;
}
else
{
$
givenType
=
gettype
(
$
object
);
if
(
$
givenType
===
'
object
'
) {
$
givenType
=
get_class
(
$
object
);
}
throw
new
TypeErrorException
(
sprintf
(
'
Path MUST be either array or PathItem object, "%s" given
'
,
$
givenType
));
}
}
}
/**
* @return mixed returns the serializable data of this object for converting it
* to JSON or YAML.
*/
public
function
getSerializableData
()
{
$
data
= [];
foreach
(
$
this
->
_paths
as
$
path
=>
$
pathItem
) {
$
data
[
$
path
] = (
$
pathItem
===
null
) ?
null
:
$
pathItem
->
getSerializableData
();
}
return
(
object
)
$
data
;
}
/**
* @param string $name path name
* @return bool
*/
public
function
hasPath
(
string
$
name
):
bool
{
return
isset
(
$
this
->
_paths
[
$
name
]);
}
/**
* @param string $name path name
* @return PathItem
*/
public
function
getPath
(
string
$
name
): ?
PathItem
{
return
$
this
->
_paths
[
$
name
] ??
null
;
}
/**
* @param string $name path name
* @param PathItem $pathItem the path item to add
*/
public
function
addPath
(
string
$
name
,
PathItem
$
pathItem
):
void
{
$
this
->
_paths
[
$
name
] =
$
pathItem
;
}
/**
* @param string $name path name
*/
public
function
removePath
(
string
$
name
):
void
{
unset(
$
this
->
_paths
[
$
name
]);
}
/**
* @return PathItem[]
*/
public
function
getPaths
():
array
{
return
$
this
->
_paths
;
}
/**
* Validate object data according to OpenAPI spec.
* @return bool whether the loaded data is valid according to OpenAPI spec
* @see getErrors()
*/
public
function
validate
():
bool
{
$
valid
=
true
;
$
this
->
_errors
= [];
foreach
(
$
this
->
_paths
as
$
key
=>
$
path
) {
if
(
$
path
===
null
) {
continue
;
}
if
(!
$
path
->
validate
()) {
$
valid
=
false
;
}
if
(
strpos
(
$
key
,
'
/
'
) !==
0
) {
$
this
->
_errors
[] =
"
Path must begin with /:
$
key
"
;
}
}
return
$
valid
&&
empty
(
$
this
->
_errors
);
}
/**
* @return string[] list of validation errors according to OpenAPI spec.
* @see validate()
*/
public
function
getErrors
():
array
{
if
((
$
pos
=
$
this
->
getDocumentPosition
()) !==
null
) {
$
errors
= [
array_map
(
function
(
$
e
)
use
(
$
pos
) {
return
"
[
{
$
pos
}
]
$
e
"
;
},
$
this
->
_errors
)
];
}
else
{
$
errors
= [
$
this
->
_errors
];
}
foreach
(
$
this
->
_paths
as
$
path
) {
if
(
$
path
===
null
) {
continue
;
}
$
errors
[] =
$
path
->
getErrors
();
}
return
array_merge
(...
$
errors
);
}
/**
* Whether a offset exists
* @link http://php.net/manual/en/arrayaccess.offsetexists.php
* @param mixed $offset An offset to check for.
* @return boolean true on success or false on failure.
* The return value will be casted to boolean if non-boolean was returned.
*/
public
function
offsetExists
(
$
offset
):
bool
{
return
$
this
->
hasPath
(
$
offset
);
}
/**
* Offset to retrieve
* @link http://php.net/manual/en/arrayaccess.offsetget.php
* @param mixed $offset The offset to retrieve.
* @return PathItem Can return all value types.
*/
#[\ReturnTypeWillChange]
public
function
offsetGet
(
$
offset
)
//: mixed
{
return
$
this
->
getPath
(
$
offset
);
}
/**
* Offset to set
* @link http://php.net/manual/en/arrayaccess.offsetset.php
* @param mixed $offset The offset to assign the value to.
* @param mixed $value The value to set.
*/
public
function
offsetSet
(
$
offset
,
$
value
):
void
{
$
this
->
addPath
(
$
offset
,
$
value
);
}
/**
* Offset to unset
* @link http://php.net/manual/en/arrayaccess.offsetunset.php
* @param mixed $offset The offset to unset.
*/
public
function
offsetUnset
(
$
offset
):
void
{
$
this
->
removePath
(
$
offset
);
}
/**
* Count elements of an object
* @link http://php.net/manual/en/countable.count.php
* @return int The custom count as an integer.
* The return value is cast to an integer.
*/
public
function
count
():
int
{
return
count
(
$
this
->
_paths
);
}
/**
* Retrieve an external iterator
* @link http://php.net/manual/en/iteratoraggregate.getiterator.php
* @return Traversable An instance of an object implementing <b>Iterator</b> or <b>Traversable</b>
*/
public
function
getIterator
():
Traversable
{
return
new
ArrayIterator
(
$
this
->
_paths
);
}
/**
* Resolves all Reference Objects in this object and replaces them with their resolution.
* @throws UnresolvableReferenceException
*/
public
function
resolveReferences
(
ReferenceContext
$
context
=
null
)
{
foreach
(
$
this
->
_paths
as
$
key
=>
$
path
) {
if
(
$
path
===
null
) {
continue
;
}
$
path
->
resolveReferences
(
$
context
);
}
}
/**
* Set context for all Reference Objects in this object.
*/
public
function
setReferenceContext
(
ReferenceContext
$
context
)
{
foreach
(
$
this
->
_paths
as
$
key
=>
$
path
) {
if
(
$
path
===
null
) {
continue
;
}
$
path
->
setReferenceContext
(
$
context
);
}
}
/**
* Provide context information to the object.
*
* Context information contains a reference to the base object where it is contained in
* as well as a JSON pointer to its position.
* @param SpecObjectInterface $baseDocument
* @param JsonPointer $jsonPointer
*/
public
function
setDocumentContext
(
SpecObjectInterface
$
baseDocument
,
JsonPointer
$
jsonPointer
)
{
$
this
->
_baseDocument
=
$
baseDocument
;
$
this
->
_jsonPointer
=
$
jsonPointer
;
foreach
(
$
this
->
_paths
as
$
key
=>
$
path
) {
if
(
$
path
instanceof
DocumentContextInterface) {
$
path
->
setDocumentContext
(
$
baseDocument
,
$
jsonPointer
->
append
(
$
key
));
}
}
}
/**
* @return SpecObjectInterface|null returns the base document where this object is located in.
* Returns `null` if no context information was provided by [[setDocumentContext]].
*/
public
function
getBaseDocument
(): ?
SpecObjectInterface
{
return
$
this
->
_baseDocument
;
}
/**
* @return JsonPointer|null returns a JSON pointer describing the position of this object in the base document.
* Returns `null` if no context information was provided by [[setDocumentContext]].
*/
public
function
getDocumentPosition
(): ?
JsonPointer
{
return
$
this
->
_jsonPointer
;
}
}
Back
|
FazBrowse Home
|
New Git URL