api/laravel/Auth/RequestGuard.yaml
2024-09-26 02:03:21 -07:00

83 lines
1.9 KiB
YAML

name: RequestGuard
class_comment: null
dependencies:
- name: Guard
type: class
source: Illuminate\Contracts\Auth\Guard
- name: UserProvider
type: class
source: Illuminate\Contracts\Auth\UserProvider
- name: Request
type: class
source: Illuminate\Http\Request
- name: Macroable
type: class
source: Illuminate\Support\Traits\Macroable
properties:
- name: callback
visibility: protected
comment: '# * The guard callback.
# *
# * @var callable'
- name: request
visibility: protected
comment: '# * The request instance.
# *
# * @var \Illuminate\Http\Request'
methods:
- name: __construct
visibility: public
parameters:
- name: callback
- name: request
- name: provider
default: 'null'
comment: "# * The guard callback.\n# *\n# * @var callable\n# */\n# protected $callback;\n\
# \n# /**\n# * The request instance.\n# *\n# * @var \\Illuminate\\Http\\Request\n\
# */\n# protected $request;\n# \n# /**\n# * Create a new authentication guard.\n\
# *\n# * @param callable $callback\n# * @param \\Illuminate\\Http\\Request\
\ $request\n# * @param \\Illuminate\\Contracts\\Auth\\UserProvider|null $provider\n\
# * @return void"
- name: user
visibility: public
parameters: []
comment: '# * Get the currently authenticated user.
# *
# * @return \Illuminate\Contracts\Auth\Authenticatable|null'
- name: validate
visibility: public
parameters:
- name: credentials
default: '[]'
comment: '# * Validate a user''s credentials.
# *
# * @param array $credentials
# * @return bool'
- name: setRequest
visibility: public
parameters:
- name: request
comment: '# * Set the current request instance.
# *
# * @param \Illuminate\Http\Request $request
# * @return $this'
traits:
- Illuminate\Contracts\Auth\Guard
- Illuminate\Contracts\Auth\UserProvider
- Illuminate\Http\Request
- Illuminate\Support\Traits\Macroable
- GuardHelpers
interfaces:
- Guard