class SecurityAdminExtension extends Extension (View source)

This extension is applied to SecurityAdmin to provide an additional endpoint for sending account reset requests.

Traits

Provides a simplified method for creating JSON-based HTTPResponses.

Properties

SecurityAdmin $owner
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

Methods

public
__construct()

No description

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

Called when this extension is added to a particular class

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

Set the owner of this extension.

public
clearOwner()

No description

public
getOwner()

Returns the owner of this 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().

public
jsonResponse(array $body, int $status = 200)

No description

public
reset(SS_HTTPRequest $request)

No description

protected
bool
sendResetEmail(MemberExtension $member)

Prepares and attempts to send the Account Reset request email.

public
string
getAccountResetLink(Member $member, string $token)

Generates a link to the Account Reset Handler endpoint to be sent to a Member.

Details

__construct()

No description

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

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'.

clearOwner()

No description

SS_Object getOwner()

Returns the owner of this extension.

Return Value

SS_Object

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"

SS_HTTPResponse jsonResponse(array $body, int $status = 200)

No description

Parameters

array $body
int $status

Return Value

SS_HTTPResponse

SS_HTTPResponse reset(SS_HTTPRequest $request)

No description

Parameters

SS_HTTPRequest $request

Return Value

SS_HTTPResponse

protected bool sendResetEmail(MemberExtension $member)

Prepares and attempts to send the Account Reset request email.

Parameters

MemberExtension $member

Return Value

bool

Generates a link to the Account Reset Handler endpoint to be sent to a Member.

Parameters

Member $member
string $token

Return Value

string