interface StoreInterface (View source)

Represents a place for temporarily storing state related to a login or registration attempt.

Methods

public
__construct(Member $member)

Create a new StoreInterface, optionally given an HTTPRequest object

public
save(HTTPRequest $request)

Persist the stored state for the given request

public static 
StoreInterface|null
load(HTTPRequest $request)

Load a StoreInterface from the given request and return it if it exists

public static 
void
clear(HTTPRequest $request)

Clear any stored state for the given request

public
array
getState()

Get the state from the store

public
setState(array $state)

Update the state in the store. Will override existing state. To add to the existing state use addState().

public
addState(array $state)

Add to the state in the store

public
Member|null
getMember()

No description

public
setMember(Member $member)

No description

public
string|null
getMethod()

No description

public
setMethod(string|null $method)

No description

public
addVerifiedMethod(string $method)

Add and keep track of methods that have been verified

public
array
getVerifiedMethods()

Get the list of methods that have been verified

Details

__construct(Member $member)

Create a new StoreInterface, optionally given an HTTPRequest object

Parameters

Member $member

StoreInterface save(HTTPRequest $request)

Persist the stored state for the given request

Parameters

HTTPRequest $request

Return Value

StoreInterface

static StoreInterface|null load(HTTPRequest $request)

Load a StoreInterface from the given request and return it if it exists

Parameters

HTTPRequest $request

Return Value

StoreInterface|null

static void clear(HTTPRequest $request)

Clear any stored state for the given request

Parameters

HTTPRequest $request

Return Value

void

array getState()

Get the state from the store

Return Value

array

StoreInterface setState(array $state)

Update the state in the store. Will override existing state. To add to the existing state use addState().

Parameters

array $state

Return Value

StoreInterface

StoreInterface addState(array $state)

Add to the state in the store

Parameters

array $state

Return Value

StoreInterface

Member|null getMember()

No description

Return Value

Member|null

StoreInterface setMember(Member $member)

No description

Parameters

Member $member

Return Value

StoreInterface

string|null getMethod()

No description

Return Value

string|null

StoreInterface setMethod(string|null $method)

No description

Parameters

string|null $method

Return Value

StoreInterface

StoreInterface addVerifiedMethod(string $method)

Add and keep track of methods that have been verified

Parameters

string $method

Return Value

StoreInterface

array getVerifiedMethods()

Get the list of methods that have been verified

Return Value

array