Class Driver

Direct known subclasses

Laravel\Auth\Drivers\Eloquent, Laravel\Auth\Drivers\Fluent

Abstract
Namespace: Laravel\Auth\Drivers
Located at laravel/auth/drivers/driver.php

Methods summary
`public`	# `__construct( )` Create a new login auth driver instance. Create a new login auth driver instance.
`public boolean`	# `guest( )` Determine if the user of the application is not logged in. Determine if the user of the application is not logged in. This method is the inverse of the "check" method. Returns `boolean`
`public boolean`	# `check( )` Determine if the user is logged in. Determine if the user is logged in. Returns `boolean`
`public mixed\|null`	# `user( )` Get the current user of the application. Get the current user of the application. If the user is a guest, null should be returned. Returns `mixed\|null`
`abstract public mixed`	# `retrieve( integer $id )` Get the given application user by ID. Get the given application user by ID. Parameters `$id` `integer` $id Returns `mixed`
`abstract public`	# `attempt( array $arguments = array() )` Attempt to log a user into the application. Attempt to log a user into the application. Parameters `$arguments` `array` $arguments
`public boolean`	# `login( string $token, boolean $remember = false )` Login the user assigned to the given token. Login the user assigned to the given token. The token is typically a numeric ID for the user. Parameters `$token` `string` $token `$remember` `boolean` $remember Returns `boolean`
`public`	# `logout( )` Log the user out of the driver's auth context. Log the user out of the driver's auth context.
`protected`	# `store( string $token )` Store a user's token in the session. Store a user's token in the session. Parameters `$token` `string` $token
`protected`	# `remember( string $token )` Store a user's token in a long-lived cookie. Store a user's token in a long-lived cookie. Parameters `$token` `string` $token
`protected string\|null`	# `recall( )` Attempt to find a "remember me" cookie for the user. Attempt to find a "remember me" cookie for the user. Returns `string\|null`
`protected`	# `cookie( string $name, string $value, integer $minutes )` Store an authentication cookie. Store an authentication cookie. Parameters `$name` `string` $name `$value` `string` $value `$minutes` `integer` $minutes
`protected string`	# `token( )` Get the session key name used to store the token. Get the session key name used to store the token. Returns `string`
`protected string`	# `recaller( )` Get the name used for the "remember me" cookie. Get the name used for the "remember me" cookie. Returns `string`
`protected string`	# `name( )` Get the name of the driver in a storage friendly format. Get the name of the driver in a storage friendly format. Returns `string`

Properties summary
`public mixed`	`$user`		# The user currently being managed by the driver. The user currently being managed by the driver.
`public string\|null`	`$token`		# The current value of the user's token. The current value of the user's token.