From 7d1f4d8907dfc0b37c8a0d4c6e36a791d4acd363 Mon Sep 17 00:00:00 2001
From: James Cole <thegrumpydictator@gmail.com>
Date: Fri, 6 Jul 2018 07:19:19 +0200
Subject: [PATCH] Improve Events code quality.

---
 app/Events/AdminRequestedTestMessage.php   |  8 ++------
 app/Events/RegisteredUser.php              |  8 ++------
 app/Events/RequestedNewPassword.php        | 14 ++++---------
 app/Events/RequestedReportOnJournals.php   | 23 ++++++++++++++++++++--
 app/Events/RequestedVersionCheckStatus.php |  4 +---
 app/Events/StoredTransactionJournal.php    |  7 ++++---
 app/Events/UpdatedTransactionJournal.php   |  2 +-
 app/Events/UserChangedEmail.php            |  8 ++++----
 8 files changed, 39 insertions(+), 35 deletions(-)

diff --git a/app/Events/AdminRequestedTestMessage.php b/app/Events/AdminRequestedTestMessage.php
index 7198811a0c..800ffb909f 100644
--- a/app/Events/AdminRequestedTestMessage.php
+++ b/app/Events/AdminRequestedTestMessage.php
@@ -35,13 +35,9 @@ class AdminRequestedTestMessage extends Event
 {
     use SerializesModels;
 
-    /**
-     * @var string
-     */
+    /** @var string The users IP address */
     public $ipAddress;
-    /**
-     * @var User
-     */
+    /** @var User The user */
     public $user;
 
     /**
diff --git a/app/Events/RegisteredUser.php b/app/Events/RegisteredUser.php
index 053d0b24c5..1bbb4b25dd 100644
--- a/app/Events/RegisteredUser.php
+++ b/app/Events/RegisteredUser.php
@@ -34,13 +34,9 @@ class RegisteredUser extends Event
 {
     use SerializesModels;
 
-    /**
-     * @var string
-     */
+    /** @var string The users IP address */
     public $ipAddress;
-    /**
-     * @var User
-     */
+    /** @var User The user */
     public $user;
 
     /**
diff --git a/app/Events/RequestedNewPassword.php b/app/Events/RequestedNewPassword.php
index 422cc19872..4452a8dfeb 100644
--- a/app/Events/RequestedNewPassword.php
+++ b/app/Events/RequestedNewPassword.php
@@ -34,18 +34,12 @@ class RequestedNewPassword extends Event
 {
     use SerializesModels;
 
-    /**
-     * @var string
-     */
+    /** @var string The users IP address */
     public $ipAddress;
-    /**
-     * @var string
-     */
-    public $token;
-    /**
-     * @var User
-     */
+    /** @var User The user */
     public $user;
+    /** @var string The token */
+    public $token;
 
     /**
      * Create a new event instance. This event is triggered when a users tries to reset his or her password.
diff --git a/app/Events/RequestedReportOnJournals.php b/app/Events/RequestedReportOnJournals.php
index d4bdf0dbb7..632ebe6570 100644
--- a/app/Events/RequestedReportOnJournals.php
+++ b/app/Events/RequestedReportOnJournals.php
@@ -1,4 +1,23 @@
 <?php
+/**
+ * RequestedReportOnJournals.php
+ * Copyright (c) 2018 thegrumpydictator@gmail.com
+ *
+ * This file is part of Firefly III.
+ *
+ * Firefly III is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Firefly III is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
+ */
 
 namespace FireflyIII\Events;
 
@@ -16,9 +35,9 @@ class RequestedReportOnJournals
 {
     use Dispatchable, InteractsWithSockets, SerializesModels;
 
-    /** @var Collection */
+    /** @var Collection The journals to report on. */
     public $journals;
-    /** @var int */
+    /** @var int The ID of the user. */
     public $userId;
 
     /**
diff --git a/app/Events/RequestedVersionCheckStatus.php b/app/Events/RequestedVersionCheckStatus.php
index 6173b031af..dabe9ca7b8 100644
--- a/app/Events/RequestedVersionCheckStatus.php
+++ b/app/Events/RequestedVersionCheckStatus.php
@@ -35,9 +35,7 @@ class RequestedVersionCheckStatus extends Event
 {
     use SerializesModels;
 
-    /**
-     * @var User
-     */
+    /** @var User The user */
     public $user;
 
     /**
diff --git a/app/Events/StoredTransactionJournal.php b/app/Events/StoredTransactionJournal.php
index 4db12b1b35..3e1348eb69 100644
--- a/app/Events/StoredTransactionJournal.php
+++ b/app/Events/StoredTransactionJournal.php
@@ -28,16 +28,17 @@ use FireflyIII\Models\TransactionJournal;
 use Illuminate\Queue\SerializesModels;
 
 /**
- * @codeCoverageIgnore
  * Class StoredTransactionJournal.
+ *
+ * @codeCoverageIgnore
  */
 class StoredTransactionJournal extends Event
 {
     use SerializesModels;
 
-    /** @var TransactionJournal */
+    /** @var TransactionJournal The journal that was stored. */
     public $journal;
-    /** @var int */
+    /** @var int The piggy bank ID. */
     public $piggyBankId;
 
     /**
diff --git a/app/Events/UpdatedTransactionJournal.php b/app/Events/UpdatedTransactionJournal.php
index 5c9c7f7a9b..3d3ef2fff6 100644
--- a/app/Events/UpdatedTransactionJournal.php
+++ b/app/Events/UpdatedTransactionJournal.php
@@ -37,7 +37,7 @@ class UpdatedTransactionJournal extends Event
 {
     use SerializesModels;
 
-    /** @var TransactionJournal */
+    /** @var TransactionJournal The journal. */
     public $journal;
 
     /**
diff --git a/app/Events/UserChangedEmail.php b/app/Events/UserChangedEmail.php
index 2c2d9d8580..917eef90ae 100644
--- a/app/Events/UserChangedEmail.php
+++ b/app/Events/UserChangedEmail.php
@@ -34,13 +34,13 @@ class UserChangedEmail extends Event
 {
     use SerializesModels;
 
-    /** @var string */
+    /** @var string The user's IP address */
     public $ipAddress;
-    /** @var string */
+    /** @var string The user's new email address */
     public $newEmail;
-    /** @var string */
+    /** @var string The user's old email address */
     public $oldEmail;
-    /** @var User */
+    /** @var User The user itself */
     public $user;
 
     /**