StarMC/Astral-nook
StarMC/Astral-nook
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Use more standardized phpcs

Browse source
This commit is contained in:
Dane Everitt 2021-01-23 12:33:34 -08:00
parent a043071e3c
commit c449ca5155
No known key found for this signature in database
GPG key ID: EEA66103B3D71F53
493 changed files with 1116 additions and 3903 deletions
Download patch file Download diff file Expand all files Collapse all files

3
app/Transformers/Api/Client/AccountTransformer.php
View file

@ -8,8 +8,6 @@ class AccountTransformer extends BaseClientTransformer
{
/**
* Return the resource name for the JSONAPI output.
*
* @return string
*/
public function getResourceName(): string
{
@ -19,7 +17,6 @@ class AccountTransformer extends BaseClientTransformer
/**
* Return basic information about the currently logged in user.
*
* @param \Pterodactyl\Models\User $model
* @return array
*/
public function transform(User $model)

3
app/Transformers/Api/Client/AllocationTransformer.php
View file

@ -8,8 +8,6 @@ class AllocationTransformer extends BaseClientTransformer
{
/**
* Return the resource name for the JSONAPI output.
*
* @return string
*/
public function getResourceName(): string
{
@ -19,7 +17,6 @@ class AllocationTransformer extends BaseClientTransformer
/**
* Return basic information about the currently logged in user.
*
* @param \Pterodactyl\Models\Allocation $model
* @return array
*/
public function transform(Allocation $model)

1
app/Transformers/Api/Client/ApiKeyTransformer.php
View file

@ -17,7 +17,6 @@ class ApiKeyTransformer extends BaseClientTransformer
/**
* Transform this model into a representation that can be consumed by a client.
*
* @param \Pterodactyl\Models\ApiKey $model
* @return array
*/
public function transform(ApiKey $model)

4
app/Transformers/Api/Client/BackupTransformer.php
View file

@ -6,16 +6,12 @@ use Pterodactyl\Models\Backup;
class BackupTransformer extends BaseClientTransformer
{
/**
* @return string
*/
public function getResourceName(): string
{
return Backup::RESOURCE_NAME;
}
/**
* @param \Pterodactyl\Models\Backup $backup
* @return array
*/
public function transform(Backup $backup)

10
app/Transformers/Api/Client/BaseClientTransformer.php
View file

@ -18,8 +18,6 @@ abstract class BaseClientTransformer extends BaseApplicationTransformer
/**
* Return the user model of the user requesting this transformation.
*
* @return \Pterodactyl\Models\User
*/
public function getUser(): User
{
@ -28,8 +26,6 @@ abstract class BaseClientTransformer extends BaseApplicationTransformer
/**
* Set the user model of the user requesting this transformation.
*
* @param \Pterodactyl\Models\User $user
*/
public function setUser(User $user)
{
@ -41,9 +37,7 @@ abstract class BaseClientTransformer extends BaseApplicationTransformer
* to access a different resource. This is used when including other
* models on a transformation request.
*
* @param string $ability
* @param \Pterodactyl\Models\Server $server
* @return bool
*/
protected function authorize(string $ability, Server $server = null): bool
{
@ -56,8 +50,6 @@ abstract class BaseClientTransformer extends BaseApplicationTransformer
* Create a new instance of the transformer and pass along the currently
* set API key.
*
* @param string $abstract
* @param array $parameters
* @return self
*
* @throws \Pterodactyl\Exceptions\Transformer\InvalidTransformerLevelException
@ -68,7 +60,7 @@ abstract class BaseClientTransformer extends BaseApplicationTransformer
$transformer = Container::getInstance()->makeWith($abstract, $parameters);
$transformer->setKey($this->getKey());
if (! $transformer instanceof self) {
if (!$transformer instanceof self) {
throw new InvalidTransformerLevelException('Calls to ' . __METHOD__ . ' must return a transformer that is an instance of ' . __CLASS__);
}

13
app/Transformers/Api/Client/DatabaseTransformer.php
View file

@ -23,9 +23,6 @@ class DatabaseTransformer extends BaseClientTransformer
/**
* Handle dependency injection.
*
* @param \Illuminate\Contracts\Encryption\Encrypter $encrypter
* @param \Pterodactyl\Contracts\Extensions\HashidsInterface $hashids
*/
public function handle(Encrypter $encrypter, HashidsInterface $hashids)
{
@ -33,18 +30,11 @@ class DatabaseTransformer extends BaseClientTransformer
$this->hashids = $hashids;
}
/**
* @return string
*/
public function getResourceName(): string
{
return Database::RESOURCE_NAME;
}
/**
* @param \Pterodactyl\Models\Database $model
* @return array
*/
public function transform(Database $model): array
{
$model->loadMissing('host');
@ -65,12 +55,11 @@ class DatabaseTransformer extends BaseClientTransformer
/**
* Include the database password in the request.
*
* @param \Pterodactyl\Models\Database $database
* @return \League\Fractal\Resource\Item|\League\Fractal\Resource\NullResource
*/
public function includePassword(Database $database)
{
if (! $this->getUser()->can(Permission::ACTION_DATABASE_VIEW_PASSWORD, $database->server)) {
if (!$this->getUser()->can(Permission::ACTION_DATABASE_VIEW_PASSWORD, $database->server)) {
return $this->null();
}

3
app/Transformers/Api/Client/EggTransformer.php
View file

@ -8,8 +8,6 @@ class EggTransformer extends BaseClientTransformer
{
/**
* Return the resource name for the JSONAPI output.
*
* @return string
*/
public function getResourceName(): string
{
@ -17,7 +15,6 @@ class EggTransformer extends BaseClientTransformer
}
/**
* @param \Pterodactyl\Models\Egg $egg
* @return array
*/
public function transform(Egg $egg)

10
app/Transformers/Api/Client/EggVariableTransformer.php
View file

@ -7,16 +7,12 @@ use Pterodactyl\Models\EggVariable;
class EggVariableTransformer extends BaseClientTransformer
{
/**
* @return string
*/
public function getResourceName(): string
{
return EggVariable::RESOURCE_NAME;
}
/**
* @param \Pterodactyl\Models\EggVariable $variable
* @return array
*/
public function transform(EggVariable $variable)
@ -24,10 +20,8 @@ class EggVariableTransformer extends BaseClientTransformer
// This guards against someone incorrectly retrieving variables (haha, me) and then passing
// them into the transformer and along to the user. Just throw an exception and break the entire
// pathway since you should never be exposing these types of variables to a client.
if (! $variable->user_viewable) {
throw new BadMethodCallException(
'Cannot transform a hidden egg variable in a client transformer.'
);
if (!$variable->user_viewable) {
throw new BadMethodCallException('Cannot transform a hidden egg variable in a client transformer.');
}
return [

6
app/Transformers/Api/Client/ScheduleTransformer.php
View file

@ -29,7 +29,6 @@ class ScheduleTransformer extends BaseClientTransformer
/**
* Returns a transformed schedule model such that a client can view the information.
*
* @param \Pterodactyl\Models\Schedule $model
* @return array
*/
public function transform(Schedule $model)
@ -56,7 +55,6 @@ class ScheduleTransformer extends BaseClientTransformer
/**
* Allows attaching the tasks specific to the schedule in the response.
*
* @param \Pterodactyl\Models\Schedule $model
* @return \League\Fractal\Resource\Collection
*
* @throws \Pterodactyl\Exceptions\Transformer\InvalidTransformerLevelException
@ -64,7 +62,9 @@ class ScheduleTransformer extends BaseClientTransformer
public function includeTasks(Schedule $model)
{
return $this->collection(
$model->tasks, $this->makeTransformer(TaskTransformer::class), Task::RESOURCE_NAME
$model->tasks,
$this->makeTransformer(TaskTransformer::class),
Task::RESOURCE_NAME
);
}
}

21
app/Transformers/Api/Client/ServerTransformer.php
View file

@ -23,9 +23,6 @@ class ServerTransformer extends BaseClientTransformer
*/
protected $availableIncludes = ['egg', 'subusers'];
/**
* @return string
*/
public function getResourceName(): string
{
return Server::RESOURCE_NAME;
@ -34,9 +31,6 @@ class ServerTransformer extends BaseClientTransformer
/**
* Transform a server model into a representation that can be returned
* to a client.
*
* @param \Pterodactyl\Models\Server $server
* @return array
*/
public function transform(Server $server): array
{
@ -62,7 +56,7 @@ class ServerTransformer extends BaseClientTransformer
'io' => $server->io,
'cpu' => $server->cpu,
],
'invocation' => $service->handle($server, ! $this->getUser()->can(Permission::ACTION_STARTUP_READ, $server)),
'invocation' => $service->handle($server, !$this->getUser()->can(Permission::ACTION_STARTUP_READ, $server)),
'docker_image' => $server->image,
'egg_features' => $server->egg->inherit_features,
'feature_limits' => [
@ -72,14 +66,13 @@ class ServerTransformer extends BaseClientTransformer
],
'is_suspended' => $server->suspended,
'is_installing' => $server->installed !== 1,
'is_transferring' => ! is_null($server->transfer),
'is_transferring' => !is_null($server->transfer),
];
}
/**
* Returns the allocations associated with this server.
*
* @param \Pterodactyl\Models\Server $server
* @return \League\Fractal\Resource\Collection|\League\Fractal\Resource\NullResource
*
* @throws \Pterodactyl\Exceptions\Transformer\InvalidTransformerLevelException
@ -95,7 +88,7 @@ class ServerTransformer extends BaseClientTransformer
//
// This allows us to avoid too much permission regression, without also hiding information that
// is generally needed for the frontend to make sense when browsing or searching results.
if (! $this->getUser()->can(Permission::ACTION_ALLOCATION_READ, $server)) {
if (!$this->getUser()->can(Permission::ACTION_ALLOCATION_READ, $server)) {
$primary = clone $server->allocation;
$primary->notes = null;
@ -106,14 +99,13 @@ class ServerTransformer extends BaseClientTransformer
}
/**
* @param \Pterodactyl\Models\Server $server
* @return \League\Fractal\Resource\Collection|\League\Fractal\Resource\NullResource
*
* @throws \Pterodactyl\Exceptions\Transformer\InvalidTransformerLevelException
*/
public function includeVariables(Server $server)
{
if (! $this->getUser()->can(Permission::ACTION_STARTUP_READ, $server)) {
if (!$this->getUser()->can(Permission::ACTION_STARTUP_READ, $server)) {
return $this->null();
}
@ -127,8 +119,8 @@ class ServerTransformer extends BaseClientTransformer
/**
* Returns the egg associated with this server.
*
* @param \Pterodactyl\Models\Server $server
* @return \League\Fractal\Resource\Item
*
* @throws \Pterodactyl\Exceptions\Transformer\InvalidTransformerLevelException
*/
public function includeEgg(Server $server)
@ -139,14 +131,13 @@ class ServerTransformer extends BaseClientTransformer
/**
* Returns the subusers associated with this server.
*
* @param \Pterodactyl\Models\Server $server
* @return \League\Fractal\Resource\Collection|\League\Fractal\Resource\NullResource
*
* @throws \Pterodactyl\Exceptions\Transformer\InvalidTransformerLevelException
*/
public function includeSubusers(Server $server)
{
if (! $this->getUser()->can(Permission::ACTION_USER_READ, $server)) {
if (!$this->getUser()->can(Permission::ACTION_USER_READ, $server)) {
return $this->null();
}

4
app/Transformers/Api/Client/StatsTransformer.php
View file

@ -6,9 +6,6 @@ use Illuminate\Support\Arr;
class StatsTransformer extends BaseClientTransformer
{
/**
* @return string
*/
public function getResourceName(): string
{
return 'stats';
@ -18,7 +15,6 @@ class StatsTransformer extends BaseClientTransformer
* Transform stats from the daemon into a result set that can be used in
* the client API.
*
* @param array $data
* @return array
*/
public function transform(array $data)

4
app/Transformers/Api/Client/SubuserTransformer.php
View file

@ -8,8 +8,6 @@ class SubuserTransformer extends BaseClientTransformer
{
/**
* Return the resource name for the JSONAPI output.
*
* @return string
*/
public function getResourceName(): string
{
@ -19,8 +17,8 @@ class SubuserTransformer extends BaseClientTransformer
/**
* Transforms a subuser into a model that can be shown to a front-end user.
*
* @param \Pterodactyl\Models\Subuser $model
* @return array|void
*
* @throws \Pterodactyl\Exceptions\Transformer\InvalidTransformerLevelException
*/
public function transform(Subuser $model)

1
app/Transformers/Api/Client/TaskTransformer.php
View file

@ -17,7 +17,6 @@ class TaskTransformer extends BaseClientTransformer
/**
* Transforms a schedule's task into a client viewable format.
*
* @param \Pterodactyl\Models\Task $model
* @return array
*/
public function transform(Task $model)

3
app/Transformers/Api/Client/UserTransformer.php
View file

@ -9,8 +9,6 @@ class UserTransformer extends BaseClientTransformer
{
/**
* Return the resource name for the JSONAPI output.
*
* @return string
*/
public function getResourceName(): string
{
@ -21,7 +19,6 @@ class UserTransformer extends BaseClientTransformer
* Transforms a User model into a representation that can be shown to regular
* users of the API.
*
* @param \Pterodactyl\Models\User $model
* @return array
*/
public function transform(User $model)