Skip to content

Commit e402b79

Browse files
Merge branch '5.4' into 6.0
* 5.4: [Security] phpdoc cleanups cs fix
2 parents 9c136ff + fb30f91 commit e402b79

File tree

9 files changed

+14
-36
lines changed

9 files changed

+14
-36
lines changed

Authentication/RememberMe/PersistentTokenInterface.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ public function getTokenValue();
4848
public function getLastUsed();
4949

5050
/**
51-
* Returns the identifier used to authenticate (e.g. their e-mailaddress or username).
51+
* Returns the identifier used to authenticate (e.g. their email address or username).
5252
*/
5353
public function getUserIdentifier(): string;
5454
}

Authentication/Token/AbstractToken.php

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -121,41 +121,31 @@ public function __unserialize(array $data): void
121121
}
122122

123123
/**
124-
* Returns the token attributes.
125-
*
126-
* @return array
124+
* {@inheritdoc}
127125
*/
128126
public function getAttributes()
129127
{
130128
return $this->attributes;
131129
}
132130

133131
/**
134-
* Sets the token attributes.
135-
*
136-
* @param array $attributes The token attributes
132+
* {@inheritdoc}
137133
*/
138134
public function setAttributes(array $attributes)
139135
{
140136
$this->attributes = $attributes;
141137
}
142138

143139
/**
144-
* Returns true if the attribute exists.
145-
*
146-
* @return bool
140+
* {@inheritdoc}
147141
*/
148142
public function hasAttribute(string $name)
149143
{
150144
return \array_key_exists($name, $this->attributes);
151145
}
152146

153147
/**
154-
* Returns an attribute value.
155-
*
156-
* @return mixed
157-
*
158-
* @throws \InvalidArgumentException When attribute doesn't exist for this token
148+
* {@inheritdoc}
159149
*/
160150
public function getAttribute(string $name)
161151
{
@@ -166,6 +156,9 @@ public function getAttribute(string $name)
166156
return $this->attributes[$name];
167157
}
168158

159+
/**
160+
* {@inheritdoc}
161+
*/
169162
public function setAttribute(string $name, mixed $value)
170163
{
171164
$this->attributes[$name] = $value;

Authentication/Token/RememberMeToken.php

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,6 @@ public function getFirewallName(): string
5252
}
5353

5454
/**
55-
* Returns the secret.
56-
*
5755
* @return string
5856
*/
5957
public function getSecret()

Authentication/Token/TokenInterface.php

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
/**
1717
* TokenInterface is the interface for the user authentication information.
1818
*
19-
* @method string getUserIdentifier() returns the user identifier used during authentication (e.g. a user's e-mailaddress or username)
19+
* @method string getUserIdentifier() returns the user identifier used during authentication (e.g. a user's email address or username)
2020
*
2121
* @author Fabien Potencier <[email protected]>
2222
* @author Johannes M. Schmitt <[email protected]>
@@ -59,38 +59,27 @@ public function setUser(UserInterface $user);
5959
public function eraseCredentials();
6060

6161
/**
62-
* Returns the token attributes.
63-
*
6462
* @return array
6563
*/
6664
public function getAttributes();
6765

6866
/**
69-
* Sets the token attributes.
70-
*
7167
* @param array $attributes The token attributes
7268
*/
7369
public function setAttributes(array $attributes);
7470

7571
/**
76-
* Returns true if the attribute exists.
77-
*
7872
* @return bool
7973
*/
8074
public function hasAttribute(string $name);
8175

8276
/**
83-
* Returns an attribute value.
84-
*
8577
* @return mixed
8678
*
8779
* @throws \InvalidArgumentException When attribute doesn't exist for this token
8880
*/
8981
public function getAttribute(string $name);
9082

91-
/**
92-
* Sets an attribute.
93-
*/
9483
public function setAttribute(string $name, mixed $value);
9584

9685
/**

Exception/AuthenticationException.php

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,6 @@ class AuthenticationException extends RuntimeException
2424
private $token;
2525

2626
/**
27-
* Get the token.
28-
*
2927
* @return TokenInterface|null
3028
*/
3129
public function getToken()

Exception/UserNotFoundException.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,15 +30,15 @@ public function getMessageKey()
3030
}
3131

3232
/**
33-
* Get the user identifier (e.g. username or e-mailaddress).
33+
* Get the user identifier (e.g. username or email address).
3434
*/
3535
public function getUserIdentifier(): ?string
3636
{
3737
return $this->identifier;
3838
}
3939

4040
/**
41-
* Set the user identifier (e.g. username or e-mailaddress).
41+
* Set the user identifier (e.g. username or email address).
4242
*/
4343
public function setUserIdentifier(string $identifier): void
4444
{

User/InMemoryUser.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ public function getPassword(): ?string
6060
}
6161

6262
/**
63-
* Returns the identifier for this user (e.g. its username or e-mailaddress).
63+
* Returns the identifier for this user (e.g. its username or email address).
6464
*/
6565
public function getUserIdentifier(): string
6666
{

User/UserInterface.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ public function getRoles();
5555
public function eraseCredentials();
5656

5757
/**
58-
* Returns the identifier for this user (e.g. its username or e-mailaddress).
58+
* Returns the identifier for this user (e.g. its username or email address).
5959
*/
6060
public function getUserIdentifier(): string;
6161
}

User/UserProviderInterface.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
* Represents a class that loads UserInterface objects from some source for the authentication system.
1919
*
2020
* In a typical authentication configuration, a user identifier (e.g. a
21-
* username or e-mailaddress) credential enters the system (via form login, or
21+
* username or email address) credential enters the system (via form login, or
2222
* any method). The user provider that is configured with that authentication
2323
* method is asked to load the UserInterface object for the given identifier (via
2424
* loadUserByIdentifier) so that the rest of the process can continue.

0 commit comments

Comments
 (0)