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 LoggerInterface $logger

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(object $owner)

Set the owner of this extension.

public
mixed
withOwner(mixed $owner, callable $callback, array $args = [])

Temporarily modify the owner. The original owner is ensured to be restored

public
clearOwner()

Clear the current owner, and restore extension to the state prior to the last setOwner()

public
object
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 that's passed to DataObject::$extensions or Object::add_extension().

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

No description

public
reset(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.

public
SecurityAdmin|null
setLogger(LoggerInterface|null $logger)

No description

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(object $owner)

Set the owner of this extension.

Parameters

object $owner

The owner object

mixed withOwner(mixed $owner, callable $callback, array $args = [])

Temporarily modify the owner. The original owner is ensured to be restored

Parameters

mixed $owner

Owner to set

callable $callback

Callback to invoke

array $args

Args to pass to callback

Return Value

mixed

clearOwner()

Clear the current owner, and restore extension to the state prior to the last setOwner()

object getOwner()

Returns the owner of this extension.

Return Value

object

static string get_classname_without_arguments(string $extensionStr)

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

Parameters

string $extensionStr

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

Return Value

string

Extension classname, e.g. "Versioned"

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

No description

Parameters

array $body
int $status

Return Value

HTTPResponse

HTTPResponse reset(HTTPRequest $request)

No description

Parameters

HTTPRequest $request

Return Value

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

SecurityAdmin|null setLogger(LoggerInterface|null $logger)

No description

Parameters

LoggerInterface|null $logger

Return Value

SecurityAdmin|null