platform/api/laravel/Contracts/Auth/PasswordBroker.yaml

43 lines
1.4 KiB
YAML
Raw Normal View History

2024-09-02 17:44:11 +00:00
name: PasswordBroker
class_comment: null
dependencies:
- name: Closure
type: class
source: Closure
properties: []
methods:
- name: sendResetLink
visibility: public
parameters:
- name: credentials
- name: callback
default: 'null'
comment: "# * Constant representing a successfully sent reminder.\n# *\n# * @var\
\ string\n# */\n# const RESET_LINK_SENT = 'passwords.sent';\n# \n# /**\n# * Constant\
\ representing a successfully reset password.\n# *\n# * @var string\n# */\n# const\
\ PASSWORD_RESET = 'passwords.reset';\n# \n# /**\n# * Constant representing the\
\ user not found response.\n# *\n# * @var string\n# */\n# const INVALID_USER =\
\ 'passwords.user';\n# \n# /**\n# * Constant representing an invalid token.\n\
# *\n# * @var string\n# */\n# const INVALID_TOKEN = 'passwords.token';\n# \n#\
\ /**\n# * Constant representing a throttled reset attempt.\n# *\n# * @var string\n\
# */\n# const RESET_THROTTLED = 'passwords.throttled';\n# \n# /**\n# * Send a\
\ password reset link to a user.\n# *\n# * @param array $credentials\n# * @param\
\ \\Closure|null $callback\n# * @return string"
- name: reset
visibility: public
parameters:
- name: credentials
- name: callback
comment: '# * Reset the password for the given token.
# *
# * @param array $credentials
# * @param \Closure $callback
# * @return mixed'
traits:
- Closure
interfaces: []