Merge pull request #253 from bscheshirwork/phpdoc-events

Add phpdoc for magic property getter

CHANGELOG.md

@@ -1,6 +1,6 @@
 # CHANGELOG
 
-## 1.5.0 - Work in progress
+## 1.1.5 - Work in progress
  - Fix: Fix condition in EmailChangeService (it was always false) (borisaeric)
  - Fix #198: Updated translations by quique, bizley, TonisOrmisson, guogan, Dezinger, maxxer, wautvda, mrbig00, fabiomlferreira
  - Fix #209: Doc fix. allowAccountDelete default value is false (Dezinger)
@@ -20,12 +20,14 @@
  - Enh #251: Use `asset-packagist` instead of `fxp-asset` if you run it as a module without having a project around (bscheshirwork)
  - Fix #252: Delete check for unexpected property `allowPasswordRecovery` for resend email by admin (bscheshirwork)
  - Fix #254: Rename `GDPR` properties to `lowerCamelCase` style (bscheshirwork)
+ - Enh #253: Add PHPDoc for events class (bscheshirwork)
  - Fix #258: Rename `GDPR` delete action to `lowerCamelCase`/`dash` style (bscheshirwork)
  - Fix #271: Add closure support for `from` email address; Change default sender to `supportEmail` (bscheshirwork)
  - Fix #276: Fix missing translatable strings
  - Enh #249: Show message `email send if possible` any time on reset password request (bscheshirwork)
  - Enh #282: Allows customization of controller namespace (maxxer)
 
+
 ## 1.1.4 - February 19, 2018
 - Enh: Check enableEmailConfirmation on registration (faenir)
 - Fix #154: Fix DateTime constructor with Unix timestamps (tonydspaniard)

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
 {
     /**

src/User/Event/FormEvent.php

@@ -14,6 +14,9 @@ namespace Da\User\Event;
 use yii\base\Event;
 use yii\base\Model;
 
+/**
+ * @property-read Model $form
+ */
 class FormEvent extends Event
 {
     const EVENT_BEFORE_REQUEST = 'beforeRequest';

src/User/Event/GdprEvent.php

@@ -14,6 +14,9 @@ namespace Da\User\Event;
 use Da\User\Model\User;
 use yii\base\Event;
 
+/**
+ * @property-read User $user
+ */
 class GdprEvent extends Event
 {
 

src/User/Event/MailEvent.php

@@ -15,6 +15,12 @@ use Da\User\Model\User;
 use Da\User\Service\MailService;
 use yii\base\Event;
 
+/**
+ * @property-read string $type
+ * @property-read User $user
+ * @property-read MailService $mailService
+ * @property-read mixed|\Exception $exception
+ */
 class MailEvent extends Event
 {
     const TYPE_WELCOME = 'welcome';

src/User/Event/ProfileEvent.php

@@ -14,6 +14,9 @@ namespace Da\User\Event;
 use Da\User\Model\Profile;
 use yii\base\Event;
 
+/**
+ * @property-read Profile $profile
+ */
 class ProfileEvent extends Event
 {
     protected $profile;

src/User/Event/ResetPasswordEvent.php

@@ -15,6 +15,10 @@ use Da\User\Form\RecoveryForm;
 use Da\User\Model\Token;
 use yii\base\Event;
 
+/**
+ * @property-read Token $token
+ * @property-read RecoveryForm $form
+ */
 class ResetPasswordEvent extends Event
 {
     const EVENT_BEFORE_TOKEN_VALIDATE = 'beforeTokenValidate';

src/User/Event/SocialNetworkAuthEvent.php

@@ -15,6 +15,10 @@ use Da\User\Model\SocialNetworkAccount;
 use yii\authclient\ClientInterface;
 use yii\base\Event;
 
+/**
+ * @property-read SocialNetworkAccount $account
+ * @property-read ClientInterface $client
+ */
 class SocialNetworkAuthEvent extends Event
 {
     const EVENT_BEFORE_AUTHENTICATE = 'beforeAuthenticate';

src/User/Event/SocialNetworkConnectEvent.php

@@ -15,6 +15,10 @@ use Da\User\Model\SocialNetworkAccount;
 use Da\User\Model\User;
 use yii\base\Event;
 
+/**
+ * @property-read User $user
+ * @property-read SocialNetworkAccount $account
+ */
 class SocialNetworkConnectEvent extends Event
 {
     const EVENT_BEFORE_CONNECT = 'beforeConnect';

src/User/Event/UserEvent.php

@@ -14,6 +14,9 @@ namespace Da\User\Event;
 use Da\User\Model\User;
 use yii\base\Event;
 
+/**
+ * @property-read User $user
+ */
 class UserEvent extends Event
 {
     const EVENT_BEFORE_CREATE = 'beforeCreate';