Update doc blocks for all app/

.gitignore

@@ -6,14 +6,11 @@
 storage/framework/*
 
 composer.lock
-
-Homestead.yaml
-Vagrantfile
-Vagrantfile
-
-node_modules
-yarn.lock
 node_modules
 
 _ide_helper_models.php
 _ide_helper.php
+
+sami.phar
+sami.config.php
+/sami

app/Events/Server/Created.php

@@ -31,11 +31,17 @@ class Created
 {
     use SerializesModels;
 
+    /**
+     * The Eloquent model of the server.
+     *
+     * @var \Pterodactyl\Models\Server
+     */
     public $server;
 
     /**
      * Create a new event instance.
      *
+     * @param  \Pterodactyl\Models\Server  $server
      * @return void
      */
     public function __construct(Server $server)

app/Events/Server/Creating.php

@@ -31,11 +31,17 @@ class Creating
 {
     use SerializesModels;
 
+    /**
+     * The Eloquent model of the server.
+     *
+     * @var \Pterodactyl\Models\Server
+     */
     public $server;
 
     /**
      * Create a new event instance.
      *
+     * @param  \Pterodactyl\Models\Server  $server
      * @return void
      */
     public function __construct(Server $server)

app/Events/Server/Deleted.php

@@ -31,11 +31,17 @@ class Deleted
 {
     use SerializesModels;
 
+    /**
+     * The Eloquent model of the server.
+     *
+     * @var \Pterodactyl\Models\Server
+     */
     public $server;
 
     /**
      * Create a new event instance.
      *
+     * @param  \Pterodactyl\Models\Server  $server
      * @return void
      */
     public function __construct(Server $server)

app/Events/Server/Deleting.php

@@ -31,11 +31,17 @@ class Deleting
 {
     use SerializesModels;
 
+    /**
+     * The Eloquent model of the server.
+     *
+     * @var \Pterodactyl\Models\Server
+     */
     public $server;
 
     /**
      * Create a new event instance.
      *
+     * @param  \Pterodactyl\Models\Server  $server
      * @return void
      */
     public function __construct(Server $server)

app/Events/Server/Saved.php

@@ -31,11 +31,17 @@ class Saved
 {
     use SerializesModels;
 
+    /**
+     * The Eloquent model of the server.
+     *
+     * @var \Pterodactyl\Models\Server
+     */
     public $server;
 
     /**
      * Create a new event instance.
      *
+     * @param  \Pterodactyl\Models\Server  $server
      * @return void
      */
     public function __construct(Server $server)

app/Events/Server/Saving.php

@@ -31,11 +31,17 @@ class Saving
 {
     use SerializesModels;
 
+    /**
+     * The Eloquent model of the server.
+     *
+     * @var \Pterodactyl\Models\Server
+     */
     public $server;
 
     /**
      * Create a new event instance.
      *
+     * @param  \Pterodactyl\Models\Server  $server
      * @return void
      */
     public function __construct(Server $server)

app/Events/Server/Updated.php

@@ -31,11 +31,17 @@ class Updated
 {
     use SerializesModels;
 
+    /**
+     * The Eloquent model of the server.
+     *
+     * @var \Pterodactyl\Models\Server
+     */
     public $server;
 
     /**
      * Create a new event instance.
      *
+     * @param  \Pterodactyl\Models\Server  $server
      * @return void
      */
     public function __construct(Server $server)

app/Events/Server/Updating.php

@@ -31,11 +31,17 @@ class Updating
 {
     use SerializesModels;
 
+    /**
+     * The Eloquent model of the server.
+     *
+     * @var \Pterodactyl\Models\Server
+     */
     public $server;
 
     /**
      * Create a new event instance.
      *
+     * @param  \Pterodactyl\Models\Server  $server
      * @return void
      */
     public function __construct(Server $server)

app/Events/Subuser/Created.php

@@ -31,11 +31,17 @@ class Created
 {
     use SerializesModels;
 
+    /**
+     * The Eloquent model of the server.
+     *
+     * @var \Pterodactyl\Models\Subuser
+     */
     public $subuser;
 
     /**
      * Create a new event instance.
      *
+     * @param  \Pterodactyl\Models\Subuser  $subuser
      * @return void
      */
     public function __construct(Subuser $subuser)

app/Events/Subuser/Creating.php

@@ -31,11 +31,17 @@ class Creating
 {
     use SerializesModels;
 
+    /**
+     * The Eloquent model of the server.
+     *
+     * @var \Pterodactyl\Models\Subuser
+     */
     public $subuser;
 
     /**
      * Create a new event instance.
      *
+     * @param  \Pterodactyl\Models\Subuser  $subuser
      * @return void
      */
     public function __construct(Subuser $subuser)

app/Events/Subuser/Deleted.php

@@ -31,11 +31,17 @@ class Deleted
 {
     use SerializesModels;
 
+    /**
+     * The Eloquent model of the server.
+     *
+     * @var \Pterodactyl\Models\Subuser
+     */
     public $subuser;
 
     /**
      * Create a new event instance.
      *
+     * @param  \Pterodactyl\Models\Subuser  $subuser
      * @return void
      */
     public function __construct(Subuser $subuser)

app/Events/Subuser/Deleting.php

@@ -31,11 +31,17 @@ class Deleting
 {
     use SerializesModels;
 
+    /**
+     * The Eloquent model of the server.
+     *
+     * @var \Pterodactyl\Models\Subuser
+     */
     public $subuser;
 
     /**
      * Create a new event instance.
      *
+     * @param  \Pterodactyl\Models\Subuser  $subuser
      * @return void
      */
     public function __construct(Subuser $subuser)

app/Events/User/Created.php

@@ -31,11 +31,17 @@ class Created
 {
     use SerializesModels;
 
+    /**
+     * The Eloquent model of the server.
+     *
+     * @var \Pterodactyl\Models\User
+     */
     public $user;
 
     /**
      * Create a new event instance.
      *
+     * @param  \Pterodactyl\Models\User  $user
      * @return void
      */
     public function __construct(User $user)

app/Events/User/Creating.php

@@ -31,11 +31,17 @@ class Creating
 {
     use SerializesModels;
 
+    /**
+     * The Eloquent model of the server.
+     *
+     * @var \Pterodactyl\Models\User
+     */
     public $user;
 
     /**
      * Create a new event instance.
      *
+     * @param  \Pterodactyl\Models\User  $user
      * @return void
      */
     public function __construct(User $user)

app/Events/User/Deleted.php

@@ -31,11 +31,17 @@ class Deleted
 {
     use SerializesModels;
 
+    /**
+     * The Eloquent model of the server.
+     *
+     * @var \Pterodactyl\Models\User
+     */
     public $user;
 
     /**
      * Create a new event instance.
      *
+     * @param  \Pterodactyl\Models\User  $user
      * @return void
      */
     public function __construct(User $user)

app/Events/User/Deleting.php

@@ -31,11 +31,17 @@ class Deleting
 {
     use SerializesModels;
 
+    /**
+     * The Eloquent model of the server.
+     *
+     * @var \Pterodactyl\Models\User
+     */
     public $user;
 
     /**
      * Create a new event instance.
      *
+     * @param  \Pterodactyl\Models\User  $user
      * @return void
      */
     public function __construct(User $user)

app/Exceptions/AccountNotFoundException.php

@@ -26,4 +26,5 @@
 
 class AccountNotFoundException extends \Exception
 {
+    //
 }

app/Exceptions/DisplayException.php

@@ -28,20 +28,19 @@
 
 class DisplayException extends \Exception
 {
-    private $_logging = null;
-
+    /**
+     * Exception constructor.
+     *
+     * @param  string  $message
+     * @param  mixed   $log
+     * @return void
+     */
     public function __construct($message, $log = null)
     {
-        $this->_logging = $log;
-        if ($this->_logging !== null) {
+        if (! is_null($log)) {
             Log::error($log);
         }
 
         parent::__construct($message);
     }
-
-    public function getLogging()
-    {
-        return $this->_logging;
-    }
 }

app/Exceptions/Handler.php

@@ -29,7 +29,7 @@ class Handler extends ExceptionHandler
      *
      * This is a great spot to send exceptions to Sentry, Bugsnag, etc.
      *
-     * @param  \Exception  $e
+     * @param  \Exception  $exception
      * @return void
      */
     public function report(Exception $exception)
@@ -41,7 +41,7 @@ public function report(Exception $exception)
      * Render an exception into an HTTP response.
      *
      * @param  \Illuminate\Http\Request  $request
-     * @param  \Exception  $e
+     * @param  \Exception                $exception
      * @return \Illuminate\Http\Response
      */
     public function render($request, Exception $exception)
@@ -60,7 +60,7 @@ public function render($request, Exception $exception)
     /**
      * Convert an authentication exception into an unauthenticated response.
      *
-     * @param  \Illuminate\Http\Request  $request
+     * @param  \Illuminate\Http\Request                  $request
      * @param  \Illuminate\Auth\AuthenticationException  $exception
      * @return \Illuminate\Http\Response
      */

app/Extensions/PhraseAppTranslator.php

@@ -31,11 +31,11 @@ class PhraseAppTranslator extends LaravelTranslator
     /**
      * Get the translation for the given key.
      *
-     * @param  string  $key
-     * @param  array   $replace
+     * @param  string       $key
+     * @param  array        $replace
      * @param  string|null  $locale
-     * @param  bool  $fallback
-     * @return string|array|null
+     * @param  bool         $fallback
+     * @return string
      */
     public function get($key, array $replace = [], $locale = null, $fallback = true)
     {

app/Facades/Version.php

@@ -28,6 +28,11 @@
 
 class Version extends Facade
 {
+    /**
+     * Returns the facade accessor class.
+     *
+     * @return strig
+     */
     protected static function getFacadeAccessor()
     {
         return '\Pterodactyl\Services\VersionService';