Add php doc blocks.

This commit is contained in:
James Cole
2017-11-25 15:20:53 +01:00
parent f7b1168e7c
commit 35647a062c
66 changed files with 235 additions and 84 deletions

View File

@@ -1,7 +1,4 @@
<?php
declare(strict_types=1);
/**
* AdminTestMail.php
* Copyright (c) 2017 thegrumpydictator@gmail.com
@@ -22,6 +19,9 @@ declare(strict_types=1);
* along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace FireflyIII\Mail;
use Illuminate\Bus\Queueable;
@@ -30,14 +30,16 @@ use Illuminate\Queue\SerializesModels;
/**
* Class AdminTestMail.
*
* Sends a test mail to administrators.
*/
class AdminTestMail extends Mailable
{
use Queueable, SerializesModels;
/** @var string */
/** @var string Email address of admin */
public $email;
/** @var string */
/** @var string IP address of admin */
public $ipAddress;
/**

View File

@@ -1,7 +1,4 @@
<?php
declare(strict_types=1);
/**
* ConfirmEmailChangeMail.php
* Copyright (c) 2017 thegrumpydictator@gmail.com
@@ -22,23 +19,30 @@ declare(strict_types=1);
* along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace FireflyIII\Mail;
use Illuminate\Bus\Queueable;
use Illuminate\Mail\Mailable;
use Illuminate\Queue\SerializesModels;
/**
* Class ConfirmEmailChangeMail
*
* Sends message to new address to confirm change.
*/
class ConfirmEmailChangeMail extends Mailable
{
use Queueable, SerializesModels;
/** @var string */
/** @var string IP address of user */
public $ipAddress;
/** @var string */
/** @var string New email address */
public $newEmail;
/** @var string */
/** @var string Old email address */
public $oldEmail;
/** @var string */
/** @var string Confirmation link */
public $uri;
/**

View File

@@ -36,12 +36,17 @@ use Illuminate\Bus\Queueable;
use Illuminate\Mail\Mailable;
use Illuminate\Queue\SerializesModels;
/**
* Sends newly registered user an email message.
*
* Class RegisteredUser
*/
class RegisteredUser extends Mailable
{
use Queueable, SerializesModels;
/** @var string */
/** @var string Email address of user */
public $address;
/** @var string */
/** @var string IP address of user */
public $ipAddress;
/**

View File

@@ -36,12 +36,16 @@ use Illuminate\Bus\Queueable;
use Illuminate\Mail\Mailable;
use Illuminate\Queue\SerializesModels;
/**
* Sends user link for new password.
* Class RequestedNewPassword
*/
class RequestedNewPassword extends Mailable
{
use Queueable, SerializesModels;
/** @var string */
/** @var string IP address of user */
public $ipAddress;
/** @var string */
/** @var string URI of password change link */
public $url;
/**

View File

@@ -1,7 +1,4 @@
<?php
declare(strict_types=1);
/**
* UndoEmailChangeMail.php
* Copyright (c) 2017 thegrumpydictator@gmail.com
@@ -22,23 +19,30 @@ declare(strict_types=1);
* along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace FireflyIII\Mail;
use Illuminate\Bus\Queueable;
use Illuminate\Mail\Mailable;
use Illuminate\Queue\SerializesModels;
/**
* Class UndoEmailChangeMail
*/
class UndoEmailChangeMail extends Mailable
{
use Queueable, SerializesModels;
/** @var string */
/** @var string IP address of user*/
public $ipAddress;
/** @var string */
/** @var string New email address */
public $newEmail;
/** @var string */
/** @var string Old email address */
public $oldEmail;
/** @var string */
/** @var string URI to undo */
public $uri;
/**