platform/api/laravel/Contracts/Auth/UserProvider.yaml
2024-09-02 10:44:11 -07:00

89 lines
1.9 KiB
YAML

name: UserProvider
class_comment: null
dependencies: []
properties: []
methods:
- name: retrieveById
visibility: public
parameters:
- name: identifier
comment: '# * Retrieve a user by their unique identifier.
# *
# * @param mixed $identifier
# * @return \Illuminate\Contracts\Auth\Authenticatable|null'
- name: retrieveByToken
visibility: public
parameters:
- name: identifier
- name: token
comment: '# * Retrieve a user by their unique identifier and "remember me" token.
# *
# * @param mixed $identifier
# * @param string $token
# * @return \Illuminate\Contracts\Auth\Authenticatable|null'
- name: updateRememberToken
visibility: public
parameters:
- name: user
- name: token
comment: '# * Update the "remember me" token for the given user in storage.
# *
# * @param \Illuminate\Contracts\Auth\Authenticatable $user
# * @param string $token
# * @return void'
- name: retrieveByCredentials
visibility: public
parameters:
- name: credentials
comment: '# * Retrieve a user by the given credentials.
# *
# * @param array $credentials
# * @return \Illuminate\Contracts\Auth\Authenticatable|null'
- name: validateCredentials
visibility: public
parameters:
- name: user
- name: credentials
comment: '# * Validate a user against the given credentials.
# *
# * @param \Illuminate\Contracts\Auth\Authenticatable $user
# * @param array $credentials
# * @return bool'
- name: rehashPasswordIfRequired
visibility: public
parameters:
- name: user
- name: credentials
- name: force
default: 'false'
comment: '# * Rehash the user''s password if required and supported.
# *
# * @param \Illuminate\Contracts\Auth\Authenticatable $user
# * @param array $credentials
# * @param bool $force
# * @return void'
traits: []
interfaces: []