github-mirror/framework
2
0
Fork 0
mirror of https://github.com/flarum/framework.git synced 2024-11-25 09:41:49 +08:00
Code Issues Actions 46 Packages Projects Releases Wiki Activity

clarify callable arguments for password checker (#2812)

Browse Source
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
1 changed files with 1 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
src/Extend/Auth.php
View File

@ -23,6 +23,7 @@ class Auth implements ExtenderInterface
* *
* @param string $identifier: Unique identifier for password checker. * @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. * @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: * It should return:
* - `true` if the given password is valid. * - `true` if the given password is valid.
* - `null` (or not return anything) if the given password is invalid, or this checker does not apply. * - `null` (or not return anything) if the given password is invalid, or this checker does not apply.