From 4b70db1e8533c4f4de65f560475d8a1836c05a33 Mon Sep 17 00:00:00 2001 From: Junaid Farooq Date: Tue, 2 Mar 2021 10:49:57 +0530 Subject: [PATCH] [Security] Remove unnecessary inherited doc annotation --- .../Component/Security/Core/User/User.php | 36 ++++++++++++++++--- 1 file changed, 32 insertions(+), 4 deletions(-) diff --git a/src/Symfony/Component/Security/Core/User/User.php b/src/Symfony/Component/Security/Core/User/User.php index 5429baa0cd..fa5cfb524e 100644 --- a/src/Symfony/Component/Security/Core/User/User.php +++ b/src/Symfony/Component/Security/Core/User/User.php @@ -83,7 +83,14 @@ final class User implements UserInterface, EquatableInterface } /** - * {@inheritdoc} + * Checks whether the user's account has expired. + * + * Internally, if this method returns false, the authentication system + * will throw an AccountExpiredException and prevent login. + * + * @return bool true if the user's account is non expired, false otherwise + * + * @see AccountExpiredException */ public function isAccountNonExpired(): bool { @@ -91,7 +98,14 @@ final class User implements UserInterface, EquatableInterface } /** - * {@inheritdoc} + * Checks whether the user is locked. + * + * Internally, if this method returns false, the authentication system + * will throw a LockedException and prevent login. + * + * @return bool true if the user is not locked, false otherwise + * + * @see LockedException */ public function isAccountNonLocked(): bool { @@ -99,7 +113,14 @@ final class User implements UserInterface, EquatableInterface } /** - * {@inheritdoc} + * Checks whether the user's credentials (password) has expired. + * + * Internally, if this method returns false, the authentication system + * will throw a CredentialsExpiredException and prevent login. + * + * @return bool true if the user's credentials are non expired, false otherwise + * + * @see CredentialsExpiredException */ public function isCredentialsNonExpired(): bool { @@ -107,7 +128,14 @@ final class User implements UserInterface, EquatableInterface } /** - * {@inheritdoc} + * Checks whether the user is enabled. + * + * Internally, if this method returns false, the authentication system + * will throw a DisabledException and prevent login. + * + * @return bool true if the user is enabled, false otherwise + * + * @see DisabledException */ public function isEnabled(): bool {