Use more standardized phpcs

app/Contracts/Core/ReceivesEvents.php

@@ -8,8 +8,6 @@ interface ReceivesEvents
 {
     /**
      * Handles receiving an event from the application.
-     *
-     * @param \Pterodactyl\Events\Event $notification
      */
     public function handle(Event $notification): void;
 }

app/Contracts/Criteria/CriteriaInterface.php

@@ -17,7 +17,7 @@ interface CriteriaInterface
      * Apply selected criteria to a repository call.
      *
      * @param \Illuminate\Database\Eloquent\Model $model
-     * @param \Pterodactyl\Repositories\Repository $repository
+     *
      * @return mixed
      */
     public function apply($model, Repository $repository);

app/Contracts/Extensions/HashidsInterface.php

@@ -17,7 +17,8 @@ interface HashidsInterface extends VendorHashidsInterface
      * Decode an encoded hashid and return the first result.
      *
      * @param string $encoded
-     * @param null $default
+     * @param null   $default
+     *
      * @return mixed
      *
      * @throws \InvalidArgumentException

app/Contracts/Http/ClientPermissionsRequest.php

@@ -8,8 +8,6 @@ interface ClientPermissionsRequest
      * Returns the permissions string indicating which permission should be used to
      * validate that the authenticated user has permission to perform this action aganist
      * the given resource (server).
-     *
-     * @return string
      */
     public function permission(): string;
 }

app/Contracts/Repository/AllocationRepositoryInterface.php

@@ -7,18 +7,12 @@ interface AllocationRepositoryInterface extends RepositoryInterface
     /**
      * Return all of the allocations that exist for a node that are not currently
      * allocated.
-     *
-     * @param int $node
-     * @return array
      */
     public function getUnassignedAllocationIds(int $node): array;
 
     /**
      * Return a single allocation from those meeting the requirements.
      *
-     * @param array $nodes
-     * @param array $ports
-     * @param bool $dedicated
      * @return \Pterodactyl\Models\Allocation|null
      */
     public function getRandomAllocation(array $nodes, array $ports, bool $dedicated = false);

app/Contracts/Repository/ApiKeyRepositoryInterface.php

@@ -9,35 +9,21 @@ interface ApiKeyRepositoryInterface extends RepositoryInterface
 {
     /**
      * Get all of the account API keys that exist for a specific user.
-     *
-     * @param \Pterodactyl\Models\User $user
-     * @return \Illuminate\Support\Collection
      */
     public function getAccountKeys(User $user): Collection;
 
     /**
      * Get all of the application API keys that exist for a specific user.
-     *
-     * @param \Pterodactyl\Models\User $user
-     * @return \Illuminate\Support\Collection
      */
     public function getApplicationKeys(User $user): Collection;
 
     /**
      * Delete an account API key from the panel for a specific user.
-     *
-     * @param \Pterodactyl\Models\User $user
-     * @param string $identifier
-     * @return int
      */
     public function deleteAccountKey(User $user, string $identifier): int;
 
     /**
      * Delete an application API key from the panel for a specific user.
-     *
-     * @param \Pterodactyl\Models\User $user
-     * @param string $identifier
-     * @return int
      */
     public function deleteApplicationKey(User $user, string $identifier): int;
 }

app/Contracts/Repository/DatabaseHostRepositoryInterface.php

@@ -9,8 +9,6 @@ interface DatabaseHostRepositoryInterface extends RepositoryInterface
     /**
      * Return database hosts with a count of databases and the node
      * information for which it is attached.
-     *
-     * @return \Illuminate\Support\Collection
      */
     public function getWithViewDetails(): Collection;
 }

app/Contracts/Repository/DatabaseRepositoryInterface.php

@@ -8,89 +8,60 @@ use Illuminate\Contracts\Pagination\LengthAwarePaginator;
 
 interface DatabaseRepositoryInterface extends RepositoryInterface
 {
-    const DEFAULT_CONNECTION_NAME = 'dynamic';
+    public const DEFAULT_CONNECTION_NAME = 'dynamic';
 
     /**
      * Set the connection name to execute statements against.
      *
-     * @param string $connection
      * @return $this
      */
     public function setConnection(string $connection);
 
     /**
      * Return the connection to execute statements against.
-     *
-     * @return string
      */
     public function getConnection(): string;
 
     /**
      * Return all of the databases belonging to a server.
-     *
-     * @param int $server
-     * @return \Illuminate\Support\Collection
      */
     public function getDatabasesForServer(int $server): Collection;
 
     /**
      * Return all of the databases for a given host with the server relationship loaded.
-     *
-     * @param int $host
-     * @param int $count
-     * @return \Illuminate\Contracts\Pagination\LengthAwarePaginator
      */
     public function getDatabasesForHost(int $host, int $count = 25): LengthAwarePaginator;
 
     /**
      * Create a new database on a given connection.
-     *
-     * @param string $database
-     * @return bool
      */
     public function createDatabase(string $database): bool;
 
     /**
      * Create a new database user on a given connection.
      *
-     * @param string $username
-     * @param string $remote
-     * @param string $password
      * @param $max_connections
-     * @return bool
      */
     public function createUser(string $username, string $remote, string $password, string $max_connections): bool;
 
     /**
      * Give a specific user access to a given database.
-     *
-     * @param string $database
-     * @param string $username
-     * @param string $remote
-     * @return bool
      */
     public function assignUserToDatabase(string $database, string $username, string $remote): bool;
 
     /**
      * Flush the privileges for a given connection.
-     *
-     * @return bool
      */
     public function flush(): bool;
 
     /**
      * Drop a given database on a specific connection.
-     *
-     * @param string $database
-     * @return bool
      */
     public function dropDatabase(string $database): bool;
 
     /**
      * Drop a given user on a specific connection.
      *
-     * @param string $username
-     * @param string $remote
      * @return mixed
      */
     public function dropUser(string $username, string $remote): bool;

app/Contracts/Repository/EggRepositoryInterface.php

@@ -17,17 +17,12 @@ interface EggRepositoryInterface extends RepositoryInterface
     /**
      * Return an egg with the variables relation attached.
      *
-     * @param int $id
-     * @return \Pterodactyl\Models\Egg
-     *
      * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
      */
     public function getWithVariables(int $id): Egg;
 
     /**
      * Return all eggs and their relations to be used in the daemon API.
-     *
-     * @return \Illuminate\Database\Eloquent\Collection
      */
     public function getAllWithCopyAttributes(): Collection;
 
@@ -35,27 +30,18 @@ interface EggRepositoryInterface extends RepositoryInterface
      * Return an egg with the scriptFrom and configFrom relations loaded onto the model.
      *
      * @param int|string $value
-     * @param string $column
-     * @return \Pterodactyl\Models\Egg
      */
     public function getWithCopyAttributes($value, string $column = 'id'): Egg;
 
     /**
      * Return all of the data needed to export a service.
      *
-     * @param int $id
-     * @return \Pterodactyl\Models\Egg
-     *
      * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
      */
     public function getWithExportAttributes(int $id): Egg;
 
     /**
      * Confirm a copy script belongs to the same nest as the item trying to use it.
-     *
-     * @param int $copyFromId
-     * @param int $service
-     * @return bool
      */
     public function isCopyableScript(int $copyFromId, int $service): bool;
 }

app/Contracts/Repository/EggVariableRepositoryInterface.php

@@ -16,9 +16,6 @@ interface EggVariableRepositoryInterface extends RepositoryInterface
     /**
      * Return editable variables for a given egg. Editable variables must be set to
      * user viewable in order to be picked up by this function.
-     *
-     * @param int $egg
-     * @return \Illuminate\Support\Collection
      */
     public function getEditableVariables(int $egg): Collection;
 }

app/Contracts/Repository/LocationRepositoryInterface.php

@@ -9,22 +9,17 @@ interface LocationRepositoryInterface extends RepositoryInterface
 {
     /**
      * Return locations with a count of nodes and servers attached to it.
-     *
-     * @return \Illuminate\Support\Collection
      */
     public function getAllWithDetails(): Collection;
 
     /**
      * Return all of the available locations with the nodes as a relationship.
-     *
-     * @return \Illuminate\Support\Collection
      */
     public function getAllWithNodes(): Collection;
 
     /**
      * Return all of the nodes and their respective count of servers for a location.
      *
-     * @param int $id
      * @return mixed
      *
      * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
@@ -34,7 +29,6 @@ interface LocationRepositoryInterface extends RepositoryInterface
     /**
      * Return a location and the count of nodes in that location.
      *
-     * @param int $id
      * @return mixed
      *
      * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException

app/Contracts/Repository/NestRepositoryInterface.php

@@ -17,6 +17,7 @@ interface NestRepositoryInterface extends RepositoryInterface
      * Return a nest or all nests with their associated eggs and variables.
      *
      * @param int $id
+     *
      * @return \Illuminate\Database\Eloquent\Collection|\Pterodactyl\Models\Nest
      *
      * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
@@ -26,7 +27,6 @@ interface NestRepositoryInterface extends RepositoryInterface
     /**
      * Return a nest or all nests and the count of eggs and servers for that nest.
      *
-     * @param int|null $id
      * @return \Pterodactyl\Models\Nest|\Illuminate\Database\Eloquent\Collection
      *
      * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
@@ -36,9 +36,6 @@ interface NestRepositoryInterface extends RepositoryInterface
     /**
      * Return a nest along with its associated eggs and the servers relation on those eggs.
      *
-     * @param int $id
-     * @return \Pterodactyl\Models\Nest
-     *
      * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
      */
     public function getWithEggServers(int $id): Nest;

app/Contracts/Repository/NodeRepositoryInterface.php

@@ -7,48 +7,32 @@ use Illuminate\Support\Collection;
 
 interface NodeRepositoryInterface extends RepositoryInterface
 {
-    const THRESHOLD_PERCENTAGE_LOW = 75;
-    const THRESHOLD_PERCENTAGE_MEDIUM = 90;
+    public const THRESHOLD_PERCENTAGE_LOW = 75;
+    public const THRESHOLD_PERCENTAGE_MEDIUM = 90;
 
     /**
      * Return the usage stats for a single node.
-     *
-     * @param \Pterodactyl\Models\Node $node
-     * @return array
      */
     public function getUsageStats(Node $node): array;
 
     /**
      * Return the usage stats for a single node.
-     *
-     * @param \Pterodactyl\Models\Node $node
-     * @return array
      */
     public function getUsageStatsRaw(Node $node): array;
 
     /**
      * Return a single node with location and server information.
-     *
-     * @param \Pterodactyl\Models\Node $node
-     * @param bool $refresh
-     * @return \Pterodactyl\Models\Node
      */
     public function loadLocationAndServerCount(Node $node, bool $refresh = false): Node;
 
     /**
      * Attach a paginated set of allocations to a node mode including
      * any servers that are also attached to those allocations.
-     *
-     * @param \Pterodactyl\Models\Node $node
-     * @param bool $refresh
-     * @return \Pterodactyl\Models\Node
      */
     public function loadNodeAllocations(Node $node, bool $refresh = false): Node;
 
     /**
      * Return a collection of nodes for all locations to use in server creation UI.
-     *
-     * @return \Illuminate\Support\Collection
      */
     public function getNodesForServerCreation(): Collection;
 }

app/Contracts/Repository/RepositoryInterface.php

@@ -39,6 +39,7 @@ interface RepositoryInterface
      * An array of columns to filter the response by.
      *
      * @param array|string $columns
+     *
      * @return $this
      */
     public function setColumns($columns = ['*']);
@@ -62,7 +63,6 @@ interface RepositoryInterface
      * Set whether or not the repository should return a fresh model
      * when changes are committed.
      *
-     * @param bool $fresh
      * @return $this
      */
     public function setFreshModel(bool $fresh = true);
@@ -70,9 +70,6 @@ interface RepositoryInterface
     /**
      * Create a new model instance and persist it to the database.
      *
-     * @param array $fields
-     * @param bool $validate
-     * @param bool $force
      * @return mixed
      *
      * @throws \Pterodactyl\Exceptions\Model\DataValidationException
@@ -82,7 +79,6 @@ interface RepositoryInterface
     /**
      * Find a model that has the specific ID passed.
      *
-     * @param int $id
      * @return mixed
      *
      * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
@@ -91,16 +87,12 @@ interface RepositoryInterface
 
     /**
      * Find a model matching an array of where clauses.
-     *
-     * @param array $fields
-     * @return \Illuminate\Support\Collection
      */
     public function findWhere(array $fields): Collection;
 
     /**
      * Find and return the first matching instance for the given fields.
      *
-     * @param array $fields
      * @return mixed
      *
      * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
@@ -109,25 +101,16 @@ interface RepositoryInterface
 
     /**
      * Return a count of records matching the passed arguments.
-     *
-     * @param array $fields
-     * @return int
      */
     public function findCountWhere(array $fields): int;
 
     /**
      * Delete a given record from the database.
-     *
-     * @param int $id
-     * @return int
      */
     public function delete(int $id): int;
 
     /**
      * Delete records matching the given attributes.
-     *
-     * @param array $attributes
-     * @return int
      */
     public function deleteWhere(array $attributes): int;
 
@@ -135,9 +118,7 @@ interface RepositoryInterface
      * Update a given ID with the passed array of fields.
      *
      * @param int $id
-     * @param array $fields
-     * @param bool $validate
-     * @param bool $force
+     *
      * @return mixed
      *
      * @throws \Pterodactyl\Exceptions\Model\DataValidationException
@@ -148,21 +129,12 @@ interface RepositoryInterface
     /**
      * Perform a mass update where matching records are updated using whereIn.
      * This does not perform any model data validation.
-     *
-     * @param string $column
-     * @param array $values
-     * @param array $fields
-     * @return int
      */
     public function updateWhereIn(string $column, array $values, array $fields): int;
 
     /**
      * Update a record if it exists in the database, otherwise create it.
      *
-     * @param array $where
-     * @param array $fields
-     * @param bool $validate
-     * @param bool $force
      * @return mixed
      *
      * @throws \Pterodactyl\Exceptions\Model\DataValidationException
@@ -171,40 +143,27 @@ interface RepositoryInterface
 
     /**
      * Return all records associated with the given model.
-     *
-     * @return Collection
      */
     public function all(): Collection;
 
     /**
      * Return a paginated result set using a search term if set on the repository.
-     *
-     * @param int $perPage
-     * @return \Illuminate\Contracts\Pagination\LengthAwarePaginator
      */
     public function paginated(int $perPage): LengthAwarePaginator;
 
     /**
      * Insert a single or multiple records into the database at once skipping
      * validation and mass assignment checking.
-     *
-     * @param array $data
-     * @return bool
      */
     public function insert(array $data): bool;
 
     /**
      * Insert multiple records into the database and ignore duplicates.
-     *
-     * @param array $values
-     * @return bool
      */
     public function insertIgnore(array $values): bool;
 
     /**
      * Get the amount of entries in the database.
-     *
-     * @return int
      */
     public function count(): int;
 }

app/Contracts/Repository/ScheduleRepositoryInterface.php

@@ -9,18 +9,12 @@ interface ScheduleRepositoryInterface extends RepositoryInterface
 {
     /**
      * Return all of the schedules for a given server.
-     *
-     * @param int $server
-     * @return \Illuminate\Support\Collection
      */
     public function findServerSchedules(int $server): Collection;
 
     /**
      * Return a schedule model with all of the associated tasks as a relationship.
      *
-     * @param int $schedule
-     * @return \Pterodactyl\Models\Schedule
-     *
      * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
      */
     public function getScheduleWithTasks(int $schedule): Schedule;

app/Contracts/Repository/ServerRepositoryInterface.php

@@ -10,37 +10,22 @@ interface ServerRepositoryInterface extends RepositoryInterface
 {
     /**
      * Load the egg relations onto the server model.
-     *
-     * @param \Pterodactyl\Models\Server $server
-     * @param bool $refresh
-     * @return \Pterodactyl\Models\Server
      */
     public function loadEggRelations(Server $server, bool $refresh = false): Server;
 
     /**
      * Return a collection of servers with their associated data for rebuild operations.
-     *
-     * @param int|null $server
-     * @param int|null $node
-     * @return \Illuminate\Support\Collection
      */
     public function getDataForRebuild(int $server = null, int $node = null): Collection;
 
     /**
      * Return a collection of servers with their associated data for reinstall operations.
-     *
-     * @param int|null $server
-     * @param int|null $node
-     * @return \Illuminate\Support\Collection
      */
     public function getDataForReinstall(int $server = null, int $node = null): Collection;
 
     /**
      * Return a server model and all variables associated with the server.
      *
-     * @param int $id
-     * @return \Pterodactyl\Models\Server
-     *
      * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
      */
     public function findWithVariables(int $id): Server;
@@ -49,28 +34,16 @@ interface ServerRepositoryInterface extends RepositoryInterface
      * Get the primary allocation for a given server. If a model is passed into
      * the function, load the allocation relationship onto it. Otherwise, find and
      * return the server from the database.
-     *
-     * @param \Pterodactyl\Models\Server $server
-     * @param bool $refresh
-     * @return \Pterodactyl\Models\Server
      */
     public function getPrimaryAllocation(Server $server, bool $refresh = false): Server;
 
     /**
      * Return enough data to be used for the creation of a server via the daemon.
-     *
-     * @param \Pterodactyl\Models\Server $server
-     * @param bool $refresh
-     * @return \Pterodactyl\Models\Server
      */
     public function getDataForCreation(Server $server, bool $refresh = false): Server;
 
     /**
      * Load associated databases onto the server model.
-     *
-     * @param \Pterodactyl\Models\Server $server
-     * @param bool $refresh
-     * @return \Pterodactyl\Models\Server
      */
     public function loadDatabaseRelations(Server $server, bool $refresh = false): Server;
 
@@ -78,46 +51,28 @@ interface ServerRepositoryInterface extends RepositoryInterface
      * Get data for use when updating a server on the Daemon. Returns an array of
      * the egg which is used for build and rebuild. Only loads relations
      * if they are missing, or refresh is set to true.
-     *
-     * @param \Pterodactyl\Models\Server $server
-     * @param bool $refresh
-     * @return array
      */
     public function getDaemonServiceData(Server $server, bool $refresh = false): array;
 
     /**
      * Return a server by UUID.
      *
-     * @param string $uuid
-     * @return \Pterodactyl\Models\Server
-     *
      * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
      */
     public function getByUuid(string $uuid): Server;
 
     /**
      * Check if a given UUID and UUID-Short string are unique to a server.
-     *
-     * @param string $uuid
-     * @param string $short
-     * @return bool
      */
     public function isUniqueUuidCombo(string $uuid, string $short): bool;
 
     /**
      * Get the amount of servers that are suspended.
-     *
-     * @return int
      */
     public function getSuspendedServersCount(): int;
 
     /**
      * Returns all of the servers that exist for a given node in a paginated response.
-     *
-     * @param int $node
-     * @param int $limit
-     *
-     * @return \Illuminate\Contracts\Pagination\LengthAwarePaginator
      */
     public function loadAllServersForNode(int $node, int $limit): LengthAwarePaginator;
 }

app/Contracts/Repository/SessionRepositoryInterface.php

@@ -8,17 +8,12 @@ interface SessionRepositoryInterface extends RepositoryInterface
 {
     /**
      * Return all of the active sessions for a user.
-     *
-     * @param int $user
-     * @return \Illuminate\Support\Collection
      */
     public function getUserSessions(int $user): Collection;
 
     /**
      * Delete a session for a given user.
      *
-     * @param int $user
-     * @param string $session
      * @return int|null
      */
     public function deleteUserSession(int $user, string $session);

app/Contracts/Repository/SettingsRepositoryInterface.php

@@ -7,9 +7,6 @@ interface SettingsRepositoryInterface extends RepositoryInterface
     /**
      * Store a new persistent setting in the database.
      *
-     * @param string $key
-     * @param string|null $value
-     *
      * @throws \Pterodactyl\Exceptions\Model\DataValidationException
      * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
      */
@@ -18,16 +15,14 @@ interface SettingsRepositoryInterface extends RepositoryInterface
     /**
      * Retrieve a persistent setting from the database.
      *
-     * @param string $key
      * @param mixed $default
+     *
      * @return mixed
      */
     public function get(string $key, $default);
 
     /**
      * Remove a key from the database cache.
-     *
-     * @param string $key
      */
     public function forget(string $key);
 }

app/Contracts/Repository/SubuserRepositoryInterface.php

@@ -8,29 +8,17 @@ interface SubuserRepositoryInterface extends RepositoryInterface
 {
     /**
      * Return a subuser with the associated server relationship.
-     *
-     * @param \Pterodactyl\Models\Subuser $subuser
-     * @param bool $refresh
-     * @return \Pterodactyl\Models\Subuser
      */
     public function loadServerAndUserRelations(Subuser $subuser, bool $refresh = false): Subuser;
 
     /**
      * Return a subuser with the associated permissions relationship.
-     *
-     * @param \Pterodactyl\Models\Subuser $subuser
-     * @param bool $refresh
-     * @return \Pterodactyl\Models\Subuser
      */
     public function getWithPermissions(Subuser $subuser, bool $refresh = false): Subuser;
 
     /**
      * Return a subuser and associated permissions given a user_id and server_id.
      *
-     * @param int $user
-     * @param int $server
-     * @return \Pterodactyl\Models\Subuser
-     *
      * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
      */
     public function getWithPermissionsUsingUserAndServer(int $user, int $server): Subuser;

app/Contracts/Repository/TaskRepositoryInterface.php

@@ -9,9 +9,6 @@ interface TaskRepositoryInterface extends RepositoryInterface
     /**
      * Get a task and the server relationship for that task.
      *
-     * @param int $id
-     * @return \Pterodactyl\Models\Task
-     *
      * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
      */
     public function getTaskForJobProcess(int $id): Task;
@@ -19,8 +16,6 @@ interface TaskRepositoryInterface extends RepositoryInterface
     /**
      * Returns the next task in a schedule.
      *
-     * @param int $schedule
-     * @param int $index
      * @return \Pterodactyl\Models\Task|null
      */
     public function getNextTask(int $schedule, int $index);