Skip to content

Commit 3abd691

Browse files
docs(appframework): clarify PasswordConfirmationRequired docblocks
Signed-off-by: Josh <josh.t.richards@gmail.com>
1 parent 1272068 commit 3abd691

1 file changed

Lines changed: 14 additions & 3 deletions

File tree

lib/public/AppFramework/Http/Attribute/PasswordConfirmationRequired.php

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,24 @@
1212
use Attribute;
1313

1414
/**
15-
* Attribute for controller methods that require the password to be confirmed with in the last 30 minutes
15+
* Attribute for controller methods that require password confirmation, if
16+
* supported by the active authentication backend.
17+
*
18+
* The exact enforcement behavior depends on the password confirmation
19+
* middleware.
20+
*
21+
* In non-strict mode, this normally relies on a recent prior confirmation,
22+
* currently defined by the middleware as within the last 30 minutes.
23+
*
24+
* In strict mode, confirmation is attempted as part of the current request.
1625
*
1726
* @since 27.0.0
1827
*/
1928
#[Attribute]
2029
class PasswordConfirmationRequired {
2130
/**
22-
* @param bool $strict - Whether password confirmation needs to happen in the request.
31+
* @param bool $strict Whether password confirmation must happen as part of
32+
* the current request instead of relying on a recent prior confirmation.
2333
*
2434
* @since 31.0.0
2535
*/
@@ -29,10 +39,11 @@ public function __construct(
2939
}
3040

3141
/**
42+
* Returns whether password confirmation must happen during the current request.
43+
*
3244
* @since 31.0.0
3345
*/
3446
public function getStrict(): bool {
3547
return $this->strict;
3648
}
37-
3849
}

0 commit comments

Comments
 (0)