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

70 lines
1.3 KiB
YAML

name: Guard
class_comment: null
dependencies: []
properties: []
methods:
- name: check
visibility: public
parameters: []
comment: '# * Determine if the current user is authenticated.
# *
# * @return bool'
- name: guest
visibility: public
parameters: []
comment: '# * Determine if the current user is a guest.
# *
# * @return bool'
- name: user
visibility: public
parameters: []
comment: '# * Get the currently authenticated user.
# *
# * @return \Illuminate\Contracts\Auth\Authenticatable|null'
- name: id
visibility: public
parameters: []
comment: '# * Get the ID for the currently authenticated user.
# *
# * @return int|string|null'
- name: validate
visibility: public
parameters:
- name: credentials
default: '[]'
comment: '# * Validate a user''s credentials.
# *
# * @param array $credentials
# * @return bool'
- name: hasUser
visibility: public
parameters: []
comment: '# * Determine if the guard has a user instance.
# *
# * @return bool'
- name: setUser
visibility: public
parameters:
- name: user
comment: '# * Set the current user.
# *
# * @param \Illuminate\Contracts\Auth\Authenticatable $user
# * @return $this'
traits: []
interfaces: []