2018-02-25 15:30:56 -06:00
|
|
|
<?php
|
|
|
|
|
2018-02-27 21:28:43 -06:00
|
|
|
namespace Pterodactyl\Http\Controllers\Api\Client;
|
2018-02-25 15:30:56 -06:00
|
|
|
|
2018-02-27 21:28:43 -06:00
|
|
|
use Webmozart\Assert\Assert;
|
|
|
|
use Pterodactyl\Transformers\Api\Client\BaseClientTransformer;
|
|
|
|
use Pterodactyl\Http\Controllers\Api\Application\ApplicationApiController;
|
2018-02-25 15:30:56 -06:00
|
|
|
|
|
|
|
abstract class ClientApiController extends ApplicationApiController
|
|
|
|
{
|
2020-07-06 21:25:00 -07:00
|
|
|
/**
|
|
|
|
* Returns only the includes which are valid for the given transformer.
|
|
|
|
*
|
|
|
|
* @return string[]
|
|
|
|
*/
|
|
|
|
protected function getIncludesForTransformer(BaseClientTransformer $transformer, array $merge = [])
|
|
|
|
{
|
|
|
|
$filtered = array_filter($this->parseIncludes(), function ($datum) use ($transformer) {
|
|
|
|
return in_array($datum, $transformer->getAvailableIncludes());
|
|
|
|
});
|
|
|
|
|
|
|
|
return array_merge($filtered, $merge);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the parsed includes for this request.
|
2020-07-09 19:17:24 -07:00
|
|
|
*
|
|
|
|
* @return string[]
|
2020-07-06 21:25:00 -07:00
|
|
|
*/
|
|
|
|
protected function parseIncludes()
|
|
|
|
{
|
2020-07-09 19:17:24 -07:00
|
|
|
$includes = $this->request->query('include') ?? [];
|
2020-07-06 21:25:00 -07:00
|
|
|
|
2021-01-23 12:33:34 -08:00
|
|
|
if (!is_string($includes)) {
|
2020-07-06 21:25:00 -07:00
|
|
|
return $includes;
|
|
|
|
}
|
|
|
|
|
|
|
|
return array_map(function ($item) {
|
|
|
|
return trim($item);
|
|
|
|
}, explode(',', $includes));
|
|
|
|
}
|
|
|
|
|
2018-02-25 15:30:56 -06:00
|
|
|
/**
|
|
|
|
* Return an instance of an application transformer.
|
|
|
|
*
|
2022-05-22 15:37:39 -04:00
|
|
|
* @template T of \Pterodactyl\Transformers\Api\Client\BaseClientTransformer
|
|
|
|
*
|
|
|
|
* @param class-string<T> $abstract
|
|
|
|
*
|
|
|
|
* @return T
|
|
|
|
*
|
|
|
|
* @noinspection PhpUndefinedClassInspection
|
|
|
|
* @noinspection PhpDocSignatureInspection
|
2018-02-25 15:30:56 -06:00
|
|
|
*/
|
|
|
|
public function getTransformer(string $abstract)
|
|
|
|
{
|
2022-05-22 16:23:22 -04:00
|
|
|
Assert::subclassOf($abstract, BaseClientTransformer::class);
|
2018-02-25 15:30:56 -06:00
|
|
|
|
2022-05-22 16:23:22 -04:00
|
|
|
return $abstract::fromRequest($this->request);
|
2018-02-25 15:30:56 -06:00
|
|
|
}
|
|
|
|
}
|