Improve Events code quality.

This commit is contained in:
James Cole 2018-07-06 07:19:19 +02:00
parent a76241c7ba
commit 7d1f4d8907
8 changed files with 39 additions and 35 deletions

View File

@ -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;
/**

View File

@ -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;
/**

View File

@ -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.

View File

@ -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;
/**

View File

@ -35,9 +35,7 @@ class RequestedVersionCheckStatus extends Event
{
use SerializesModels;
/**
* @var User
*/
/** @var User The user */
public $user;
/**

View File

@ -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;
/**

View File

@ -37,7 +37,7 @@ class UpdatedTransactionJournal extends Event
{
use SerializesModels;
/** @var TransactionJournal */
/** @var TransactionJournal The journal. */
public $journal;
/**

View File

@ -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;
/**