1. class
  2. SilverStripe
  3. \
  4. Security
  5. \
  6. MemberAuthenticator
  7. \
  8. CookieAuthenticationHandler

CookieAuthenticationHandler

class CookieAuthenticationHandler implements AuthenticationHandler (View source)

Authenticate a member passed on a session cookie

Methods

string
getDeviceCookieName()

Get the name of the cookie used to track this device

$this
setDeviceCookieName(string $deviceCookieName)

Set the name of the cookie used to track this device

string
getTokenCookieName()

Get the name of the cookie used to store an login token

$this
setTokenCookieName(string $tokenCookieName)

Set the name of the cookie used to store an login token

string
getTokenCookieSecure()

Get the name of the cookie used to store an login token

$this
setTokenCookieSecure(string $tokenCookieSecure)

Set cookie with HTTPS only flag

IdentityStore
getCascadeInTo()

Once a member is found by authenticateRequest() pass it to this identity store

$this
setCascadeInTo(IdentityStore $cascadeInTo)

Set the name of the cookie used to store an login token

Member|null
authenticateRequest(HTTPRequest $request)

No description

logIn(Member $member, bool $persistent = false, HTTPRequest $request = null)

No description

logOut(HTTPRequest $request = null)

No description

Details

at line 45
string getDeviceCookieName()

Get the name of the cookie used to track this device

Return Value

string

at line 56
$this setDeviceCookieName(string $deviceCookieName)

Set the name of the cookie used to track this device

Parameters

string $deviceCookieName

Return Value

$this

at line 67
string getTokenCookieName()

Get the name of the cookie used to store an login token

Return Value

string

at line 78
$this setTokenCookieName(string $tokenCookieName)

Set the name of the cookie used to store an login token

Parameters

string $tokenCookieName

Return Value

$this

at line 89
string getTokenCookieSecure()

Get the name of the cookie used to store an login token

Return Value

string

at line 100
$this setTokenCookieSecure(string $tokenCookieSecure)

Set cookie with HTTPS only flag

Parameters

string $tokenCookieSecure

Return Value

$this

at line 111
IdentityStore getCascadeInTo()

Once a member is found by authenticateRequest() pass it to this identity store

Return Value

IdentityStore

at line 122
$this setCascadeInTo(IdentityStore $cascadeInTo)

Set the name of the cookie used to store an login token

Parameters

IdentityStore $cascadeInTo

Return Value

$this

at line 132
Member|null authenticateRequest(HTTPRequest $request)

Parameters

HTTPRequest $request

The current HTTP request

Return Value

Member|null

The authenticated Member, or null if this auth mechanism isn't used.

at line 207
logIn(Member $member, bool $persistent = false, HTTPRequest $request = null)

Parameters

Member $member

The member to log in.
bool $persistent

boolean If set to true, the login may persist beyond the current session.
HTTPRequest $request

The request of the visitor that is logging in, to get, for example, cookies.

at line 247
logOut(HTTPRequest $request = null)

Parameters

HTTPRequest $request

The request of the visitor that is logging out, to get, for example, cookies.