From 9637be5778172ca91ca62a99310543c8add558b8 Mon Sep 17 00:00:00 2001
From: bscheshirwork <bscheshir.work@gmail.com>
Date: Fri, 21 Sep 2018 11:13:15 +0300
Subject: [PATCH 1/4] add phpdoc and avoid same-named class

---
 src/User/Bootstrap.php                       | 4 ++--
 src/User/Event/FormEvent.php                 | 6 ++++++
 src/User/Event/GdprEvent.php                 | 6 ++++++
 src/User/Event/MailEvent.php                 | 9 +++++++++
 src/User/Event/ProfileEvent.php              | 6 ++++++
 src/User/Event/ResetPasswordEvent.php        | 7 +++++++
 src/User/Event/SocialNetworkAuthEvent.php    | 7 +++++++
 src/User/Event/SocialNetworkConnectEvent.php | 7 +++++++
 src/User/Event/UserEvent.php                 | 6 ++++++
 9 files changed, 56 insertions(+), 2 deletions(-)

diff --git a/src/User/Bootstrap.php b/src/User/Bootstrap.php
index a40200f..4ad380f 100644
--- a/src/User/Bootstrap.php
+++ b/src/User/Bootstrap.php
@@ -25,7 +25,7 @@ use yii\console\Application as ConsoleApplication;
 use yii\i18n\PhpMessageSource;
 use yii\web\Application as WebApplication;
 
-use yii\base\Event;
+use yii\base\Event as YiiEvent;
 use Da\User\Event\FormEvent;
 use Da\User\Controller\SecurityController;
 
@@ -153,7 +153,7 @@ class Bootstrap implements BootstrapInterface
 
             // Attach an event to check if the password has expired
             if (!is_null(Yii::$app->getModule('user')->maxPasswordAge)) {
-                Event::on(SecurityController::class, FormEvent::EVENT_AFTER_LOGIN, function (FormEvent $event) {
+                YiiEvent::on(SecurityController::class, FormEvent::EVENT_AFTER_LOGIN, function (FormEvent $event) {
                     $user = $event->form->user;
                     if ($user->password_age >= Yii::$app->getModule('user')->maxPasswordAge) {
                         // Force password change
diff --git a/src/User/Event/FormEvent.php b/src/User/Event/FormEvent.php
index ccefc16..1f1f525 100644
--- a/src/User/Event/FormEvent.php
+++ b/src/User/Event/FormEvent.php
@@ -14,6 +14,12 @@ namespace Da\User\Event;
 use yii\base\Event;
 use yii\base\Model;
 
+/**
+ * Class FormEvent
+ * @package Da\User\Event
+ *
+ * @property Model $form
+ */
 class FormEvent extends Event
 {
     const EVENT_BEFORE_REQUEST = 'beforeRequest';
diff --git a/src/User/Event/GdprEvent.php b/src/User/Event/GdprEvent.php
index 89872c5..4fd532a 100644
--- a/src/User/Event/GdprEvent.php
+++ b/src/User/Event/GdprEvent.php
@@ -14,6 +14,12 @@ namespace Da\User\Event;
 use Da\User\Model\User;
 use yii\base\Event;
 
+/**
+ * Class GdprEvent
+ * @package Da\User\Event
+ *
+ * @property User $user
+ */
 class GdprEvent extends Event
 {
 
diff --git a/src/User/Event/MailEvent.php b/src/User/Event/MailEvent.php
index 8ebe5f8..51bf9bf 100644
--- a/src/User/Event/MailEvent.php
+++ b/src/User/Event/MailEvent.php
@@ -15,6 +15,15 @@ use Da\User\Model\User;
 use Da\User\Service\MailService;
 use yii\base\Event;
 
+/**
+ * Class MailEvent
+ * @package Da\User\Event
+ *
+ * @property string $type
+ * @property User $user
+ * @property MailService $mailService
+ * @property mixed|\Exception $exception
+ */
 class MailEvent extends Event
 {
     const TYPE_WELCOME = 'welcome';
diff --git a/src/User/Event/ProfileEvent.php b/src/User/Event/ProfileEvent.php
index 902c276..05af532 100644
--- a/src/User/Event/ProfileEvent.php
+++ b/src/User/Event/ProfileEvent.php
@@ -14,6 +14,12 @@ namespace Da\User\Event;
 use Da\User\Model\Profile;
 use yii\base\Event;
 
+/**
+ * Class ProfileEvent
+ * @package Da\User\Event
+ *
+ * @property Profile $profile
+ */
 class ProfileEvent extends Event
 {
     protected $profile;
diff --git a/src/User/Event/ResetPasswordEvent.php b/src/User/Event/ResetPasswordEvent.php
index 4cc21d0..906099f 100644
--- a/src/User/Event/ResetPasswordEvent.php
+++ b/src/User/Event/ResetPasswordEvent.php
@@ -15,6 +15,13 @@ use Da\User\Form\RecoveryForm;
 use Da\User\Model\Token;
 use yii\base\Event;
 
+/**
+ * Class ResetPasswordEvent
+ * @package Da\User\Event
+ *
+ * @property Token $token
+ * @property RecoveryForm $form
+ */
 class ResetPasswordEvent extends Event
 {
     const EVENT_BEFORE_TOKEN_VALIDATE = 'beforeTokenValidate';
diff --git a/src/User/Event/SocialNetworkAuthEvent.php b/src/User/Event/SocialNetworkAuthEvent.php
index a126e24..5ac1ed3 100644
--- a/src/User/Event/SocialNetworkAuthEvent.php
+++ b/src/User/Event/SocialNetworkAuthEvent.php
@@ -15,6 +15,13 @@ use Da\User\Model\SocialNetworkAccount;
 use yii\authclient\ClientInterface;
 use yii\base\Event;
 
+/**
+ * Class SocialNetworkAuthEvent
+ * @package Da\User\Event
+ *
+ * @property SocialNetworkAccount $account
+ * @property ClientInterface $client
+ */
 class SocialNetworkAuthEvent extends Event
 {
     const EVENT_BEFORE_AUTHENTICATE = 'beforeAuthenticate';
diff --git a/src/User/Event/SocialNetworkConnectEvent.php b/src/User/Event/SocialNetworkConnectEvent.php
index 5f28201..50e685a 100644
--- a/src/User/Event/SocialNetworkConnectEvent.php
+++ b/src/User/Event/SocialNetworkConnectEvent.php
@@ -15,6 +15,13 @@ use Da\User\Model\SocialNetworkAccount;
 use Da\User\Model\User;
 use yii\base\Event;
 
+/**
+ * Class SocialNetworkConnectEvent
+ * @package Da\User\Event
+ *
+ * @property User $user
+ * @property SocialNetworkAccount $account
+ */
 class SocialNetworkConnectEvent extends Event
 {
     const EVENT_BEFORE_CONNECT = 'beforeConnect';
diff --git a/src/User/Event/UserEvent.php b/src/User/Event/UserEvent.php
index d8f032e..a68c5ab 100644
--- a/src/User/Event/UserEvent.php
+++ b/src/User/Event/UserEvent.php
@@ -14,6 +14,12 @@ namespace Da\User\Event;
 use Da\User\Model\User;
 use yii\base\Event;
 
+/**
+ * Class UserEvent
+ * @package Da\User\Event
+ *
+ * @property User $user
+ */
 class UserEvent extends Event
 {
     const EVENT_BEFORE_CREATE = 'beforeCreate';

From 24105a893140d3e091c83ab80ea8ac824fb55f06 Mon Sep 17 00:00:00 2001
From: bscheshirwork <bscheshir.work@gmail.com>
Date: Fri, 21 Sep 2018 11:42:07 +0300
Subject: [PATCH 2/4] :book:

---
 CHANGELOG.md | 1 +
 1 file changed, 1 insertion(+)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index e5ba762..890c1c2 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -17,6 +17,7 @@
  - Enh: Add controller module class reference (TonisOrmisson)
  - Enh: Replace the deprecated InvalidParamException in ClassMapHelper (TonisOrmisson)
  - Fix #242: Add POST filter for `admin/force-password-change` action (bscheshirwork)
+ - Enh #253: Add PHPDoc for events class (bscheshirwork)
 
 ## 1.1.4 - February 19, 2018
 - Enh: Check enableEmailConfirmation on registration (faenir)

From 1deff4f6054f08369982bb2559983a517450d6c6 Mon Sep 17 00:00:00 2001
From: bscheshirwork <bscheshir.work@gmail.com>
Date: Mon, 15 Oct 2018 16:57:11 +0300
Subject: [PATCH 3/4] revert changes for same named class

---
 src/User/Bootstrap.php | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/src/User/Bootstrap.php b/src/User/Bootstrap.php
index 4ad380f..a40200f 100644
--- a/src/User/Bootstrap.php
+++ b/src/User/Bootstrap.php
@@ -25,7 +25,7 @@ use yii\console\Application as ConsoleApplication;
 use yii\i18n\PhpMessageSource;
 use yii\web\Application as WebApplication;
 
-use yii\base\Event as YiiEvent;
+use yii\base\Event;
 use Da\User\Event\FormEvent;
 use Da\User\Controller\SecurityController;
 
@@ -153,7 +153,7 @@ class Bootstrap implements BootstrapInterface
 
             // Attach an event to check if the password has expired
             if (!is_null(Yii::$app->getModule('user')->maxPasswordAge)) {
-                YiiEvent::on(SecurityController::class, FormEvent::EVENT_AFTER_LOGIN, function (FormEvent $event) {
+                Event::on(SecurityController::class, FormEvent::EVENT_AFTER_LOGIN, function (FormEvent $event) {
                     $user = $event->form->user;
                     if ($user->password_age >= Yii::$app->getModule('user')->maxPasswordAge) {
                         // Force password change

From b350039fa26b187fa1f05fc449c0609adcc949e6 Mon Sep 17 00:00:00 2001
From: bscheshirwork <bscheshir.work@gmail.com>
Date: Fri, 19 Oct 2018 12:25:59 +0300
Subject: [PATCH 4/4] change PHPDoc

---
 src/User/Contracts/AuthClientInterface.php   |  4 ++++
 src/User/Event/FormEvent.php                 |  5 +----
 src/User/Event/GdprEvent.php                 |  5 +----
 src/User/Event/MailEvent.php                 | 11 ++++-------
 src/User/Event/ProfileEvent.php              |  5 +----
 src/User/Event/ResetPasswordEvent.php        |  7 ++-----
 src/User/Event/SocialNetworkAuthEvent.php    |  7 ++-----
 src/User/Event/SocialNetworkConnectEvent.php |  7 ++-----
 src/User/Event/UserEvent.php                 |  5 +----
 9 files changed, 18 insertions(+), 38 deletions(-)

diff --git a/src/User/Contracts/AuthClientInterface.php b/src/User/Contracts/AuthClientInterface.php
index 2b3a335..6aad034 100644
--- a/src/User/Contracts/AuthClientInterface.php
+++ b/src/User/Contracts/AuthClientInterface.php
@@ -13,6 +13,10 @@ namespace Da\User\Contracts;
 
 use yii\authclient\ClientInterface;
 
+/**
+ * @property-read string $email
+ * @property-read string $username
+ */
 interface AuthClientInterface extends ClientInterface
 {
     /**
diff --git a/src/User/Event/FormEvent.php b/src/User/Event/FormEvent.php
index 1f1f525..b498c08 100644
--- a/src/User/Event/FormEvent.php
+++ b/src/User/Event/FormEvent.php
@@ -15,10 +15,7 @@ use yii\base\Event;
 use yii\base\Model;
 
 /**
- * Class FormEvent
- * @package Da\User\Event
- *
- * @property Model $form
+ * @property-read Model $form
  */
 class FormEvent extends Event
 {
diff --git a/src/User/Event/GdprEvent.php b/src/User/Event/GdprEvent.php
index 4fd532a..d038b96 100644
--- a/src/User/Event/GdprEvent.php
+++ b/src/User/Event/GdprEvent.php
@@ -15,10 +15,7 @@ use Da\User\Model\User;
 use yii\base\Event;
 
 /**
- * Class GdprEvent
- * @package Da\User\Event
- *
- * @property User $user
+ * @property-read User $user
  */
 class GdprEvent extends Event
 {
diff --git a/src/User/Event/MailEvent.php b/src/User/Event/MailEvent.php
index 51bf9bf..13e55b7 100644
--- a/src/User/Event/MailEvent.php
+++ b/src/User/Event/MailEvent.php
@@ -16,13 +16,10 @@ use Da\User\Service\MailService;
 use yii\base\Event;
 
 /**
- * Class MailEvent
- * @package Da\User\Event
- *
- * @property string $type
- * @property User $user
- * @property MailService $mailService
- * @property mixed|\Exception $exception
+ * @property-read string $type
+ * @property-read User $user
+ * @property-read MailService $mailService
+ * @property-read mixed|\Exception $exception
  */
 class MailEvent extends Event
 {
diff --git a/src/User/Event/ProfileEvent.php b/src/User/Event/ProfileEvent.php
index 05af532..872d767 100644
--- a/src/User/Event/ProfileEvent.php
+++ b/src/User/Event/ProfileEvent.php
@@ -15,10 +15,7 @@ use Da\User\Model\Profile;
 use yii\base\Event;
 
 /**
- * Class ProfileEvent
- * @package Da\User\Event
- *
- * @property Profile $profile
+ * @property-read Profile $profile
  */
 class ProfileEvent extends Event
 {
diff --git a/src/User/Event/ResetPasswordEvent.php b/src/User/Event/ResetPasswordEvent.php
index 906099f..188553d 100644
--- a/src/User/Event/ResetPasswordEvent.php
+++ b/src/User/Event/ResetPasswordEvent.php
@@ -16,11 +16,8 @@ use Da\User\Model\Token;
 use yii\base\Event;
 
 /**
- * Class ResetPasswordEvent
- * @package Da\User\Event
- *
- * @property Token $token
- * @property RecoveryForm $form
+ * @property-read Token $token
+ * @property-read RecoveryForm $form
  */
 class ResetPasswordEvent extends Event
 {
diff --git a/src/User/Event/SocialNetworkAuthEvent.php b/src/User/Event/SocialNetworkAuthEvent.php
index 5ac1ed3..b9a88f6 100644
--- a/src/User/Event/SocialNetworkAuthEvent.php
+++ b/src/User/Event/SocialNetworkAuthEvent.php
@@ -16,11 +16,8 @@ use yii\authclient\ClientInterface;
 use yii\base\Event;
 
 /**
- * Class SocialNetworkAuthEvent
- * @package Da\User\Event
- *
- * @property SocialNetworkAccount $account
- * @property ClientInterface $client
+ * @property-read SocialNetworkAccount $account
+ * @property-read ClientInterface $client
  */
 class SocialNetworkAuthEvent extends Event
 {
diff --git a/src/User/Event/SocialNetworkConnectEvent.php b/src/User/Event/SocialNetworkConnectEvent.php
index 50e685a..2c7f614 100644
--- a/src/User/Event/SocialNetworkConnectEvent.php
+++ b/src/User/Event/SocialNetworkConnectEvent.php
@@ -16,11 +16,8 @@ use Da\User\Model\User;
 use yii\base\Event;
 
 /**
- * Class SocialNetworkConnectEvent
- * @package Da\User\Event
- *
- * @property User $user
- * @property SocialNetworkAccount $account
+ * @property-read User $user
+ * @property-read SocialNetworkAccount $account
  */
 class SocialNetworkConnectEvent extends Event
 {
diff --git a/src/User/Event/UserEvent.php b/src/User/Event/UserEvent.php
index a68c5ab..948c0bb 100644
--- a/src/User/Event/UserEvent.php
+++ b/src/User/Event/UserEvent.php
@@ -15,10 +15,7 @@ use Da\User\Model\User;
 use yii\base\Event;
 
 /**
- * Class UserEvent
- * @package Da\User\Event
- *
- * @property User $user
+ * @property-read User $user
  */
 class UserEvent extends Event
 {