Update doc blocks for all app/
This commit is contained in:
Dane Everitt
parent
5e27772fef
commit
0312c974f5
114 changed files with 1360 additions and 949 deletions
|
|
@ -31,22 +31,12 @@ use Pterodactyl\Models\Server;
|
|||
|
||||
class ServerPolicy
|
||||
{
|
||||
/**
|
||||
* Create a new policy instance.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function __construct()
|
||||
{
|
||||
//
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if the user has the given permission on/for the server.
|
||||
*
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @param $permission
|
||||
* @param string $permission
|
||||
* @return bool
|
||||
*/
|
||||
private function checkPermission(User $user, Server $server, $permission)
|
||||
|
|
@ -93,8 +83,8 @@ class ServerPolicy
|
|||
/**
|
||||
* Check if user has permission to control power for a server.
|
||||
*
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @return bool
|
||||
*/
|
||||
public function power(User $user, Server $server)
|
||||
|
|
@ -105,8 +95,8 @@ class ServerPolicy
|
|||
/**
|
||||
* Check if user has permission to start a server.
|
||||
*
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @return bool
|
||||
*/
|
||||
public function powerStart(User $user, Server $server)
|
||||
|
|
@ -117,8 +107,8 @@ class ServerPolicy
|
|||
/**
|
||||
* Check if user has permission to stop a server.
|
||||
*
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @return bool
|
||||
*/
|
||||
public function powerStop(User $user, Server $server)
|
||||
|
|
@ -129,8 +119,8 @@ class ServerPolicy
|
|||
/**
|
||||
* Check if user has permission to restart a server.
|
||||
*
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @return bool
|
||||
*/
|
||||
public function powerRestart(User $user, Server $server)
|
||||
|
|
@ -141,8 +131,8 @@ class ServerPolicy
|
|||
/**
|
||||
* Check if user has permission to kill a server.
|
||||
*
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @return bool
|
||||
*/
|
||||
public function powerKill(User $user, Server $server)
|
||||
|
|
@ -153,8 +143,8 @@ class ServerPolicy
|
|||
/**
|
||||
* Check if user has permission to run a command on a server.
|
||||
*
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @return bool
|
||||
*/
|
||||
public function sendCommand(User $user, Server $server)
|
||||
|
|
@ -165,8 +155,8 @@ class ServerPolicy
|
|||
/**
|
||||
* Check if user has permission to list files on a server.
|
||||
*
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @return bool
|
||||
*/
|
||||
public function listFiles(User $user, Server $server)
|
||||
|
|
@ -177,8 +167,8 @@ class ServerPolicy
|
|||
/**
|
||||
* Check if user has permission to edit files on a server.
|
||||
*
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @return bool
|
||||
*/
|
||||
public function editFiles(User $user, Server $server)
|
||||
|
|
@ -189,8 +179,8 @@ class ServerPolicy
|
|||
/**
|
||||
* Check if user has permission to save files on a server.
|
||||
*
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @return bool
|
||||
*/
|
||||
public function saveFiles(User $user, Server $server)
|
||||
|
|
@ -201,8 +191,8 @@ class ServerPolicy
|
|||
/**
|
||||
* Check if user has permission to move and rename files and folders on a server.
|
||||
*
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @return bool
|
||||
*/
|
||||
public function moveFiles(User $user, Server $server)
|
||||
|
|
@ -213,8 +203,8 @@ class ServerPolicy
|
|||
/**
|
||||
* Check if user has permission to copy folders and files on a server.
|
||||
*
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @return bool
|
||||
*/
|
||||
public function copyFiles(User $user, Server $server)
|
||||
|
|
@ -225,8 +215,8 @@ class ServerPolicy
|
|||
/**
|
||||
* Check if user has permission to compress files and folders on a server.
|
||||
*
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @return bool
|
||||
*/
|
||||
public function compressFiles(User $user, Server $server)
|
||||
|
|
@ -237,8 +227,8 @@ class ServerPolicy
|
|||
/**
|
||||
* Check if user has permission to decompress files on a server.
|
||||
*
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @return bool
|
||||
*/
|
||||
public function decompressFiles(User $user, Server $server)
|
||||
|
|
@ -249,8 +239,8 @@ class ServerPolicy
|
|||
/**
|
||||
* Check if user has permission to add files to a server.
|
||||
*
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @return bool
|
||||
*/
|
||||
public function createFiles(User $user, Server $server)
|
||||
|
|
@ -262,8 +252,8 @@ class ServerPolicy
|
|||
* Check if user has permission to upload files to a server.
|
||||
* This permission relies on the user having the 'create-files' permission as well due to page authorization.
|
||||
*
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @return bool
|
||||
*/
|
||||
public function uploadFiles(User $user, Server $server)
|
||||
|
|
@ -274,8 +264,8 @@ class ServerPolicy
|
|||
/**
|
||||
* Check if user has permission to download files from a server.
|
||||
*
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @return bool
|
||||
*/
|
||||
public function downloadFiles(User $user, Server $server)
|
||||
|
|
@ -286,8 +276,8 @@ class ServerPolicy
|
|||
/**
|
||||
* Check if user has permission to delete files from a server.
|
||||
*
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @return bool
|
||||
*/
|
||||
public function deleteFiles(User $user, Server $server)
|
||||
|
|
@ -298,8 +288,8 @@ class ServerPolicy
|
|||
/**
|
||||
* Check if user has permission to view subusers for the server.
|
||||
*
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @return bool
|
||||
*/
|
||||
public function listSubusers(User $user, Server $server)
|
||||
|
|
@ -310,8 +300,8 @@ class ServerPolicy
|
|||
/**
|
||||
* Check if user has permission to view specific subuser permissions.
|
||||
*
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @return bool
|
||||
*/
|
||||
public function viewSubuser(User $user, Server $server)
|
||||
|
|
@ -322,8 +312,8 @@ class ServerPolicy
|
|||
/**
|
||||
* Check if user has permission to edit a subuser.
|
||||
*
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @return bool
|
||||
*/
|
||||
public function editSubuser(User $user, Server $server)
|
||||
|
|
@ -334,8 +324,8 @@ class ServerPolicy
|
|||
/**
|
||||
* Check if user has permission to delete a subuser.
|
||||
*
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @return bool
|
||||
*/
|
||||
public function deleteSubuser(User $user, Server $server)
|
||||
|
|
@ -346,8 +336,8 @@ class ServerPolicy
|
|||
/**
|
||||
* Check if user has permission to edit a subuser.
|
||||
*
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @return bool
|
||||
*/
|
||||
public function createSubuser(User $user, Server $server)
|
||||
|
|
@ -358,8 +348,8 @@ class ServerPolicy
|
|||
/**
|
||||
* Check if user has permission to set the default connection for a server.
|
||||
*
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @return bool
|
||||
*/
|
||||
public function setConnection(User $user, Server $server)
|
||||
|
|
@ -370,8 +360,8 @@ class ServerPolicy
|
|||
/**
|
||||
* Check if user has permission to view the startup command used for a server.
|
||||
*
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @return bool
|
||||
*/
|
||||
public function viewStartup(User $user, Server $server)
|
||||
|
|
@ -382,8 +372,8 @@ class ServerPolicy
|
|||
/**
|
||||
* Check if user has permission to edit the startup command used for a server.
|
||||
*
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @return bool
|
||||
*/
|
||||
public function editStartup(User $user, Server $server)
|
||||
|
|
@ -394,8 +384,8 @@ class ServerPolicy
|
|||
/**
|
||||
* Check if user has permission to view the SFTP information for a server.
|
||||
*
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @return bool
|
||||
*/
|
||||
public function viewSftp(User $user, Server $server)
|
||||
|
|
@ -406,8 +396,8 @@ class ServerPolicy
|
|||
/**
|
||||
* Check if user has permission to reset the SFTP password for a server.
|
||||
*
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @return bool
|
||||
*/
|
||||
public function resetSftp(User $user, Server $server)
|
||||
|
|
@ -418,8 +408,8 @@ class ServerPolicy
|
|||
/**
|
||||
* Check if user has permission to view the SFTP password for a server.
|
||||
*
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @return bool
|
||||
*/
|
||||
public function viewSftpPassword(User $user, Server $server)
|
||||
|
|
@ -430,8 +420,8 @@ class ServerPolicy
|
|||
/**
|
||||
* Check if user has permission to view databases for a server.
|
||||
*
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @return bool
|
||||
*/
|
||||
public function viewDatabases(User $user, Server $server)
|
||||
|
|
@ -442,8 +432,8 @@ class ServerPolicy
|
|||
/**
|
||||
* Check if user has permission to reset database passwords.
|
||||
*
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @return bool
|
||||
*/
|
||||
public function resetDbPassword(User $user, Server $server)
|
||||
|
|
@ -454,8 +444,8 @@ class ServerPolicy
|
|||
/**
|
||||
* Check if user has permission to view all tasks for a server.
|
||||
*
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @return bool
|
||||
*/
|
||||
public function listTasks(User $user, Server $server)
|
||||
|
|
@ -466,8 +456,8 @@ class ServerPolicy
|
|||
/**
|
||||
* Check if user has permission to view a specific task for a server.
|
||||
*
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @return bool
|
||||
*/
|
||||
public function viewTask(User $user, Server $server)
|
||||
|
|
@ -478,8 +468,8 @@ class ServerPolicy
|
|||
/**
|
||||
* Check if user has permission to view a toggle a task for a server.
|
||||
*
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @return bool
|
||||
*/
|
||||
public function toggleTask(User $user, Server $server)
|
||||
|
|
@ -490,8 +480,8 @@ class ServerPolicy
|
|||
/**
|
||||
* Check if user has permission to queue a task for a server.
|
||||
*
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @return bool
|
||||
*/
|
||||
public function queueTask(User $user, Server $server)
|
||||
|
|
@ -502,8 +492,8 @@ class ServerPolicy
|
|||
/**
|
||||
* Check if user has permission to delete a specific task for a server.
|
||||
*
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @return bool
|
||||
*/
|
||||
public function deleteTask(User $user, Server $server)
|
||||
|
|
@ -514,8 +504,8 @@ class ServerPolicy
|
|||
/**
|
||||
* Check if user has permission to create a task for a server.
|
||||
*
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @return bool
|
||||
*/
|
||||
public function createTask(User $user, Server $server)
|
||||
|
|
@ -526,8 +516,8 @@ class ServerPolicy
|
|||
/**
|
||||
* Check if user has permission to view server allocations.
|
||||
*
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @return bool
|
||||
*/
|
||||
public function viewAllocation(User $user, Server $server)
|
||||
|
|
@ -538,8 +528,8 @@ class ServerPolicy
|
|||
/**
|
||||
* Check if user has permission to set the default allocation.
|
||||
*
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @param \Pterodactyl\Models\User $user
|
||||
* @param \Pterodactyl\Models\Server $server
|
||||
* @return bool
|
||||
*/
|
||||
public function setAllocation(User $user, Server $server)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue