clarify callable arguments for password checker (#2812)

This commit is contained in:
Daniël Klabbers 2021-04-29 16:19:06 +02:00 committed by GitHub
parent c119731e65
commit deadd67691
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -23,6 +23,7 @@ class Auth implements ExtenderInterface
*
* @param string $identifier: Unique identifier for password checker.
* @param callable|string $callback: A closure or invokable class that contains the logic of the password checker.
* Arguments are a User $object and string $password.
* It should return:
* - `true` if the given password is valid.
* - `null` (or not return anything) if the given password is invalid, or this checker does not apply.