1. class
  2. SilverStripe
  3. \
  4. MFA
  5. \
  6. Extension
  7. \
  8. AccountReset
  9. \
  10. SecurityExtension

SecurityExtension

class SecurityExtension extends Extension (View source)

Extends the Security controller to support Account Resets. This extension can itself be extended to add procedures to the reset action (such as removing additional authentication factors, sending alerts, etc.)

Traits

BaseHandlerTrait

Properties

protected SS_Object $owner

The object this extension is applied to.

 from  Extension
protected DataObject $ownerBaseClass

The base class that this extension was applied to; $this->owner must be one of these

 from  Extension
public $class from  Extension
protected StoreInterface $store

A "session store" object that helps contain MFA specific session detail

 from  BaseHandlerTrait

Methods

public
__construct()

No description

from  Extension
public static 
add_to_class(string $class, string $extensionClass, mixed $args = null)

Called when this extension is added to a particular class

from  Extension
public
setOwner(SS_Object $owner, string $ownerBaseClass = null)

Set the owner of this extension.

from  Extension
public
clearOwner()

No description

from  Extension
public
SS_Object
getOwner()

Returns the owner of this extension.

from  Extension
public static 
string
get_classname_without_arguments(string $extensionStr)

Helper method to strip eval'ed arguments from a string thats passed to DataObject::$extensions or Object::add_extension().

from  Extension
protected
void
applyRequirements(bool $frontEndRequirements = true)

Perform the necessary "Requirements" calls to ensure client side scripts are available in the response

from  BaseHandlerTrait
protected
StoreInterface|null
getStore()

No description

from  BaseHandlerTrait
public
BaseHandlerTrait
setStore(StoreInterface $store)

No description

from  BaseHandlerTrait
protected
StoreInterface
createStore(Member $member)

No description

from  BaseHandlerTrait
protected
SudoModeServiceInterface
getSudoModeService()

Returns a sudo mode service instance

from  BaseHandlerTrait
public
resetaccount(SS_HTTPRequest $request)

No description

public
Form
ResetAccountForm()

No description

public
SS_HTTPResponse
doResetAccount(array $data, Form $form)

Resets the user's password, and triggers other account reset procedures

Details

in Extension at line 42
__construct()

No description

in Extension at line 54
static add_to_class(string $class, string $extensionClass, mixed $args = null)

Called when this extension is added to a particular class

Parameters

string $class
string $extensionClass
mixed $args

in Extension at line 66
setOwner(SS_Object $owner, string $ownerBaseClass = null)

Set the owner of this extension.

Parameters

SS_Object $owner

The owner object,
string $ownerBaseClass

The base class that the extension is applied to; this may be the class of owner, or it may be a parent. For example, if Versioned was applied to SiteTree, and then a Page object was instantiated, $owner would be a Page object, but $ownerBaseClass would be 'SiteTree'.

in Extension at line 74
clearOwner()

No description

in Extension at line 85
SS_Object getOwner()

Returns the owner of this extension.

Return Value

SS_Object

in Extension at line 97
static string get_classname_without_arguments(string $extensionStr)

Helper method to strip eval'ed arguments from a string thats passed to DataObject::$extensions or Object::add_extension().

Parameters

string $extensionStr

E.g. "Versioned('Stage','Live')"

Return Value

string

Extension classname, e.g. "Versioned"

in BaseHandlerTrait at line 26
protected void applyRequirements(bool $frontEndRequirements = true)

Perform the necessary "Requirements" calls to ensure client side scripts are available in the response

Parameters

bool $frontEndRequirements

Indicates dependencies usually provided by admin should also be required

Return Value

void

in BaseHandlerTrait at line 50
protected StoreInterface|null getStore()

No description

Return Value

StoreInterface|null

in BaseHandlerTrait at line 64
BaseHandlerTrait setStore(StoreInterface $store)

No description

Parameters

StoreInterface $store

Return Value

BaseHandlerTrait

in BaseHandlerTrait at line 74
protected StoreInterface createStore(Member $member)

No description

Parameters

Member $member

Return Value

StoreInterface

in BaseHandlerTrait at line 87
protected SudoModeServiceInterface getSudoModeService()

Returns a sudo mode service instance

Return Value

SudoModeServiceInterface

at line 43
resetaccount(SS_HTTPRequest $request)

No description

Parameters

SS_HTTPRequest $request

at line 102
Form ResetAccountForm()

No description

Return Value

Form

at line 141
SS_HTTPResponse doResetAccount(array $data, Form $form)

Resets the user's password, and triggers other account reset procedures

Parameters

array $data
Form $form

Return Value

SS_HTTPResponse