Skip to content

Commit 02af96b

Browse files
Cleanup more @return annotations
1 parent 760993a commit 02af96b

12 files changed

+27
-27
lines changed

Authentication/Provider/AuthenticationProviderInterface.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ interface AuthenticationProviderInterface extends AuthenticationManagerInterface
3838
/**
3939
* Checks whether this provider supports the given token.
4040
*
41-
* @return bool true if the implementation supports the Token, false otherwise
41+
* @return bool
4242
*/
4343
public function supports(TokenInterface $token);
4444
}

Authentication/Provider/UserAuthenticationProvider.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ public function supports(TokenInterface $token)
115115
/**
116116
* Retrieves the user from an implementation-specific location.
117117
*
118-
* @return UserInterface The user
118+
* @return UserInterface
119119
*
120120
* @throws AuthenticationException if the credentials could not be validated
121121
*/

Authentication/Token/AbstractToken.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ public function __unserialize(array $data): void
210210
/**
211211
* Returns the token attributes.
212212
*
213-
* @return array The token attributes
213+
* @return array
214214
*/
215215
public function getAttributes()
216216
{
@@ -230,7 +230,7 @@ public function setAttributes(array $attributes)
230230
/**
231231
* Returns true if the attribute exists.
232232
*
233-
* @return bool true if the attribute exists, false otherwise
233+
* @return bool
234234
*/
235235
public function hasAttribute(string $name)
236236
{
@@ -240,7 +240,7 @@ public function hasAttribute(string $name)
240240
/**
241241
* Returns an attribute value.
242242
*
243-
* @return mixed The attribute value
243+
* @return mixed
244244
*
245245
* @throws \InvalidArgumentException When attribute doesn't exist for this token
246246
*/

Authentication/Token/TokenInterface.php

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,14 +35,14 @@ public function __toString();
3535
/**
3636
* Returns the user roles.
3737
*
38-
* @return string[] The associated roles
38+
* @return string[]
3939
*/
4040
public function getRoleNames(): array;
4141

4242
/**
4343
* Returns the user credentials.
4444
*
45-
* @return mixed The user credentials
45+
* @return mixed
4646
*
4747
* @deprecated since 5.4
4848
*/
@@ -90,7 +90,7 @@ public function eraseCredentials();
9090
/**
9191
* Returns the token attributes.
9292
*
93-
* @return array The token attributes
93+
* @return array
9494
*/
9595
public function getAttributes();
9696

@@ -104,14 +104,14 @@ public function setAttributes(array $attributes);
104104
/**
105105
* Returns true if the attribute exists.
106106
*
107-
* @return bool true if the attribute exists, false otherwise
107+
* @return bool
108108
*/
109109
public function hasAttribute(string $name);
110110

111111
/**
112112
* Returns an attribute value.
113113
*
114-
* @return mixed The attribute value
114+
* @return mixed
115115
*
116116
* @throws \InvalidArgumentException When attribute doesn't exist for this token
117117
*/

Authorization/AccessDecisionManagerInterface.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ interface AccessDecisionManagerInterface
2626
* @param array $attributes An array of attributes associated with the method being invoked
2727
* @param mixed $object The object to secure
2828
*
29-
* @return bool true if the access is granted, false otherwise
29+
* @return bool
3030
*/
3131
public function decide(TokenInterface $token, array $attributes, $object = null);
3232
}

Authorization/Voter/Voter.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ public function vote(TokenInterface $token, $subject, array $attributes)
6565
* @param string $attribute An attribute
6666
* @param mixed $subject The subject to secure, e.g. an object the user wants to access or any other PHP type
6767
*
68-
* @return bool True if the attribute and subject are supported, false otherwise
68+
* @return bool
6969
*/
7070
abstract protected function supports(string $attribute, $subject);
7171

Encoder/BasePasswordEncoder.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ protected function demergePasswordAndSalt(string $mergedPasswordSalt)
6060
/**
6161
* Merges a password and a salt.
6262
*
63-
* @return string a merged password and salt
63+
* @return string
6464
*
6565
* @throws \InvalidArgumentException
6666
*/
@@ -83,7 +83,7 @@ protected function mergePasswordAndSalt(string $password, ?string $salt)
8383
* This method implements a constant-time algorithm to compare passwords to
8484
* avoid (remote) timing attacks.
8585
*
86-
* @return bool true if the two passwords are the same, false otherwise
86+
* @return bool
8787
*/
8888
protected function comparePasswords(string $password1, string $password2)
8989
{
@@ -93,7 +93,7 @@ protected function comparePasswords(string $password1, string $password2)
9393
/**
9494
* Checks if the password is too long.
9595
*
96-
* @return bool true if the password is too long, false otherwise
96+
* @return bool
9797
*/
9898
protected function isPasswordTooLong(string $password)
9999
{

Encoder/PasswordEncoderInterface.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ interface PasswordEncoderInterface
2828
/**
2929
* Encodes the raw password.
3030
*
31-
* @return string The encoded password
31+
* @return string
3232
*
3333
* @throws BadCredentialsException If the raw password is invalid, e.g. excessively long
3434
* @throws \InvalidArgumentException If the salt is invalid
@@ -42,7 +42,7 @@ public function encodePassword(string $raw, ?string $salt);
4242
* @param string $raw A raw password
4343
* @param string|null $salt The salt
4444
*
45-
* @return bool true if the password is valid, false otherwise
45+
* @return bool
4646
*
4747
* @throws \InvalidArgumentException If the salt is invalid
4848
*/

Encoder/UserPasswordEncoderInterface.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,12 @@ interface UserPasswordEncoderInterface
2828
/**
2929
* Encodes the plain password.
3030
*
31-
* @return string The encoded password
31+
* @return string
3232
*/
3333
public function encodePassword(UserInterface $user, string $plainPassword);
3434

3535
/**
36-
* @return bool true if the password is valid, false otherwise
36+
* @return bool
3737
*/
3838
public function isPasswordValid(UserInterface $user, string $raw);
3939

User/PasswordAuthenticatedUserInterface.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ interface PasswordAuthenticatedUserInterface
2424
*
2525
* Usually on authentication, a plain-text password will be compared to this value.
2626
*
27-
* @return string|null The hashed password or null (if not set or erased)
27+
* @return string|null
2828
*/
2929
public function getPassword(): ?string;
3030
}

0 commit comments

Comments
 (0)