From b350039fa26b187fa1f05fc449c0609adcc949e6 Mon Sep 17 00:00:00 2001 From: bscheshirwork Date: Fri, 19 Oct 2018 12:25:59 +0300 Subject: [PATCH] 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 {