LaravelAuthDriversDriver

Summary

No protected properties found
N/A
No private methods found
No private properties found
N/A
abstract
File
authdriversdriver.php
Package
Default
Class hierarchy
LaravelAuthDriversDriver

Tags

None found

Properties

$user

$user : mixed

The user currently being managed by the driver.

Type

mixed

Tags

None found

$token

$token : string|null

The current value of the user's token.

Type

string|null

Tags

None found

Methods

__construct()

__construct() : void

Create a new login auth driver instance.

Tags

None found

guest()

guest() : boolean

Determine if the user of the application is not logged in.

This method is the inverse of the "check" method.

Returns

boolean

Tags

None found

check()

check() : boolean

Determine if the user is logged in.

Returns

boolean

Tags

None found

user()

user() : mixed|null

Get the current user of the application.

If the user is a guest, null should be returned.

Returns

mixed|null

Tags

None found

retrieve()

retrieve(integer  $id) : mixed

Get the given application user by ID.

Parameters

integer $id

Returns

mixed

abstract

Tags

None found

attempt()

attempt(array  $arguments = array()) : void

Attempt to log a user into the application.

Parameters

array $arguments

abstract

Tags

None found

login()

login(string  $token, boolean  $remember = false) : boolean

Login the user assigned to the given token.

The token is typically a numeric ID for the user.

Parameters

string $token
boolean $remember

Returns

boolean

Tags

None found

logout()

logout() : void

Log the user out of the driver's auth context.

Tags

None found

store()

store(string  $token) : void

Store a user's token in the session.

Parameters

string $token

Tags

None found

remember()

remember(string  $token) : void

Store a user's token in a long-lived cookie.

Parameters

string $token

Tags

None found

recall()

recall() : string|null

Attempt to find a "remember me" cookie for the user.

Returns

string|null

Tags

None found

cookie()

cookie(string  $name, string  $value, integer  $minutes) : void

Store an authentication cookie.

Parameters

string $name
string $value
integer $minutes

Tags

None found

token()

token() : string

Get the session key name used to store the token.

Returns

string

Tags

None found

recaller()

recaller() : string

Get the name used for the "remember me" cookie.

Returns

string

Tags

None found

name()

name() : string

Get the name of the driver in a storage friendly format.

Returns

string

Tags

None found