/
SpigetAPI.php
520 lines (475 loc) · 20.4 KB
/
SpigetAPI.php
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
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
<?php
/*
Copyright (c) 2018 Jens F.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
/**
* Created by Th3Shadowbroker/M4taiori https://m4taiori.de
* GitHub: https://github.com/th3shadowbroker
* Date: 30.06.2018
* Time: 14:19
*/
namespace de\m4taiori\spiget4php;
require_once 'Exceptions/SpigetException.php';
require_once 'Environment/Constants.php';
use de\m4taiori\spiget4php\exceptions\SpigetException as SpigetException;
/**
* This is the main-class of spiget4php.
* Use the getInstance function to create a new instance or get an existing instance.
*
* @see \de\m4taiori\spiget4php\exceptions\SpigetException SpigetException - This exception will be thrown if something goes wrong and $throwExceptions is true.
*
* @package de\m4taiori\spiget4php
*/
class SpigetAPI
{
/**
* @var SpigetAPI The current instance of this class.
*/
private static $instance;
/**
* @var string The useragent-name defined by the api-user.
*/
private $userargent;
/**
* @var string The url of the spiget-api.
*/
private $spiget = 'https://api.spiget.org/v2/';
/**
* @var bool Used to toggle exception throwing.
*/
private $throwExceptions = true;
/**
* SpigetAPI constructor.
* @param $useragent string The useragent-name you want to use.
*/
private function __construct( $useragent )
{
$this->userargent = $useragent;
}
/**
* Get a authors detailed record.
* @param $author string The name or id of the author.
* @return array
* @throws SpigetException
*/
public function getAuthor( $author )
{
return $this->getResult( "authors/".$author );
}
/**
* Get a list of authors.
* @param int $size The size of the list.
* @param int $page The page of the list.
* @param string $sort Sort the list with + for ascending and - for descending in front of the field you want to sort by.
* @param array $fields The fields you want to receive.
* @return array
* @throws SpigetException
*/
public function getAuthorList( $size = SPIGET4PHP_DEFAULT, $page = SPIGET4PHP_DEFAULT, $sort = SPIGET4PHP_DEFAULT, $fields = SPIGET4PHP_DEFAULT )
{
$function = 'authors';
$args = [];
if ( !is_null( $size ) ) $args['size'] = $size;
if ( !is_null( $page ) ) $args['page'] = $page;
if ( !is_null( $sort ) ) $args['sort'] = $sort;
if ( !is_null( $fields ) ) $args['fields'] = implode(',', $fields );
return $this->getResult( $function, $args );
}
/**
* Get the reviews of an specific author.
* @param string $author The authors name or id.
* @param int $size The results max. size.
* @param int $page The page you want to get.
* @param string $sort Sort the list with + for ascending and - for descending in front of the field you want to sort by.
* @param array $fields The fields you want to receive.
* @return array
* @throws SpigetException
*/
public function getAuthorReviews( $author, $size = SPIGET4PHP_DEFAULT, $page = SPIGET4PHP_DEFAULT, $sort = SPIGET4PHP_DEFAULT, $fields = SPIGET4PHP_DEFAULT )
{
$function = 'authors/'.$author.'/reviews';
$args = [];
if ( !is_null( $size ) ) $args['size'] = $size;
if ( !is_null( $page ) ) $args['page'] = $page;
if ( !is_null( $sort ) ) $args['sort'] = $sort;
if ( !is_null( $fields ) ) $args['fields'] = implode(',', $fields );
return $this->getResult( $function, $args );
}
/**
* Get the resources of an specific author.
* @param string $author The authors name or id.
* @param int $size The results max. size.
* @param int $page The page you want to get.
* @param string $sort Sort the list with + for ascending and - for descending in front of the field you want to sort by.
* @param array $fields The fields you want to receive.
* @return array
* @throws SpigetException
*/
public function getAuthorResources( $author, $size = SPIGET4PHP_DEFAULT, $page = SPIGET4PHP_DEFAULT, $sort = SPIGET4PHP_DEFAULT, $fields = SPIGET4PHP_DEFAULT )
{
$function = 'authors/'.$author.'/resources';
$args = [];
if ( !is_null( $size ) ) $args['size'] = $size;
if ( !is_null( $page ) ) $args['page'] = $page;
if ( !is_null( $sort ) ) $args['sort'] = $sort;
if ( !is_null( $fields ) ) $args['fields'] = implode(',', $fields );
return $this->getResult( $function, $args );
}
/**
* Get a list of categories.
* @param int $size The size of the list.
* @param int $page The page of the list.
* @param string $sort Sort the list with + for ascending and - for descending in front of the field you want to sort by.
* @param array $fields The fields you want to receive.
* @return array
* @throws SpigetException
*/
public function getCategoryList( $size = SPIGET4PHP_DEFAULT, $page = SPIGET4PHP_DEFAULT, $sort = SPIGET4PHP_DEFAULT, $fields = SPIGET4PHP_DEFAULT )
{
$function = 'categories';
$args = [];
if ( !is_null( $size ) ) $args['size'] = $size;
if ( !is_null( $page ) ) $args['page'] = $page;
if ( !is_null( $sort ) ) $args['sort'] = $sort;
if ( !is_null( $fields ) ) $args['fields'] = implode(',', $fields );
return $this->getResult( $function, $args );
}
/**
* Get detailed information about an specific category.
* @param string $category The name or id of the category.
* @return array
* @throws SpigetException
*/
public function getCategory( $category )
{
$function = 'categories/'.$category;
return $this->getResult( $function );
}
/**
* Get a list of resources of an specific category.
* @param string The category you want to search in.
* @param int $size The size of the list.
* @param int $page The page of the list.
* @param string $sort Sort the list with + for ascending and - for descending in front of the field you want to sort by.
* @param array $fields The fields you want to receive.
* @return array
* @throws SpigetException
*/
public function getCategoryResources( $category, $size = SPIGET4PHP_DEFAULT, $page = SPIGET4PHP_DEFAULT, $sort = SPIGET4PHP_DEFAULT, $fields = SPIGET4PHP_DEFAULT )
{
$function = 'categories/'.$category.'/resources';
$args = [];
if ( !is_null( $size ) ) $args['size'] = $size;
if ( !is_null( $page ) ) $args['page'] = $page;
if ( !is_null( $sort ) ) $args['sort'] = $sort;
if ( !is_null( $fields ) ) $args['fields'] = implode(',', $fields );
return $this->getResult( $function, $args );
}
/**
* Get detailed information about an specific resource.
* @param $resource string The resource.
* @return array
* @throws SpigetException
*/
public function getResource( $resource )
{
$function = 'resources/'.$resource;
return $this->getResult( $function );
}
/**
* Get detailed information about the author of an specific resource.
* @param $resource string The resource.
* @return array
* @throws SpigetException
*/
public function getResourceAuthor( $resource )
{
$function = 'resources/'.$resource.'/author';
return $this->getResult( $function );
}
/**
* Get a list of resource-reviews of an specific resource.
* @param string $resource The resource you want to read the reviews of.
* @param int $size The size of the list.
* @param int $page The page of the list.
* @param string $sort Sort the list with + for ascending and - for descending in front of the field you want to sort by.
* @param array $fields The fields you want to receive.
* @return array
* @throws SpigetException
*/
public function getResourceReviews( $resource, $size = SPIGET4PHP_DEFAULT, $page = SPIGET4PHP_DEFAULT, $sort = SPIGET4PHP_DEFAULT, $fields = SPIGET4PHP_DEFAULT )
{
$function = 'resources/'.$resource.'/reviews';
$args = [];
if ( !is_null( $size ) ) $args['size'] = $size;
if ( !is_null( $page ) ) $args['page'] = $page;
if ( !is_null( $sort ) ) $args['sort'] = $sort;
if ( !is_null( $fields ) ) $args['fields'] = implode(',', $fields );
return $this->getResult( $function, $args );
}
/**
* Get a list of updates for an specific resource.
* @param string $resource The resource you want get the list for.
* @param int $size The size of the list.
* @param int $page The page of the list.
* @param string $sort Sort the list with + for ascending and - for descending in front of the field you want to sort by.
* @param array $fields The fields you want to receive.
* @return array
* @throws SpigetException
*/
public function getResourceUpdates( $resource, $size = SPIGET4PHP_DEFAULT, $page = SPIGET4PHP_DEFAULT, $sort = SPIGET4PHP_DEFAULT, $fields = SPIGET4PHP_DEFAULT )
{
$function = 'resources/'.$resource.'/updates';
$args = [];
if ( !is_null( $size ) ) $args['size'] = $size;
if ( !is_null( $page ) ) $args['page'] = $page;
if ( !is_null( $sort ) ) $args['sort'] = $sort;
if ( !is_null( $fields ) ) $args['fields'] = implode(',', $fields );
return $this->getResult( $function, $args );
}
/**
* Get a resources versions.
* @param string $resource The resource you want get the versions of.
* @param int $size The size of the list.
* @param int $page The page of the list.
* @param string $sort Sort the list with + for ascending and - for descending in front of the field you want to sort by.
* @param array $fields The fields you want to receive.
* @return array
* @throws SpigetException
*/
public function getResourceVersionList( $resource, $size = SPIGET4PHP_DEFAULT, $page = SPIGET4PHP_DEFAULT, $sort = SPIGET4PHP_DEFAULT, $fields = SPIGET4PHP_DEFAULT )
{
$function = 'resources/'.$resource.'/versions';
$args = [];
if ( !is_null( $size ) ) $args['size'] = $size;
if ( !is_null( $page ) ) $args['page'] = $page;
if ( !is_null( $sort ) ) $args['sort'] = $sort;
if ( !is_null( $fields ) ) $args['fields'] = implode(',', $fields );
return $this->getResult( $function, $args );
}
/**
* Get a resource-search results..
* @param string $resource The resource-name you're looking for..
* @param int $size The size of the list.
* @param int $page The page of the list.
* @param string $sort Sort the list with + for ascending and - for descending in front of the field you want to sort by.
* @param array $fields The fields you want to receive.
* @return array
* @throws SpigetException
*/
public function getSearchResource( $resource, $size = SPIGET4PHP_DEFAULT, $page = SPIGET4PHP_DEFAULT, $sort = SPIGET4PHP_DEFAULT, $fields = SPIGET4PHP_DEFAULT )
{
$function = 'search/resources/'.$resource;
$args = [];
if ( !is_null( $size ) ) $args['size'] = $size;
if ( !is_null( $page ) ) $args['page'] = $page;
if ( !is_null( $sort ) ) $args['sort'] = $sort;
if ( !is_null( $fields ) ) $args['fields'] = implode(',', $fields );
return $this->getResult( $function, $args );
}
/**
* Get a list of resources.
* @param int $size The size of the list.
* @param int $page The page of the list.
* @param string $sort Sort the list with + for ascending and - for descending in front of the field you want to sort by.
* @param array $fields The fields you want to receive.
* @return array
* @throws SpigetException
*/
public function getResourceList( $size = SPIGET4PHP_DEFAULT, $page = SPIGET4PHP_DEFAULT, $sort = SPIGET4PHP_DEFAULT, $fields = SPIGET4PHP_DEFAULT )
{
$function = 'resources';
$args = [];
if ( !is_null( $size ) ) $args['size'] = $size;
if ( !is_null( $page ) ) $args['page'] = $page;
if ( !is_null( $sort ) ) $args['sort'] = $sort;
if ( !is_null( $fields ) ) $args['fields'] = implode(',', $fields );
return $this->getResult( $function, $args );
}
/**
* Get a list of free resources.
* @param int $size The size of the list.
* @param int $page The page of the list.
* @param string $sort Sort the list with + for ascending and - for descending in front of the field you want to sort by.
* @param array $fields The fields you want to receive.
* @return array
* @throws SpigetException
*/
public function getFreeResourceList( $size = SPIGET4PHP_DEFAULT, $page = SPIGET4PHP_DEFAULT, $sort = SPIGET4PHP_DEFAULT, $fields = SPIGET4PHP_DEFAULT )
{
$function = 'resources/free';
$args = [];
if ( !is_null( $size ) ) $args['size'] = $size;
if ( !is_null( $page ) ) $args['page'] = $page;
if ( !is_null( $sort ) ) $args['sort'] = $sort;
if ( !is_null( $fields ) ) $args['fields'] = implode(',', $fields );
return $this->getResult( $function, $args );
}
/**
* Get a list of premium resources.
* @param int $size The size of the list.
* @param int $page The page of the list.
* @param string $sort Sort the list with + for ascending and - for descending in front of the field you want to sort by.
* @param array $fields The fields you want to receive.
* @return array
* @throws SpigetException
*/
public function getPremiumResourceList( $size = SPIGET4PHP_DEFAULT, $page = SPIGET4PHP_DEFAULT, $sort = SPIGET4PHP_DEFAULT, $fields = SPIGET4PHP_DEFAULT )
{
$function = 'resources/premium';
$args = [];
if ( !is_null( $size ) ) $args['size'] = $size;
if ( !is_null( $page ) ) $args['page'] = $page;
if ( !is_null( $sort ) ) $args['sort'] = $sort;
if ( !is_null( $fields ) ) $args['fields'] = implode(',', $fields );
return $this->getResult( $function, $args );
}
/**
* Get a list of the newest resources.
* @param int $size The size of the list.
* @param int $page The page of the list.
* @param string $sort Sort the list with + for ascending and - for descending in front of the field you want to sort by.
* @param array $fields The fields you want to receive.
* @return array
* @throws SpigetException
*/
public function getNewResourceList( $size = SPIGET4PHP_DEFAULT, $page = SPIGET4PHP_DEFAULT, $sort = SPIGET4PHP_DEFAULT, $fields = SPIGET4PHP_DEFAULT )
{
$function = 'resources/new';
$args = [];
if ( !is_null( $size ) ) $args['size'] = $size;
if ( !is_null( $page ) ) $args['page'] = $page;
if ( !is_null( $sort ) ) $args['sort'] = $sort;
if ( !is_null( $fields ) ) $args['fields'] = implode(',', $fields );
return $this->getResult( $function, $args );
}
/**
* Get a list of resources for an specific version of minecraft/spigot.
* @param string The version.
* @param string The search-method. Use any or all.
* @param int $size The size of the list.
* @param int $page The page of the list.
* @param string $sort Sort the list with + for ascending and - for descending in front of the field you want to sort by.
* @param array $fields The fields you want to receive.
* @return array
* @throws SpigetException
*/
public function getResourcesForVersion( $version, $method = 'any',$size = SPIGET4PHP_DEFAULT, $page = SPIGET4PHP_DEFAULT, $sort = SPIGET4PHP_DEFAULT, $fields = SPIGET4PHP_DEFAULT )
{
$function = 'resources/for/'.$version;
$args = [];
if ( !is_null( $method ) ) $args['method'] = $method;
if ( !is_null( $size ) ) $args['size'] = $size;
if ( !is_null( $page ) ) $args['page'] = $page;
if ( !is_null( $sort ) ) $args['sort'] = $sort;
if ( !is_null( $fields ) ) $args['fields'] = implode(',', $fields );
return $this->getResult( $function, $args );
}
/**
* Get the search-result for an specific username.
* @param string $author The authors name or id.
* @param string $field The field you want to search in.
* @param int $size The results max. size.
* @param int $page The page you want to get.
* @param string $sort Sort the list with + for ascending and - for descending in front of the field you want to sort by.
* @param array $fields The fields you want to receive.
* @return array
* @throws SpigetException
*/
public function getSearchAuthors( $author, $field = SPIGET4PHP_DEFAULT, $size = SPIGET4PHP_DEFAULT, $page = SPIGET4PHP_DEFAULT, $sort = SPIGET4PHP_DEFAULT, $fields = SPIGET4PHP_DEFAULT )
{
$function = 'search/authors/'.$author;
$args = [];
if ( !is_null( $field ) ) $args['field'] = $field;
if ( !is_null( $size ) ) $args['size'] = $size;
if ( !is_null( $page ) ) $args['page'] = $page;
if ( !is_null( $sort ) ) $args['sort'] = $sort;
if ( !is_null( $fields ) ) $args['fields'] = implode(',', $fields );
return $this->getResult( $function, $args );
}
/**
* Get the api-status.
* @return array
* @throws SpigetException
*/
public function getAPIStatus()
{
$function = 'status';
return $this->getResult($function);
}
/**
* Get the result of an api-request.
* @param $function string The rest-function you want to access.
* @param $args array Assoc containing the arguments transmitted within the url.
* @param $post bool Use post instead of get.
* @return array
* @throws SpigetException
*/
private function getResult($function, $args = [], $post = false )
{
$qargs = ($post ? '' : '?') . http_build_query( $args );
$curl = curl_init( $this->spiget.$function.( !$post ? ( sizeof( $args ) > 0 ? $qargs : '' ) : '' ) );
curl_setopt($curl, CURLOPT_USERAGENT, $this->userargent);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
if ($post) curl_setopt($curl,CURLOPT_POST, 1);
if ($post) curl_setopt($curl, CURLOPT_POSTFIELDS, $qargs);
$result = curl_exec($curl);
$http_response = curl_getinfo($curl)['http_code'];
curl_close($curl);
if ( $http_response == 200 )
{
return json_decode( $result, true );
}
elseif ( $this->throwExceptions )
{
throw new SpigetException( json_decode( $result, true )['error'], $http_response );
}
else
{
return null;
}
}
/**
* Set the throw-exceptions option.
* @param $enabled bool Enabled or disabled.
*/
public function setThrowExceptions( $enabled )
{
$this->throwExceptions = $enabled;
}
/**
* To enable or disable exception throwing use the setThrowExceptions function.
* @return bool True if throwing exceptions is enabled.
*/
public function isThrowingExceptions()
{
return $this->throwExceptions;
}
/**
* Get the current instance of the api-wrapper or create a new one.
* @param string $useragent The name of the wrappers-useragent.
* @return SpigetAPI
*/
public static function getInstance( $useragent = 'Spiget4PHP' )
{
if (is_null(SpigetAPI::$instance)) {
SpigetAPI::$instance = new SpigetAPI($useragent);
}
return SpigetAPI::$instance;
}
}