Update doc blocks for all app/

app/Models/APILog.php

@@ -49,12 +49,12 @@ class APILog extends Model
      */
     protected $guarded = ['id', 'created_at', 'updated_at'];
 
-     /**
-      * Cast values to correct type.
-      *
-      * @var array
-      */
-     protected $casts = [
-         'authorized' => 'boolean',
-     ];
+    /**
+     * Cast values to correct type.
+     *
+     * @var array
+     */
+    protected $casts = [
+        'authorized' => 'boolean',
+    ];
 }

app/Models/APIPermission.php

@@ -42,14 +42,14 @@ class APIPermission extends Model
      */
     protected $guarded = ['id'];
 
-     /**
-      * Cast values to correct type.
-      *
-      * @var array
-      */
-     protected $casts = [
-         'key_id' => 'integer',
-     ];
+    /**
+     * Cast values to correct type.
+     *
+     * @var array
+     */
+    protected $casts = [
+        'key_id' => 'integer',
+    ];
 
     /**
      * Disable timestamps for this table.

app/Models/Allocation.php

@@ -56,7 +56,7 @@ class Allocation extends Model
      /**
       * Accessor to automatically provide the IP alias if defined.
       *
-      * @param  null|string $value
+      * @param  null|string  $value
       * @return string
       */
      public function getAliasAttribute($value)
@@ -67,7 +67,7 @@ class Allocation extends Model
      /**
       * Accessor to quickly determine if this allocation has an alias.
       *
-      * @param  null|string $value
+      * @param  null|string  $value
       * @return bool
       */
      public function getHasAliasAttribute($value)

app/Models/Database.php

@@ -51,33 +51,33 @@ class Database extends Model
         'server_id', 'database_host_id', 'database', 'username', 'remote',
     ];
 
-     /**
-      * Cast values to correct type.
-      *
-      * @var array
-      */
-     protected $casts = [
-         'server_id' => 'integer',
-         'database_host_id' => 'integer',
-     ];
+    /**
+     * Cast values to correct type.
+     *
+     * @var array
+     */
+    protected $casts = [
+        'server_id' => 'integer',
+        'database_host_id' => 'integer',
+    ];
 
-     /**
-      * Gets the host database server associated with a database.
-      *
-      * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
-      */
-     public function host()
-     {
-         return $this->belongsTo(DatabaseHost::class, 'database_host_id');
-     }
+    /**
+     * Gets the host database server associated with a database.
+     *
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function host()
+    {
+        return $this->belongsTo(DatabaseHost::class, 'database_host_id');
+    }
 
-     /**
-      * Gets the server associated with a database.
-      *
-      * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
-      */
-     public function server()
-     {
-         return $this->belongsTo(Server::class);
-     }
+    /**
+     * Gets the server associated with a database.
+     *
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function server()
+    {
+        return $this->belongsTo(Server::class);
+    }
 }

app/Models/DatabaseHost.php

@@ -51,34 +51,34 @@ class DatabaseHost extends Model
         'name', 'host', 'port', 'username', 'max_databases', 'node_id',
     ];
 
-     /**
-      * Cast values to correct type.
-      *
-      * @var array
-      */
-     protected $casts = [
-         'id' => 'integer',
-         'max_databases' => 'integer',
-         'node_id' => 'integer',
-     ];
+    /**
+     * Cast values to correct type.
+     *
+     * @var array
+     */
+    protected $casts = [
+        'id' => 'integer',
+        'max_databases' => 'integer',
+        'node_id' => 'integer',
+    ];
 
-     /**
-      * Gets the node associated with a database host.
-      *
-      * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
-      */
-     public function node()
-     {
-         return $this->belongsTo(Node::class);
-     }
+    /**
+     * Gets the node associated with a database host.
+     *
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function node()
+    {
+        return $this->belongsTo(Node::class);
+    }
 
-     /**
-      * Gets the databases assocaited with this host.
-      *
-      * @return \Illuminate\Database\Eloquent\Relations\HasMany
-      */
-     public function databases()
-     {
-         return $this->hasMany(Database::class);
-     }
+    /**
+     * Gets the databases assocaited with this host.
+     *
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany
+     */
+    public function databases()
+    {
+        return $this->hasMany(Database::class);
+    }
 }

app/Models/Node.php

@@ -75,6 +75,11 @@ class Node extends Model
         'daemonSFTP', 'daemonListen',
     ];
 
+    /**
+     * Fields that are searchable.
+     *
+     * @var array
+     */
     protected $searchable = [
          'columns' => [
              'nodes.name' => 10,
@@ -90,7 +95,7 @@ class Node extends Model
     /**
      * Return an instance of the Guzzle client for this specific node.
      *
-     * @param array $headers
+     * @param  array  $headers
      * @return \GuzzleHttp\Client
      */
     public function guzzleClient($headers = [])
@@ -106,8 +111,8 @@ class Node extends Model
     /**
      * Returns the configuration in JSON format.
      *
-     * @param bool $pretty Wether to pretty print the JSON or not
-     * @return string The configration in JSON format
+     * @param  bool  $pretty
+     * @return string
      */
     public function getConfigurationAsJson($pretty = false)
     {

app/Models/Pack.php

@@ -83,7 +83,7 @@ class Pack extends Model
     /**
      * Returns all of the archived files for a given pack.
      *
-     * @param  bool   $collection
+     * @param  bool  $collection
      * @return \Illuminate\Support\Collection|object
      */
     public function files($collection = false)

app/Models/Server.php

@@ -115,8 +115,11 @@ class Server extends Model
      * DO NOT USE THIS TO MODIFY SERVER DETAILS OR SAVE THOSE DETAILS.
      * YOU WILL OVERWRITE THE SECRET KEY AND BREAK THINGS.
      *
-     * @param  string $uuid The Short-UUID of the server to return an object about.
-     * @return \Illuminate\Database\Eloquent\Collection
+     * @param  string  $uuid
+     * @param  array   $with
+     * @param  array   $withCount
+     * @return \Pterodactyl\Models\Server
+     * @todo   Remove $with and $withCount due to cache issues, they aren't used anyways.
      */
     public static function byUuid($uuid, array $with = [], array $withCount = [])
     {
@@ -147,7 +150,6 @@ class Server extends Model
     /**
      * Returns non-administrative headers for accessing a server on the daemon.
      *
-     * @param  string $uuid
      * @return array
      */
     public function guzzleHeaders()
@@ -171,6 +173,8 @@ class Server extends Model
     /**
      * Returns javascript object to be embedded on server view pages with relevant information.
      *
+     * @param  array|null  $additional
+     * @param  array|null  $overwrite
      * @return \Laracasts\Utilities\JavaScript\JavaScriptFacade
      */
     public function js($additional = null, $overwrite = null)

app/Models/ServiceOption.php

@@ -42,63 +42,63 @@ class ServiceOption extends Model
      */
     protected $guarded = ['id', 'created_at', 'updated_at'];
 
-     /**
-      * Cast values to correct type.
-      *
-      * @var array
-      */
-     protected $casts = [
-         'service_id' => 'integer',
-     ];
+    /**
+     * Cast values to correct type.
+     *
+     * @var array
+     */
+    protected $casts = [
+        'service_id' => 'integer',
+    ];
 
-     /**
-      * Returns the display startup string for the option and will use the parent
-      * service one if the option does not have one defined.
-      *
-      * @return string
-      */
-     public function getDisplayStartupAttribute($value)
-     {
-         return (is_null($this->startup)) ? $this->service->startup : $this->startup;
-     }
+    /**
+     * Returns the display startup string for the option and will use the parent
+     * service one if the option does not have one defined.
+     *
+     * @return string
+     */
+    public function getDisplayStartupAttribute($value)
+    {
+        return (is_null($this->startup)) ? $this->service->startup : $this->startup;
+    }
 
-     /**
-      * Gets service associated with a service option.
-      *
-      * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
-      */
-     public function service()
-     {
-         return $this->belongsTo(Service::class);
-     }
+    /**
+     * Gets service associated with a service option.
+     *
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function service()
+    {
+        return $this->belongsTo(Service::class);
+    }
 
-     /**
-      * Gets all servers associated with this service option.
-      *
-      * @return \Illuminate\Database\Eloquent\Relations\HasMany
-      */
-     public function servers()
-     {
-         return $this->hasMany(Server::class, 'option_id');
-     }
+    /**
+     * Gets all servers associated with this service option.
+     *
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany
+     */
+    public function servers()
+    {
+        return $this->hasMany(Server::class, 'option_id');
+    }
 
-     /**
-      * Gets all variables associated with this service.
-      *
-      * @return \Illuminate\Database\Eloquent\Relations\HasMany
-      */
-     public function variables()
-     {
-         return $this->hasMany(ServiceVariable::class, 'option_id');
-     }
+    /**
+     * Gets all variables associated with this service.
+     *
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany
+     */
+    public function variables()
+    {
+        return $this->hasMany(ServiceVariable::class, 'option_id');
+    }
 
-     /**
-      * Gets all packs associated with this service.
-      *
-      * @return \Illuminate\Database\Eloquent\Relations\HasMany
-      */
-     public function packs()
-     {
-         return $this->hasMany(Pack::class, 'option_id');
-     }
+    /**
+     * Gets all packs associated with this service.
+     *
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany
+     */
+    public function packs()
+    {
+        return $this->hasMany(Pack::class, 'option_id');
+    }
 }

app/Models/ServiceVariable.php

@@ -57,7 +57,7 @@ class ServiceVariable extends Model
      * Returns the display executable for the option and will use the parent
      * service one if the option does not have one defined.
      *
-     * @return string
+     * @return bool
      */
     public function getRequiredAttribute($value)
     {

app/Models/Session.php

@@ -35,13 +35,13 @@ class Session extends Model
      */
     protected $table = 'sessions';
 
-     /**
-      * Cast values to correct type.
-      *
-      * @var array
-      */
-     protected $casts = [
-         'id' => 'string',
-         'user_id' => 'integer',
-     ];
+    /**
+     * Cast values to correct type.
+     *
+     * @var array
+     */
+    protected $casts = [
+        'id' => 'string',
+        'user_id' => 'integer',
+    ];
 }

app/Models/Task.php

@@ -42,16 +42,16 @@ class Task extends Model
      */
     protected $guarded = ['id', 'created_at', 'updated_at'];
 
-     /**
-      * Cast values to correct type.
-      *
-      * @var array
-      */
-     protected $casts = [
-         'id' => 'integer',
-         'server' => 'integer',
-         'queued' => 'integer',
-     ];
+    /**
+     * Cast values to correct type.
+     *
+     * @var array
+     */
+    protected $casts = [
+        'id' => 'integer',
+        'server' => 'integer',
+        'queued' => 'integer',
+    ];
 
     /**
      * The attributes that should be mutated to dates.

app/Models/TaskLog.php

@@ -42,16 +42,16 @@ class TaskLog extends Model
      */
     protected $guarded = ['id', 'created_at', 'updated_at'];
 
-     /**
-      * Cast values to correct type.
-      *
-      * @var array
-      */
-     protected $casts = [
-         'id' => 'integer',
-         'task_id' => 'integer',
-         'run_status' => 'integer',
-     ];
+    /**
+     * Cast values to correct type.
+     *
+     * @var array
+     */
+    protected $casts = [
+        'id' => 'integer',
+        'task_id' => 'integer',
+        'run_status' => 'integer',
+    ];
 
     /**
      * The attributes that should be mutated to dates.

app/Models/User.php

@@ -70,16 +70,16 @@ class User extends Model implements AuthenticatableContract, AuthorizableContrac
      */
     protected $fillable = ['username', 'email', 'name_first', 'name_last', 'password', 'language', 'use_totp', 'totp_secret', 'gravatar', 'root_admin'];
 
-     /**
-      * Cast values to correct type.
-      *
-      * @var array
-      */
-     protected $casts = [
-         'root_admin' => 'integer',
-         'use_totp' => 'integer',
-         'gravatar' => 'integer',
-     ];
+    /**
+     * Cast values to correct type.
+     *
+     * @var array
+     */
+    protected $casts = [
+        'root_admin' => 'integer',
+        'use_totp' => 'integer',
+        'gravatar' => 'integer',
+    ];
 
     /**
      * The attributes excluded from the model's JSON form.
@@ -106,7 +106,7 @@ class User extends Model implements AuthenticatableContract, AuthorizableContrac
     /**
      * Enables or disables TOTP on an account if the token is valid.
      *
-     * @param int $token The token that we want to verify.
+     * @param  int  $token
      * @return bool
      */
     public function toggleTotp($token)
@@ -116,9 +116,7 @@ class User extends Model implements AuthenticatableContract, AuthorizableContrac
         }
 
         $this->use_totp = ! $this->use_totp;
-        $this->save();
-
-        return true;
+        return $this->save();
     }
 
     /**
@@ -128,8 +126,8 @@ class User extends Model implements AuthenticatableContract, AuthorizableContrac
      *      - at least one lowercase character
      *      - at least one number.
      *
-     * @param string $password The raw password to set the account password to.
-     * @param string $regex The regex to use when validating the password. Defaults to '((?=.*\d)(?=.*[a-z])(?=.*[A-Z]).{8,})'.
+     * @param  string  $password
+     * @param  string  $regex
      * @return void
      */
     public function setPassword($password, $regex = '((?=.*\d)(?=.*[a-z])(?=.*[A-Z]).{8,})')
@@ -156,7 +154,7 @@ class User extends Model implements AuthenticatableContract, AuthorizableContrac
     /**
      * Return true or false depending on wether the user is root admin or not.
      *
-     * @return bool the user is root admin
+     * @return bool
      */
     public function isRootAdmin()
     {
@@ -165,7 +163,8 @@ class User extends Model implements AuthenticatableContract, AuthorizableContrac
 
     /**
      * Returns the user's daemon secret for a given server.
-     * @param  Server $server \Pterodactyl\Models\Server
+     *
+     * @param  \Pterodactyl\Models\Server  $server
      * @return null|string
      */
     public function daemonToken(Server $server)
@@ -200,7 +199,9 @@ class User extends Model implements AuthenticatableContract, AuthorizableContrac
      * Returns an array of all servers a user is able to access.
      * Note: does not account for user admin status.
      *
-     * @return Collection
+     * @param  int|null  $paginate
+     * @param  array     $load
+     * @return \Illuminate\Pagination\LengthAwarePagination|\Illuiminate\Database\Eloquent\Collection
      */
     public function serverAccessCollection($paginate = null, $load = ['service', 'node', 'allocation'])
     {